¿Cómo genero un constructor a partir de campos de clase usando Visual Studio (y / o ReSharper)?


159

Me he acostumbrado a muchos de los IDEs de Java ( Eclipse , NetBeans y IntelliJ IDEA ) que le proporcionan un comando para generar un constructor predeterminado para una clase basada en los campos de la clase.

Por ejemplo:

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

Hacer que un constructor complete todos los campos de un objeto es una tarea tan común en la mayoría de los lenguajes OOP, supongo que hay una forma de ahorrar tiempo al escribir este código repetitivo en C #. Soy nuevo en el mundo de C #, así que me pregunto si me estoy perdiendo algo fundamental sobre el lenguaje. ¿Hay alguna opción en Visual Studio que sea obvia?

Respuestas:


124

ReSharper ofrece una herramienta Generar constructor donde puede seleccionar cualquier campo / propiedades que desee inicializar. Utilizo la tecla de acceso rápido Alt+ Inspara acceder a esto.


Eso responde a la pregunta para mí en términos de "hacerlo". Sin embargo, no hay soporte para ello en VS2010 directamente, ¿verdad?
Elijah

1
Como Jared menciona a continuación, VS2010 agregó una herramienta "Generar a partir del uso", pero por lo que puedo decir, no hay forma de generar un constructor basado en campos que ya están en la clase. Si intenta crear una instancia de la clase con una firma que no coincida con ninguna existente, le ofrecerá generar ese constructor por usted.
James Kolpack

Oh wow, sé que esta es una pregunta bastante antigua, ¡pero acabo de descubrirla!
Brett

49
Probablemente deberías mencionar que ReSharper no es gratis .
b1nary.atr0phy

184

En Visual Studio 2015 Update3 tengo esta característica.

Simplemente resaltando las propiedades y luego presione Ctrl+ .y luego presione Generar constructor .

Por ejemplo, si ha resaltado dos propiedades, le sugerirá que cree un constructor con dos parámetros y si ha seleccionado tres, le sugerirá uno con tres parámetros, etc.

También funciona con Visual Studio 2017.

Visualización automática de accesos directos


3
Hola, esto funcionó para mí en la comunidad Visual Studio 2015. No estoy seguro de cómo esto no se conoce públicamente, pero esto es bueno. Gracias. :)
El 0bserver

3
Eso es perfecto. El trabajo que esto podría haber salvado si lo hubiera leído el día que lo publicaste ... xD
Timo

3
Por lo que vale, la función no aparece si usa propiedades de solo lectura C # 6. (p. ej., public int Age { get; }) Deben tener los setters especificados, incluso si son temporales, para que la opción esté disponible. Probado en la comunidad VS2015; No estoy seguro si esto se ha solucionado en VS2017.
Chris Sinclair

1
@PouyaSamie: en C # 6.0, las propiedades automáticas de solo lectura se pueden asignar en el constructor. Vea esto para ver un ejemplo: github.com/dotnet/roslyn/wiki/…
Chris Sinclair

55
¡Esta es la solución perfecta! ¡Marcaría esto como la solución real!
Václav Holuša

29

C # agregó una nueva característica en Visual Studio 2010 llamada generar a partir del uso. La intención es generar el código estándar a partir de un patrón de uso. Una de las características es generar un constructor basado en un patrón de inicialización.

Se puede acceder a la función a través de la etiqueta inteligente que aparecerá cuando se detecte el patrón.

Por ejemplo, digamos que tengo la siguiente clase

class MyType { 

}

Y escribo lo siguiente en mi solicitud

var v1 = new MyType(42);

Un constructor que toma un intno existe, por lo que aparecerá una etiqueta inteligente y una de las opciones será "Generar código auxiliar de constructor". Al seleccionar eso, se modificará el código para MyTypeque sea el siguiente.

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

15

Podría escribir una macro para hacer esto; usaría el analizador de Visual Studio para recuperar información sobre los miembros de la clase.

Escribí una macro similar. (Compartiré el código a continuación). La macro que escribí es para copiar todos los constructores en una clase base cuando heredas de ella (útil para clases como Exception que tienen muchas sobrecargas en el ctor).

Aquí está mi macro (de nuevo, no resuelve su problema, pero probablemente puede modificar para hacer lo que quiera)


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
Falta un operador: "If searchParam.Type.AsFullName funcParam.Type.AsFullName Then" debería ser "If searchParam.Type.AsFullName = funcParam.Type.AsFullName Then"
LTR

1
@LTR Gran captura, excepto que se supone que es "If searchParam.Type.AsFullName <> funcParam.Type.AsFullName". Perdí el escape en los corchetes angulares: aparecieron en el editor, pero no en la vista. ¡Gracias!
JMarsch

13

A partir de Visual Studio 2017, parece ser una característica incorporada. Presiona Ctrl+ .mientras tu cursor está en el cuerpo de la clase y selecciona "Generar constructor" en el menú desplegable Acciones rápidas y refactorizaciones .


11

Aquí hay una macro que uso para ese propósito. Generará un constructor a partir de campos y propiedades que tengan un 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

Tuve que dividir la línea: "If Not String.IsNullOrEmpty (parameterName) And Not visitNames.ContainsKey (parameterName) Then" en dos líneas para evitar una excepción de referencia nula:
cedd

9

Tal vez podría probar esto: http://cometaddin.codeplex.com/


CodePlex se ha cerrado (pero el enlace todavía es válido, con un archivo descargable). Pero quizás intente actualizar el enlace (si el proyecto se ha movido a otro lugar). Y / o tome medidas para evitar un desastre si el enlace actual se rompe en el futuro.
Peter Mortensen

5

Puede hacerlo fácilmente con ReSharper 8 o posterior. El ctorf, ctorpy ctorfpfragmentos generan constructores que pueblan todos los campos, propiedades o campos y propiedades de una clase.


4

Aquí está la macro de Visual Studio de JMarsh modificada para generar un constructor basado en los campos y propiedades de la clase.

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

Para Visual Studio 2015 encontré una extensión que hace exactamente esto. Parece funcionar bien y tiene una cantidad razonablemente alta de descargas. Entonces, si no puede o no quiere usar ReSharper, puede instalar este.

También puede adquirirlo a través de NuGet .


-3

Estoy usando el siguiente truco:

Selecciono la declaración de la clase con los miembros de datos y presiono:

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

  • El primer comando copia la declaración en el portapapeles,
  • El segundo comando es un atajo que invoca el PROGRAMA
  • El último comando sobrescribe la selección por texto del portapapeles.

El PROGRAMA obtiene la declaración del portapapeles, encuentra el nombre de la clase, busca todos los miembros y sus tipos, genera un constructor y lo copia todo nuevamente en el portapapeles.

Lo estamos haciendo con estudiantes de primer año en mi práctica de "Programación-I" (Universidad de Charles, Praga) y la mayoría de los estudiantes lo hacen hasta el final de la hora.

Si quieres ver el código fuente, avísame.


1
El segundo comando es un acceso directo a la vista de clase, ¿no es así? ¿O este consejo no se trata de Visual Studio 2010?
Joel Peltonen
Al usar nuestro sitio, usted reconoce que ha leído y comprende nuestra Política de Cookies y Política de Privacidad.
Licensed under cc by-sa 3.0 with attribution required.