如何为C#Auto-Property提供默认值?

时间:2008-09-02 21:29:41

标签: c# automatic-properties

如何为C#Auto-Property提供默认值?我要么使用构造函数,要么还原为旧语法。

使用构造函数:

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

使用普通属性语法(使用默认值)

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

有更好的方法吗?

26 个答案:

答案 0 :(得分:1957)

在C#5及更早版本中,要为自动实现的属性提供默认值,您必须在构造函数中执行此操作。

自C#6.0以来,包含自动属性初始值设定项的功能。语法是:

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

答案 1 :(得分:271)

于1/2/15编辑

C#6

使用C#6,您可以直接初始化自动属性(最后!),现在线程中有其他答案可以描述。

C#5及以下

虽然该属性的预期用途并非实际设置属性的值,但您可以使用反射始终设置它们......

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

答案 2 :(得分:148)

当你为变量内联一个初始值时,无论如何都会在构造函数中隐式地完成它。

我认为这种语法是C#中的最佳实践,最多可达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; }
}

这样可以清楚地控制分配的订单值。

从C#6开始,有一种新的方式:

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

答案 3 :(得分:83)

DefaultValueAttribute仅适用于vs设计器。它不会将属性初始化为该值。

请参阅DefaultValue attribute is not working with my Auto Property

答案 4 :(得分:57)

有时候我会使用它,如果我不希望它实际设置并保存在我的数据库中:

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

        set { _name = value; } 
    }
}

显然,如果它不是字符串,那么我可以使对象可以为空(double?,int?)并检查它是否为null,返回默认值,或返回它设置的值。

然后我可以在我的存储库中检查它是否是我的默认值而不是持久存在,或者在保存之前检查后门以查看支持值的真实状态。

希望有所帮助!

答案 5 :(得分:39)

在C#6.0中,这是轻而易举的事!

您可以在-(void)bannerViewDidLoadAd:(ADBannerView *)banner { [UIView beginAnimations:nil context:NULL]; [UIView setAnimationDuration:1]; [banner setAlpha:1]; [UIView commitAnimations]; } -(void)bannerView:(ADBannerView *)banner didFailToReceiveAdWithError:(NSError *)error { [UIView beginAnimations:nil context:NULL]; [UIView setAnimationDuration:1]; [banner setAlpha:0]; [UIView commitAnimations]; } 声明本身的属性声明语句中执行此操作。

Class

答案 6 :(得分:38)

从C#6.0开始,我们可以为自动实现的属性指定默认值。

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

我们还可以创建只读的自动实现属性,如:

public string Name { get; } = "Some Name";

请参阅:C# 6: First reactions , Initializers for automatically implemented properties - By Jon Skeet

答案 7 :(得分:26)

C#(6.0)版本中&更好,你可以这样做:

对于Readonly属性

public int ReadOnlyProp => 2;

对于Writable和&可读属性

public string PropTest { get; set; } = "test";

C#(7.0)的当前版本中,您可以执行以下操作:(该代码片段显示了如何使用表达式的get / set访问器,以便在使用支持字段时更紧凑)< / p>

private string label = "Default Value";

// Expression-bodied get / set accessors.
public string Label
{
   get => label;
   set => this.label = value; 
 }

答案 8 :(得分:16)

除了已经接受的答案之外,对于您希望将默认属性定义为其他属性的函数的场景,您可以使用 表达式主体符号 在C#6.0(及更高版本)上,可以获得更优雅,更简洁的结构,如:

public class Person{

    public string FullName  => $"{First} {Last}"; // expression body notation

    public string First { get; set; } = "First";
    public string Last { get; set; } = "Last";
}

您可以按以下方式使用上述内容

    var p = new Person();

    p.FullName; // First Last

    p.First = "Jon";
    p.Last = "Snow";

    p.FullName; // Jon Snow

为了能够使用上述“=&gt;”表示法,该属性必须是只读的,并且不使用get accessor关键字。

有关MSDN

的详情

答案 9 :(得分:13)

一点点完整样本:

using System.ComponentModel;

private bool bShowGroup ;
[Description("Show the group table"), Category("Sea"),DefaultValue(true)]
public bool ShowGroup
{
    get { return bShowGroup; }
    set { bShowGroup = value; }
}

答案 10 :(得分:10)

我的解决方案是使用自定义属性,该属性通过常量或使用属性类型初始化程序提供默认值属性初始化。

[AttributeUsage(AttributeTargets.Property, AllowMultiple = false, Inherited = true)]
public class InstanceAttribute : Attribute
{
    public bool IsConstructorCall { get; private set; }
    public object[] Values { get; private set; }
    public InstanceAttribute() : this(true) { }
    public InstanceAttribute(object value) : this(false, value) { }
    public InstanceAttribute(bool isConstructorCall, params object[] values)
    {
        IsConstructorCall = isConstructorCall;
        Values = values ?? new object[0];
    }
}

要使用此属性,必须从特殊的基类初始化程序继承一个类或使用静态帮助程序方法:

public abstract class DefaultValueInitializer
{
    protected DefaultValueInitializer()
    {
        InitializeDefaultValues(this);
    }

    public static void InitializeDefaultValues(object obj)
    {
        var props = from prop in obj.GetType().GetProperties()
                    let attrs = prop.GetCustomAttributes(typeof(InstanceAttribute), false)
                    where attrs.Any()
                    select new { Property = prop, Attr = ((InstanceAttribute)attrs.First()) };
        foreach (var pair in props)
        {
            object value = !pair.Attr.IsConstructorCall && pair.Attr.Values.Length > 0
                            ? pair.Attr.Values[0]
                            : Activator.CreateInstance(pair.Property.PropertyType, pair.Attr.Values);
            pair.Property.SetValue(obj, value, null);
        }
    }
}

用法示例:

public class Simple : DefaultValueInitializer
{
    [Instance("StringValue")]
    public string StringValue { get; set; }
    [Instance]
    public List<string> Items { get; set; }
    [Instance(true, 3,4)]
    public Point Point { get; set; }
}

public static void Main(string[] args)
{
    var obj = new Simple
        {
            Items = {"Item1"}
        };
    Console.WriteLine(obj.Items[0]);
    Console.WriteLine(obj.Point);
    Console.WriteLine(obj.StringValue);
}

输出:

Item1
(X=3,Y=4)
StringValue

答案 11 :(得分:9)

在C#6及以上版本中,您只需使用以下语法:

public object Foo { get; set; } = bar;

请注意,要拥有readonly属性,只需省略该集合,如下所示:

public object Foo { get; } = bar;

您还可以从构造函数中分配readonly自动属性。

在此之前,我的回答如下。

我会避免在构造函数中添加默认值;保留动态赋值,避免分配变量的两个点(即默认类型和构造函数)。通常我会在这种情况下写一个普通的属性。

另一个选择是执行ASP.Net所做的事情并通过属性定义默认值:

http://msdn.microsoft.com/en-us/library/system.componentmodel.defaultvalueattribute.aspx

答案 12 :(得分:5)

C# 9.0 中有 added supportinit 关键字 - 用于声明只读自动属性的非常有用和复杂的方法: >

声明:

class Person 
{ 
    public string Name { get; init; } = "Anonymous user";
}

~享受~使用:

// 1. Person with default name
var anonymous = new Person();
Console.WriteLine($"Hello, {anonymous.Name}!");
// > Hello, Anonymous user!


// 2. Person with assigned value
var me = new Person { Name = "@codez0mb1e"};
Console.WriteLine($"Hello, {me.Name}!");
// > Hello, @codez0mb1e!


// 3. Attempt to re-assignment Name
me.Name = "My fake"; 
// > Compilation error: Init-only property can only be assigned in an object initializer

答案 13 :(得分:5)

在构造函数中。构造函数的目的是初始化它的数据成员。

答案 14 :(得分:3)

public Class ClassName{
    public int PropName{get;set;}
    public ClassName{
        PropName=0;  //Default Value
    }
}

答案 15 :(得分:3)

private string name;
public string Name 
{
    get 
    {
        if(name == null)
        {
            name = "Default Name";
        }
        return name;
    }
    set
    {
        name = value;
    }
}

答案 16 :(得分:3)

您是否尝试将DefaultValueAttributeShouldSerialize and Reset methods与构造函数结合使用?如果您正在创建一个可能出现在设计器表面或属性网格中的类,我觉得这两种方法中的一种是必要的。

答案 17 :(得分:2)

使用构造函数,因为“当构造函数完成时,应该完成构造”。属性就像您的类所持有的状态,如果必须初始化默认状态,则可以在构造函数中执行此操作。

答案 18 :(得分:2)

澄清一下,是的,您需要在类派生对象的构造函数中设置默认值。您需要确保构造函数存在,并使用适当的访问修饰符进行构造。如果对象未被实例化,例如它没有构造函数(例如静态方法),然后可以通过字段设置默认值。这里的原因是对象本身只会创建一次而你没有实例化它。

@Darren Kopp - 很好的答案,干净,正确。重申一下,您可以编写Abstract方法的构造函数。在编写构造函数时,您只需要从基类访问它们:

基类的构造函数:

public BaseClassAbstract()
{
    this.PropertyName = "Default Name";
}

Derived / Concrete / Sub-Class的构造函数:

public SubClass() : base() { }

这里的要点是从基类中抽取的实例变量可能会掩埋您的基本字段名称。使用“this”设置当前实例化的对象值。将允许您根据当前实例和实例化所需的权限级别(访问修饰符)正确地形成对象。

答案 19 :(得分:2)

就个人而言,如果你不打算在汽车财产之外做任何事情,我根本就没有把它变成财产的意义。把它留作田地吧。这些项目的封装优势只是红色鲱鱼,因为它们背后没有什么可以封装的。如果您需要更改底层实现,您仍然可以自由地将它们重构为属性而不会破坏任何相关代码。

嗯...也许这将成为后来问题的主题

答案 20 :(得分:2)

您可以像这样简单放置

    public sealed  class Employee
{
    public int Id { get; set; } = 101;
}

答案 21 :(得分:1)

class Person 
{    
    /// Gets/sets a value indicating whether auto 
    /// save of review layer is enabled or not
    [System.ComponentModel.DefaultValue(true)] 
    public bool AutoSaveReviewLayer { get; set; }
}

答案 22 :(得分:1)

我知道这是一个老问题,但是当我在寻找如何让默认值继承并带有覆盖选项时,我想到了

//base class
public class Car
{
    public virtual string FuelUnits
    {
        get { return "gasoline in gallons"; }
        protected set { }
    }
}
//derived
public class Tesla : Car
{
    public override string FuelUnits => "ampere hour";
}

答案 23 :(得分:0)

在c#8.0中,您还可以将它们设置为可空:

public string? MyProperty { get; set; } = null;

或不能为空:

 public string MyProperty { get; set; } = null!; 

答案 24 :(得分:-2)

我认为这样做会让你的SomeFlag默认为false。

private bool _SomeFlagSet = false;
public bool SomeFlag
{
    get
    {
        if (!_SomeFlagSet)
            SomeFlag = false;        

        return SomeFlag;
    }
    set
    {
        if (!_SomeFlagSet)
            _SomeFlagSet = true;

        SomeFlag = value;        
    }
}

答案 25 :(得分:-5)

初始化,使用构造函数进行初始化是不好的做法,并会在以后导致更多的更改。