Was ist der beste Weg, um eine C# Auto-Eigenschaft einen Anfangswert zu geben?

Question

Wie gibt man einer C#-Auto-Eigenschaft einen Anfangswert?

Entweder verwende ich den Konstruktor, oder ich greife auf die alte Syntax zurück.

Verwendung des Konstruktors:

class Person 
{
    public Person()
    {
        Name = "Initial Name";
    }
    public string Name { get; set; }
}

Verwendung der normalen Eigenschaftssyntax (mit einem Anfangswert)

private string name = "Initial Name";
public string Name 
{
    get 
    {
        return name;
    }
    set
    {
        name = value;
    }
}

Gibt es einen besseren Weg?

Answer 1

In C# 5 und früher mussten Sie einen Konstruktor verwenden, um automatisch implementierten Eigenschaften einen Anfangswert zu geben.

Seit C# 6.0 können Sie den Anfangswert in-line angeben. Die Syntax lautet:

public int X { get; set; } = x; // C# 6 or higher

DefaultValueAttribute soll vom VS-Designer (oder einem anderen Verbraucher) verwendet werden, um einen Standardwert anzugeben, nicht einen Anfangswert. (Auch wenn im entworfenen Objekt der Anfangswert der Standardwert ist).

Zur Kompilierzeit DefaultValueAttribute hat keinen Einfluss auf die generierte AWL und es wird nicht gelesen, um die Eigenschaft auf diesen Wert zu initialisieren (siehe Das DefaultValue-Attribut funktioniert nicht mit meiner Auto-Eigenschaft ).

Beispiele für Attribute, die sich auf die IL auswirken, sind ThreadStaticAttribute , CallerMemberNameAttribute , ...

Answer 2

Bearbeitet am 1/2/15

C# 6 :

Mit C# 6 können Sie Auto-Properties direkt initialisieren (endlich!), es gibt jetzt andere Antworten, die das beschreiben.

C# 5 und niedriger :

Obwohl die beabsichtigte Verwendung des Attributs nicht darin besteht, die Werte der Eigenschaften tatsächlich zu setzen, können Sie die Reflexion verwenden, um sie trotzdem immer zu setzen...

public class DefaultValuesTest
{    
    public DefaultValuesTest()
    {               
        foreach (PropertyDescriptor property in TypeDescriptor.GetProperties(this))
        {
            DefaultValueAttribute myAttribute = (DefaultValueAttribute)property.Attributes[typeof(DefaultValueAttribute)];

            if (myAttribute != null)
            {
                property.SetValue(this, myAttribute.Value);
            }
        }
    }

    public void DoTest()
    {
        var db = DefaultValueBool;
        var ds = DefaultValueString;
        var di = DefaultValueInt;
    }

    [System.ComponentModel.DefaultValue(true)]
    public bool DefaultValueBool { get; set; }

    [System.ComponentModel.DefaultValue("Good")]
    public string DefaultValueString { get; set; }

    [System.ComponentModel.DefaultValue(27)]
    public int DefaultValueInt { get; set; }
}

Answer 3

Wenn Sie einen Anfangswert für eine Variable einfügen, wird dies ohnehin implizit im Konstruktor geschehen.

Ich würde argumentieren, dass diese Syntax war beste Praxis in C # bis 5:

class Person 
{
    public Person()
    {
        //do anything before variable assignment

        //assign initial values
        Name = "Default Name";

        //do anything after variable assignment
    }
    public string Name { get; set; }
}

So haben Sie eine klare Kontrolle über die Reihenfolge, in der die Werte zugewiesen werden.

Ab C#6 gibt es einen neuen Weg:

public string Name { get; set; } = "Default Name";

Answer 4

Manchmal verwende ich dies, wenn ich nicht möchte, dass die Daten tatsächlich in meiner Datenbank gespeichert und persistiert werden:

class Person
{
    private string _name; 
    public string Name 
    { 
        get 
        {
            return string.IsNullOrEmpty(_name) ? "Default Name" : _name;
        } 

        set { _name = value; } 
    }
}

Wenn es sich nicht um eine Zeichenkette handelt, könnte ich das Objekt nullable (double?, int?) machen und prüfen, ob es null ist, einen Standardwert zurückgeben oder den Wert zurückgeben, auf den es gesetzt ist.

Dann kann ich in meinem Repository prüfen, ob es sich um meinen Standardwert handelt und nicht bestehen bleibt, oder ich kann durch eine Hintertür den wahren Status des Sicherungswertes prüfen, bevor ich speichere.

Ich hoffe, das hilft!

Answer 5

In C# 6.0 ist das ein Kinderspiel!

Sie können dies in der Class Deklaration selbst, in den Erklärungen zu den Eigenschaften.

public class Coordinate
{ 
    public int X { get; set; } = 34; // get or set auto-property with initializer

    public int Y { get; } = 89;      // read-only auto-property with initializer

    public int Z { get; }            // read-only auto-property with no initializer
                                     // so it has to be initialized from constructor    

    public Coordinate()              // .ctor()
    {
        Z = 42;
    }
}