C# 9.0新特性詳解系列之一：只初始化設置器（init only setter)

1、背景與動機

自C#1.0版本以來，我們要定義一個不可變數據類型的基本做法就是：先聲明字段為readonly，再聲明只包含get訪問器的屬性。例子如下：

struct Point
{
    public int X { get; }
    public int Y { get; }

    public Point(int x, int y)
    {
        this.X = x;
        this.Y = y;
    }
}

這種方式雖然很有效，但是它是以添加大量代碼為代價的，並且類型越大，屬性就越多，工作量就大，也就意味着更低的生產效率。

為了節省工作量，我們也用對象初始化方式來解決。對於創建對象來說，對象初始化方式是一種非常靈活和可讀的方式，特別對一口氣創建含有嵌套結構的樹狀對象來說更有用。下面是一個簡單的對象初始化的例子：

var person = new Person{ FirstName = "Mads", LastName = "Torgersen" };

從這個例子，可以看出，要進行對象初始化，我們不得不先要在需要初始化的屬性中添加set訪問器，然后在對象初始化器中，通過給屬性或者索引器賦值來實現。

public class Person
{
    public string? FirstName { get; set; }
    public string? LastName { get; set; }
}

這種方式最大的局限就是，對於初始化來說，屬性必須是可變的，也就是說，set訪問器對於初始化來說是必須的，而其他情況下又不需要set，而且我們需要的是不可變對象類型，因此這個setter明顯在這里就不合適。既然有這種常見的需要和局限性，那么我為何不引入一個只能用來初始化的Setter呢？於是只用來初始化的init設置訪問器就出現了。這時，上面的Point結構定義就可以簡化成下面的樣子：

struct Point
{
    public int X { get; init; }
    public int Y { get; init; }
}

那么現在，我們使用對象初始化器來創建一個實例：

var p = new Point() { X = 54, Y = 717 };

第二例子Person類型中，將set訪問器換為init就成了不可變類型了。同時，使用對象初始化器方式沒有變化，依然如前面所寫。

public class Person
{
    public string? FirstName { get; init; }
    public string? LastName { get; init; }
}

通過采用init訪問器，編碼量減少，滿足了只讀需求，代碼簡潔易懂。

2. 定義和要求

只初始化屬性或索引器訪問器是一個只在對象構造階段進行初始化時用來賦值的set訪問器的變體，它通過在set訪問器的位置來使用init來實現的。init有着如下限制：

• init訪問器只能用在實例屬性或索引器中，靜態屬性或索引器中不可用。
• 屬性或索引器不能同時包含init和set兩個訪問器
• 如果基類的屬性有init，那么屬性或索引器的所有相關重寫，都必須有init。接口也一樣。

2.1 init訪問器可設置值的時機

除過在局部方法和lambda表達式中，帶有init訪問器的屬性和索引器在下面情況是被認為可設置的。這幾個可以進行設置的時機，在這里統稱為對象的構造階段。除過這個構造階段之外，其他的后續賦值操作是不允許的。

• 在對象初始化器工作期間
• 在with表達式初始化器工作期間
• 在所處或者派生的類型的實例構造函數中，在this或者base使用上
• 在任意屬性init訪問器里面，在this或者base使用上
• 在帶有命名參數的attribute使用中

根據這些時機，這意味着Person類可以按如下方式使用。在下面代碼中第一行初始化賦值正確，第二行再次賦值就不被允許了。這說明，一旦初始化完成之后，只初始化屬性或索引就保護着對象的狀態免於改變。

var person = new Person { FirstName = "Mads", LastName = "Nielsen" }; // OK
person.LastName = "Torgersen"; // 錯誤!

2.2 init屬性訪問器和只讀字段

因為init訪問器只能在初始化時被調用，所以在init屬性訪問器中可以改變封閉類的只讀字段。需要注意的是，從init訪問器中來給readonly字段賦值僅限於跟init訪問器處於同一類型中定義的字段，通過它是不能給父類中定義的readonly字段賦值的，關於這繼承有關的示例，我們會在2.4類型間的層級傳遞中看到。

public class Person
{
    private readonly string firstName = "<unknown>";
    private readonly string lastName = "<unknown>";
    
    public string FirstName 
    { 
        get => firstName; 
        init => firstName = (value ?? throw new ArgumentNullException(nameof(FirstName)));
    }
    public string LastName 
    { 
        get => lastName; 
        init => lastName = (value ?? throw new ArgumentNullException(nameof(LastName)));
    }
}

2.3 類型層級間的傳遞

我們知道只包含get訪問器的屬性或索引器只能在所處類的自身構造函數中被初始化，但init訪問器可以進行設置的規則是可以跨類型層級傳遞的。帶有init訪問器的成員只要是可訪問的，對象實例並能在構造階段被知曉，那這個成員就是可設置的。

class Person
{
    public Person()
    {
        //下面這段都是允許的
        Name = "Unknown";
        Age = 0;
    }
    public string Name { get; init; }
    public int Age { get; }

}

class Adult : Person
{
    public Adult()
    {
        // 只有get訪問器的屬性會出錯，但是帶有init是允許的
        Name = "Unknown Adult"; //正確
        Age = 18; //錯誤
    }
}

class Consumption
{
    void Example()
    {
        var d = new Adult() 
        { 
            Name = "Jack", //正確
            Age = 23 //錯誤，因為是只讀，只有get
        };
    }
}

從init訪問器能被調用這一方面來看，對象實例在開放的構造階段就可以被知曉。因此除過正常set可以做之外，init訪問器的下列行為也是被允許的。

• 通過this或者base調用其他可用的init訪問器
• 在同一類型中定義的readonly字段，是可以通過this給賦值的

class Example
{
    public Example()
    {
        Prop1 = 1;
    }

    readonly int Field1;
    string Field2;
    int Prop1 { get; init; }
    public bool Prop2
    {
        get => false;
        init
        {
            Field1 = 500; // 正確
            Field2 = "hello"; // 正確
            Prop1 = 50; // 正確
        }
    }
}

前面2.2節中提到，init中是不能更改父類中的readonly字段的，只能更改本類中readonly字段。示例代碼如下：

class BaseClass
{
    protected readonly int Field;
    public int Prop
    {
        get => Field;
        init => Field = value; // 正確
    }

    internal int OtherProp { get; init; }
}

class DerivedClass : BaseClass
{
    protected readonly int DerivedField;
    internal int DerivedProp
    {
        get => DerivedField;
        init
        {
            DerivedField = 89;  // 正確
            Prop = 0;       // 正確
            Field = 35;     // 出錯，試圖修改基類中的readonly字段Field
        }
    }

    public DerivedClass()
    {
        Prop = 23;  // 正確 
        Field = 45;     // 出錯，試圖修改基類中的readonly字段Field
    }
}

如果init被用於virtual修飾的屬性或者索引器，那么所有的覆蓋重寫都必須被標記為init，是不能用set的。同樣地，我們不可能用init來覆蓋重寫一個set的。

class Person
{
    public virtual int Age { get; init; }
    public virtual string Name { get; set; }
}

class Adult : Person
{
    public override int Age { get; init; }
    public override string Name { get; set; }
}

class Minor : Person
{
    // 錯誤: 屬性必須有init來重寫Person.Age
    public override int Age { get; set; }
    // 錯誤: 屬性必須有set來重寫Person.Name
    public override string Name { get; init; }
}

2.4 init和接口

一個接口中的默認實現，也是可以采用init進行初始化，下面就是一個應用模式示例。

interface IPerson
{
    string Name { get; init; }
}

class Initializer
{
    void NewPerson<T>() where T : IPerson, new()
    {
        var person = new T()
        {
            Name = "Jerry"
        };
        person.Name = "Jerry"; // 錯誤
    }
}

2.5 init和readonly struct

init訪問器是允許在readonly struct中的屬性中使用的，init和readonly的目標都是一致的，就是只讀。示例代碼如下：

readonly struct Point
{
    public int X { get; init; } 
    public int Y { get; init; }
}

但是要注意的是：

• 不管是readonly結構還是非readonly結構，不管是手工定義屬性還是自動生成屬性，init都是可以使用的。
• init訪問器本身是不能標記為readonly的。但是所在屬性或索引器可以被標記為readonly

struct Point
{
    public readonly int X { get; init; } // 正確
    public int Y { get; readonly init; } // 錯誤
}

如對您有價值，請推薦，您的鼓勵是我繼續的動力，在此萬分感謝。關注本人公眾號“碼客風雲”，享第一時間閱讀最新文章。