关于如何正确重写 object.GetHashCode() 的一般建议和指南

Question

根据 MSDN，哈希函数必须具有以下内容特性：

1. 如果两个对象比较相等，则每个对象的 GetHashCode 方法必须返回相同的值。但是，如果两个对象比较不相等，则两个对象的 GetHashCode 方法不必返回不同的值。

2. 只要确定对象的 Equals 方法的返回值的对象状态没有发生修改，对象的 GetHashCode 方法就必须始终返回相同的哈希码。请注意，这仅适用于应用程序的当前执行，并且如果应用程序再次运行，则可以返回不同的哈希码。

3. 为了获得最佳性能，哈希函数必须为所有输入生成随机分布。

---

我不断发现自己处于以下场景：我创建了一个类，实现了 IEquatable并重写了 object.Equals(object)。 MSDN 指出：

覆盖 Equals 的类型也必须覆盖 GetHashCode ；否则，Hashtable 可能无法正常工作。

然后它通常对我来说会有点停止。因为，如何正确重写object.GetHashCode()？永远不知道从哪里开始，而且似乎有很多陷阱。

在 StackOverflow 上，有很多与 GetHashCode 重写相关的问题，但其中大多数似乎都是针对非常特殊的情况和特定问题。因此，我想在这里得到一份好的汇编。包含一般建议和指南的概述。该做什么、不该做什么、常见的陷阱、从哪里开始等等。

我希望它特别针对 C#，但我认为它也适用于其他 .NET 语言（？ ）。

---

我认为最好的方法可能是为每个主题创建一个答案，首先给出一个快速而简短的答案（如果可能的话，接近一句话），然后可能是一些更多信息，最后以相关问题、讨论、博客文章结束等等，如果有的话。然后，我可以创建一篇文章作为接受的答案（将其放在顶部），只需一个“目录”。尽量保持简短。不要只链接到其他问题和博客文章。尝试获取它们的本质，然后链接到源（特别是因为源可能会消失。另外，请尝试编辑和改进答案，而不是创建大量非常相似的答案。

我不是非常好的技术作家，但我至少会尝试格式化答案，使它们看起来相似，创建目录等。我还将尝试在此处搜索一些相关问题，以回答其中的部分问题，也许会拉但由于我在这个话题上不太稳定，所以我会尽量避开大部分内容：p

Answer 1

目录

• 何时覆盖 object.GetHashCode？

• 为什么我必须重写 object.GetHashCode()？< /p>

• GetHashCode 实现中看到的那些神奇数字是什么？

---

我希望涵盖但尚未涵盖的内容然而：

• 如何创建整数（如何将对象“转换”为 int 对我来说并不是很明显）。
• 哈希码基于哪些字段。
  • 如果它应该只存在于不可变字段上，那么如果只有可变字段怎么办？
• 如何生成良好的随机分布。 （MSDN 属性 #3）
  • 对此，似乎要选择一个很好的神奇素数（已经使用过 17、23 和 397），但是如何选择它，它到底有什么用？
• 如何确保哈希码在整个对象生命周期中保持不变。 （MSDN 属性 #2）
  • 特别是当相等性基于可变字段时。 （MSDN 属性 #1）
• 如何处理复杂类型的字段（不在 中）内置 C# 类型）。
  • 复杂对象和结构、数组、集合、列表、字典、泛型类型等。
  • 例如，即使列表或字典可能是只读的，但这并不意味着它的内容是只读的。
• 如何处理继承的类。
  • 您是否应该以某种方式将 base.GetHashCode() 合并到您的哈希码中？
• 从技术上来说，你能偷懒并返回 0 吗？会严重违反 MSDN 指南 #3，但至少会确保 #1 和 #2 始终正确：P
• 常见陷阱和陷阱。

Answer 2

GetHashCode 实现中经常看到的那些神奇数字是什么？

它们是质数。质数用于创建哈希码，因为质数可以最大化哈希码空间的使用。

具体来说，从小素数 3 开始，只考虑结果：

• 3 * 1 = 3 = 3(mod 8) = 0011
• 3 * 2 = 6 = 6(mod 8) = 1010
• 3 * 3 = 9 = 1( mod 8) = 0001
• 3 * 4 = 12 = 4(mod 8) = 1000
• 3 * 5 = 15 = 7(mod 8) = 1111代码>
• 3 * 6 = 18 = 2(mod 8) = 0010
• 3 * 7 = 21 = 5(mod 8) = 1001
• 3 * 8 = 24 = 0( mod 8) = 0000
• 3 * 9 = 27 = 3(mod 8) = 0011

我们重新开始。但是您会注意到，在开始重复之前，素数的连续倍数在我们的半字节中生成了所有可能的位排列。我们可以使用任何素数和任意位数获得相同的效果，这使得素数最适合生成近随机哈希码。我们通常看到较大素数而不是小素数（如上例中的 3）的原因是，对于散列码中的位数较多的情况，使用小素数获得的结果甚至不是伪随机的 - 它们只是一个增加序列直到遇到溢出。为了获得最佳随机性，应使用导致相当小的系数溢出的质数，除非您可以保证系数不会很小。

相关链接：

• 为什么使用“397”用于 ReSharper GetHashCode 覆盖？

Answer 3

为什么我必须重写 object.GetHashCode()？

重写此方法很重要，因为以下属性必须始终保持 true：

如果两个对象比较相等，则每个对象的 GetHashCode 方法必须返回相同的值。

原因如 JaredPar 在 关于实现平等的博客文章，是这样吗？

许多类使用哈希码来对对象进行分类。特别是哈希表和字典倾向于根据哈希码将对象放置在存储桶中。当检查一个对象是否已经在哈希表中时，它会首先在存储桶中查找它。如果两个对象相等但哈希码不同，它们可能会被放入不同的桶中，字典将无法查找该对象。

相关链接：

• 我是否必须覆盖 GetHashCode 和在新类中相等吗？
• 我需要重写吗引用类型上的 GetHashCode()？
• 覆盖 Equals 和 GetHashCode 问题
• 为什么覆盖很重要在 C# 中重写 Equals 方法时获取HashCode？
• 在 VB 中正确实现相等

Answer 4

查看 Eric Lippert 撰写的 GetHashCode 指南和规则

Answer 5

只要您对该类型的对象有有意义的相等性度量（即您覆盖 Equals），就应该覆盖它。如果您知道该对象不会因任何原因被散列，您可以保留它，但您不太可能提前知道这一点。

哈希值应仅基于用于定义相等性的对象的属性，因为被视为相等的两个对象应具有相同的哈希码。一般来说，您通常会这样做：

public override int GetHashCode()
{
    int mc = //magic constant, usually some prime
    return mc * prop1.GetHashCode() * prop2.GetHashCode * ... * propN.GetHashCode();
}

我通常假设将值相乘会产生相当均匀的分布，假设每个属性的哈希码函数执行相同的操作，尽管这很可能是错误的。使用此方法，如果对象相等性定义属性发生变化，则哈希码也可能发生变化，鉴于问题中的定义#2，这是可以接受的。它还以统一的方式处理所有类型。

您可以为所有实例返回相同的值，尽管这将使任何使用散列的算法（例如字典）非常慢 - 本质上所有实例都将被散列到同一个存储桶，然后查找将变为 O(n) 而不是预期的 O(n) O(1)。这当然否定了使用此类结构进行查找的任何好处。

Answer 6

A) 如果您想使用值相等而不是默认的引用相等，则必须重写 Equals 和 GetHashCode。对于后者，如果两个对象引用都引用同一个对象实例，则它们比较相等。对于前者，如果它们的值相同，即使它们引用不同的对象，它们也比较相等。例如，您可能希望对 Date、Money 和 Point 对象采用值相等。

B) 为了实现值相等，您必须重写 Equals 和 GetHashCode。两者都应该取决于封装该值的对象的字段。例如，日期.年、日期.月和日期.日；或 Money.Currency 和 Money.Amount；或 X 点、Y 点和 Z 点。您还应该考虑重写运算符 ==、运算符 !=、运算符 < 和运算符 >。

C) 哈希码不必在对象的整个生命周期中保持不变。然而，当它作为哈希的键参与时，它必须保持不可变。来自 MSDN doco for Dictionary：“只要一个对象用作 Dictionary<(Of <(TKey, TValue>)>) 中的键，它就不能以任何影响其哈希值的方式进行更改。”如果必须更改键的值，请从字典中删除该条目，更改键值，然后替换该条目。

D）在我看来，如果你的价值对象本身是不可变的，你的生活就会变得简单。

Answer 7

我什么时候重写object.GetHashCode()？

正如MSDN所述：

覆盖 Equals 的类型也必须覆盖 GetHashCode ；否则，Hashtable 可能无法正常工作。

相关链接：

• 何时覆盖 GetHashCode()？

Answer 8

如何生成 GetHashCode() 和 Equals()

Visual Studio 2017
https:// learn.microsoft.com/en-us/visualstudio/ide/reference/generate-equals-gethashcode-methods?view=vs-2017

ReSharper
https://www.jetbrains.com/help/resharper/Code_Generation__Equality_Members.html

Answer 9

哈希码基于哪些字段？如果它只应该在不可变字段上，那么如果只有可变字段怎么办？

它不需要仅基于不可变字段。我将其基于确定 equals 方法结果的字段。

Answer 10

如何确保哈希码在整个对象生命周期中保持不变。 （MSDN 属性 #2）尤其是当相等性基于可变字段时。 （MSDN 属性#1）

您似乎误解了属性#2。哈希码不需要在对象的生命周期内保持不变。只要确定 equals 方法结果的值不改变，它就需要保持不变。因此从逻辑上讲，哈希码仅基于这些值。那么应该就没有问题了。

Answer 11

public override int GetHashCode()
{
    return IntProp1 ^ IntProp2 ^ StrProp3.GetHashCode() ^ StrProp4.GetHashCode ^ CustomClassProp.GetHashCode;
}

在 customClass 的 GetHasCode 方法中执行相同的操作。就像魅力一样。