.NET Dictionary / IDictionary 的 Equals() 合约与 Java Map 的 equals() 合约

Question

怀念 Collections.unmodifyingMap()，我一直在实现一个基于 这个讨论，我的单元测试很快遇到了一个问题：

Assert.AreEqual (backingDictionary, readOnlyDictionary);

失败，即使键值对成对匹配。我又玩了一下，看起来至少（感谢西蒙尼）

Assert.AreEquals (backingDictionary, new Dictionary<..> { /* same contents */ });

确实通过了。

我快速浏览了 Dictionary 和 IDictionary 文档，令我惊讶的是，我找不到任何与 Java Map 约定两个具有相同 entrySet()s 的 Map必须相等。 （文档说 Dictionary -- not IDictionary -- 覆盖 Equals()，但没有说覆盖的作用。）

所以看起来 C# 中的键值相等是 Dictionary 具体类的属性，而不是 IDictionary 接口的属性。这是对的吗？整个 System.Collections 框架通常都是如此吗？

如果是这样，我有兴趣阅读一些关于 MS 为什么选择这种方法的讨论，以及检查 C# 中集合内容是否相等的首选方法。

最后，我不介意指向经过充分测试的 ReadOnlyDictionary 实现的指针。 :)

---

预计到达时间：需要明确的是，我不是寻找有关如何测试我的实现的建议——这相对来说是微不足道的。我正在寻找有关这些测试应执行哪些合同的指导。以及原因。

---

预计到达：各位，我知道 IDictionary 是一个接口，而且我知道接口无法实现方法。在Java中也是一样的。尽管如此，Java Map 接口记录了 来自 equals() 方法的某些行为。当然，一定有 .NET 接口可以执行此类操作，即使集合接口不在其中。

Answer 1

重写 equals 通常只适用于具有一定程度值语义的类（例如 string）。引用相等性是人们更常关心的大多数引用类型和良好的默认值，特别是在不太清楚的情况下（两个字典具有完全相同的键值对但不同的相等比较器[因此添加相同的额外键值对可能使它们现在不同]相等或不相等？）或者不会经常寻找值相等的地方。

毕竟，您正在寻找两种不同类型被视为相等的情况。平等覆盖可能仍然会让你失败。

更重要的是，您总是可以足够快地创建自己的相等比较器：

public class SimpleDictEqualityComparer<TKey, TValue> : IEqualityComparer<IDictionary<TKey, TValue>>
{
    // We can do a better job if we use a more precise type than IDictionary and use
    // the comparer of the dictionary too.
    public bool Equals(IDictionary<TKey, TValue> x, IDictionary<TKey, TValue> y)
    {
        if(ReferenceEquals(x, y))
            return true;
        if(ReferenceEquals(x, null) || ReferenceEquals(y, null))
            return false;
        if(x.Count != y.Count)
            return false;
        TValue testVal = default(TValue);
        foreach(TKey key in x.Keys)
            if(!y.TryGetValue(key, out testVal) || !Equals(testVal, x[key]))
                return false;
        return true;
    }
    public int GetHashCode(IDictionary<TKey, TValue> dict)
    {
        unchecked
        {
            int hash = 0x15051505;
            foreach(TKey key in dict.Keys)
            {
                var value = dict[key];
                var valueHash = value == null ? 0 : value.GetHashCode();
                hash ^= ((key.GetHashCode() << 16 | key.GetHashCode() >> 16) ^ valueHash);
            }
            return hash;
        }
    }
}

这并不能满足人们想要比较字典的所有可能情况，但这就是我的观点。

用“可能是他们的意思”的平等方法来填充 BCL 会很麻烦，而不是有帮助。

Answer 2

我建议使用 NUnit 中的 CollectionAssert.AreEquivalent() 。 Assert.AreEqual() 实际上不适用于集合。 http://www.nunit.org/index.php?p=collectionAssert& ;r=2.4

Answer 3

对于后来的读者，这是我被告知/能够弄清楚的：

1. .NET 集合的契约，
   与 Java 集合不同，它不
   包括任何特定行为
   Equals() 或 GetHashCode()。
2. LINQ Enumerable.SequenceEqual()
   扩展方法适用于
   订购的集合，包括
   字典——呈现为
   IEnumerable;
   KeyValuePair 是一个结构体，它的
   Equals 方法使用反射
   来比较内容。
3. Enumerable 提供其他扩展
   可以用来鹅卵石的方法
   一起进行内容平等检查，例如
   如Union() 和Intersect()。

我的想法是，尽管 Java 方法很方便，但如果我们谈论可变集合以及典型的隐式 equals() 语义，它们可能不是最好的主意 - - 两个相等对象是可以互换的。 .NET 没有为不可变集合提供很好的支持，但开源 PowerCollections 库可以提供。

Answer 4

public sealed class DictionaryComparer<TKey, TValue>
    : EqualityComparer<IDictionary<TKey, TValue>>
{
    public override bool Equals(
        IDictionary<TKey, TValue> x, IDictionary<TKey, TValue> y)
    {
        if (object.ReferenceEquals(x, y)) return true;
        if ((x == null) || (y == null)) return false;
        if (x.Count != y.Count) return false;

        foreach (KeyValuePair<TKey, TValue> kvp in x)
        {
            TValue yValue;
            if (!y.TryGetValue(kvp.Key, out yValue)) return false;
            if (!kvp.Value.Equals(yValue)) return false;
        }
        return true;
    }

    public override int GetHashCode(IDictionary<TKey, TValue> obj)
    {
        unchecked
        {
            int hash = 1299763;
            foreach (KeyValuePair<TKey, TValue> kvp in obj)
            {
                int keyHash = kvp.Key.GetHashCode();
                if (keyHash == 0) keyHash = 937;

                int valueHash = kvp.Value.GetHashCode();
                if (valueHash == 0) valueHash = 318907;

                hash += (keyHash * valueHash);
            }
            return hash;
        }
    }
}

Answer 5

所以看起来键值相等
C# 是字典的一个属性
具体类，而不是 IDictionary 的类
界面。这是对的吗？是吗
一般而言，整体正确
System.Collections 框架？

如果是这样，我有兴趣阅读一些
讨论 MS 为什么选择它
方法

它非常简单 - IDictionary 是一个接口，接口不能有任何实现，在 .NET 世界中，两个对象的相等性是通过 Equals 方法定义的。因此，不可能重写 IDictionary 接口的 Equals 来使其拥有“键值相等”。

Answer 6

你在原来的帖子中犯了一个很大的错误。您谈到了 IDictionary 接口中的 Equals() 方法。这就是重点！

Equals() 是类可以重写的 System.Object 的虚拟方法。接口根本不实现方法。相反，接口的实例是引用类型，因此继承自 System.Object 并可能声明对 Equals() 的重写。

现在的重点是... System.Collections.Generic.Dictionary 确实不覆盖 Equals。您说您以自己的方式实现了 IDictionary，并合理地覆盖了 Equals，但是看看您自己的代码。

Assert.AreEqual (backingDictionary, readOnlyDictionary); 

此方法基本上实现为 return backingDictionary.Equals(readOnlyDictionary) ，这也是重点。

如果两个对象是不同类的实例，基本 Equals() 方法将返回 false，这是您无法控制的。否则，如果两个对象属于相同类型，则使用 Equals() 方法而不是 == 通过反射（仅是成员，而不是属性）比较每个成员（这就是手册所说的“值比较”而不是“引用比较”）

因此，首先，如果 Assert.AreEqual (readOnlyDictionary,backingDictionary); 成功，我不会感到惊讶，因为它会触发用户定义的等于方法。

我毫不怀疑该线程中其他用户的方法是有效的，但我只是想向您解释一下您原来的方法中的错误是什么。当然，微软最好实现一个 Equals 方法，将当前实例与任何其他 IDictionary 实例进行比较，但是，这又超出了 Dictionary 类的范围，该类是一个公共独立类，并不意味着IDictionary 的唯一公开实现。例如，当您定义一个接口、一个工厂和一个在库中实现它的受保护类时，您可能希望将该类与基接口的其他实例进行比较，而不是与非公共类本身进行比较。

我希望对您有所帮助。
干杯。