给定以下类别

public class Foo
{
    public int FooId { get; set; }
    public string FooName { get; set; }

    public override bool Equals(object obj)
    {
        Foo fooItem = obj as Foo;

        if (fooItem == null) 
        {
           return false;
        }

        return fooItem.FooId == this.FooId;
    }

    public override int GetHashCode()
    {
        // Which is preferred?

        return base.GetHashCode();

        //return this.FooId.GetHashCode();
    }
}

我重写了Equals方法,因为Foo表示Foos表的一行。哪个是重写GetHashCode的首选方法?

为什么重写GetHashCode很重要?


当前回答

重写Equal()时,请不要忘记检查obj参数是否为null。并比较类型。

public override bool Equals(object obj)
{
    Foo fooItem = obj as Foo;

    if (fooItem == null)
    {
       return false;
    }

    return fooItem.FooId == this.FooId;
}

原因是:与null比较时,Equals必须返回false。另请参见http://msdn.microsoft.com/en-us/library/bsc2ak47.aspx

其他回答

哈希代码用于基于哈希的集合,如Dictionary、Hashtable、HashSet等。该代码的目的是通过将特定对象放入特定组(bucket)来快速地对其进行预排序。当您需要从哈希集合中检索该对象时,这种预排序非常有助于找到该对象,因为代码必须在一个桶中而不是在它包含的所有对象中搜索该对象。哈希码的分布越好(唯一性越好),检索速度越快。在理想情况下,每个对象都有一个唯一的哈希码,找到它是一个O(1)操作。在大多数情况下,它接近O(1)。

您应该始终保证,如果两个对象相等(由Equals()定义),它们应该返回相同的哈希代码。正如其他一些评论所说,理论上,如果对象永远不会在HashSet或Dictionary等基于哈希的容器中使用,则这不是强制性的。但我建议你始终遵守这条规则。原因很简单,因为人们很容易将集合从一种类型更改为另一种类型,以便实际提高性能或以更好的方式传递代码语义。

例如,假设我们在列表中保留一些对象。一段时间后,有人意识到HashSet是一个更好的选择,因为它具有更好的搜索特性。这是我们可能陷入麻烦的时候。List将在内部为类型使用默认的相等比较器,在您的情况下,这意味着Equals,而HashSet使用GetHashCode()。如果两者的行为不同,那么您的程序也会不同。请记住,这些问题不是最容易解决的。

我在一篇博客文章中总结了这种行为和其他GetHashCode()陷阱,在这里可以找到更多的示例和解释。

从C#9(.net5或.netcore3.1)开始,您可能希望使用记录,因为默认情况下它使用基于值的相等。

这并不一定重要;这取决于集合的大小和性能要求,以及您的类是否将用于您可能不知道性能要求的库中。我经常知道我的集合大小不是很大,我的时间比创建一个完美的哈希代码所获得的几微秒的性能更有价值;所以(为了消除编译器发出的恼人警告)我只需使用:

   public override int GetHashCode()
   {
      return base.GetHashCode();
   }

(当然,我也可以使用#pragma关闭警告,但我更喜欢这种方式。)

当然,当你处于一个你确实需要表现的位置时,这里其他人提到的所有问题都适用。最重要的是,否则在从哈希集或字典中检索项目时会得到错误的结果:哈希码不能随对象的生存时间而变化(更准确地说,在需要哈希码的时间,例如在字典中作为关键字时):例如,以下内容是错误的,因为Value是公共的,因此可以在实例的生命周期内在类外部进行更改,因此不能将其用作哈希代码的基础:


   class A
   {
      public int Value;

      public override int GetHashCode()
      {
         return Value.GetHashCode(); //WRONG! Value is not constant during the instance's life time
      }
   }    

另一方面,如果无法更改值,则可以使用:


   class A
   {
      public readonly int Value;

      public override int GetHashCode()
      {
         return Value.GetHashCode(); //OK  Value is read-only and can't be changed during the instance's life time
      }
   }

重写Equal()时,请不要忘记检查obj参数是否为null。并比较类型。

public override bool Equals(object obj)
{
    Foo fooItem = obj as Foo;

    if (fooItem == null)
    {
       return false;
    }

    return fooItem.FooId == this.FooId;
}

原因是:与null比较时,Equals必须返回false。另请参见http://msdn.microsoft.com/en-us/library/bsc2ak47.aspx