给定以下类别

public class Foo
{
    public int FooId { get; set; }
    public string FooName { get; set; }

    public override bool Equals(object obj)
    {
        Foo fooItem = obj as Foo;

        if (fooItem == null) 
        {
           return false;
        }

        return fooItem.FooId == this.FooId;
    }

    public override int GetHashCode()
    {
        // Which is preferred?

        return base.GetHashCode();

        //return this.FooId.GetHashCode();
    }
}

我重写了Equals方法,因为Foo表示Foos表的一行。哪个是重写GetHashCode的首选方法?

为什么重写GetHashCode很重要?


当前回答

这是因为框架要求两个相同的对象必须具有相同的哈希代码。如果重写equals方法来对两个对象进行特殊比较,并且该方法认为这两个对象是相同的,那么两个对象的哈希代码也必须相同。(字典和哈希表依赖于这一原则)。

其他回答

在我看来,考虑到公共财产,下面使用反射似乎是一个更好的选择,因为在此情况下,您不必担心财产的添加/删除(尽管不太常见)。我发现这也表现得更好。(使用诊断学秒表比较时间)。

    public int getHashCode()
    {
        PropertyInfo[] theProperties = this.GetType().GetProperties();
        int hash = 31;
        foreach (PropertyInfo info in theProperties)
        {
            if (info != null)
            {
                var value = info.GetValue(this,null);
                if(value != null)
                unchecked
                {
                    hash = 29 * hash ^ value.GetHashCode();
                }
            }
        }
        return hash;  
    }

从.NET 4.7开始,重写GetHashCode()的首选方法如下所示。如果目标是较旧的.NET版本,请包含System.ValueTuple nuget包。

// C# 7.0+
public override int GetHashCode() => (FooId, FooName).GetHashCode();

在性能方面,该方法将优于大多数复合哈希代码实现。ValueTuple是一个结构,因此不会有任何垃圾,而底层算法的速度也很快。

哈希代码用于基于哈希的集合,如Dictionary、Hashtable、HashSet等。该代码的目的是通过将特定对象放入特定组(bucket)来快速地对其进行预排序。当您需要从哈希集合中检索该对象时,这种预排序非常有助于找到该对象,因为代码必须在一个桶中而不是在它包含的所有对象中搜索该对象。哈希码的分布越好(唯一性越好),检索速度越快。在理想情况下,每个对象都有一个唯一的哈希码,找到它是一个O(1)操作。在大多数情况下,它接近O(1)。

您应该始终保证,如果两个对象相等(由Equals()定义),它们应该返回相同的哈希代码。正如其他一些评论所说,理论上,如果对象永远不会在HashSet或Dictionary等基于哈希的容器中使用,则这不是强制性的。但我建议你始终遵守这条规则。原因很简单,因为人们很容易将集合从一种类型更改为另一种类型,以便实际提高性能或以更好的方式传递代码语义。

例如,假设我们在列表中保留一些对象。一段时间后,有人意识到HashSet是一个更好的选择,因为它具有更好的搜索特性。这是我们可能陷入麻烦的时候。List将在内部为类型使用默认的相等比较器,在您的情况下,这意味着Equals,而HashSet使用GetHashCode()。如果两者的行为不同,那么您的程序也会不同。请记住,这些问题不是最容易解决的。

我在一篇博客文章中总结了这种行为和其他GetHashCode()陷阱,在这里可以找到更多的示例和解释。

从C#9(.net5或.netcore3.1)开始,您可能希望使用记录,因为默认情况下它使用基于值的相等。