Jak zaimplementować lekką klasę z automatycznie zaimplementowanymi właściwościami (Przewodnik programowania w języku C#)

  • Artykuł

W tym przykładzie pokazano, jak utworzyć niezmienną lekką klasę, która służy tylko do hermetyzacji zestawu automatycznie zaimplementowanych właściwości. Użyj tego rodzaju konstrukcji zamiast struktury, gdy musisz użyć semantyki typu odwołania.

Właściwość niezmienną można ustawić w następujący sposób:

  • Zadeklaruj tylko metodę pobierania, która sprawia, że właściwość jest niezmienna wszędzie, z wyjątkiem konstruktora typu.
  • Zadeklaruj metodę dostępu init zamiast set metody dostępu, która sprawia, że właściwość jest ustawiana tylko w konstruktorze lub za pomocą inicjatora obiektu.
  • Zadeklaruj metodę dostępu zestawu jako prywatną. Właściwość jest ustawiana w obrębie typu, ale jest niezmienna dla użytkowników.

Modyfikator można dodać required do deklaracji właściwości, aby wymusić ustawienie właściwości w ramach inicjowania nowego obiektu.

W poniższym przykładzie pokazano, jak właściwość z metodą get get różni się od właściwości get i private set.

class Contact
{
    public string Name { get; }
    public string Address { get; private set; }

    public Contact(string contactName, string contactAddress)
    {
        // Both properties are accessible in the constructor.
        Name = contactName;
        Address = contactAddress;
    }

    // Name isn't assignable here. This will generate a compile error.
    //public void ChangeName(string newName) => Name = newName;

    // Address is assignable here.
    public void ChangeAddress(string newAddress) => Address = newAddress;
}

Przykład

W poniższym przykładzie przedstawiono dwa sposoby implementowania niezmiennej klasy, która ma właściwości implementowane automatycznie. Każdy sposób deklaruje jedną z właściwości z właściwością prywatną set i jedną z właściwości z get tylko. Pierwsza klasa używa konstruktora tylko do inicjowania właściwości, a druga klasa używa statycznej metody fabryki, która wywołuje konstruktora.

// 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 property.
    public string Name { get; }

    // Read-write property with a private set accessor.
    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-write property with a private set accessor.
    public string Name { get; private set; }

    // Read-only property.
    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";
    }
}

/* Output:
    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.
*/

Kompilator tworzy pola zapasowe dla każdej właściwości implementowanej automatycznie. Pola nie są dostępne bezpośrednio z kodu źródłowego.

Zobacz też