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

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) 防止意外突变。

但是，有一个皱纹，实际上是一个奇怪的巧合，我计划在下周写博客。即：只读结构字段是谎言。人们期望只读字段不能更改，但它当然可以。结构字段上的“只读”是声明在其帐户中没有钱的情况下书写支票。 一个结构不拥有它的存储空间，它是可以变异的存储空间。

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

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
}

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

正如Eric Lippert's answer 中所述，这不会阻止结构本身被完全重新分配，从而提供其字段从您下方更改的效果。通过值传递或使用新的in 参数修饰符可以帮助防止这种情况：

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

Answer 3

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

Answer 4

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

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