对不可变结构使用公共只读字段是否有效？

Question

这是声明不可变结构的正确方法吗？

public struct Pair
{
    public readonly int x;
    public readonly int y;

    // Constructor and stuff
}

我想不出为什么这会遇到问题，但我只是想确认一下。

在这个例子中，我使用了整数。如果我改用一个类，但该类也是不可变的，就像这样呢？那应该也可以正常工作，对吧？

public struct Pair
{
    public readonly (immutableClass) x;
    public readonly (immutableClass) y;

    // Constructor and stuff
}

（旁白：我知道使用 Properties 更通用并且允许更改，但是这个结构实际上只是存储两个值。我只是对这里的不变性问题感兴趣。）

Answer 1

如果您要使用结构，最佳实践是使它们不可变。

将所有字段设置为只读是一个很好的方法，可以帮助 (1) 记录结构是不可变的，以及 (2) 防止意外突变。

然而，有一个问题，实际上是一个奇怪的巧合，我正计划下周在博客上讨论这个问题。也就是说：结构体字段上的只读是一个谎言。人们期望只读字段不能更改，但它当然可以。结构体字段上的“readonly”是在其帐户中没有钱的情况下写支票的声明。 结构不拥有自己的存储，并且该存储可以发生变化。

例如，让我们以您的结构为例：

public struct Pair
{
    public readonly int x;
    public readonly int y;
    public Pair(int x, int y)
    {
        this.x = x;
        this.y = y;
    }
    public void M(ref Pair p)
    {
        int oldX = x;
        int oldY = y;
        // Something happens here
        Debug.Assert(x == oldX);
        Debug.Assert(y == oldY);
    }
}

在“此处发生某事”时是否会发生任何导致调试断言的事情被侵犯？当然。

    public void M(ref Pair p)
    {
        int oldX = this.x;
        int oldY = this.y;
        p = new Pair(0, 0);
        Debug.Assert(this.x == oldX);
        Debug.Assert(this.y == oldY);
    }
...
    Pair myPair = new Pair(10, 20);
    myPair.M(ref myPair);

现在会发生什么？主张已被违反！ “this”和“p”指的是相同的存储位置。存储位置发生了变化，因此“this”的内容也发生了变化，因为它们是相同的东西。该结构无法强制 x 和 y 的只读性，因为该结构不拥有存储；存储是一个局部变量，可以随意改变。

您不能依赖结构中的只读字段永远不会发生变化的不变性；您唯一可以依赖的是您无法编写直接更改它的代码。但通过像这样的一些偷偷摸摸的工作，你可以间接地改变你想要的一切。

另请参阅 Joe Duffy 关于此问题的优秀博客文章：

http:// joeduffyblog.com/2010/07/01/when-is-a-readonly-field-not-readonly/

Answer 2

从 C# 7.2 开始，您现在可以将整个结构声明为不可变：

public readonly struct Pair
{
    public int x;
    public int y;

    // Constructor and stuff
}

这与将所有字段标记为只读具有相同的效果，并且还将向编译器本身记录该结构是不可变的。这将通过减少编译器创建的防御副本的数量来提高使用该结构的区域的性能。

正如 Eric Lippert 的回答中所述，这并不能阻止结构本身被完全重新分配，从而提供其结构的效果领域从你的脚下发生变化。按值传递或使用新的 in 参数修饰符都可以帮助防止这种情况：

public void DoSomething(in Pair p) {
    p.x = 0; // illegal
    p = new Pair(0, 0); // also illegal
}

Answer 3

这确实会使其成为不可变的。我想你最好添加一个构造函数。
如果它的所有成员也是不可变的，这将使其完全不可变。这些可以是类或简单值。

Answer 4

编译器将禁止分配给readonly字段以及只读属性。

我建议使用只读属性主要是出于公共接口原因和数据绑定（这不适用于字段）。如果这是我的项目，我会要求结构/类是否是公共的。如果它是程序集的内部或类的私有属性，我可以首先忽略它，然后将它们重构为只读属性。