如何使结构不可变？

Question

在 Stack Overflow 和互联网上，我发现保持结构不可变是一个很好的设计原则。不幸的是，我从未见过任何实际导致这些结构真正不可变的实现。

假设一个结构内部没有任何引用类型，我如何才能真正使结构不可变？也就是说，我如何防止其任何原始字段发生突变（可能通过 compile-time/runtime 异常）？

我写了一个简单的测试试图使结构不可变，但甚至没有使用 System.ComponentModel.ImmutableObjectAttribute 工作：

class Program
{
    static void Main(string[] args)
    {
        ImmutableStruct immStruct1 = new ImmutableStruct();
        Console.WriteLine(immStruct1); //Before mutation.

        immStruct1.field1 = 1;
        immStruct1.field2 = "Hello";
        immStruct1.field3 = new object();
        Console.WriteLine(immStruct1); //After 1st mutation.

        immStruct1.field1 = 2;
        immStruct1.field2 = "World";
        immStruct1.field3 = new object();
        Console.WriteLine(immStruct1); //After 2nd mutation.

        Console.ReadKey();
    }
}

[ImmutableObject(true)]
struct ImmutableStruct
{
    public int field1;
    public string field2;
    public object field3;

    public override string ToString()
    {
        string field3String = "null";
        if (field3 != null)
        {
            field3String = field3.GetHashCode().ToString();
        }
        return String.Format("Field1: {0}, Field2: {1}, Field3: {2}", field1, field2, field3String);
    }
}

Answer 1

将您的不可变数据保密：

struct ImmutableStruct
{
    private int field1;
    private string field2;
    private object field3;

    public ImmutableStruct(int f1, string f2, object f3)
    {
        field1 = f1;
        field2 = f2;
        field3 = f3;
    }

    public int Field1 => field1;
    public string Field2 => field2;
    public object Field3 => field3;
}

或不那么混乱：

struct ImmutableStruct
{
    public ImmutableStruct(int f1, string f2, object f3)
    {
        Field1 = f1;
        Field2 = f2;
        Field3 = f3;
    }

    public int Field1 { get; }
    public string Field2 { get; }
    public object Field3 { get; }
}

Answer 2

创建字段private readonly并在构造函数中传递初始值

public struct ImmutableStruct
{
    private readonly int _field1;
    private readonly string _field2;
    private readonly object _field3;

    public ImmutableStruct(int f1, string f2, object f3)
    {
        _field1 = f1;
        _field2 = f2;
        _field3 = f3;
    }

    public int Field1 { get { return _field1; } }
    public string Field2 { get { return _field2; } }
    public object Field3 { get { return _field3; } }
}

从 C#6.0 开始（Visual Studio 2015）您只能使用 getter 属性

public struct ImmutableStruct
{
    public ImmutableStruct(int f1, string f2, object f3)
    {
        Field1 = f1;
        Field2 = f2;
        Field3 = f3;
    }

    public int Field1 { get; }
    public string Field2 { get; }
    public object Field3 { get; }
}

请注意，只读字段和 getter only 属性可以在构造函数中初始化，或者在类中也可以使用字段或属性初始化程序 public int Field1 { get; } = 7;。

不保证构造函数在结构上运行。例如。如果您有一个结构数组，则必须为每个数组元素显式调用初始化程序。对于引用类型的数组，所有元素首先被初始化为 null，这很明显您必须对每个元素调用 new。但是对于结构这样的值类型很容易忘记它。

var immutables = new ImmutableStruct[10];
immutables[0] = new ImmutableStruct(5, "hello", new Person());
immutables[1] = new ImmutableStruct(6, "world", new Student());
...

从 C# 7.2 开始，您可以使用 Read-only structs

从 C# 9.0 开始，还有另一种选择：Init-Only Properties。只读字段和只读自动实现的属性可以在构造函数和字段或属性初始化器中初始化，但不能在对象初始化器中初始化。

这就是引入 init-only 属性的动机。他们将 set 访问器替换为 init 访问器。这将突变阶段从实际对象创建扩展到整个对象构造阶段，包括对象初始化器和 with expressions（也是 C# 9.0 的新功能）。

public string Name { get; init; }

用法：

var x = new ImmutableStruct { Name = "John" }; // Okay

x.Name = "Sue"; // Compiler error CS8852: Init-only property or indexer
                // 'ImmutableStruct.Name' can only be assigned in an object
                // initializer, or on 'this' or 'base' in an instance constructor
                // or an 'init' accessor.

C# 10.0 (Visual Studio 2022) 引入了 Record structs, Parameterless struct constructors 和字段初始值设定项。

readonly record struct Point(int X, int Y);

这会生成具有 get 和 init 访问器的 X 和 Y 属性。

如何使结构不可变？

How do I make a struct immutable?

c#

struct

immutability