为什么在重写 Equals 方法时重写 GetHashCode 很重要？

Question

给定以下类

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很重要？

Answer 1

从 C# 9（.net 5 或 .net core 3.1）开始，您可能希望像使用 Value Based Equality 一样使用 records。

Answer 2

从.NET 4.7 开始，覆盖GetHashCode() 的首选方法如下所示。如果针对较旧的 .NET 版本，请包含 System.ValueTuple nuget 包。

// C# 7.0+
public override int GetHashCode() => (FooId, FooName).GetHashCode();

在性能方面，这种方法将优于大多数复合哈希码实现。 ValueTuple 是 struct，所以不会有任何垃圾，并且底层算法是最快的。

Answer 3

是的，如果您的项目将用作字典中的键或 HashSet<T> 等，这一点很重要 - 因为这是用于（在没有自定义 IEqualityComparer<T> 的情况下）将项目分组到存储桶中。如果两个项目的哈希码不匹配，它们可能永远被认为是相等的（Equals 永远不会被调用）。

GetHashCode() 方法应该反映Equals 逻辑；规则是：

• 如果两个事物相等 (Equals(...) == true)，那么它们必须为 GetHashCode() 返回相同的值
• 如果GetHashCode() 相等，则不需要它们必须相同；这是一个冲突，Equals 将被调用以查看它是否是真正的相等。

在这种情况下，“return FooId;”看起来是一个合适的GetHashCode() 实现。如果您正在测试多个属性，通常使用如下代码组合它们，以减少对角线冲突（即，new Foo(3,5) 与 new Foo(5,3) 具有不同的哈希码）：

unchecked // only needed if you're compiling with arithmetic checks enabled
{ // (the default compiler behaviour is *disabled*, so most folks won't need this)
    int hash = 13;
    hash = (hash * 7) + field1.GetHashCode();
    hash = (hash * 7) + field2.GetHashCode();
    ...
    return hash;
}

哦 - 为方便起见，您还可以考虑在覆盖 Equals 和 GetHashCode 时提供 == 和 != 运算符。

---

here 演示了当您弄错时会发生什么。

Answer 4

您应该始终保证如果两个对象相等，如 Equals() 定义的那样，它们应该返回相同的哈希码。正如其他一些 cmets 所述，理论上，如果对象永远不会在基于散列的容器（如 HashSet 或 Dictionary）中使用，则这不是强制性的。不过，我建议您始终遵循此规则。原因很简单，因为人们很容易将集合从一种类型更改为另一种类型，以实际提高性能或只是以更好的方式传达代码语义。

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

我在blog post 中总结了这种行为与其他一些 GetHashCode() 陷阱，您可以在其中找到更多示例和解释。

Answer 5

我们有两个问题需要解决。

1. 如果在 对象可以改变。也经常一个对象永远不会在一个 依赖于GetHashCode() 的集合。所以成本 实施GetHashCode() 通常不值得，或者不值得 可能。

2. 如果有人将您的对象放入一个调用 GetHashCode() 并且您已经覆盖了Equals() 而没有 GetHashCode() 行为正确，那个人可能会花几天时间 追查问题。

因此默认情况下我会这样做。

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()
    {
        // Some comment to explain if there is a real problem with providing GetHashCode() 
        // or if I just don't see a need for it for the given class
        throw new Exception("Sorry I don't know what GetHashCode should do for this class");
    }
}

Answer 6

在覆盖Equals() 时，请不要忘记对照null 检查obj 参数。 并且还要比较类型。

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

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

    return fooItem.FooId == this.FooId;
}

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

Answer 7

通过覆盖 Equals，您基本上是在说明您是最了解如何比较给定类型的两个实例的人，因此您可能是提供最佳哈希码的最佳人选。

这是 ReSharper 如何为您编写 GetHashCode() 函数的示例：

public override int GetHashCode()
{
    unchecked
    {
        var result = 0;
        result = (result * 397) ^ m_someVar1;
        result = (result * 397) ^ m_someVar2;
        result = (result * 397) ^ m_someVar3;
        result = (result * 397) ^ m_someVar4;
        return result;
    }
}

如您所见，它只是尝试根据类中的所有字段猜测一个好的哈希码，但由于您知道对象的域或值范围，您仍然可以提供更好的哈希码。

Answer 8

怎么样：

public override int GetHashCode()
{
    return string.Format("{0}_{1}_{2}", prop1, prop2, prop3).GetHashCode();
}

假设性能不是问题:)

Answer 9

只是补充以上答案：

如果您不覆盖 Equals，则默认行为是比较对象的引用。这同样适用于哈希码——默认实现通常基于引用的内存地址。 因为您确实覆盖了 Equals 这意味着正确的行为是比较您在 Equals 上实现的任何内容而不是引用，因此您应该对哈希码执行相同的操作。

您的类的客户会期望哈希码与 equals 方法具有相似的逻辑，例如使用 IEqualityComparer 的 linq 方法首先比较哈希码，只有当它们相等时，他们才会比较 Equals() 方法，这可能运行起来成本更高，如果我们没有实现 hashcode，equal 对象可能会有不同的 hashcode（因为它们有不同的内存地址）并且会被错误地确定为不相等（Equals() 甚至不会命中）。

此外，除了如果您在字典中使用对象可能无法找到对象的问题（因为它是由一个哈希码插入的，当您查找它时，默认哈希码可能会有所不同，并且再次Equals() 甚至不会被调用，就像 Marc Gravell 在他的回答中解释的那样，您还引入了对字典或哈希集概念的违反，它不应该允许相同的键 - 您已经声明，当您覆盖 Equals 时，这些对象本质上是相同的，因此您不希望它们都作为假设具有唯一键的数据结构上的不同键。但是因为它们具有不同的哈希码，所以“相同”的密钥将作为不同的密钥插入。

Answer 10

在我看来，考虑到公共属性，下面使用反射是一个更好的选择，因为这样您就不必担心添加/删除属性（尽管不是很常见的情况）。我发现这也表现得更好。（使用 Diagonistics 秒表比较时间）。

    public int getHashCode()
    {
        PropertyInfo[] theProperties = this.GetType().GetProperties();
        int hash = 31;
        foreach (PropertyInfo info in theProperties)
        {
            if (info != null)
            {
                var value = info.GetValue(this,null);
                if(value != null)
                unchecked
                {
                    hash = 29 * hash ^ value.GetHashCode();
                }
            }
        }
        return hash;  
    }

Answer 11

我的理解是原始的 GetHashCode() 返回对象的内存地址，因此如果您想比较两个不同的对象，则必须重写它。

编辑： 那是不正确的，原来的 GetHashCode() 方法不能保证 2 个值的相等性。尽管相等的对象返回相同的哈希码。

Answer 12

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

Answer 13

不一定重要；这取决于您的集合的大小和您的性能要求，以及您的类是否将用于您可能不知道性能要求的库中。我经常知道我的集合大小不是很大，我的时间比创建完美哈希码获得的几微秒性能更有价值；所以（为了摆脱编译器的恼人警告）我只是使用：

   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
      }
   }    

另一方面，如果 Value 无法更改，则可以使用：

   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
      }
   }

Answer 14

实际上很难正确实现GetHashCode()，因为除了Marc 已经提到的规则之外，哈希码在对象的生命周期内不应该改变。因此用于计算哈希码的字段必须是不可变的。

当我使用 NHibernate 时，我终于找到了解决这个问题的方法。 我的方法是根据对象的 ID 计算哈希码。 ID 只能通过构造函数设置，因此如果您想更改 ID（这不太可能），您必须创建一个具有新 ID 的新对象，因此需要一个新的哈希码。这种方法最适合 GUID，因为您可以提供随机生成 ID 的无参数构造函数。

Answer 15

这是因为框架要求两个相同的对象必须具有相同的哈希码。如果重写 equals 方法对两个对象进行特殊比较，并且该方法认为这两个对象相同，那么这两个对象的哈希码也必须相同。 （字典和 Hashtable 依赖于这个原则）。