C# 9 记录的自定义相等检查

Question

据我了解，记录实际上是实现自己的相等检查的类，其方式是您的对象是值驱动而不是引用驱动。

简而言之，对于像这样实现的record Foo：var foo = new Foo { Value = "foo" } 和var bar = new Foo { Value = "foo" }，foo == bar 表达式将导致True，即使它们具有不同的引用 (ReferenceEquals(foo, bar) // False)。

现在有了记录，尽管the article 发布在 .Net 博客中，它说：

如果您不喜欢默认的逐字段比较行为 生成的 Equals 覆盖，您可以自己编写。

当我尝试放置 public override bool Equals、public override int GetHashCode 或 public static bool operator == 等时，我收到了 Member with the same signature is already declared 错误，所以我认为这是一种受限制的行为，但情况并非如此struct 对象。

Failing example:

public sealed record SimpleVo
    : IEquatable<SimpleVo>
{
    public bool Equals(SimpleVo other) =>
        throw new System.NotImplementedException();

    public override bool Equals(object obj) =>
        obj is SimpleVo other && Equals(other);

    public override int GetHashCode() =>
        throw new System.NotImplementedException();

    public static bool operator ==(SimpleVo left, SimpleVo right) =>
        left.Equals(right);

    public static bool operator !=(SimpleVo left, SimpleVo right) =>
        !left.Equals(right);
}

编译结果：

SimpleVo.cs(11,30): error CS0111: Type 'SimpleVo' already defines a member called 'Equals' with the same parameter types

SimpleVo.cs(17,37): error CS0111: Type 'SimpleVo' already defines a member called 'op_Equality' with the same parameter types

SimpleVo.cs(20,37): error CS0111: Type 'SimpleVo' already defines a member called 'op_Inequality' with the same parameter types

我的主要问题是，如果我们想自定义相等检查器的工作方式怎么办？我的意思是，我明白这超出了记录的全部目的，但另一方面，平等检查器并不是让记录使用起来很酷的唯一功能。

有人想要覆盖记录的相等性的一个用例是因为您可能有一个 attribute 会从相等性检查中排除一个属性。以 this ValueObject 实现为例。

如果你像这样扩展这个ValueObject抽象类：

public sealed class FullNameVo : ValueObject
{
    public FullNameVo(string name, string surname)
    {
        Name    = name;
        Surname = surname;
    }

    [IgnoreMember]
    public string Name { get; }

    public string Surname { get; }

    [IgnoreMember]
    public string FullName => $"{Name} {Surname}";
}

那么你会得到以下results:

var user1 = new FullNameVo("John", "Doe");
var user2 = new FullNameVo("John", "Doe");
var user3 = new FullNameVo("Jane", "Doe");

Console.WriteLine(user1 == user2); // True
Console.WriteLine(ReferenceEquals(user1, user2)); // False
Console.WriteLine(user1 == user3); // True
Console.WriteLine(user1.Equals(user3)); // True

到目前为止，为了以某种方式实现上述用例，我已经实现了an abstract record object并像这样使用它：

public sealed record FullNameVo : ValueObject
{
    [IgnoreMember]
    public string Name;

    public string Surname;

    [IgnoreMember]
    public string FullName => $"{Name} {Surname}";
}

结果如下所示：

var user1 = new FullNameVo
{
    Name    = "John",
    Surname = "Doe"
};

var user2 = new FullNameVo
{
    Name    = "John",
    Surname = "Doe"
};

var user3 = user1 with { Name = "Jane" };

Console.WriteLine(user1 == user2); // True
Console.WriteLine(ReferenceEquals(user1, user2)); // False
Console.WriteLine(user1 == user3); // False
Console.WriteLine(user1.Equals(user3)); // False
Console.WriteLine(ValueObject.EqualityComparer.Equals(user1, user3)); // True

最后，我有点困惑，限制记录对象的相等方法的覆盖是预期的行为还是因为它仍处于预览阶段？如果是设计使然，您会以不同的（更好）方式实现上述行为，还是继续使用类？

dotnet --version 输出：5.0.100-rc.1.20452.10

Answer 1

根据the C#9 record proposal，以下应该编译，即使在没有实际实现的情况下不是很有用..

// No explicit IEquatable<R> - this is synthesized!
public sealed record SimpleVo
{
    // Not virtual, as SimpleVo (R) is sealed.
    // Accepts SimpleVo? (R?), and not SimpleVo (R), as argument.
    public bool Equals(SimpleVo? other) =>
        throw new System.NotImplementedException();

    // Optional: warning generated if not supplied when Equals(R?) is user-defined.
    public int GetHashCode() =>
        throw new System.NotImplementedException();

    // No other “standard” equality members!
}

由于大部分代码是综合的，所以对等式相关的成员有限制。该提案包括预期综合基础类型的示例。

也就是说，给定仅Equals(R?)，编译器会创建==、!= 和Equals(object)。 可以定义的方法可以在提案中搜索“user-defined”找到。

尝试覆盖/定义其他相等方法或运算符预计会失败：

如果显式声明覆盖，则会出错。

该行为在“平等成员”中进行了讨论，并在以下段落中进行了总结：

记录类型实现System.IEquatable<R> 并包括book Equals(R? other) 的综合强类型重载，其中R 是记录类型。该方法是公共的，并且该方法是虚拟的，除非记录类型是密封的。 [Equals(R?)] 方法可以显式声明。 如果显式声明与预期的签名或可访问性不匹配，或者显式声明不允许在派生类型中覆盖它，则会出错并且记录类型没有密封。 如果Equals(R? other) 是用户定义的（未合成）但GetHashCode 不是[用户定义的]，则会产生警告。

Answer 2

不，这不是因为记录处于预览状态（当我写这篇文章时它们不在）。这是因为自定义Equals 的记录不是record 的正确使用方式。这是滥用记录的一个例子。

仅仅因为记录存在，您就应该不要在任何地方使用它们。

记录的美妙之处在于事半功倍，因此由编译器生成的样板代码，而不是由您生成。

如果你坚持使用记录，我会走这条路：

using System;

namespace ConsoleApp1;

class Program
{
    static void Main()
    {
        var foo = new Test("ShouldBeSame");
        var bar = new Test("shouldbesame");
        Console.WriteLine(foo.CustomEquals(bar));
    }
}

public record Test(string ToCompare);

public static class TestExtensions
{
    // You can do whatever you want here...
    public static bool CustomEquals(this Test foo, Test other) => string.Equals(foo.ToCompare.ToLowerInvariant(), other.ToCompare.ToLowerInvariant());
}