字典的单声道实现 <T,T> 使用.Equals（obj o）而不是.GetHashCode（）

Question

通过搜索msdn c＃文档和堆栈溢出，我得到明显的印象， Dictionary<T,T>应该使用GetHashCode()来检查键唯一性并进行查找。

Dictionary泛型类提供了从一组键到一组值的映射。 字典的每个加法项都包含一个值及其关联的键。 通过使用键的值检索值非常快，接近O（1），因为Dictionary类是作为哈希表实现的。 ...检索速度取决于为TKey指定的类型的哈希算法的质量。

我使用单声道（在Unity3D中），在获得一些奇怪的结果之后，我进行了以下实验：

public class DictionaryTest
{
    public static void TestKeyUniqueness()
    {
    //Test a dictionary of type1
    Dictionary<KeyType1, string> dictionaryType1 = new Dictionary<KeyType1, string>();
    dictionaryType1[new KeyType1(1)] = "Val1";
    if(dictionaryType1.ContainsKey(new KeyType1(1)))
    {
        Debug.Log ("Key in dicType1 was already present"); //This line does NOT print
    }

    //Test a dictionary of type1
    Dictionary<KeyType2, string> dictionaryType2 = new Dictionary<KeyType2, string>();
    dictionaryType2[new KeyType2(1)] = "Val1";
    if(dictionaryType2.ContainsKey(new KeyType2(1)))
    {
        Debug.Log ("Key in dicType2 was already present"); // Only this line prints
    }
  }
}

//This type implements only GetHashCode()
public class KeyType1
{
    private int var1;

    public KeyType1(int v1)
    {
        var1 = v1;
    }

    public override int GetHashCode ()
    {
        return var1;
    }
}

//This type implements both GetHashCode() and Equals(obj), where  Equals uses the hashcode.
public class KeyType2
{
    private int var1;

    public KeyType2(int v1)
    {
        var1 = v1;
    }

    public override int GetHashCode ()
    {
        return var1;
    }

    public override bool Equals (object obj)
    {
        return GetHashCode() == obj.GetHashCode();
    }
}

仅在使用类型KeyType2时将键视为相等。 对我来说，这表明Dictionary使用Equals（obj）-而不是GetHashCode（）。

有人可以复制此内容，并帮助我解释其含义吗？ 单声道实现不正确吗？ 还是我误会了一些东西。

Answer 1

我得到明确的印象，即Dictionary应该使用.GetHashCode（）来检查键唯一性

是什么让你觉得呢？ GetHashCode不返回唯一值。

MSDN明确指出：

字典需要一个相等的实现来确定键是否相等。 您可以通过使用接受比较器参数的构造函数来指定IEqualityComparer通用接口的实现。 如果未指定实现，则使用默认的泛型相等比较器EqualityComparer.Default。 如果类型TKey实现System.IEquatable通用接口，则默认的相等比较器将使用该实现。

Answer 2

这样做：

public override bool Equals (object obj)
{
    return GetHashCode() == obj.GetHashCode();
}

在一般情况下是错误的，因为您可能最终得到的KeyType2实例等于 StringBuilder ， SomeOtherClass ， AnythingYouCanImagine而不是实例。

您应该完全这样做：

public override bool Equals (object obj)
{
    if (obj is KeyType2) {
        return (obj as KeyType2).var1 == this.var1;
    } else
        return false;
}

当您尝试覆盖Equals以及固有的GetHashCode ，必须确保按以下顺序 （考虑到类MyObject）确保以下几点（反之亦然）：

1）什么时候MyObject 2个实例相等？ 说您有：

public class MyObject {
     public string Name { get; set; }
     public string Address { get; set; }
     public int Age { get; set; }

     public DateTime TimeWhenIBroughtThisInstanceFromTheDatabase { get; set; }
}

并且在某些数据库中有1条记录需要将其映射到此类的实例。 并且您约定从数据库读取记录的时间将存储在TimeWhenIBroughtThisInstanceFromTheDatabase ：

MyObject obj1 = DbHelper.ReadFromDatabase( ...some params...);
// you do that at 14:05 and thusly the TimeWhenIBroughtThisInstanceFromTheDatabase
// will be assigned accordingly

// later.. at 14:07 you read the same record into a different instance of MyClass
MyObject obj2 = DbHelper.ReadFromDatabase( ...some params...);
// (the same)

// At 14:09 you ask yourself if the 2 instances are the same
bool theyAre  = obj1.Equals(obj2)

您是否希望结果为真 ？ 我会说你愿意。 因此，等于的优先级应为：

public class MyObject {
    ...
    public override bool Equals(object obj) {
        if (obj is MyObject) {
            var that = obj as MyObject;
            return (this.Name == that.Name) && 
                   (this.Address == that.Address) &&
                   (this.Age == that.Age);
                   // without the syntactically possible but logically challenged:
                   // && (this.TimeWhenIBroughtThisInstanceFromTheDatabase == 
                   //     that.TimeWhenIBroughtThisInstanceFromTheDatabase)
        } else 
            return false;
    }
    ...
}

2） 确保每两个实例相等（如您实现的Equals方法所指示），其GetHashCode结果将相同。

int hash1 = obj1.GetHashCode();
int hash2 = obj2.GetHashCode();
bool theseMustBeAlso = hash1 == hash2;

最简单的方法是（在示例方案中）：

   public class MyObject {
    ...
    public override int GetHashCode() {
       int result;
       result = ((this.Name != null) ? this.Name.GetHashCode() : 0) ^
                ((this.Address != null) ? this.Address.GetHashCode() : 0) ^
                this.Age.GetHashCode();
       // without the syntactically possible but logically challenged:
       // ^ this.TimeWhenIBroughtThisInstanceFromTheDatabase.GetHashCode()
    }
    ...
} 

请注意 ：-字符串可以为null，并且.GetHashCode()可能会由于NullReferenceException失败。 -我使用^（XOR）。 您可以使用任何您想要的东西，只要遵守黄金法则（数字2）即可。 -x ^ 0 == x（对于x而言）