Welche Themen sollten betrachtet werden, wenn Sie das überschreiben von equals und hashCode in Java?

Die Theorie (für die Sprache der Juristen und der mathematisch):

equals() (javadoc) definieren eine äquivalenz-relation (es muss reflexive, symmetrischen, und transitive). Zusätzlich, Sie werden müssen konsistente (sofern die Objekte nicht verändert wird, dann muss es immer wieder der gleiche Wert). Darüber hinaus o.equals(null) muss immer false zurück.

hashCode() (javadoc) müssen auch konsistente (wenn das Objekt nicht geändert in Bezug auf equals() es müssen immer wieder die gleichen Wert).

Den Bezug zwischen den beiden Methoden ist:

Wenn a.equals(b), dann a.hashCode() muss gleich sein wie b.hashCode().

In der Praxis:

Wenn Sie überschreiben, dann sollten Sie überschreiben die anderen.

Verwenden den gleichen Satz von Feldern, die Sie verwenden, um zu berechnen equals() zu berechnen hashCode().

Nutzen die hervorragende Helfer-Klassen EqualsBuilder und HashCodeBuilder aus der Apache Commons Lang Bibliothek. Ein Beispiel:

public class Person {
    private String name;
    private int age;
    //...

    @Override
    public int hashCode() {
        return new HashCodeBuilder(17, 31). //two randomly chosen prime numbers
            //if deriving: appendSuper(super.hashCode()).
            append(name).
            append(age).
            toHashCode();
    }

    @Override
    public boolean equals(Object obj) {
       if (!(obj instanceof Person))
            return false;
        if (obj == this)
            return true;

        Person rhs = (Person) obj;
        return new EqualsBuilder().
            //if deriving: appendSuper(super.equals(obj)).
            append(name, rhs.name).
            append(age, rhs.age).
            isEquals();
    }
}

Denken Sie auch daran:

Wenn eine hash-basierte Sammlung oder Anzeigen wie HashSet, LinkedHashSet, HashMap, Hashtable, oder WeakHashMap, stellen Sie sicher, dass die hashCode() der key-Objekte, die Sie in der Sammlung, die sich nie ändert, während das Objekt in der Sammlung. Der kugelsichere Weg, um sicherzustellen, dass dies, um Ihren Schlüssel unveränderlich, das hat auch andere Vorteile.

InformationsquelleAutor

Einer Klärung über die obj.getClass() != getClass().

Diese Aussage ist das Ergebnis von equals() sein Erbe unfreundlich. Die JLS (Java language specification) legt fest, dass, wenn A.equals(B) == true dann B.equals(A) muss auch zurück true. Wenn Sie die weglassen, die Aussage erbenden Klassen überschreiben equals() (und ändern Ihr Verhalten) brechen dieser Spezifikation.

Betrachten Sie das folgende Beispiel, was passiert, wenn die Anweisung weggelassen wird:

    class A {
      int field1;

      A(int field1) {
        this.field1 = field1;
      }

      public boolean equals(Object other) {
        return (other != null && other instanceof A && ((A) other).field1 == field1);
      }
    }

    class B extends A {
        int field2;

        B(int field1, int field2) {
            super(field1);
            this.field2 = field2;
        }

        public boolean equals(Object other) {
            return (other != null && other instanceof B && ((B)other).field2 == field2 && super.equals(other));
        }
    }    

Tun new A(1).equals(new A(1)) Auch new B(1,1).equals(new B(1,1)) Resultat heraus wahr, wie es sollte.

Das sieht alles sehr gut aus, aber schauen Sie, was passiert, wenn wir versuchen, beide Klassen:

A a = new A(1);
B b = new B(1,1);
a.equals(b) == true;
b.equals(a) == false;

Offensichtlich ist dies falsch.

Wenn Sie sicherstellen möchten, dass die symmetrischen Zustand. a=b wenn b=a ist und das Liskov-substitution-Prinzip nennen super.equals(other) nicht nur im Fall von B Instanz, sondern prüfen Sie nach für A Beispiel:

if (other instanceof B )
   return (other != null && ((B)other).field2 == field2 && super.equals(other)); 
if (other instanceof A) return super.equals(other); 
   else return false;

Die Ausgabe:

a.equals(b) == true;
b.equals(a) == true;

Wo, wenn a ist nicht eine Referenz B, dann könnte es sein, eine Referenz der Klasse A (weil Sie es verlängern), in diesem Fall rufen Sie super.equals() zu.

InformationsquelleAutor Ran Biron

Immer noch erstaunt, dass keiner empfohlen der guava library.

 //Sample taken from a current working project of mine just to illustrate the idea

    @Override
    public int hashCode(){
        return Objects.hashCode(this.getDate(), this.datePattern);
    }

    @Override
    public boolean equals(Object obj){
        if ( ! obj instanceof DateAndPattern ) {
            return false;
        }
        return Objects.equal(((DateAndPattern)obj).getDate(), this.getDate())
                && Objects.equal(((DateAndPattern)obj).getDate(), this.getDatePattern());
    }

InformationsquelleAutor Eugene

Gibt es ein paar Möglichkeiten prüfen, um die Gleichheit der Klassen, bevor Sie Mitglied der Gleichstellung, und ich denke, beide sind nützlich, in den richtigen Umständen.

1. Verwenden Sie die instanceof Betreiber.
2. Verwenden this.getClass().equals(that.getClass()).

Verwende ich #1 in einem final equals-Implementierung oder bei der Implementierung einer Schnittstelle, das vorschreibt, dass ein Algorithmus für die equals (wie die java.util collection interfaces—der richtige Weg, um zu überprüfen, mit (obj instanceof Set) oder was auch immer-Schnittstelle Sie implementieren). Es ist allgemein eine schlechte Wahl, wenn equals überschrieben werden können, denn das bricht die Symmetrie-Eigenschaft.

Option #2 erlaubt die Klasse sicher länger ohne überschreiben von equals oder die Brechung der Symmetrie.

Wenn Ihre Klasse ist auch Comparable, die equals und compareTo Methoden sollten konstant zu. Hier eine Vorlage, die für die equals-Methode in einem Comparable Klasse:

final class MyClass implements Comparable<MyClass>
{

  …

  @Override
  public boolean equals(Object obj)
  {
    /* If compareTo and equals aren't final, we should check with getClass instead. */
    if (!(obj instanceof MyClass)) 
      return false;
    return compareTo((MyClass) obj) == 0;
  }

}

InformationsquelleAutor erickson

equals () - Methode wird verwendet, um die Gleichheit von zwei Objekten.

als int-Wert von 10 ist immer gleich 10. Aber diese equals () - Methode wird über die Gleichheit von zwei Objekten. Wenn wir sagen, Objekt, Eigenschaften. Entscheidet über die Gleichstellung auf diese Eigenschaften betrachtet werden. Es ist nicht notwendig, dass alle Eigenschaften müssen berücksichtigt werden, um zu bestimmen, die Gleichheit und in Bezug auf die definition der Klasse und Kontext entschieden werden kann. Dann die equals () - Methode kann überschrieben werden.

sollten wir immer überschreiben Sie hashCode () - Methode, wenn wir überschreiben Sie equals () - Methode. Wenn nicht, was wird passieren? Wenn wir hashtables in unsere Anwendung, es wird nicht so verhält wie erwartet. Wie der hashCode ist die Bestimmung der Gleichheit von Werten gespeichert, es wird nicht wieder das Recht entsprechende Wert für einen Schlüssel.

Default-Implementierung gegeben ist hashCode() Methode in der Object-Klasse verwendet die interne Adresse des Objektes und wandelt diese in integer und gibt Sie zurück.

public class Tiger {
  private String color;
  private String stripePattern;
  private int height;

  @Override
  public boolean equals(Object object) {
    boolean result = false;
    if (object == null || object.getClass() != getClass()) {
      result = false;
    } else {
      Tiger tiger = (Tiger) object;
      if (this.color == tiger.getColor()
          && this.stripePattern == tiger.getStripePattern()) {
        result = true;
      }
    }
    return result;
  }

  //just omitted null checks
  @Override
  public int hashCode() {
    int hash = 3;
    hash = 7 * hash + this.color.hashCode();
    hash = 7 * hash + this.stripePattern.hashCode();
    return hash;
  }

  public static void main(String args[]) {
    Tiger bengalTiger1 = new Tiger("Yellow", "Dense", 3);
    Tiger bengalTiger2 = new Tiger("Yellow", "Dense", 2);
    Tiger siberianTiger = new Tiger("White", "Sparse", 4);
    System.out.println("bengalTiger1 and bengalTiger2: "
        + bengalTiger1.equals(bengalTiger2));
    System.out.println("bengalTiger1 and siberianTiger: "
        + bengalTiger1.equals(siberianTiger));

    System.out.println("bengalTiger1 hashCode: " + bengalTiger1.hashCode());
    System.out.println("bengalTiger2 hashCode: " + bengalTiger2.hashCode());
    System.out.println("siberianTiger hashCode: "
        + siberianTiger.hashCode());
  }

  public String getColor() {
    return color;
  }

  public String getStripePattern() {
    return stripePattern;
  }

  public Tiger(String color, String stripePattern, int height) {
    this.color = color;
    this.stripePattern = stripePattern;
    this.height = height;

  }
}

Beispiel-Code-Ausgang:

bengalTiger1 and bengalTiger2: true 
bengalTiger1 and siberianTiger: false 
bengalTiger1 hashCode: 1398212510 
bengalTiger2 hashCode: 1398212510 
siberianTiger hashCode: –1227465966

InformationsquelleAutor rohan kamat

Eine gotcha, die ich gefunden habe, ist, wenn zwei Objekte enthalten Referenzen auf andere (zum Beispiel ein Eltern - /Kind-Beziehung mit eine bequeme Methode, auf die Eltern zu Holen alle Kinder).

Diese Dinge sind relativ Häufig, wenn dabei die Hibernate-mappings zum Beispiel.

Wenn Sie beide enden der Beziehung in Ihrem hashCode entspricht oder tests ist es möglich, in einer rekursiven Schleife, die endet in einer StackOverflowException.

Die einfachste Lösung ist nicht die getChildren-Sammlung in den Methoden.

InformationsquelleAutor Darren Greaves