Come posso generare un costruttore dai campi di classe usando Visual Studio (e / o ReSharper)?


159

Mi sono abituato a molti degli IDE Java ( Eclipse , NetBeans e IntelliJ IDEA ) che forniscono un comando per generare un costruttore predefinito per una classe in base ai campi della classe.

Per esempio:

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

Avere un costruttore che popola tutti i campi di un oggetto è un'attività così comune nella maggior parte dei linguaggi OOP, presumo che ci sia un modo per me di risparmiare tempo scrivendo questo codice boilerplate in C #. Sono nuovo nel mondo C #, quindi mi chiedo se mi manca qualcosa di fondamentale sulla lingua? C'è qualche opzione in Visual Studio che è ovvia?

Risposte:


124

ReSharper offre uno strumento Genera costruttore in cui è possibile selezionare qualsiasi campo / proprietà che si desidera inizializzare. Uso il Alttasto di scelta Insrapida + per accedere a questo.


Ciò risponde alla domanda per me in termini di "farlo". Tuttavia, non c'è supporto direttamente in VS2010, giusto?
Elia il

1
Come menzionato di seguito da Jared, VS2010 ha aggiunto uno strumento "Genera da utilizzo", ma per quanto ne so, non c'è modo di generare un costruttore basato su campi già presenti nella classe. Se provi a creare un'istanza della classe con una firma che non corrisponde a nessuna esistente, offrirà di generare quel costruttore per te.
James Kolpack,

Oh wow, so che questa è una domanda abbastanza vecchia ma l'ho appena scoperta!
Brett,

49
Probabilmente dovresti dire che ReSharper non è gratuito .
b1nary.atr0phy

184

In Visual Studio 2015 Update3 ho questa funzione.

Evidenziando semplicemente le proprietà, quindi premere Ctrl+, .quindi Genera costruttore .

Ad esempio, se hai evidenziato due proprietà ti suggerirà di creare un costruttore con due parametri e se ne hai selezionati tre, ne suggerirai uno con tre parametri e così via.

Funziona anche con Visual Studio 2017.

Generazione automatica della visualizzazione dei collegamenti


3
Ehi, questo ha funzionato per me nella comunità di Visual Studio 2015. Non sono sicuro di come questo non sia molto pubblicamente noto, ma è bello. Grazie. :)
The 0bserver

3
È perfetto. Il lavoro che avrebbe potuto salvare se l'avessi letto il giorno in cui l'hai pubblicato ... xD
Timo,

3
Per quello che vale, la funzione non viene visualizzata se si utilizzano le proprietà di sola lettura di C # 6. (ad es. public int Age { get; }) Devono essere specificati nei setter, anche se temporaneamente, affinché l'opzione sia disponibile. Testato nella community VS2015; non sono sicuro se questo è stato risolto in VS2017.
Chris Sinclair,

1
@PouyaSamie: in C # 6.0, le proprietà automatiche di sola lettura possono essere assegnate nel costruttore. Vedi questo per un esempio: github.com/dotnet/roslyn/wiki/…
Chris Sinclair,

5
Questa è la soluzione perfetta! Vorrei contrassegnare questa come la vera soluzione!
Václav Holuša,

29

C # ha aggiunto una nuova funzionalità in Visual Studio 2010 chiamata generate dall'utilizzo. L'intento è generare il codice standard da un modello di utilizzo. Una delle caratteristiche è la generazione di un costruttore basato su un modello di inizializzazione.

La funzione è accessibile tramite lo smart tag che apparirà quando viene rilevato il motivo.

Ad esempio, supponiamo che io abbia la seguente classe

class MyType { 

}

E scrivo quanto segue nella mia domanda

var v1 = new MyType(42);

Un costruttore che prende un intnon esiste quindi verrà mostrato uno smart tag e una delle opzioni sarà "Genera stub costruttore". Selezionando questo, il codice verrà modificato per MyTypeessere il seguente.

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

15

È possibile scrivere una macro per fare ciò: utilizzare il parser di Visual Studio per recuperare informazioni sui membri della classe.

Ho scritto una macro simile. (Condividerò il codice qui sotto). La macro che ho scritto è per copiare in avanti tutti i costruttori in una classe base quando erediti da essa (utile per classi come le eccezioni che hanno molti sovraccarichi sul ctor).

Ecco la mia macro (di nuovo, non risolve il tuo problema, ma probabilmente puoi modificarlo per fare quello che vuoi)


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
Manca un operatore: "Se searchParam.Type.AsFullName funcParam.Type.AsFullName Quindi" dovrebbe essere "Se searchParam.Type.AsFullName = funcParam.Type.AsFullName Then"
LTR

1
@LTR Great catch - tranne che dovrebbe essere "If searchParam.Type.AsFullName <> funcParam.Type.AsFullName". Ho perso la fuga tra parentesi angolari: sono apparsi nell'editor, ma non nella vista. Grazie!
JMarsch,

13

A partire da Visual Studio 2017, questa sembra essere una funzionalità integrata. Premi Ctrl+ .mentre il cursore si trova nel corpo della classe e seleziona "Genera costruttore" dal menu a discesa Azioni rapide e Rifattorizzazioni .


11

Ecco una macro che uso a tale scopo. Genererà un costruttore da campi e proprietà che hanno un setter privato.

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

Ho dovuto dividere la riga: "If Not String.IsNullOrEmpty (parameterName) e Not visitedNames.ContainsKey (parameterName) Quindi" in due righe per evitare un'eccezione di riferimento null:
cedd

9

Forse potresti provare questo: http://cometaddin.codeplex.com/


CodePlex è stato chiuso (ma il collegamento è ancora in qualche modo valido, con un archivio scaricabile). Ma forse prova ad aggiornare il link (se il progetto è stato spostato altrove). E / o prendere misure per prevenire un disastro se il collegamento corrente viene interrotto in futuro.
Peter Mortensen,

5

Puoi farlo facilmente con ReSharper 8 o versioni successive. Il ctorf, ctorpe ctorfpframmenti generano costruttori che popolano tutti i campi, le proprietà, o campi e le proprietà di una classe.


4

Ecco la macro di Visual Studio di JMarsh modificata per generare un costruttore basato sui campi e sulle proprietà della 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

2

Per Visual Studio 2015 ho trovato un'estensione che fa proprio questo. Sembra funzionare bene e ha una quantità ragionevolmente alta di download. Quindi, se non puoi o non vuoi usare ReSharper, puoi installare questo.

Puoi anche acquisirlo tramite NuGet .


-3

Sto usando il seguente trucco:

Seleziono la dichiarazione della classe con i membri dei dati e premo:

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

  • Il primo comando copia la dichiarazione negli appunti,
  • Il secondo comando è un collegamento che richiama il PROGRAMMA
  • L'ultimo comando sovrascrive la selezione per testo dagli appunti.

Il PROGRAMMA ottiene la dichiarazione dagli Appunti, trova il nome della classe, trova tutti i membri e i loro tipi, genera costruttore e copia tutto negli Appunti.

Lo stiamo facendo con matricole nella mia pratica di "Programmazione-I" (Charles University, Praga) e la maggior parte degli studenti lo fa fino alla fine dell'ora.

Se vuoi vedere il codice sorgente, fammi sapere.


1
Il secondo comando è un collegamento alla vista di classe, no? Oppure questo suggerimento non riguarda Visual Studio 2010?
Joel Peltonen,
Utilizzando il nostro sito, riconosci di aver letto e compreso le nostre Informativa sui cookie e Informativa sulla privacy.
Licensed under cc by-sa 3.0 with attribution required.