C#记录类型中意外的数据不一致问题

前几天，我在调试代码时发现了一个bug，结果发现是我对C#记录类型工作机制的误解。可能只有我一个人期望它们以某种方式工作，但我觉得值得写下来以防万一。

实际上，这个问题是我在修改2029年英国大选网站时发现的，但它与大选本身无关，因此我没有将其包含在大选网站博客系列中。

回顾：非破坏性变更

当记录类型被引入C#时，同时引入了使用with操作符的“非破坏性变更”功能。其理念是记录类型可以是不可变的，但你可以轻松高效地创建一个新实例，该实例具有与现有实例相同的数据，但某些属性值不同。

例如，假设你有这样一个记录：

1

public sealed record HighScoreEntry(string PlayerName, int Score, int Level);

然后你可以编写如下代码：

1
2


HighScoreEntry entry = new("Jon", 5000, 50);
var updatedEntry = entry with { Score = 6000, Level = 55 };

这不会改变第一个实例中的数据（因此entry.Score仍然是5000）。

回顾派生数据

记录类型不允许你为主要构造函数指定构造函数体（这是我在之前关于记录和集合的文章中打算写的内容），但你可以根据主要构造函数参数的值初始化字段（以及自动实现的属性）。

作为一个非常简单（且高度人为）的例子，你可以创建一个记录，在初始化时确定一个值是奇数还是偶数：

1
2
3
4


public sealed record Number(int Value)
{
    public bool Even { get; } = (Value & 1) == 0;
}

乍一看，这看起来没问题：

1
2
3
4


var n2 = new Number(2);
var n3 = new Number(3);
Console.WriteLine(n2); // 输出: Number { Value = 2, Even = True }
Console.WriteLine(n3); // 输出: Number { Value = 3, Even = False }

到目前为止，一切顺利。直到本周，我还以为这一切都很好。

糟糕：混合使用`with`和派生数据

问题出现在混合使用这两个功能时。如果我们更改上面的代码（同时保持记录本身不变），使用with操作符创建第二个Number而不是调用构造函数，输出就会变得不正确：

1
2
3
4


var n2 = new Number(2);
var n3 = n2 with { Value = 3 };
Console.WriteLine(n2); // 输出: Number { Value = 2, Even = True }
Console.WriteLine(n3); // 输出: Number { Value = 3, Even = True }

“Value = 3, Even = True”真的不好。

这是怎么发生的？嗯，出于某种原因，我一直假设with操作符会使用新值调用构造函数。但实际上并非如此。上面的with操作符大致翻译成这样的代码：

1
2
3


// 这不会编译，但大致是生成的代码。
var n3 = n2.<Clone>$();
n3.Value = 3;

<Clone>$方法（至少在这种情况下）调用生成的复制构造函数（Number(Number)），该构造函数复制Value和Even的支持字段。

这一切都有文档记录——但目前没有任何关于可能引入的不一致性的警告。（我会给微软的人发邮件，看看能否在其中添加一些内容。）

请注意，由于Value是在克隆操作之后设置的，我们无论如何都无法编写一个复制构造函数来做正确的事情。（至少，没有直接的方法——我稍后会提到一种复杂的方法。）

如果有人想“为什么不直接使用计算属性？”，显然这样可以正常工作：

1
2
3
4


public sealed record Number(int Value)
{
    public bool Even => (Value & 1) == 0;
}

任何可以像这样轻松按需计算的属性都很棒——不仅不会出现本文中的问题，而且在内存方面也更高效。但这对于我在大选网站中使用的记录中的许多属性来说真的不适用，这些记录通常是用集合构造的，然后按ID索引，或者执行其他相对昂贵的计算。

我们能做什么？

到目前为止，我想到了四种前进的方法，但没有一种是令人愉快的。我很想听听其他人的建议。

选项1：耸耸肩继续生活

既然我知道了这一点，我可以避免对任何“简单”记录使用with操作符。如果没有计算属性或字段，with操作符仍然非常有用。

当然，存在一种风险，我可能在一个最初“简单”的记录类型上使用with操作符，然后后来引入一个计算成员。嗯。

选项2：编写一个Roslyn分析器来检测问题

理论上，至少对于在声明它们的同一解决方案中使用的任何记录（我的大选网站中的所有内容），编写一个Roslyn分析器应该是可行的，该分析器：

分析每个声明记录中的每个成员初始化器，以查看使用了哪些参数
分析每个with操作符的使用，以查看正在设置哪些参数
如果两者之间存在任何交集，则记录错误

这很有吸引力，并且可能对其他人有用。它的缺点是需要实现Roslyn分析器。自从我上次编写分析器以来已经很久了，但我猜这仍然是一个相当复杂的过程。如果我确实找到了时间，这很可能是我会做的事情——但我希望有人评论说分析器已经存在，或者解释为什么不需要它。

选项3：找出安全使用`with`的方法

我一直在尝试找出如何使用Lazy<T>来延迟计算任何属性，直到它们第一次被使用，这将在with操作符为属性设置新值之后发生。我想出了下面的模式——我认为它有效，但非常混乱。采用这种模式不需要父记录中的每个新参数都反映在嵌套类型中——仅用于计算属性中使用的参数。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27


public sealed record Number(int Value)
{
    private readonly Lazy<ComputedMembers> computed =
        new(() => new(Value), LazyThreadSafetyMode.ExecutionAndPublication);
    
    public bool Even => computed.Value.Even;
    
    private Number(Number other)
    {
        Value = other.Value;
        // 延迟创建ComputedMembers实例直到
        computed = new(() => new(this), LazyThreadSafetyMode.ExecutionAndPublication);
    }
    
    // 这是一个结构体（或者可以是一个类），而不是记录，
    // 以避免为Value创建字段。我们只需要计算属性。
    // （我们甚至不需要使用主要构造函数，
    // 在某些情况下最好不要使用。）
    private struct ComputedMembers(int Value)
    {
        internal ComputedMembers(Number parent) : this(parent.Value)
        {
        }
        
        public bool Even { get; } = (Value & 1) == 0;
    }
}

这是：

难以记住要做
一开始需要大量额外的代码（尽管设置好后，添加新的计算成员并不太糟糕）
由于添加了Lazy<T>实例，在内存方面效率低下

在“大”记录中，这种低效可能无关紧要，但它使得在只有几个参数的“小”记录中使用计算属性变得痛苦，特别是如果这些只是数字等。

选项4：请求更改语言

我提出这一点只是为了完整性。我非常信任C#设计团队：他们是聪明的人，会非常仔细地思考问题。如果发现我是第一个提出这个“问题”的人，我会感到震惊。我认为更可能的是，这种行为的利弊已经被详细讨论过，替代方案也被讨论和原型化过，然后才将当前行为作为最不坏的选择。

现在也许Roslyn编译器可以开始发出警告（选项2），这样我就不必编写分析器了——也许可以为以后的C#版本添加替代方案（理想情况下，为记录中的初始化提供更多的灵活性，例如，在实例“准备就绪”时调用的特殊命名成员，并且仍然可以写入只读属性）……但如果没有明确的鼓励，我可能不会开始为此创建提案。

结论

我很少在C#中发现陷阱，但这对我来说确实像一个。也许只是因为我在大选网站中如此广泛地使用了计算属性——也许记录真的不是设计用来这样使用的，我的一半记录类型应该真正是类。

我不想停止使用记录，也绝对不鼓励其他人这样做。我不想停止使用with操作符，再次强调，我也不鼓励其他人这样做。我希望这篇文章能对那些以不安全的方式使用with的人起到一点警示作用。

哦，当然，如果我确实编写了一个能够检测到这一点的Roslyn分析器，我会编辑这篇文章以链接到它。