Question

我在这里提出的许多问题涉及IEquatable的实现。我发现正确实现起来非常困难，因为在天真的实现中存在许多隐藏的错误，我发现的关于它的文章非常不完整。我想找到或写出一个必须包含的权威参考：

如何正确实现IEquatable
如何正确覆盖等于
如何正确覆盖GetHashCode
如何正确实现ToString方法
如何实现运营商==正确
如何实施运营商！=正确

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

PS：即使MSDN reference对我来说也是有缺陷的

Answer 1

为值类型

实施IEquatable<T>

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

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

我们的第一步是实施IEquatable<T>并覆盖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<double>，因为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<double>，我们需要四个运营商，因为您可以Complex == double或double == Complex（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<T>：

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

Answer 2

我认为在.NET的设计中，获取像检查对象一样简单正确的东西是有点棘手的。

对于Struct

1）实施IEquatable<T>。它显着提高了性能。

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方法的语法糖。写a == b比写a.Equals(b)更直观。我们很少需要检查参考平等。在处理物理对象的逻辑表示的抽象级别中，这不是我们需要检查的。我认为为==和Equals设置不同的语义实际上可能令人困惑。我认为它应该是==用于值相等，而Equals用于引用（或更好的名称，如IsSameAs）首先是平等。 我很想在这里不认真对待MS指南，不仅因为这对我来说不自然，而且因为超载==没有造成任何重大伤害。这不是没有重写可以咬回的非通用Equals或GetHashCode，因为框架不会在任何地方使用==，但仅限于我们自己使用它。我从没有重载==和!= 获得的唯一真正好处将是与我无法控制的整个框架的设计的一致性。这确实是一件大事，很遗憾我会坚持下去。

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

1）覆盖Equals和GetHashCode。

2）实施IEquatable<T>不是必须的，但如果你有一个就很好。

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。 确保它适用于空值。

2）实施IEquatable<T>不是必须的，但如果你有一个就很好。

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中的Equals相等性基类的。

一般注意不要重复代码。我可以创建一个通用的抽象基类（IEqualizable<T>左右）作为模板，以便更容易重用，但遗憾的是在C＃中阻止我从其他类派生。

Answer 3

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

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 Anonymous Type实现。对于具有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);
    }
}

是否有完整的IEquatable实现引用？

5 个答案:

为值类型