意外的不一致性：记录类型中的陷阱

前几天，我在调试代码中的一个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分析器。虽然我已经很久没有编写分析器了，但我的猜测是这仍然是一个相当复杂的过程。

更新，2025-07-29：我已经编写了一对分析器！详见我的后续文章。

选项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

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#设计团队：他们是聪明的人，会非常仔细地思考问题。如果发现我是第一个提出这个"问题"的人，我会感到震惊。我认为更可能的是，这种行为的利弊已经被详细讨论过，替代方案也被讨论和原型化过，然后才将当前行为定为最不坏的选择。

结论

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

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

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