C#记录类型与集合的深度探讨：自定义相等性比较与工具集成

本文深入探讨了在C#中使用记录类型和不可变集合时遇到的实践挑战，特别是关于属性级自定义相等性比较的缺失、引用相等性比较器的使用、字符串序数比较扩展方法，以及Visual Studio对记录类型的工具支持不足等问题。

记录与集合

这篇文章在某种程度上是我在使用记录和集合构建选举网站时遇到的一系列摩擦点的集合。

记录类型回顾

这可能会成为本系列中最具普遍适用性的博客文章。尽管记录类型自 C# 第 10 版就已存在，但我个人使用得并不多。（我期待使用它们已超过十年，但那是另一回事了。）

决定将所有数据模型设为不可变后，在 C# 中使用记录类型（在我的案例中总是密封记录）来实现这些模型几乎是理所当然的。只需使用与主构造函数相同的格式指定所需的属性，编译器就会为你完成大量样板工作。

作为一个简单的例子，考虑以下记录声明：

1

public sealed record Candidate(int Id, string Name, int? MySocietyId, int? ParliamentId);

这生成的代码大致相当于：

 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
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69

public sealed class Candidate : IEquatable<Candidate>
{
    public int Id { get; }
    public string Name { get; }
    public int? MySocietyId { get; }
    public int? ParliamentId { get; }
    
    public Candidate(int id, string name, int? mySocietyId, int? parliamentId)
    {
        Id = id;
        Name = name;
        MySocietyId = mySocietyId;
        ParliamentId = parliamentId;
    }
    
    public override bool Equals(object? obj) => obj is Candidate other && Equals(other);
    
    public override int GetHashCode()
    {
        // 真实代码也使用 EqualityContract，此处省略。
        int idHash = EqualityComparer<int>.Default.GetHashCode(Id);
        int hash = idHash * -1521134295;
        int nameHash = EqualityComparer<string>.Default.GetHashCode(Name);
        hash = (hash + nameHash) * -1521134295;
        int mySocietyIdHash = EqualityComparer<int?>.Default.GetHashCode(MySocietyId);
        hash = (hash + mySocietyIdHash) * -1521134295;
        int parliamentIdHash = EqualityComparer<int?>.Default.GetHashCode(ParliamentId);
        hash = (hash + parliamentIdHash) * -1521134295;
        return hash;
    }
    
    public bool Equals(Candidate? other)
    {
        if (ReferenceEquals(this, other))
        {
            return true;
        }
        if (other is null)
        {
            return false;
        }
        // 真实代码也使用 EqualityContract，此处省略。
        return EqualityComparer<int>.Default.Equals(Id, other.Id) &&
               EqualityComparer<string>.Default.Equals(Name, other.Name) &&
               EqualityComparer<int?>.Default.Equals(MySocietyId, other.MySocietyId) &&
               EqualityComparer<int?>.Default.Equals(ParliamentId, other.ParliamentId);
    }
    
    public static bool operator==(Candidate? left, Candidate? right)
    {
        if (ReferenceEquals(left, right))
        {
            return true;
        }
        if (left is null)
        {
            return false;
        }
        return left.Equals(right);
    }
    
    public static bool operator!=(Candidate? left, Candidate? right) => !(left == right);
    
    public override string ToString() =>
        $"Candidate {{ Id = {Id}, Name = {Name}, MySocietyId = {MySocietyId}, ParliamentId = {ParliamentId} }}";
    
    public void Deconstruct(out int Id, out string Name, out int? MySocietyId, out int? ParliamentId) =>
        (Id, Name, MySocietyId, ParliamentId) = (this.Id, this.Name, this.MySocietyId, this.ParliamentId);
}

（本可以使用主构造函数写得更紧凑些，但我保持了“老派”C#风格以避免混淆。）

此外，编译器允许对记录使用 with 运算符，基于现有实例和一些更新的属性创建新实例。例如：

1
2

var original = new Candidate(10, "Jon", 20, 30);
var updated = original with { Id = 40, Name = "Jonathan" };

这很棒！除了当它不完全符合需求时……

记录相等性

如上所示，记录类型的默认相等性实现为每个属性使用 EqualityComparer<T>.Default。当属性类型的默认相等比较器是你想要的时，这没问题——但并不总是如此。在我们的选举数据模型案例中，大多数类型都没问题——但 ImmutableList<T> 不行，而我们大量使用它。

ImmutableList<T> 本身不重写 Equals 和 GetHashCode——因此它具有引用相等性语义。我真正想要的是使用元素类型的相等比较器，并说如果两个不可变列表具有相同数量且元素成对比较相等，则它们相等。这很容易实现——同时还需要一个合适的 GetHashCode 方法。它可以很容易地被包装在一个实现 IEqualityComparer<ImmutableList<T>> 的类型中，尽管碰巧我还没这么做。

不幸的是，C# 中记录类型的工作方式，无法为给定属性指定要使用的相等比较器。如果你直接实现 Equals 和 GetHashCode 方法，这些方法将代替生成的版本被使用（并且生成的 Equals(object) 代码仍将使用你实现的版本），但这意味着你必须为所有属性实现它。这反过来意味着，如果你在记录中添加新属性，需要记得修改 Equals 和 GetHashCode（我至少忘记过一次）——而如果你乐于使用默认的生成实现，添加属性是轻而易举的。

我真正希望的是有某种方式向编译器指示，它应该使用指定类型来获取属性的相等比较器（可以假定为无状态的）。例如，假设我们有这些类型：

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17

// 假设这在框架中...
public interface IEqualityComparerProvider
{
    static abstract IEqualityComparer<T> GetEqualityComparer<T>();
}

// 这个也是...
[AttributeUsage(AttributeTargets.Property)]
public sealed class EqualityComparerAttribute : Attribute
{
    public Type ProviderType { get; }
    
    public EqualityComparer(Type providerType)
    {
        ProviderType = providerType;
    }
}

现在我可以这样实现接口：

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

public sealed class CollectionEqualityProvider : IEqualityComparerProvider
{
    public static IEqualityComparer<T> GetEqualityComparer<T>()
    {
        var type = typeof(T);
        if (!type.IsGenericType)
        {
            throw new InvalidOperationException("Unsupported type");
        }
        var genericTypeDefinition = type.GetGenericTypeDefinition();
        if (genericTypeDefinition == typeof(ImmutableList<>))
        {
            // 实例化并返回适当的相等比较器
        }
        if (genericTypeDefinition == typeof(ImmutableDictionary<,>))
        {
            // 实例化并返回适当的相等比较器
        }
        // 等等...
        throw new InvalidOperationException("Unsupported type");
    }
}

遗憾的是，注释会涉及进一步的反射——但这肯定是可行的。

然后我们可以这样声明一个记录：

1
2
3

public sealed record Ballot(
    Constituency Constituency,
    [IEqualityComparerProvider(typeof(CollectionEqualityProvider))] ImmutableList<Candidacy> Candidacies);

……并且我期望编译器生成如下代码：

 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
28
29

public sealed class Ballot
{
    private static readonly IEqualityComparer<ImmutableList<Candidacy>> candidaciesComparer;
    
    // 跳过与今天生成方式相同的代码。
    
    public bool Equals(Candidate? other)
    {
        if (ReferenceEquals(this, other))
        {
            return true;
        }
        if (other is null)
        {
            return false;
        }
        return EqualityComparer<Constituency>.Default.Equals(Constituency, other.Constituency) &&
               candidaciesComparer.Equals(Candidacies, other.Candidacies);
    }
    
    public override int GetHashCode()
    {
        int constituencyHash = EqualityComparer<Constituency>.Default.GetHashCode(Constituency);
        int hash = constituencyHash * -1521134295;
        int candidaciesHash = candidaciesComparer.GetHashCode(Candidacies);
        hash = (hash + candidaciesHash) * -1521134295;
        return hash;
    }
}

我相信还有其他方法可以做到这一点。该属性可以改为指定用于获取相等比较器的私有静态只读属性的名称，从而移除接口。或者 GetEqualityComparer 方法可以是非泛型的，带一个 Type 参数（让编译器在调用后进行转换生成）。我几乎没有仔细考虑过——但重要的是，对单个属性进行自定义相等比较的需求变得独立于所有其他属性。如果你已经有一个包含 9 个属性且默认相等性比较没问题的记录，那么添加第 10 个需要更多自定义的属性就很容易——而在今天，你需要实现包括所有 10 个属性的 Equals 和 GetHashCode。

（对于属性的字符串格式化也可以这样说，但这还不是一个困扰我的领域。）

我遇到的另一个摩擦点也与相等性有关，但方向不同。

引用相等性

如果你还记得我关于数据模型的帖子，在单个 ElectionContext 中，模型仅需要引用相等性。网站永远不需要通过指定来自不同上下文的 Constituency 来从一个上下文中获取（例如）2024 年选举的选区结果。事实上，如果我 ever 发现代码尝试这样做，那可能表明存在错误：任何给定 Web 请求中的所有内容都应引用相同的 ElectionContext。

鉴于此，当我创建 ImmutableDictionary<Constituency, Result> 时，我想提供一个仅执行引用比较的 IEqualityComparer<Constituency>。虽然这看起来很简单，但我发现当重新加载上下文时，这对构建视图模型所花费的时间有相当显著的影响。

我原以为在框架中找到一个引用相等比较器会很容易——但如果有的话，我错过了。

更新，2025-03-27T21:04Z，感谢 Michael Damatov

正如 Michael 在评论中指出的，框架中有一个：System.Collections.Generic.ReferenceEqualityComparer——我记得当我第一次发现我需要一个时就找到了它。但我愚蠢地否定了它。你看，它是非泛型的：

1
2
3

public sealed class ReferenceEqualityComparer :
    System.Collections.Generic.IEqualityComparer<object>,
    System.Collections.IEqualityComparer

我当时想，这很奇怪，而且不太有用。为什么我只想要 IEqualityComparer<object> 而不是泛型的呢？

哦，Jon。愚蠢，愚蠢的 Jon。

IEqualityComparer<T> 在 T 上是逆变的——因此对于任何类类型 X，都存在从 IEqualityComparer<object> 到 IEqualityComparer<X> 的隐式引用转换。

我现在已经移除了我自己写的泛型 ReferenceEqualityComparer<T> 类型……尽管这意味着我不得不在以前通过比较器的类型推断出类型参数的地方，要么进行强制转换，要么显式指定一些类型参数。

更新结束

我现在已经养成了在数据模型中处处使用引用相等比较的习惯，这使得添加一些扩展方法变得有价值——而这些方法可能不太适合添加到框架中（尽管它们可以很容易地通过 NuGet 包提供）：

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18

public static ImmutableDictionary<TKey, TValue> ToImmutableReferenceDictionary<TSource, TKey, TValue>(
    this IEnumerable<TSource> source,
    Func<TSource, TKey> keySelector,
    Func<TSource, TValue> elementSelector) where TKey : class =>
    source.ToImmutableDictionary(keySelector, elementSelector, ReferenceEqualityComparer<TKey>.Instance);

public static ImmutableDictionary<TKey, TSource> ToImmutableReferenceDictionary<TSource, TKey>(
    this IEnumerable<TSource> source,
    Func<TSource, TKey> keySelector) where TKey : class =>
    source.ToImmutableDictionary(keySelector, ReferenceEqualityComparer<TKey>.Instance);

public static ImmutableDictionary<TKey, TValue> ToImmutableReferenceDictionary<TKey, TValue>(
    this IDictionary<TKey, TValue> source) where TKey : class =>
    source.ToImmutableDictionary(ReferenceEqualityComparer<TKey>.Instance);

public static ImmutableDictionary<TKey, TValue> ToImmutableReferenceDictionary<TKey, TValue, TSourceValue>(
    this IDictionary<TKey, TSourceValue> source, Func<KeyValuePair<TKey, TSourceValue>, TValue> elementSelector) where TKey : class =>
    source.ToImmutableDictionary(pair => pair.Key, elementSelector, ReferenceEqualityComparer<TKey>.Instance);

（我当然可以轻松地为构建 Lookup 添加类似的方法。）请随意对命名提出异议——既然它们只在选举代码仓库内使用，我不会太担心它们。

插曲

为什么不默认使用引用相等性？

我或许可以在这里一石二鸟。如果我经常需要引用相等性，而“深度”相等性相对难以实现，为什么不直接提供 Equals 和 GetHashCode 方法，让我所有的记录类型都表现出引用相等性比较的行为呢？

这当然是一个选择——但我确实在测试目的上依赖深度相等性比较：例如，如果我两次加载相同的上下文，结果应该是相等的，否则就有问题。

此外，由于记录类型鼓励深度相等性，感觉通过指定引用相等性比较，我会颠覆它们的自然行为。虽然我不期望其他人会看到这段代码，但我不喜欢编写会混淆那些基于大多数代码工作方式抱有预期的读者的代码。

插曲结束

说到常用比较器的扩展方法……

字符串序数比较

字符串比较让我紧张。我绝对不是国际化专家，但我知道这很复杂。

我也知道足够多，可以相当确信默认的字符串比较对于 Equals 和 GetHashCode 是序数的，但对于 CompareTo 是文化敏感的。正如我所说，我对此相当有信心——但我总觉得很难验证，所以既然我几乎总是想使用序数比较，我喜欢明确指定。以前我指定 StringComparer.Ordinal（或偶尔用 StringComparer.OrdinalIgnoreCase）——但就像上面提到的引用相等比较器一样——如果你经常使用它，这就会变得烦人。

因此，我创建了另一批扩展方法，只是为了明确表明我想使用序数字符串比较——即使在相等性比较的情况下，这已经是默认的。

我不会用完整的方法来烦你，但我有：

  • OrderByOrdinal
  • OrderByOrdinalDescending
  • ThenByOrdinal
  • ThenByOrdinalDescending
  • ToImmutableOrdinalDictionary（4 个重载，类似于上面的 ToImmutableReferenceDictionary）
  • ToOrdinalDictionary（同样是 4 个重载）
  • ToOrdinalLookup（2 个重载）

（我实际上不常用 ToOrdinalLookup，但实现所有方法感觉很合理。）

这些在框架中会有用吗？可能吧。我明白为什么它们不在那里——字符串“只是另一种类型”而已……但我敢打赌，很大比例的 LINQ 使用最终都会以某种形式将字符串作为键。或许我应该建议将它们加入 MoreLINQ——尽管我在超过 15 年前启动了这个项目，但我已经有十多年没有为其贡献代码了……

Visual Studio 中主构造函数和记录的“调用层次结构”小问题

我经常在 Visual Studio 中使用“调用层次结构”。将光标放在一个成员上，然后按 Ctrl-K、Ctrl-T，你就可以看到调用该成员的所有内容，以及调用调用者的内容，等等。

对于主构造函数和记录参数，“查找所有引用”有效（Ctrl-K、Ctrl-R），但“调用层次结构”无效。我可以接受“调用层次结构”对主构造函数参数无效，但由于记录参数会成为属性，我期望能像对待任何其他属性一样看到它们的调用层次结构。

但更令人沮丧的是，无法看到“调用构造函数”的调用层次结构。鉴于类/记录的声明在某种程度上也充当了构造函数的声明，我以为将光标放在类/记录声明上（在名称处）会起作用。这并不是因为它有歧义——Visual Studio 只是抱怨“光标必须位于成员名称上”。你可以通过展开解决方案资源管理器中的源文件条目来获取调用信息，但仅为此一种情况而必须这样做，这很奇怪。

功能请求（针对 C# 语言、.NET 和 Visual Studio）

总而言之，我喜欢记录类型，也喜欢不可变集合——但通过引入以下内容，可以减少一些摩擦：

  • 某种方式（基于每个属性）控制在生成代码中使用哪个相等比较器
  • 不可变集合的相等比较器，并能够指定要使用的元素比较方式
  • 执行引用比较的 IEqualityComparer<T> 实现
  • 显示主构造函数和记录构造函数的调用情况的“调用层次结构”

结论

我在记录和集合中发现的一些小问题，至少在某种程度上特定于我的选举网站，尽管我强烈怀疑我不是唯一在记录中使用不可变集合并希望在相等性比较中使用它们的开发人员。

总的来说，记录类型到目前为止在网站中表现良好，我很高兴它们可用，即使仍有改进的余地。同样，能自然获得不可变集合也很好——但若能获得一些关于如何对它们进行比较的帮助，将不胜欢迎。

comments powered by Disqus
© 2020 - 2026 qife
使用 Hugo 构建
主题 Stack 由 Jimmy 设计
本站总访问量次 本站访客数人次