C# 9 新特性——init only setter

WeihanLi發表於2020-12-31

C# 9 新特性——init only setter

Intro

C# 9 中新支援了 init 關鍵字,這是一個特殊的 setter,用來指定只能在物件初始化的時候進行賦值,另外支援構造器簡化的寫法,比如:Target-typed new expression 在已知型別的情況下可以使用 new() 來代表構造方法的簡化用法,可以簡化欄位的宣告,也可以簡化一次宣告多個相同型別的變數

Sample

來看一個示例,我們定義一個測試用的 Person 類,測試程式碼如下:

public class Person
{
    public int Age { get; init; }

    public string Name { get; init; }

    public string Description { get; set; }

    public override string ToString()
    {
        return $"Name:{Name}(Age:{Age})";
    }
}

init 是一個特殊的 setter 適用於例項屬性,被標記為 init 的屬性,只能在例項化的時候通過初始化器來賦值,例項化操作完成後不允許再修改值。

var p1 = new Person()
{
    Name = "Michael",
    Age = 10
};
Console.WriteLine(p1);
// compiler error,不能對 init 的欄位再賦值
// p1.Age = 12;

// Target-Typed new expression, C#9 新特性
Person p2 = new()
{
    Name = "Jane",
    Age = 10,
}, p3 = new()
{
    Name = "Alice"
};
Console.WriteLine(p2);
Console.WriteLine(p3);

init 的等效寫法,init 類似於 set ,但是 init 對應的欄位會是一個 readonly 的欄位,來保證只能在構造器中或者初始化器中被賦值,另外編譯器會做檢查如果是 init,會有一個特殊的標識,在初始化後再賦值的時候就會報錯,類似於下面這樣:

internal class TestInitModel
{
    private readonly string _name;

    public string Name
    {
        get => _name;
        init => _name = value;
    }
}

我們以上面的 Person 為例來看一下生成 IL 程式碼的區別:

可以看到宣告為 init 的 屬性會比普通的 set 多出來一個修飾符,這是由編譯器去生成的,編譯器也會根據此去判斷是否是在初始化的時候賦值,如果不是就會報錯。

序列化是否會有問題呢,我們來測試一下,可以看到 model1 是被正常賦值(這裡的 ToJson/JsonToObject是基於 Newtonsoft.JsonJsonConvert 封裝的擴充套件方法)

More

我覺得 init 為我們帶來的好處在於,可以在初始化的時候賦值而非直接通過構造器賦值,如果希望一個屬性只能 get ,不在初始化之外的地方被賦值,之前我的做法都是在構造器裡初始化,只保留一個 getter,沒有 setter,有了這個支援之後就可以不需要修改構造方法比較方便的使用了

Reference

相關文章