有完整的 IEquatable 实现参考吗？

Question

我在这里关于 SO 的许多问题都涉及 IEquatable 的实现。我发现正确实现非常困难，因为幼稚的实现中存在许多隐藏的错误，而且我发现的有关它的文章相当不完整。我想找到或编写一个明确的参考，其中必须包括：

• 如何正确实现 IEquatable
• 如何正确重写 Equals
• 如何正确重写 GetHashCode
• 如何正确实现 ToString 方法
• 如何正确实现运算符 == 如何正确
• 实现运算符 !=正确

这样的完整参考已经存在吗？

PS：即使是 MSDN 参考 对我来说似乎也有缺陷

Answer 1

为值类型实现 IEquatable 为

值类型实现 IEquatable 与引用类型略有不同。假设我们有 Implement-Your-Own-Value-Type 原型，即一个复数结构。

public struct Complex
{
    public double RealPart { get; set; }
    public double ImaginaryPart { get; set; }
}

我们的第一步是实现 IEquatable并覆盖 Object.Equals 和 Object.GetHashCode：

public bool Equals(Complex other)
{
    // Complex is a value type, thus we don't have to check for null
    // if (other == null) return false;

    return (this.RealPart == other.RealPart)
        && (this.ImaginaryPart == other.ImaginaryPart);
}

public override bool Equals(object other)
{
    // other could be a reference type, the is operator will return false if null
    if (other is Complex)
        return this.Equals((Complex)other);
    else
        return false;
}

public override int GetHashCode()
{
    return this.RealPart.GetHashCode() ^ this.ImaginaryPart.GetHashCode();
}

只需很少的努力，我们就得到了正确的结果实施，但运营商除外。添加运算符也是一个简单的过程：

public static bool operator ==(Complex term1, Complex term2)
{
    return term1.Equals(term2);
}

public static bool operator !=(Complex term1, Complex term2)
{
    return !term1.Equals(term2);
}

精明的读者会注意到，我们可能应该实现 IEquatable，因为Complex 数字可以与底层值类型互换。

public bool Equals(double otherReal)
{
    return (this.RealPart == otherReal) && (this.ImaginaryPart == 0.0);
}

public override bool Equals(object other)
{
    // other could be a reference type, thus we check for null
    if (other == null) return base.Equals(other);

    if (other is Complex)
    {
        return this.Equals((Complex)other);
    }
    else if (other is double)
    {
        return this.Equals((double)other);
    }
    else
    {
        return false;
    }
}

如果添加 IEquatable，我们需要四个运算符，因为您可以使用 Complex == double 或 double == Complex （并且相同for operator !=)：

public static bool operator ==(Complex term1, double term2)
{
    return term1.Equals(term2);
}

public static bool operator ==(double term1, Complex term2)
{
    return term2.Equals(term1);
}

public static bool operator !=(Complex term1, double term2)
{
    return !term1.Equals(term2);
}

public static bool operator !=(double term1, Complex term2)
{
    return !term2.Equals(term1);
}

现在您已经知道了，只需付出最小的努力，我们就为值类型提供了正确且有用的实现 IEquatable：

public struct Complex : IEquatable<Complex>, IEquatable<double>
{
}

Answer 2

我相信，对于 .NET 的设计来说，像检查对象是否相等这样简单的事情有点棘手。

对于结构

1) 实现IEquatable。它显着提高了性能。

2) 由于您现在拥有自己的 Equals，请重写 GetHashCode，并与各种相等性检查重写 object.Equals 保持一致。

3) 重载 == 和 != 运算符不需要虔诚地完成，因为如果您无意中使用 == 或 !=，但这样做最好与 Equals 方法保持一致。

public struct Entity : IEquatable<Entity>
{
    public bool Equals(Entity other)
    {
        throw new NotImplementedException("Your equality check here...");
    }

    public override bool Equals(object obj)
    {
        if (obj == null || !(obj is Entity))
            return false;

        return Equals((Entity)obj);
    }

    public static bool operator ==(Entity e1, Entity e2)
    {
        return e1.Equals(e2);
    }

    public static bool operator !=(Entity e1, Entity e2)
    {
        return !(e1 == e2);
    }

    public override int GetHashCode()
    {
        throw new NotImplementedException("Your lightweight hashing algorithm, consistent with Equals method, here...");
    }
}

对于班级

来自 MS：

大多数引用类型不应重载相等运算符，即使它们覆盖 Equals。

对我来说， == 感觉就像值相等，更像是 Equals 方法的语法糖。编写a == b比编写a.Equals(b)直观得多。我们很少需要检查引用相等性。在处理物理对象的逻辑表示的抽象级别中，这不是我们需要检查的内容。我认为 == 和 Equals 具有不同的语义实际上可能会令人困惑。我相信首先应该是 == 表示值相等，而 Equals 表示引用（或更好的名称，如 IsSameAs）。 我不想在这里认真对待 MS 指南，不仅因为它对我来说不自然，而且还因为重载 == 不会造成任何重大伤害。这与不覆盖非泛型 Equals 或 GetHashCode 不同，后者可能会反噬，因为框架不会在任何地方使用 ==，除非我们自己使用使用它。我从不重载 == 和 != 中获得的唯一真正好处是与整个框架设计的一致性，而我没有的控制.这确实是一件大事，所以遗憾的是我会坚持下去。

使用引用语义（可变对象）

1) 覆盖 Equals 和 GetHashCode。

2) 实现 IEquatable 不是必须的，但如果你有一个那就太好了。

public class Entity : IEquatable<Entity>
{
    public bool Equals(Entity other)
    {
        if (ReferenceEquals(this, other))
            return true;

        if (ReferenceEquals(null, other))
            return false;

        //if your below implementation will involve objects of derived classes, then do a 
        //GetType == other.GetType comparison
        throw new NotImplementedException("Your equality check here...");
    }

    public override bool Equals(object obj)
    {
        return Equals(obj as Entity);
    }

    public override int GetHashCode()
    {
        throw new NotImplementedException("Your lightweight hashing algorithm, consistent with Equals method, here...");
    }
}

具有值语义（不可变对象）

这是棘手的部分。如果不小心，很容易搞砸。

1) 覆盖 Equals 和 GetHashCode。

2) 重载 == 和 != 以匹配 Equals。 确保它适用于 null。

2) 实现 IEquatable 不是必须的，但如果你有一个那就太好了。

public class Entity : IEquatable<Entity>
{
    public bool Equals(Entity other)
    {
        if (ReferenceEquals(this, other))
            return true;

        if (ReferenceEquals(null, other))
            return false;

        //if your below implementation will involve objects of derived classes, then do a 
        //GetType == other.GetType comparison
        throw new NotImplementedException("Your equality check here...");
    }

    public override bool Equals(object obj)
    {
        return Equals(obj as Entity);
    }

    public static bool operator ==(Entity e1, Entity e2)
    {
        if (ReferenceEquals(e1, null))
            return ReferenceEquals(e2, null);

        return e1.Equals(e2);
    }

    public static bool operator !=(Entity e1, Entity e2)
    {
        return !(e1 == e2);
    }

    public override int GetHashCode()
    {
        throw new NotImplementedException("Your lightweight hashing algorithm, consistent with Equals method, here...");
    }
}

要特别注意如果您的类可以继承，情况会如何，在这种情况下，您必须确定基类对象是否可以等于派生类对象。理想情况下，如果没有派生类的对象用于相等性检查，则基类实例可以等于派生类实例，在这种情况下，不需要检查泛型 Type 相等性。 code>Equals 基类。

一般来说，请注意不要重复代码。我本可以制作一个通用抽象基类（IEqualized 左右）作为模板，以便更轻松地重用，但遗憾的是在 C# 中，这阻止了我从其他类派生。

Answer 3

在阅读 MSDN 后，我非常确定正确实现的最佳示例位于 IEquatable.Equals 方法 页面。我唯一的偏差如下：

public override bool Equals(Object obj)
{
   if (obj == null) return base.Equals(obj);

   if (! (obj is Person))
      return false; // Instead of throw new InvalidOperationException
   else
      return Equals(obj as Person);   
}

对于那些想知道偏差的人，它源自 Object.Equals(Object) MSDN 页面：

Equals 的实现不得抛出异常。

Answer 4

我找到了另一个参考，它是 .NET 匿名类型实现。对于具有 int 和 double 作为属性的匿名类型，我反汇编了以下 C# 代码：

public class f__AnonymousType0
{
    // Fields
    public int A { get; }
    public double B { get; }

    // Methods
    public override bool Equals(object value)
    {
        var type = value as f__AnonymousType0;
        return (((type != null)
            && EqualityComparer<int>.Default.Equals(this.A, type.A))
            && EqualityComparer<double>.Default.Equals(this.B, type.B));
    }

    public override int GetHashCode()
    {
        int num = -1134271262;
        num = (-1521134295 * num) + EqualityComparer<int>.Default.GetHashCode(this.A);
        return ((-1521134295 * num) + EqualityComparer<double>.Default.GetHashCode(this.B);
    }

    public override string ToString()
    {
        StringBuilder builder = new StringBuilder();
        builder.Append("{ A = ");
        builder.Append(this.A);
        builder.Append(", B = ");
        builder.Append(this.B);
        builder.Append(" }");
        return builder.ToString();
    }
}

Answer 5

我只需要从这个类派生

public abstract class DataClass : IEquatable<DataClass>
{
    public override bool Equals(object obj)
    {
        var other = obj as DataClass;
        return this.Equals(other);
    }

    public bool Equals(DataClass other)
    {
        return (!ReferenceEquals(null, other))
            && this.Execute((self2, other2) =>
                other2.Execute((other3, self3) => self3.Equals(other3), self2)
                , other);
    }

    public override int GetHashCode()
    {
        return this.Execute(obj => obj.GetHashCode());
    }

    public override string ToString()
    {
        return this.Execute(obj => obj.ToString());
    }

    private TOutput Execute<TOutput>(Func<object, TOutput> function)
    {
        return this.Execute((obj, other) => function(obj), new object());
    }

    protected abstract TOutput Execute<TParameter, TOutput>(
        Func<object, TParameter, TOutput> function,
        TParameter other);
}

然后实现这样的抽象方法

public class Complex : DataClass
{
    public double Real { get; set; }

    public double Imaginary { get; set; }

    protected override TOutput Execute<TParameter, TOutput>(
        Func<object, TParameter, TOutput> function,
        TParameter other)
    {
        return function(new
        {
            Real = this.Real,
            Imaginary = this.Imaginary,
        }, other);
    }
}