Warum ist es wichtig, GetHashCode zu überschreiben, wenn die Equals-Methode überschrieben wird?

Gegeben die folgende Klasse

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();
    }
}

Ich habe die EqualsMethode überschrieben , weil Foosie eine Zeile für die FooTabelle s darstellt. Welches ist die bevorzugte Methode zum Überschreiben der GetHashCode?

Warum ist es wichtig zu überschreiben GetHashCode?

Ja, es ist wichtig, ob Ihr Artikel als Schlüssel in einem Wörterbuch oder HashSet<T>usw. verwendet wird, da dies (ohne benutzerdefinierte Funktion IEqualityComparer<T>) zum Gruppieren von Artikeln in Buckets verwendet wird. Wenn der Hash-Code für zwei Elemente nicht übereinstimmt, kann sie nie als gleich betrachtet werden ( Equals wird einfach nie genannt werden).

Die GetHashCode () -Methode sollte die EqualsLogik widerspiegeln . Die Regeln sind:

• Wenn zwei Dinge gleich sind ( Equals(...) == true), müssen sie den gleichen Wert für zurückgebenGetHashCode()
• wenn das GetHashCode()gleich ist, ist es nicht notwendig, dass sie gleich sind; Dies ist eine Kollision und Equalswird aufgerufen, um zu sehen, ob es sich um eine echte Gleichheit handelt oder nicht.

In diesem Fall scheint " return FooId;" eine geeignete GetHashCode()Implementierung zu sein. Wenn Sie mehrere Eigenschaften testen, ist es üblich, diese mit dem folgenden Code zu kombinieren, um diagonale Kollisionen zu reduzieren (dh new Foo(3,5)einen anderen Hash-Code als new Foo(5,3)):

unchecked // only needed if you're compiling with arithmetic checks enabled
{ // (the default compiler behaviour is *disabled*, so most folks won't need this)
    int hash = 13;
    hash = (hash * 7) + field1.GetHashCode();
    hash = (hash * 7) + field2.GetHashCode();
    ...
    return hash;
}

Oh - der Einfachheit halber können Sie auch prüfen , Bereitstellung ==und !=Betreiber beim Überschreiben Equalsund GetHashCode.

Eine Demonstration dessen, was passiert, wenn Sie dies falsch verstehen, finden Sie hier .

Die GetHashCode()korrekte Implementierung ist tatsächlich sehr schwierig, da sich der Hash-Code zusätzlich zu den bereits erwähnten Regeln von Marc während der Lebensdauer eines Objekts nicht ändern sollte. Daher müssen die Felder, die zur Berechnung des Hash-Codes verwendet werden, unveränderlich sein.

Als ich mit NHibernate arbeitete, fand ich endlich eine Lösung für dieses Problem. Mein Ansatz besteht darin, den Hash-Code aus der ID des Objekts zu berechnen. Die ID kann nur über den Konstruktor festgelegt werden. Wenn Sie also die ID ändern möchten, was sehr unwahrscheinlich ist, müssen Sie ein neues Objekt erstellen, das eine neue ID und daher einen neuen Hashcode hat. Dieser Ansatz funktioniert am besten mit GUIDs, da Sie einen parameterlosen Konstruktor bereitstellen können, der zufällig eine ID generiert.

Wenn Sie Equals überschreiben, geben Sie im Grunde an, dass Sie derjenige sind, der besser weiß, wie zwei Instanzen eines bestimmten Typs zu vergleichen sind. Sie sind also wahrscheinlich der beste Kandidat, um den besten Hash-Code bereitzustellen.

Dies ist ein Beispiel dafür, wie ReSharper eine GetHashCode () - Funktion für Sie schreibt:

public override int GetHashCode()
{
    unchecked
    {
        var result = 0;
        result = (result * 397) ^ m_someVar1;
        result = (result * 397) ^ m_someVar2;
        result = (result * 397) ^ m_someVar3;
        result = (result * 397) ^ m_someVar4;
        return result;
    }
}

Wie Sie sehen, wird nur versucht, einen guten Hash-Code basierend auf allen Feldern in der Klasse zu erraten. Da Sie jedoch die Domäne oder die Wertebereiche Ihres Objekts kennen, können Sie immer noch einen besseren bereitstellen.

Bitte vergessen Sie nicht, den Parameter obj nullbeim Überschreiben zu überprüfen Equals(). Und vergleichen Sie auch den Typ.

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

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

    return fooItem.FooId == this.FooId;
}

Der Grund dafür ist: Equalsmuss beim Vergleich mit false zurückgeben null. Siehe auch http://msdn.microsoft.com/en-us/library/bsc2ak47.aspx

Wie wäre es mit:

public override int GetHashCode()
{
    return string.Format("{0}_{1}_{2}", prop1, prop2, prop3).GetHashCode();
}

Vorausgesetzt, Leistung ist kein Problem :)

Wir haben zwei Probleme zu bewältigen.

1. Sie können keinen Sinn angeben, GetHashCode()wenn ein Feld im Objekt geändert werden kann. Außerdem wird ein Objekt NIEMALS in einer Sammlung verwendet, die davon abhängt GetHashCode(). Die Implementierungskosten GetHashCode()lohnen sich also oft nicht oder sind nicht möglich.

2. Wenn jemand Ihr Objekt in eine Sammlung legt, die aufruft, GetHashCode()und Sie es überschrieben haben, Equals()ohne sich auch GetHashCode()korrekt zu verhalten, kann diese Person Tage damit verbringen, das Problem aufzuspüren.

Deshalb mache ich das standardmäßig.

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()
    {
        // Some comment to explain if there is a real problem with providing GetHashCode() 
        // or if I just don't see a need for it for the given class
        throw new Exception("Sorry I don't know what GetHashCode should do for this class");
    }
}

Dies liegt daran, dass das Framework erfordert, dass zwei Objekte, die identisch sind, denselben Hashcode haben müssen. Wenn Sie die Methode equals überschreiben, um einen speziellen Vergleich zweier Objekte durchzuführen, und die beiden Objekte von der Methode als gleich angesehen werden, muss auch der Hash-Code der beiden Objekte identisch sein. (Wörterbücher und Hashtabellen basieren auf diesem Prinzip).

Nur um die obigen Antworten hinzuzufügen:

Wenn Sie Equals nicht überschreiben, werden standardmäßig Referenzen der Objekte verglichen. Gleiches gilt für Hashcode - die Standardimplementierung basiert normalerweise auf einer Speicheradresse der Referenz. Da Sie Equals überschrieben haben, bedeutet dies, dass das richtige Verhalten darin besteht, alles zu vergleichen, was Sie auf Equals implementiert haben, und nicht die Referenzen. Daher sollten Sie dasselbe für den Hashcode tun.

Clients Ihrer Klasse erwarten, dass der Hashcode eine ähnliche Logik wie die equals-Methode aufweist. Beispielsweise vergleichen linq-Methoden, die einen IEqualityComparer verwenden, zuerst die Hashcodes und nur dann, wenn sie gleich sind, vergleichen sie die Equals () -Methode, die möglicherweise teurer ist Wenn wir keinen Hashcode implementiert haben, hat das gleiche Objekt wahrscheinlich unterschiedliche Hashcodes (weil sie unterschiedliche Speicheradressen haben) und wird fälschlicherweise als ungleich bestimmt (Equals () trifft nicht einmal).

Abgesehen von dem Problem, dass Sie Ihr Objekt möglicherweise nicht finden können, wenn Sie es in einem Wörterbuch verwendet haben (weil es von einem Hashcode eingefügt wurde und wenn Sie danach suchen, wird der Standard-Hashcode wahrscheinlich anders sein und wieder Equals () wird nicht einmal aufgerufen, wie Marc Gravell in seiner Antwort erklärt, Sie führen auch eine Verletzung des Wörterbuch- oder Hashset-Konzepts ein, die keine identischen Schlüssel zulassen sollte - Sie haben bereits erklärt, dass diese Objekte im Wesentlichen gleich sind, wenn Sie Equals überschreiben, also ziehen Sie an Sie möchten nicht, dass beide Schlüssel in einer Datenstruktur unterschiedliche Schlüssel haben, die einen eindeutigen Schlüssel haben. Da sie jedoch einen anderen Hashcode haben, wird der "gleiche" Schlüssel als unterschiedlicher Schlüssel eingefügt.

Hash-Code wird für Hash-basierte Sammlungen wie Dictionary, Hashtable, HashSet usw. verwendet. Der Zweck dieses Codes besteht darin, ein bestimmtes Objekt sehr schnell vorab zu sortieren, indem es in eine bestimmte Gruppe (Bucket) eingeordnet wird. Diese Vorsortierung hilft enorm beim Auffinden dieses Objekts, wenn Sie es aus der Hash-Sammlung zurückholen müssen, da der Code Ihr Objekt in nur einem Bucket anstatt in allen darin enthaltenen Objekten suchen muss. Je besser die Verteilung der Hash-Codes (bessere Eindeutigkeit) ist, desto schneller wird sie abgerufen. In einer idealen Situation, in der jedes Objekt einen eindeutigen Hashcode hat, handelt es sich um eine O (1) -Operation. In den meisten Fällen nähert es sich O (1).

Es ist nicht unbedingt wichtig; Dies hängt von der Größe Ihrer Sammlungen und Ihren Leistungsanforderungen ab und davon, ob Ihre Klasse in einer Bibliothek verwendet wird, in der Sie die Leistungsanforderungen möglicherweise nicht kennen. Ich weiß häufig, dass meine Sammlungsgrößen nicht sehr groß sind und meine Zeit wertvoller ist als ein paar Mikrosekunden Leistung, die durch das Erstellen eines perfekten Hash-Codes erzielt werden. Also (um die nervige Warnung des Compilers loszuwerden) benutze ich einfach:

   public override int GetHashCode()
   {
      return base.GetHashCode();
   }

(Natürlich könnte ich auch ein #pragma verwenden, um die Warnung auszuschalten, aber ich bevorzuge diesen Weg.)

Wenn Sie in der Lage sind , dass Sie tun , die Leistung als alle Probleme von anderen erwähnt müssen hier gelten selbstverständlich. Am wichtigsten - andernfalls erhalten Sie beim Abrufen von Elementen aus einem Hash-Set oder Wörterbuch falsche Ergebnisse: Der Hash-Code darf nicht mit der Lebensdauer eines Objekts variieren (genauer gesagt während der Zeit, in der der Hash-Code benötigt wird, z. B. während des Aufenthalts ein Schlüssel in einem Wörterbuch): Beispielsweise ist Folgendes falsch, da Value öffentlich ist und daher während der Lebensdauer der Instanz extern für die Klasse geändert werden kann. Sie dürfen ihn daher nicht als Grundlage für den Hash-Code verwenden:

   class A
   {
      public int Value;

      public override int GetHashCode()
      {
         return Value.GetHashCode(); //WRONG! Value is not constant during the instance's life time
      }
   }    

Wenn der Wert jedoch nicht geändert werden kann, kann Folgendes verwendet werden:

   class A
   {
      public readonly int Value;

      public override int GetHashCode()
      {
         return Value.GetHashCode(); //OK  Value is read-only and can't be changed during the instance's life time
      }
   }

Sie sollten immer sicherstellen, dass zwei Objekte, die gemäß Equals () gleich sind, denselben Hash-Code zurückgeben, wenn sie gleich sind. Wie in einigen anderen Kommentaren angegeben, ist dies theoretisch nicht obligatorisch, wenn das Objekt niemals in einem Hash-basierten Container wie HashSet oder Dictionary verwendet wird. Ich würde Ihnen jedoch raten, diese Regel immer zu befolgen. Der Grund liegt einfach darin, dass es für jemanden viel zu einfach ist, eine Sammlung von einem Typ in einen anderen zu ändern, um die Leistung tatsächlich zu verbessern oder die Codesemantik besser zu vermitteln.

Angenommen, wir behalten einige Objekte in einer Liste. Einige Zeit später erkennt jemand tatsächlich, dass ein HashSet eine viel bessere Alternative ist, zum Beispiel aufgrund der besseren Sucheigenschaften. Dies ist der Zeitpunkt, an dem wir in Schwierigkeiten geraten können. List würde intern den Standardgleichheitsvergleich für den Typ verwenden, was in Ihrem Fall Gleich bedeutet, während HashSet GetHashCode () verwendet. Wenn sich die beiden unterschiedlich verhalten, wird dies auch Ihr Programm tun. Und denken Sie daran, dass solche Probleme nicht am einfachsten zu beheben sind.

Ich habe dieses Verhalten mit einigen anderen Fallstricken von GetHashCode () in a zusammengefasst Blog-Beitrag zusammengefasst, in dem Sie weitere Beispiele und Erklärungen finden.

Ab .NET 4.7dem bevorzugten Verfahren zur Überschreiben GetHashCode()wird unten gezeigt. Wenn Sie auf ältere .NET-Versionen abzielen, fügen Sie das System.ValueTuple-Nuget- Paket hinzu.

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

In Bezug auf die Leistung übertrifft diese Methode die meisten Implementierungen von zusammengesetztem Hashcode. Das ValueTuple ist ein, structdamit es keinen Müll gibt, und der zugrunde liegende Algorithmus ist so schnell wie es nur geht.

Nach meinem Verständnis gibt der ursprüngliche GetHashCode () die Speicheradresse des Objekts zurück. Daher ist es wichtig, diese zu überschreiben, wenn Sie zwei verschiedene Objekte vergleichen möchten.

BEARBEITET: Das war falsch, die ursprüngliche GetHashCode () -Methode kann die Gleichheit von 2 Werten nicht gewährleisten. Gleiche Objekte geben jedoch denselben Hashcode zurück.

Im Folgenden scheint mir die Verwendung von Reflektion eine bessere Option zu sein, wenn man öffentliche Eigenschaften berücksichtigt, da man sich dabei nicht um das Hinzufügen / Entfernen von Eigenschaften kümmern muss (obwohl dies kein so häufiges Szenario ist). Dies hat sich auch als besser erwiesen (Vergleich der Zeit mit der Stoppuhr Diagonistics).

    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;  
    }