Автоматически реализуемые свойства (Руководство по программированию на C#)

  • Статья

Автоматически реализуемые свойства делают объявление свойств более кратким, если в методах доступа к свойствам не требуется дополнительная логика. Они также позволяют клиентскому коду создавать объекты. При объявлении свойства, как показано в следующем примере, компилятор создает закрытое анонимное резервное поле, которое может быть доступно только через методы доступа get и set свойства. В C# 9 и более поздних версий методы доступа init также можно объявить как автоматически реализуемые свойства.

Пример

В следующем примере показан простой класс, имеющий несколько автоматически реализуемых свойств.

// This class is mutable. Its data can be modified from
// outside the class.
public class Customer
{
    // Auto-implemented 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()
    {
        // Initialize a new object.
        Customer cust1 = new Customer(4987.63, "Northwind", 90108);

        // Modify a property.
        cust1.TotalPurchases += 499.99;
    }
}

В интерфейсах невозможно объявлять автоматически реализуемые свойства. Автоматически реализуемые свойства объявляют резервное поле частного экземпляра, а интерфейсы могут не объявлять поля экземпляров. Объявление свойства в интерфейсе без определения тела приводит к объявлению свойства с методами доступа, которые должны реализовываться каждым типом, реализующим этот интерфейс.

Автоматически реализуемые свойства можно инициализировать аналогично полям:

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

Класс, который показан в предыдущем примере, является изменяемым. Клиентский код может изменить значения в объектах после создания. В сложных классах, которые содержат значительные возможности (методы) и данные, часто необходимо иметь открытые свойства. Но для небольших классов или структур, которые просто инкапсулируют набор значений (данных) без какого-либо поведения (или с минимальным поведением), следует использовать один из следующих параметров, чтобы сделать объекты неизменяемыми:

  • Объявите только метод доступа get (неизменяемое значение везде, за исключением конструктора).
  • Объявите методы доступа get и init (неизменяемое значение везде, за исключением создания объекта).
  • Объявите метод доступа set с атрибутом private (неизменяемое значение для потребителей).

Дополнительные сведения см. в статье Практическое руководство. Реализация облегченного класса с автоматически реализуемыми свойствами.

См. также