浅谈 GetHashCode

我们知道，System.Object 类是 .NET Framework 中所有类的最终基类，它是类型层次结构的根，并为派生类提供低级别服务。通常不要求类声明从 Object 的继承，因为继承是隐式的。因为 .NET Framework 中的所有类均从 Object 派生，所以 Object 类中定义的每个方法可用于系统中的所有对象。派生类可以而且确实重写这些方法中的某些，其中包括：

• Equals — 支持对象间的比较。

• Finalize — 在自动回收对象之前执行清理操作。

• GetHashCode — 生成一个与对象的值相对应的数字以支持哈希表的使用。

• ToString — 生成描述类的实例的可读文本字符串。

现在，我们就来谈谈这个 GetHashCode 方法：

public virtual int GetHashCode()

GetHashCode 方法适用于哈希算法和诸如哈希表之类的数据结构。

GetHashCode 方法的默认实现不保证针对不同的对象返回唯一值。而且，.NET Framework 不保证 GetHashCode 方法的默认实现以及它所返回的值在不同版本的 .NET Framework 中是相同的。因此，在进行哈希运算时，该方法的默认实现不得用作唯一对象标识符。

GetHashCode 方法可以由派生类型重写。值类型必须重写此方法，以提供适合该类型的哈希函数和在哈希表中提供有用的分布。为了获得最佳结果，哈希代码必须基于实例字段或属性（而非静态字段或属性）的值。

哈希函数用于快速生成一个与对象的值相对应的数字（哈希代码）。哈希函数通常是特定于每个 Type 的，而且，必须至少使用一个实例字段作为输入。

哈希函数必须具有以下特点：

• 如果两个对象的比较结果相等，则每个对象的 GetHashCode 方法都必须返回同一个值。但是，如果两个对象的比较结果不相等，则这两个对象的 GetHashCode 方法不一定返回不同的值。

• 一个对象的 GetHashCode 方法必须总是返回同一个哈希代码，但前提是没有修改过对象状态，对象状态用来确定对象的 Equals 方法的返回值。请注意，这仅适用于应用程序的当前执行，再次运行该应用程序时可能会返回另一个哈希代码。

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

例如，String 类提供的 GetHashCode 方法的实现为相同的字符串值返回相同的哈希代码。因此，如果两个 String 对象表示相同的字符串值，则它们返回相同的哈希代码。另外，该方法使用字符串中的所有字符生成相当随机的分布式输出，即使当输入集中在某些范围内时（例如，许多用户可能有只包含低位 128 个 ASCII 字符的字符串，即使字符串可以包含 65,535 个 Unicode 字符中的任何字符）。

对于 Object 的派生类，当且仅当此派生类将值相等性定义为引用相等并且类型不是值类型时，GetHashCode 方法才可以委托给 Object.GetHashCode 实现。

在类上提供好的哈希函数可以显著影响将这些对象添加到哈希表的性能。在具有好的哈希函数实现的哈希表中，搜索元素所用的时间是固定的（例如运算复杂度为 O(1) 的运算）。而在具有不好的哈希函数实现的哈希表中，搜索性能取决于哈希表中的项数（例如运算复杂度为 O(n) 的运算，其中的 n 是哈希表中的项数）。哈希函数的计算成本也必须不高。

GetHashCode 方法的实现必须不会导致循环引用。例如，如果 ClassA.GetHashCode 调用 ClassB.GetHashCode，ClassB.GetHashCode 必须不直接或间接调用 ClassA.GetHashCode。

GetHashCode 方法的实现必须不引发异常。

重写 GetHashCode 的派生类还必须重写 Equals，以保证被视为相等的两个对象具有相同的哈希代码。

 

好了，引用了 MSDN 技术资源库中的一大段内容后，让我们来看看具体的例子吧。

首先，让我们用 .NET Reflector 来看看 .NET Framework 4.0 中 System.Object.GetHashCode 的实现吧。

[TargetedPatchingOptOut("Performance critical to inline across NGen image boundaries")]
public virtual int GetHashCode()
{
  return System.Runtime.CompilerServices.RuntimeHelpers.GetHashCode(this);
}

而 RuntimeHelpers.GetHashCode 是一个外部的静态方法，如下所示：

namespace System.Runtime.CompilerServices
{
  public static class RuntimeHelpers
  {
    [MethodImpl(MethodImplOptions.InternalCall), SecuritySafeCritical]
    public static extern int GetHashCode(object o);
  }
}

这样线索就断了。如果那位朋友知道 RuntimeHelpers.GetHashCode 方法的具体实现是什么的话，麻烦在评论中指出，谢谢。

 

我们现在来看看 .NET Framework 4.0 中 System.String.GetHashCode 的实现吧。

[ReliabilityContract(Consistency.WillNotCorruptState, Cer.MayFail), SecuritySafeCritical]
public override unsafe int GetHashCode()
{
  fixed (char* str = ((char*)this))
  {
    char* chPtr = str;
    int num = 0x15051505;
    int num2 = num;
    int* numPtr = (int*)chPtr;
    for (int i = this.Length; i > 0; i -= 4)
    {
      num = (((num << 5) + num) + (num >> 0x1b)) ^ numPtr[0];
      if (i <= 2) break;
      num2 = (((num2 << 5) + num2) + (num2 >> 0x1b)) ^ numPtr[1];
      numPtr += 2;
    }
    return (num + (num2 * 0x5d588b65));
  }
}

可以看出，这里使用了 unsafe 的指针，我想是为了“哈希函数的计算成本也必须不高”，因为使用指针会更快一点。

 

再来看看 .NET Framework 3.5 中 System.Numeric.BigInteger.GetHashCode 的实现吧。

[Serializable, StructLayout(LayoutKind.Sequential), Immutable, ComVisible(false)]
internal struct BigInteger : IFormattable, IEquatable<BigInteger>, IComparable<BigInteger>, IComparable
{
  private readonly short _sign;
  private readonly uint[] _data;

  public override int GetHashCode()
  {
    if (this._sign == 0) return 0;
    return (int)this._data[0];
  }
}

严格来说，这个 GetHashCode 方法其实是不合格的，违反了“为了获得最佳性能，哈希函数必须为所有输入生成随机分布”这一原则，因为它只取 BigInteger 的 _data 数组中的第一个元素，忽略了数组中的其他元素。我猜想，这是因为在 .NET Framework 3.5 中，BigInteger 是 internal 的，别人不可能使用，而 Microsoft 的 Base Class Libraray 团队自己也没有使用 BigInteger.GetHashCode 方法，所以就随便实现一个啦。

 

现在来看看 .NET Framework 4.0 中 System.Numerics.BigInteger.GetHashCode 的实现吧。

[Serializable, StructLayout(LayoutKind.Sequential)]
public struct BigInteger : IFormattable, IComparable, IComparable<BigInteger>, IEquatable<BigInteger>
{
  internal int _sign;
  internal uint[] _bits;

  public override int GetHashCode()
  {
    if (this._bits == null) return this._sign;
    int num = this._sign;
    int index = Length(this._bits);
    while (--index >= 0) num = NumericsHelpers.CombineHash(num, (int)this._bits[index]);
    return num;
  }

  internal static int Length(uint[] rgu)
  {
    int length = rgu.Length;
    return (rgu[length - 1] != 0) ? length : (length - 1);
  }
}

internal static class NumericsHelpers
{
  public static int CombineHash(int n1, int n2)
  {
    return (int)CombineHash((uint)n1, (uint)n2);
  }

  public static uint CombineHash(uint u1, uint u2)
  {
    return (((u1 << 7) | (u1 >> 0x19)) ^ u2);
  }
}

在 .NET Framework 4.0 中，BigInteger 变成了 public 的，所以不能随便实现一个 GetHashCode 方法了。

 

我于 2008-07-13 发表过一篇随笔“浅谈 BigInteger”，其中的 Skyiv.Numeric.BigInteger.GetHashCode 方法如下所示：

sealed class BigInteger : IEquatable<BigInteger>, IComparable<BigInteger>
{
  sbyte sign;  // 符号，取值：-1, 0, 1。
  byte[] data; // 字节数组以 100 为基，字节数组中第一个元素存储的数字是最高有效位。

  public override int GetHashCode()
  {
    int hash = sign;
    foreach (int n in data) hash ^= n;
    return hash;
  }
}

这个 GetHashCode 方法也不太合格。原因是……，你们自己猜吧。我现在要实现一个新的 GetHashCode 方法，如下所示：

public override int GetHashCode()
{
  int n = sign;
  for (int i = data.Length - 1; i >= 0; i -= 4)
  {
    int m = data[i];
    if (i > 0) m |= (data[i - 1] << 8);
    if (i > 1) m |= (data[i - 2] << 16);
    if (i > 2) m |= (data[i - 3] << 24);
    n = m ^ (n + (n << 5) + (n >> 0x1b));
  }
  return n * 0x5d588b65;
}

各位朋友认为这个新的 GetHashCode 方法是否合格呢？

 

参考资料

1. .NET Framework Class Library: Object.GetHashCode Method
2. .NET Framework Class Library: BigInteger Structure
3. Understanding GetHashCode, 理解GetHashCode