Como gerar um construtor a partir dos campos de classe usando o Visual Studio (e / ou ReSharper)?

158

Eu me acostumei a muitos dos Java IDEs ( Eclipse , NetBeans e IntelliJ IDEA ), fornecendo um comando para gerar um construtor padrão para uma classe com base nos campos da classe.

Por exemplo:

public class Example
{
    public decimal MyNumber { get; set; }
    public string Description { get; set; }
    public int SomeInteger { get; set; }

    // ↓↓↓ This is what I want generated ↓↓↓
    public Example(decimal myNumber, string description, int someInteger)
    {
        MyNumber = myNumber;
        Description = description;
        SomeInteger = someInteger;
    }
}

Ter um construtor preenchendo todos os campos de um objeto é uma tarefa tão comum na maioria dos idiomas OOP, presumo que haja uma maneira de economizar tempo escrevendo esse código padrão em C #. Eu sou novo no mundo C #, então estou me perguntando se estou perdendo algo fundamental sobre o idioma. Existe alguma opção no Visual Studio que é óbvia?

Elijah
fonte

Respostas:

124

O ReSharper oferece uma ferramenta Generate Constructor , na qual você pode selecionar qualquer campo / propriedade que deseja inicializar. Eu uso a tecla de atalho Alt+ Inspara acessar isso.

James Kolpack
fonte
Isso responde a pergunta para mim em termos de "fazê-lo". No entanto, não há suporte para isso diretamente no VS2010, certo?
Elias
1
Como Jared menciona abaixo, o VS2010 adicionou uma ferramenta "Gerar a partir do uso", mas, pelo que sei, não há como gerar um construtor com base nos campos que já estão na classe. Se você tentar instanciar a classe com uma assinatura que não corresponda a nenhuma existente, ela oferecerá a geração desse construtor para você.
James Kolpack
Oh uau, eu sei que essa é uma pergunta bastante antiga, mas eu acabei de descobrir isso!
Brett
49
Você provavelmente deve mencionar que o ReSharper não é gratuito .
b1nary.atr0phy
184

No Visual Studio 2015 Update3, tenho esse recurso.

Apenas realçando propriedades e pressione Ctrl+ .e, em seguida, pressione Gerar Construtor .

Por exemplo, se você destacou duas propriedades, sugerirá que você crie um construtor com dois parâmetros e, se você selecionou três, sugerirá um com três parâmetros e assim por diante.

Também funciona com o Visual Studio 2017.

Visualização automática de atalhos de geração

Pouya Samie
fonte
3
Ei, isso funcionou para mim na comunidade do Visual Studio 2015. Não tenho certeza de como isso não é muito conhecido publicamente, mas isso é legal. Obrigado. :)
The 0bserver
3
Isso é perfeito. O trabalho esta poderia ter economizado se eu tinha lido o dia que você postou ... xD
Timo
3
Pelo que vale a pena, o recurso não será exibido se você usar propriedades C-6 somente leitura. (por exemplo, public int Age { get; }) Eles precisam ter nos setters especificados, mesmo que temporariamente, para que a opção esteja disponível. Testado na comunidade VS2015; não tenho certeza se isso foi corrigido no VS2017.
18717 Chris
1
@PouyaSamie: No C # 6.0, propriedades automáticas somente leitura podem ser atribuídas no construtor. Veja isto para um exemplo: github.com/dotnet/roslyn/wiki/…
Chris Sinclair
5
Esta é a solução perfeita! Eu marcaria isso como a solução real!
Václav Holuša
29

O C # adicionou um novo recurso no Visual Studio 2010 chamado gerar a partir do uso. A intenção é gerar o código padrão a partir de um padrão de uso. Um dos recursos é gerar um construtor baseado em um padrão de inicialização.

O recurso é acessível por meio da marca inteligente que aparecerá quando o padrão for detectado.

Por exemplo, digamos que tenho a seguinte classe

class MyType { 

}

E escrevo o seguinte na minha inscrição

var v1 = new MyType(42);

intNão existe um construtor usando uma marca, então uma marca inteligente será exibida e uma das opções será "Gerar stub do construtor". A seleção que modificará o código para MyTypeser o seguinte.

class MyType {
    private int p;
    public MyType(int p) {
        // TODO: Complete member initialization
        this.p = p;
    }
}
JaredPar
fonte
15

Você pode escrever uma macro para fazer isso - você usaria o analisador do Visual Studio para recuperar informações sobre os membros da classe.

Eu escrevi uma macro semelhante. (Compartilharei o código abaixo). A macro que escrevi é para copiar adiante todos os construtores de uma classe base quando você a herdar (útil para classes como Exception que possuem muitas sobrecargas no ctor).

Aqui está minha macro (novamente, isso não resolve o seu problema, mas você provavelmente pode modificar para fazer o que quiser)


Imports System
Imports EnvDTE
Imports EnvDTE80
Imports EnvDTE90
Imports EnvDTE100
Imports System.Diagnostics

Public Module ConstructorEditor
    Public Sub StubConstructors()
        'adds stubs for all of the constructors in the current class's base class
        Dim selection As TextSelection = DTE.ActiveDocument.Selection
        Dim classInfo As CodeClass2 = GetClassElement()

        If classInfo Is Nothing Then
            System.Windows.Forms.MessageBox.Show("No class was found surrounding the cursor.  Make sure that this file compiles and try again.", "Error")
            Return
        End If

        If classInfo.Bases.Count = 0 Then
            System.Windows.Forms.MessageBox.Show("No parent class was found for this class.  Make sure that this file, and any file containing parent classes compiles and try again")
            Return
        End If

        'setting up an undo context -- one ctrl+z undoes everything
        Dim closeUndoContext As Boolean = False
        If DTE.UndoContext.IsOpen = False Then
            closeUndoContext = True
            DTE.UndoContext.Open("StubConstructorsContext", False)
        End If

        Try
            Dim parentInfo As CodeClass2 = classInfo.Bases.Item(1)
            Dim childConstructors As System.Collections.Generic.List(Of CodeFunction2) = GetConstructors(classInfo)
            Dim parentConstructors As System.Collections.Generic.List(Of CodeFunction2) = GetConstructors(parentInfo)
            For Each constructor As CodeFunction2 In parentConstructors
                If Not MatchingSignatureExists(constructor, childConstructors) Then
                    ' we only want to create ctor stubs for ctors that are missing
                    ' note: a dictionary could be more efficient, but I doubt most classes will have more than 4 or 5 ctors...
                    StubConstructor(classInfo, constructor)
                End If
            Next
        Finally
            If closeUndoContext Then
                DTE.UndoContext.Close()
            End If
        End Try
    End Sub
    Private Function GetConstructors(ByVal classInfo As CodeClass2) As System.Collections.Generic.List(Of CodeFunction2)
        ' return a list of all of the constructors in the specified class
        Dim result As System.Collections.Generic.List(Of CodeFunction2) = New System.Collections.Generic.List(Of CodeFunction2)
        Dim func As CodeFunction2
        For Each member As CodeElement2 In classInfo.Members
            ' members collection has all class members.  filter out just the function members, and then of the functions, grab just the ctors
            func = TryCast(member, CodeFunction2)
            If func Is Nothing Then Continue For
            If func.FunctionKind = vsCMFunction.vsCMFunctionConstructor Then
                result.Add(func)
            End If
        Next
        Return result
    End Function
    Private Function MatchingSignatureExists(ByVal searchFunction As CodeFunction2, ByVal functions As System.Collections.Generic.List(Of CodeFunction2)) As Boolean
        ' given a function (searchFunction), searches a list of functions where the function signatures (not necessarily the names) match
        ' return null if no match is found, otherwise returns first match
        For Each func As CodeFunction In functions
            If func.Parameters.Count <> searchFunction.Parameters.Count Then Continue For
            Dim searchParam As CodeParameter2
            Dim funcParam As CodeParameter2
            Dim match As Boolean = True

            For count As Integer = 1 To searchFunction.Parameters.Count
                searchParam = searchFunction.Parameters.Item(count)
                funcParam = func.Parameters.Item(count)
                If searchParam.Type.AsFullName <> funcParam.Type.AsFullName Then
                    match = False
                    Exit For
                End If
            Next

            If match Then
                Return True
            End If
        Next
        ' no match found
        Return False
    End Function

    Private Sub StubConstructor(ByVal classInfo As CodeClass2, ByVal parentConstructor As CodeFunction2)
        ' adds a constructor to the current class, based upon the parentConstructor that is passed in

        ' highly inefficient hack to position the ctor where I want it (after the last ctor in the class, if there is another ctor
        ' note that passing zero as the position (put the ctor first) caused some problems when we were adding ctors to classes that already had ctors
        Dim position As Object
        Dim ctors As System.Collections.Generic.List(Of CodeFunction2) = GetConstructors(classInfo)

        If ctors.Count = 0 Then
            position = 0
        Else
            position = ctors.Item(ctors.Count - 1)
        End If

        ' if there are no other ctors, put this one at the top
        Dim ctor As CodeFunction2 = classInfo.AddFunction(classInfo.Name, vsCMFunction.vsCMFunctionConstructor, vsCMTypeRef.vsCMTypeRefVoid, position, parentConstructor.Access)

        Dim baseCall As String = ":base("
        Dim separator As String = ""
        For Each parameter As CodeParameter2 In parentConstructor.Parameters
            ctor.AddParameter(parameter.Name, parameter.Type, -1)
            baseCall += separator + parameter.Name
            separator = ", "
        Next
        baseCall += ")"

        ' and 1 sad hack -- appears to be no way to programmatically add the :base() calls without using direct string manipulation
        Dim startPoint As TextPoint = ctor.GetStartPoint()
        Dim endOfSignature As EditPoint = startPoint.CreateEditPoint()
        endOfSignature.EndOfLine()
        endOfSignature.Insert(baseCall)
        startPoint.CreateEditPoint().SmartFormat(endOfSignature)
    End Sub

    Private Function GetClassElement() As CodeClass2
        'returns a CodeClass2 element representing the class that the cursor is within, or null if there is no class
        Try
            Dim selection As TextSelection = DTE.ActiveDocument.Selection
            Dim fileCodeModel As FileCodeModel2 = DTE.ActiveDocument.ProjectItem.FileCodeModel
            Dim element As CodeElement2 = fileCodeModel.CodeElementFromPoint(selection.TopPoint, vsCMElement.vsCMElementClass)
            Return element
        Catch
            Return Nothing
        End Try
    End Function

End Module

JMarsch
fonte
1
Existe um operador ausente: "Se searchParam.Type.AsFullName funcParam.Type.AsFullName Then" deve ser "Se searchParam.Type.AsFullName = funcParam.Type.AsFullName Then"
LTR
1
@LTR Grande captura - exceto que deveria ser "Se searchParam.Type.AsFullName <> funcParam.Type.AsFullName". Eu perdi a fuga entre colchetes angulares - eles apareceram no editor, mas não na vista. Obrigado!
JMarsch
13

A partir do Visual Studio 2017, esse parece ser um recurso interno. Pressione Ctrl+ .enquanto o cursor estiver no corpo da classe e selecione "Gerar construtor" na lista suspensa Ações rápidas e refatorações .

lt1
fonte
11

Aqui está uma macro que eu uso para esse fim. Ele irá gerar um construtor a partir de campos e propriedades que possuem um setter privado.

Imports System
Imports EnvDTE
Imports EnvDTE80
Imports EnvDTE90
Imports EnvDTE90a
Imports EnvDTE100
Imports System.Diagnostics
Imports System.Collections.Generic

Public Module Temp

    Sub AddConstructorFromFields()
        DTE.UndoContext.Open("Add constructor from fields")

        Dim classElement As CodeClass, index As Integer
        GetClassAndInsertionIndex(classElement, index)

        Dim constructor As CodeFunction
        constructor = classElement.AddFunction(classElement.Name, vsCMFunction.vsCMFunctionConstructor, vsCMTypeRef.vsCMTypeRefVoid, index, vsCMAccess.vsCMAccessPublic)

        Dim visitedNames As New Dictionary(Of String, String)
        Dim element As CodeElement, parameterPosition As Integer, isFirst As Boolean = True
        For Each element In classElement.Children
            Dim fieldType As String
            Dim fieldName As String
            Dim parameterName As String

            Select Case element.Kind
                Case vsCMElement.vsCMElementVariable
                    Dim field As CodeVariable = CType(element, CodeVariable)
                    fieldType = field.Type.AsString
                    fieldName = field.Name
                    parameterName = field.Name.TrimStart("_".ToCharArray())

                Case vsCMElement.vsCMElementProperty
                    Dim field As CodeProperty = CType(element, CodeProperty)
                    If field.Setter.Access = vsCMAccess.vsCMAccessPrivate Then
                        fieldType = field.Type.AsString
                        fieldName = field.Name
                        parameterName = field.Name.Substring(0, 1).ToLower() + field.Name.Substring(1)
                    End If
            End Select

            If Not String.IsNullOrEmpty(parameterName) And Not visitedNames.ContainsKey(parameterName) Then
                visitedNames.Add(parameterName, parameterName)

                constructor.AddParameter(parameterName, fieldType, parameterPosition)

                Dim endPoint As EditPoint
                endPoint = constructor.EndPoint.CreateEditPoint()
                endPoint.LineUp()
                endPoint.EndOfLine()

                If Not isFirst Then
                    endPoint.Insert(Environment.NewLine)
                Else
                    isFirst = False
                End If

                endPoint.Insert(String.Format(MemberAssignmentFormat(constructor.Language), fieldName, parameterName))

                parameterPosition = parameterPosition + 1
            End If
        Next

        DTE.UndoContext.Close()

        Try
            ' This command fails sometimes '
            DTE.ExecuteCommand("Edit.FormatDocument")
        Catch ex As Exception
        End Try
    End Sub
    Private Sub GetClassAndInsertionIndex(ByRef classElement As CodeClass, ByRef index As Integer, Optional ByVal useStartIndex As Boolean = False)
        Dim selection As TextSelection
        selection = CType(DTE.ActiveDocument.Selection, TextSelection)

        classElement = CType(selection.ActivePoint.CodeElement(vsCMElement.vsCMElementClass), CodeClass)

        Dim childElement As CodeElement
        index = 0
        For Each childElement In classElement.Children
            Dim childOffset As Integer
            childOffset = childElement.GetStartPoint(vsCMPart.vsCMPartWholeWithAttributes).AbsoluteCharOffset
            If selection.ActivePoint.AbsoluteCharOffset < childOffset Or useStartIndex Then
                Exit For
            End If
            index = index + 1
        Next
    End Sub
    Private ReadOnly Property MemberAssignmentFormat(ByVal language As String) As String
        Get
            Select Case language
                Case CodeModelLanguageConstants.vsCMLanguageCSharp
                    Return "this.{0} = {1};"

                Case CodeModelLanguageConstants.vsCMLanguageVB
                    Return "Me.{0} = {1}"

                Case Else
                    Return ""
            End Select
        End Get
    End Property
End Module
Antoine Aubry
fonte
Eu tive que dividir a linha: "If Not String.IsNullOrEmpty (parameterName) And Not visitedNames.ContainsKey (parameterName) Then" em duas linhas para evitar uma exceção de referência nula:
cedd
9

Talvez você possa experimentar isso: http://cometaddin.codeplex.com/

Simon
fonte
O CodePlex foi desligado (mas o link ainda é válido, com um arquivo para download). Mas talvez tente atualizar o link (se o projeto foi movido para outro lugar). E / ou tome medidas para evitar um desastre se o link atual for quebrado no futuro.
Peter Mortensen
5

Você pode fazer isso facilmente com o ReSharper 8 ou posterior. A ctorf, ctorpe ctorfptrechos gerar construtores que povoam todos os campos, propriedades ou campos e propriedades de uma classe.

Mike B
fonte
4

Aqui está a macro do Visual Studio do JMarsh modificada para gerar um construtor com base nos campos e propriedades da classe.

Imports System
Imports EnvDTE
Imports EnvDTE80
Imports EnvDTE90
Imports EnvDTE100
Imports System.Diagnostics
Imports System.Collections.Generic

Public Module ConstructorEditor

    Public Sub AddConstructorFromFields()

        Dim classInfo As CodeClass2 = GetClassElement()
        If classInfo Is Nothing Then
            System.Windows.Forms.MessageBox.Show("No class was found surrounding the cursor.  Make sure that this file compiles and try again.", "Error")
            Return
        End If

        ' Setting up undo context. One Ctrl+Z undoes everything
        Dim closeUndoContext As Boolean = False
        If DTE.UndoContext.IsOpen = False Then
            closeUndoContext = True
            DTE.UndoContext.Open("AddConstructorFromFields", False)
        End If

        Try
            Dim dataMembers As List(Of DataMember) = GetDataMembers(classInfo)
            AddConstructor(classInfo, dataMembers)
        Finally
            If closeUndoContext Then
                DTE.UndoContext.Close()
            End If
        End Try

    End Sub

    Private Function GetClassElement() As CodeClass2
        ' Returns a CodeClass2 element representing the class that the cursor is within, or null if there is no class
        Try
            Dim selection As TextSelection = DTE.ActiveDocument.Selection
            Dim fileCodeModel As FileCodeModel2 = DTE.ActiveDocument.ProjectItem.FileCodeModel
            Dim element As CodeElement2 = fileCodeModel.CodeElementFromPoint(selection.TopPoint, vsCMElement.vsCMElementClass)
            Return element
        Catch
            Return Nothing
        End Try
    End Function

    Private Function GetDataMembers(ByVal classInfo As CodeClass2) As System.Collections.Generic.List(Of DataMember)

        Dim dataMembers As List(Of DataMember) = New List(Of DataMember)
        Dim prop As CodeProperty2
        Dim v As CodeVariable2

        For Each member As CodeElement2 In classInfo.Members

            prop = TryCast(member, CodeProperty2)
            If Not prop Is Nothing Then
                dataMembers.Add(DataMember.FromProperty(prop.Name, prop.Type))
            End If

            v = TryCast(member, CodeVariable2)
            If Not v Is Nothing Then
                If v.Name.StartsWith("_") And Not v.IsConstant Then
                    dataMembers.Add(DataMember.FromPrivateVariable(v.Name, v.Type))
                End If
            End If

        Next

        Return dataMembers

    End Function

    Private Sub AddConstructor(ByVal classInfo As CodeClass2, ByVal dataMembers As List(Of DataMember))

        ' Put constructor after the data members
        Dim position As Object = dataMembers.Count

        ' Add new constructor
        Dim ctor As CodeFunction2 = classInfo.AddFunction(classInfo.Name, vsCMFunction.vsCMFunctionConstructor, vsCMTypeRef.vsCMTypeRefVoid, position, vsCMAccess.vsCMAccessPublic)

        For Each dataMember As DataMember In dataMembers
            ctor.AddParameter(dataMember.NameLocal, dataMember.Type, -1)
        Next

        ' Assignments
        Dim startPoint As TextPoint = ctor.GetStartPoint(vsCMPart.vsCMPartBody)
        Dim point As EditPoint = startPoint.CreateEditPoint()
        For Each dataMember As DataMember In dataMembers
            point.Insert("            " + dataMember.Name + " = " + dataMember.NameLocal + ";" + Environment.NewLine)
        Next

    End Sub

    Class DataMember

        Public Name As String
        Public NameLocal As String
        Public Type As Object

        Private Sub New(ByVal name As String, ByVal nameLocal As String, ByVal type As Object)
            Me.Name = name
            Me.NameLocal = nameLocal
            Me.Type = type
        End Sub

        Shared Function FromProperty(ByVal name As String, ByVal type As Object)

            Dim nameLocal As String
            If Len(name) > 1 Then
                nameLocal = name.Substring(0, 1).ToLower + name.Substring(1)
            Else
                nameLocal = name.ToLower()
            End If

            Return New DataMember(name, nameLocal, type)

        End Function

        Shared Function FromPrivateVariable(ByVal name As String, ByVal type As Object)

            If Not name.StartsWith("_") Then
                Throw New ArgumentException("Expected private variable name to start with underscore.")
            End If

            Dim nameLocal As String = name.Substring(1)

            Return New DataMember(name, nameLocal, type)

        End Function

    End Class

End Module
rybo103
fonte
2

Para o Visual Studio 2015, encontrei uma extensão que faz exatamente isso. Parece funcionar bem e possui uma quantidade razoavelmente alta de downloads. Portanto, se você não pode ou não deseja usar o ReSharper, pode instalar este.

Você também pode adquiri-lo via NuGet .

TKharaishvili
fonte
-3

Estou usando o seguinte truque:

Seleciono a declaração da classe com os membros dos dados e pressiono:

Ctrl+ C, Shift+ Ctrl+ C, Ctrl+ V.

  • O primeiro comando copia a declaração para a área de transferência,
  • O segundo comando é um atalho que chama o PROGRAMA
  • O último comando substitui a seleção pelo texto da área de transferência.

O PROGRAMA obtém a declaração da área de transferência, localiza o nome da classe, encontra todos os membros e seus tipos, gera construtor e copia tudo de volta para a área de transferência.

Estamos fazendo isso com calouros na minha prática de "Programação-I" (Universidade Charles, Praga) e a maioria dos alunos faz isso até o final da hora.

Se você quiser ver o código fonte, me avise.

Tom Holan
fonte
1
O segundo comando é um atalho para a exibição de classe, não é? Ou essa dica não é sobre o Visual Studio 2010?
Joel Peltonen