Jak wygenerować konstruktora z pól klas przy użyciu programu Visual Studio (i / lub ReSharper)?


159

Przyzwyczaiłem się do wielu środowisk Java IDE ( Eclipse , NetBeans i IntelliJ IDEA ) udostępniających polecenie wygenerowania domyślnego konstruktora dla klasy na podstawie pól w klasie.

Na przykład:

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;
    }
}

Posiadanie konstruktora wypełniającego wszystkie pola obiektu jest tak powszechnym zadaniem w większości języków OOP, zakładam, że istnieje sposób, aby zaoszczędzić czas, pisząc ten standardowy kod w C #. Jestem nowy w świecie C #, więc zastanawiam się, czy brakuje mi czegoś fundamentalnego w tym języku? Czy jest jakaś opcja w programie Visual Studio, która jest oczywista?

Odpowiedzi:


124

ReSharper oferuje narzędzie Generate Constructor , w którym możesz wybrać dowolne pole / właściwości, które chcesz zainicjować. Aby uzyskać dostęp do tego, używam klawisza skrótu Alt+ Ins.


To odpowiada na pytanie w kategoriach „załatwienia sprawy”. Jednak nie ma dla niego bezpośredniego wsparcia w VS2010, prawda?
Elijah

1
Jak Jared wspomina poniżej, VS2010 dodał narzędzie „Generuj na podstawie użycia”, ale o ile wiem, nie ma sposobu na wygenerowanie konstruktora na podstawie pól, które są już w klasie. Jeśli spróbujesz utworzyć instancję klasy z podpisem, który nie pasuje do żadnej z istniejących, zaproponuje wygenerowanie tego konstruktora.
James Kolpack

Och, wiem, że to dość stare pytanie, ale dopiero co odkryłem!
Brett,

49
Prawdopodobnie powinieneś wspomnieć, że ReSharper nie jest darmowy .
b1nary.atr0phy

184

W programie Visual Studio 2015 Update3 mam tę funkcję.

Wystarczy zaznaczyć właściwości, a następnie nacisnąć Ctrl+, .a następnie nacisnąć Generuj konstruktor .

Na przykład, jeśli zaznaczyłeś dwie właściwości, zasugeruje ci utworzenie konstruktora z dwoma parametrami, a jeśli wybrałeś trzy, zasugeruje jeden z trzema parametrami i tak dalej.

Działa również z programem Visual Studio 2017.

Automatycznie generuj wizualizację skrótów


3
Hej, to zadziałało dla mnie w społeczności Visual Studio 2015. Nie jestem pewien, dlaczego nie jest to powszechnie znane, ale to miło. Dzięki. :)
The 0bserver

3
To jest perfekcyjne. Praca ta mogła zapisać gdybym ją przeczytać dzień pisał to ... xD
Timo

3
Warto zauważyć, że funkcja nie pojawia się, jeśli używasz właściwości tylko do odczytu języka C # 6. (np. public int Age { get; }) Muszą mieć określone at setters, nawet jeśli tymczasowo, aby opcja była dostępna. Przetestowano w społeczności VS2015; nie jestem pewien, czy zostało to naprawione w VS2017.
Chris Sinclair

1
@PouyaSamie: W C # 6,0 właściwości automatyczne tylko do odczytu można przypisać w konstruktorze. Zobacz to na przykład: github.com/dotnet/roslyn/wiki/ ...
Chris Sinclair

5
To idealne rozwiązanie! Oznaczałbym to jako prawdziwe rozwiązanie!
Václav Holuša

29

C # dodał nową funkcję w programie Visual Studio 2010 o nazwie Generuj na podstawie użycia. Celem jest wygenerowanie standardowego kodu na podstawie wzorca użycia. Jedną z funkcji jest generowanie konstruktora na podstawie wzorca inicjalizacji.

Ta funkcja jest dostępna za pośrednictwem inteligentnego tagu, który pojawi się po wykryciu wzorca.

Na przykład, powiedzmy, że mam następującą klasę

class MyType { 

}

W mojej aplikacji piszę co następuje

var v1 = new MyType(42);

Konstruktor pobierający intkod nie istnieje, więc pojawi się tag inteligentny, a jedną z opcji będzie „Generuj kod konstruktora”. Wybranie tego spowoduje zmodyfikowanie kodu na MyTypenastępujący.

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

15

Możesz napisać makro, aby to zrobić - użyjesz parsera programu Visual Studio do pobrania informacji o członkach klasy.

Napisałem podobne makro. (Podzielę się kodem poniżej). Makro, które napisałem, służy do kopiowania w przód wszystkich konstruktorów w klasie bazowej podczas dziedziczenia po nim (przydatne w przypadku klas takich jak Exception, które mają wiele przeciążeń na ctor).

Oto moje makro (ponownie, to nie rozwiązuje twojego problemu, ale prawdopodobnie możesz zmodyfikować, aby robić to, co chcesz)


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


1
Brakuje operatora: „If searchParam.Type.AsFullName funcParam.Type.AsFullName Then” powinno mieć wartość „If searchParam.Type.AsFullName = funcParam.Type.AsFullName Then”
LTR

1
@LTR Świetny chwyt - z wyjątkiem tego, że ma to być „If searchParam.Type.AsFullName <> funcParam.Type.AsFullName”. Brakowało mi ucieczki na nawiasach kątowych - pojawiły się w edytorze, ale nie w widoku. Dzięki!
JMarsch,

13

Od wersji Visual Studio 2017 wygląda na to, że jest to funkcja wbudowana. Naciśnij Ctrl+, .gdy kursor znajduje się w treści klasy, i wybierz „Generuj konstruktor” z listy rozwijanej Szybkie akcje i refaktoryzacje .


11

Oto makro, którego używam do tego celu. Wygeneruje konstruktora z pól i właściwości, które mają prywatny ustawiacz.

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

Musiałem podzielić wiersz: „If Not String.IsNullOrEmpty (parameterName) And Not VisitedNames.ContainsKey (parameterName) Then” na dwa wiersze, aby uniknąć zerowego wyjątku odniesienia:
cedd

9

Może mógłbyś spróbować tego: http://cometaddin.codeplex.com/


CodePlex został zamknięty (ale łącze jest obecnie nadal nieco poprawne, z archiwum do pobrania). Ale może spróbuj zaktualizować link (jeśli projekt został przeniesiony w inne miejsce). I / lub podejmij kroki, aby zapobiec katastrofie, jeśli obecne łącze zostanie zerwane w przyszłości.
Peter Mortensen

5

Możesz to łatwo zrobić za pomocą ReSharper 8 lub nowszego. Fragmenty ctorf, ctorpi ctorfpgenerują konstruktory, które wypełniają wszystkie pola, właściwości lub pola i właściwości klasy.


4

Oto makro JMarsha Visual Studio zmodyfikowane w celu generowania konstruktora na podstawie pól i właściwości w klasie.

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

2

W przypadku programu Visual Studio 2015 znalazłem rozszerzenie, które właśnie to robi. Wydaje się, że działa dobrze i ma dość dużą liczbę pobrań. Więc jeśli nie możesz lub nie chcesz używać ReSharper, możesz zamiast tego zainstalować ten.

Możesz go również uzyskać za pośrednictwem NuGet .


-3

Używam następującej sztuczki:

Wybieram deklarację klasy z członkami danych i naciskam:

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

  • Pierwsze polecenie kopiuje deklarację do schowka,
  • Drugie polecenie to skrót wywołujący PROGRAM
  • Ostatnie polecenie zastępuje zaznaczenie tekstem ze schowka.

PROGRAM pobiera deklarację ze schowka, znajduje nazwę klasy, znajduje wszystkie składowe i ich typy, generuje konstruktor i kopiuje wszystko z powrotem do schowka.

Robimy to ze studentami pierwszego roku na mojej praktyce "Programowanie I" (Uniwersytet Karola w Pradze) i większość studentów robi to do końca.

Jeśli chcesz zobaczyć kod źródłowy, daj mi znać.


1
Drugie polecenie to skrót do widoku klasy, prawda? Czy ta wskazówka nie dotyczy programu Visual Studio 2010?
Joel Peltonen
Korzystając z naszej strony potwierdzasz, że przeczytałeś(-aś) i rozumiesz nasze zasady używania plików cookie i zasady ochrony prywatności.
Licensed under cc by-sa 3.0 with attribution required.