C# 如何实现一个基于值相等性比较的字典

实现一个基于值相等性比较的字典需要满足两个条件：

1. 能够将自定义类型作为字典中的键；
2. 能够通过自定义类型的值相等性判断两个键是否相等。

下面将介绍如何使用 C# 实现这两个条件：

第一步：让自定义类型实现 IEquatable 接口

我们需要通过重写 Equals 方法来实现这一点。示例如下：

public class MyClass : IEquatable<MyClass>
{
    public int Age { get; set; }
    public string Name { get; set; }

    public bool Equals(MyClass other)
    {
        if (ReferenceEquals(null, other)) return false;
        if (ReferenceEquals(this, other)) return true;
        return Age == other.Age && Name == other.Name;
    }

    public override bool Equals(object obj)
    {
        if (ReferenceEquals(null, obj)) return false;
        if (ReferenceEquals(this, obj)) return true;
        if (obj.GetType() != this.GetType()) return false;
        return Equals((MyClass) obj);
    }

    public override int GetHashCode()
    {
        unchecked
        {
            return (Age * 397) ^ (Name != null ? Name.GetHashCode() : 0);
        }
    }
}

这里我们让 MyClass 类实现了 IEquatable 接口，并重写了 Equals、Equals(object) 和 GetHashCode 方法。其中 GetHashCode 方法是用来返回当前对象的哈希值，以支持字典的快速查找和定位。

第二步：创建基于值相等性比较的字典

我们可以使用 C# 中的 Dictionary 类型来创建字典。但是默认情况下，Dictionary 是基于引用相等性比较的，所以它不能直接用于自定义类型。

为了实现基于值相等性比较的字典，我们需要使用 EqualityComparer 泛型类。具体实现代码如下：

var dict = new Dictionary<MyClass, string>(EqualityComparer<MyClass>.Default);

var mc1 = new MyClass {Age = 18, Name = "Tom"};
var mc2 = new MyClass {Age = 18, Name = "Tom"};

dict.Add(mc1, "value1");

// 往字典中添加一个与 mc1 值相等的 MyClass 实例 mc2
// 应该能够成功并且返回 "value1" 的结果
if (dict.TryGetValue(mc2, out string value))
{
    Console.WriteLine(value);
}

通过使用 EqualityComparer.Default，我们可以创建一个基于值相等性比较的字典。

在示例中，我们创建了两个 MyClass 实例，它们的年龄和姓名都相等。然后将第一个实例作为一个键添加到字典中，并尝试以第二个实例作为键去检索值。由于实现了 Equals 方法，Equals 方法在尝试比较两个 MyClass 实例的值时将它们视为等同的，因此 TryGetValue 方法应该返回字典中的值 "value1"。

第三步：结合泛型实现通用的基于值相等性比较的字典

我们可以使用泛型来实现一个通用的基于值相等性比较的字典。示例代码如下：

using System.Collections.Generic;

public class ValueDictionary<TKey, TValue> : Dictionary<TKey, TValue>
    where TKey : IEquatable<TKey>
{
    public ValueDictionary() : base(new ValueEqualityComparer<TKey>())
    {}

    public class ValueEqualityComparer<T> : EqualityComparer<T>
        where T : IEquatable<T>
    {
        public override bool Equals(T x, T y)
        {
            if (ReferenceEquals(x, y)) return true;
            if (ReferenceEquals(x, null) || ReferenceEquals(y, null)) return false;
            return x.Equals(y);
        }

        public override int GetHashCode(T obj)
        {
            return obj.GetHashCode();
        }
    }
}

在示例中，我们定义了一个名为 ValueDictionary 的泛型字典类，并在其实现中使用了一个 ValueEqualityComparer 泛型嵌套类。该嵌套类实现了抽象类 EqualityComparer，并通过泛型约束 List 的元素类型 T 来支持我们自定义的类型。

由于我们的类已实现 IEquatable 接口，所以 Equals 方法已被定义到了类中。我们使用 GetHashCode 方法来实现哈希表中元素的索引，以加速查找操作。

当我们新建一个 ValueDictionary 实例时，它会基于指定的 VlaueEqualityComparer 实例来实现基于值相等性比较的字典。

使用 ValueDictionary 可以将自定义类型作为字典中的键，以及通过自定义类型的值相等性判断两个键是否相等。

下面是一个使用 ValueDictionary 的示例：

var dict = new ValueDictionary<MyClass, string>();

var mc1 = new MyClass { Age = 18, Name = "Tom" };
var mc2 = new MyClass { Age = 18, Name = "Tom" };

dict.Add(mc1, "value1");

// 往字典中添加一个与 mc1 值相等的 MyClass 实例 mc2
// 应该能够成功并且返回 "value1" 的结果
if (dict.TryGetValue(mc2, out string value))
{
    Console.WriteLine(value);
}

通过使用 ValueDictionary，我们可以创建一个完整的基于值相等性比较的字典，并且使用时可以像使用 C# 中的 Dictionary 类型一样方便。