Pourquoi devrais-je redéfinir hashCode() lorsque je remplace la méthode equals()?

Question

Ok, j'ai entendu de nombreux endroits et sources que chaque fois que je substitue la méthode equals(), j'ai besoin de surcharger la méthode hashCode(). Mais considérez la pièce de code suivante

package test; 

public class MyCustomObject { 

    int intVal1; 
    int intVal2; 

    public MyCustomObject(int val1, int val2){ 
     intVal1 = val1; 
     intVal2 = val2; 
    } 

    public boolean equals(Object obj){ 
     return (((MyCustomObject)obj).intVal1 == this.intVal1) && 
       (((MyCustomObject)obj).intVal2 == this.intVal2); 
    } 

    public static void main(String a[]){ 
     MyCustomObject m1 = new MyCustomObject(3,5); 
     MyCustomObject m2 = new MyCustomObject(3,5); 
     MyCustomObject m3 = new MyCustomObject(4,5); 

     System.out.println(m1.equals(m2)); 
     System.out.println(m1.equals(m3)); 
    } 
} 

Ici, la sortie est vrai, faux exactement la façon dont je veux que ce soit et je ne garde de passer outre la méthode hashCode() du tout. Cela signifie que le remplacement de hashCode() est une option plutôt obligatoire que tout le monde le dit.

Je veux une deuxième confirmation.

Answer 1

Cela fonctionne pour vous parce que votre code n'utilise aucune fonctionnalité (HashMap, HashTable) qui a besoin de l'API hashCode().

Cependant, vous ne savez pas si votre classe (vraisemblablement non écrite à titre exceptionnel) sera appelée ultérieurement dans un code qui utilise effectivement ses objets comme clé de hachage, auquel cas les choses seront affectées.

Selon le documentation for Object class:

Le contrat général de hashCode est:

• Chaque fois qu'il est invoqué sur le même objet plus d'une fois lors d'une exécution d'une application Java, le hashCode La méthode doit renvoyer systématiquement le même entier, à condition qu'aucune information utilisée dans les comparaisons égales sur l'objet ne soit modifiée. Cet entier n'a pas besoin de rester cohérent d'une exécution d'une application à une autre exécution de la même application.

• Si deux objets sont égaux selon la méthode égale (Object), l'appel de la méthode hashCode sur chacun des deux objets doit produire le même résultat entier.

Answer 2

Parce que HashMap/Hashtable recherche d'abord l'objet par hashCode().

Si elles ne sont pas identiques, les objets hashmap assert ne sont pas identiques et le retour n'existe pas dans la carte.

Answer 3

La raison pour laquelle vous devez @Override ni l'un ni les deux est due à la manière dont ils interagissent avec le reste de l'API.

Vous constaterez que si vous mettez m1 dans un HashSet<MyCustomObject>, alors il n'est pas contains(m2). C'est comportement incohérent et peut causer beaucoup de bugs et de chaos.

La bibliothèque Java a des tonnes de fonctionnalités. Afin de les faire fonctionner pour vous, vous devez jouer par les règles, et en s'assurant que equals et hashCode sont cohérentes est l'un des plus importants.

Answer 4

La plupart des autres commentaires que vous avez déjà donné la réponse: vous devez le faire parce qu'il ya des collections (par exemple: HashSet, HashMap) qui utilise hashCode comme exemples d'optimisation à objet « d'index », un ces optimisations s'attendent à ce que: a.equals(b) ==>a.hashCode() == b.hashCode() (NOTE que l'inverse ne tient pas).

Mais comme une information supplémentaire, vous pouvez faire cet exercice:

class Box { 
    private String value; 
    /* some boring setters and getters for value */ 
    public int hashCode() { return value.hashCode(); } 
    public boolean equals(Object obj) { 
      if (obj != null && getClass().equals(obj.getClass()) { 
       return ((Box) obj).value.equals(value); 
      } else { return false; } 
    } 
} 

Le faire:

Set<Box> s = new HashSet<Box>(); 
Box b = new Box(); 
b.setValue("hello"); 
s.add(b); 
s.contains(b); // TRUE 
b.setValue("other"); 
s.contains(b); // FALSE 
s.iterator().next() == b // TRUE!!! b is in s but contains(b) returns false 

Ce que vous apprenez de cet exemple est que la mise en œuvre equals ou hashCode avec des propriétés qui peuvent être changé (mutable) est une très mauvaise idée.

Answer 5

Il est principalement important lors de la recherche d'un objet en utilisant sa valeur hashCode() dans une collection (c'est-à-dire HashMap, HashSet, etc.). Chaque objet renvoie une valeur hashCode() différente. Vous devez donc remplacer cette méthode pour générer systématiquement une valeur hashCode basée sur l'état de l'objet afin d'aider l'algorithme Collections à localiser les valeurs dans la table de hachage.