举例讲解C#中自动实现的属性

时间:2022-04-03 12:09:24

在 C# 3.0 及更高版本,当属性访问器中不需要任何其他逻辑时,自动实现的属性会使属性声明更加简洁。它们还允许客户端代码创建对象。当你声明以下示例中所示的属性时,编译器将创建仅可以通过该属性的 get 和 set 访问器访问的专用、匿名支持字段。
下列示例演示一个简单的类,它具有某些自动实现的属性:

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
// This class is mutable. Its data can be modified from
// outside the class.
class Customer
{
  // Auto-Impl Properties for trivial get and set
  public double TotalPurchases { get; set; }
  public string Name { get; set; }
  public int CustomerID { get; set; }
 
  // Constructor
  public Customer(double purchases, string name, int ID)
  {
    TotalPurchases = purchases;
    Name = name;
    CustomerID = ID;
  }
  // Methods
  public string GetContactInfo() {return "ContactInfo";}
  public string GetTransactionHistory() {return "History";}
 
  // .. Additional methods, events, etc.
}
 
class Program
{
  static void Main()
  {
    // Intialize a new object.
    Customer cust1 = new Customer ( 4987.63, "Northwind",90108 );
 
    //Modify a property
    cust1.TotalPurchases += 499.99;
  }
}

在 C# 6 和更高版本中,你可以像字段一样初始化自动实现属性:

?
1
public string FirstName { get; set; } = "Jane";

上一示例中所示的类是可变的。创建客户端代码后可以用于更改对象中的值。在包含重要行为(方法)以及数据的复杂类中,通常有必要具有公共属性。但是,对于较小类或仅封装一组值(数据)且只有很少行为或没有行为的结构,则应该通过声明 set 访问器为 专用(对使用者的不可变)或通过声明仅一个 get 访问器 (除构造函数外都不可变),使对象不可变。
动实现的属性上允许使用特性,但很明显支持字段上不允许,因为不能从你的源代码访问它们。如果必须使用属性的支持字段上的特性,只需创建一个常规属性。

使用自动实现的属性实现轻量类
本示例演示如何创建一个仅用于封装一组自动实现的属性的不可变轻型类。 当你必须使用引用类型语义时,请使用此种构造而不是结构。
可通过两种方法来实现不可变的属性。 可以将 set 取值函数声明为 private。 属性只能在该类型中设置,但它对于使用者是不可变的。 也可以仅声明 get 取值函数,使属性除了能在该类型的构造函数中设置,在其他任何位置都不可变。
当你声明一个 private set 取值函数时,你无法使用对象初始值设定项来初始化属性。 你必须使用构造函数或工厂方法。
示例
下面的示例演示了实现具有自动实现属性的不可变类的两种方法。 这两种方法均使用 private set 声明其中一个属性,使用单独的 get 声明另一个属性。 第一个类仅使用构造函数来初始化属性,第二个类则使用可调用构造函数的静态工厂方法。

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
// This class is immutable. After an object is created,
  // it cannot be modified from outside the class. It uses a
  // constructor to initialize its properties.
  class Contact
  {
    // Read-only properties.
    public string Name { get; }
    public string Address { get; private set; }
 
    // Public constructor.
    public Contact(string contactName, string contactAddress)
    {
      Name = contactName;
      Address = contactAddress;       
    }
  }
 
  // This class is immutable. After an object is created,
  // it cannot be modified from outside the class. It uses a
  // static method and private constructor to initialize its properties. 
  public class Contact2
  {
    // Read-only properties.
    public string Name { get; private set; }
    public string Address { get; }
 
    // Private constructor.
    private Contact2(string contactName, string contactAddress)
    {
      Name = contactName;
      Address = contactAddress;       
    }
 
    // Public factory method.
    public static Contact2 CreateContact(string name, string address)
    {
      return new Contact2(name, address);
    }
  }
 
  public class Program
  {
    static void Main()
    {
      // Some simple data sources.
      string[] names = {"Terry Adams","Fadi Fakhouri", "Hanying Feng",
               "Cesar Garcia", "Debra Garcia"};
      string[] addresses = {"123 Main St.", "345 Cypress Ave.", "678 1st Ave",
                 "12 108th St.", "89 E. 42nd St."};
 
      // Simple query to demonstrate object creation in select clause.
      // Create Contact objects by using a constructor.
      var query1 = from i in Enumerable.Range(0, 5)
            select new Contact(names[i], addresses[i]);
 
      // List elements cannot be modified by client code.
      var list = query1.ToList();
      foreach (var contact in list)
      {
        Console.WriteLine("{0}, {1}", contact.Name, contact.Address);
      }
 
      // Create Contact2 objects by using a static factory method.
      var query2 = from i in Enumerable.Range(0, 5)
             select Contact2.CreateContact(names[i], addresses[i]);
 
      // Console output is identical to query1.
      var list2 = query2.ToList();
 
      // List elements cannot be modified by client code.
      // CS0272:
      // list2[0].Name = "Eugene Zabokritski";
 
      // Keep the console open in debug mode.
      Console.WriteLine("Press any key to exit.");
      Console.ReadKey();       
    }
  }

输出:

?
1
2
3
4
5
Terry Adams, 123 Main St.
Fadi Fakhouri, 345 Cypress Ave.
Hanying Feng, 678 1st Ave
Cesar Garcia, 12 108th St.
Debra Garcia, 89 E. 42nd St.

编译器为每个自动实现的属性创建了支持字段。 这些字段无法直接从源代码进行访问。