Coleções Java – hashCode() e equals() – Como substituir o método equals() e hashcode() em Java?

Publicados: 2018-08-08
Coleções Java hashCode e iguais

equals() e hashCode() em Java são dois métodos fundamentais que são declarados na classe Object e parte ou biblioteca Java principal.

Se você tiver alguma das preocupações abaixo em Java, então você está no lugar certo.

  • Práticas Java -> Implementando equals
  • override – Substituindo equals e hashCode em Java
  • Como substituir o método equals () em java
  • Como substituir o método hashCode () em java
  • Como substituir o método equals e hashCode em Java
  • Como e por que substituir o método equals em Java
  • Por que sempre substituir hashcode() se substituir equals()?

Vamos dar uma olhada em um exemplo simples para entender primeiro Reference Equality e Logical Equality . O operador de igualdade (==) compara as referências (endereços na memória) das duas Strings como dois números diferentes – isso é conhecido como Reference equality .

Logical equality compara os dados dos objetos em vez do valor das referências.

Java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
package com . crunchify . tutorials ;
 
/**
* @author Crunchify.com
*/
 
public class CrunchifyLogicalVsReferenceEqality {
 
     public static void main ( String [ ] args ) {
         String strA = new String ( "eBay" ) ;
         String strB = new String ( "eBay" ) ;
         String strC = new String ( "Paypal" ) ;
 
         // Create a String reference and assign an existing String's reference to it
         // so that both references point to the same String object in memory.
         String strD = strA ;
 
         // Print out the results of various equality checks
         // Reference Equality
         System . out . println ( "Reference Equality Result:" ) ;
         System . out . println ( strA == strB ) ;
         System . out . println ( strA == strC ) ;
         System . out . println ( strA == strD ) ;
 
         // Logical Equality
         System . out . println ( "\nLogical Equality Result:" ) ;
         System . out . println ( strA . equals ( strB ) ) ;
         System . out . println ( strA . equals ( strC ) ) ;
         System . out . println ( strA . equals ( strD ) ) ;
 
     }
}

Saída:

1
2
3
4
5
6
7
8
9
Reference Equality Result :
false
false
true
 
Logical Equality Result :
true
false
true

hashCode e equals estão intimamente relacionados:

  • se você substituir equals , deverá substituir hashCode .
  • hashCode deve gerar valores iguais para objetos iguais.
  • equals e hashCode devem depender do same set of significant fields . Você deve usar o mesmo conjunto de campos em ambos os métodos. Você não é obrigado a usar todos os campos. Por exemplo, um campo calculado que depende de outros provavelmente deve ser omitido de equals e hashCode .

Ao implementar equals , os campos são comparados de forma diferente, de acordo com seu tipo:

  • campos de objeto, incluindo coleções: use equals
  • enumerações de tipo seguro: use equals ou == (elas equivalem à mesma coisa, neste caso)
  • campos de objeto possivelmente nulos: use ambos == e igual
  • campos de matriz: use Arrays.equals
  • campos primitivos diferentes de float ou double : use ==
  • float : converte para int usando Float.floatToIntBits , e use ==
  • double : converta para long usando Double.doubleToLongBits , então use ==

Implementando hashCode :

  • se uma classe substituir equals , ela deve substituir hashCode
  • quando ambos são substituídos, equals e hashCode devem usar o mesmo conjunto de campos
  • se dois objetos são iguais, seus valores de hashCode também devem ser iguais
  • se o objeto é imutável, então hashCode é um candidato para cache e inicialização lenta

É um equívoco popular que hashCode fornece um identificador exclusivo para um objeto. Isso não.

Por contrato geral, o método equals() em Java deve ser reflexivo, simétrico, transitivo, consistente e qualquer referência não nula deve retornar false. Em outras palavras, para valores arbitrários de a, b e c, os seguintes testes devem sempre passar:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
/ reflexive property
assertTrue ( a . equals ( a ) ) ;
 
// symmetric property
assertTrue ( a . equals ( b ) == b . equals ( a ) ) ;
 
// transitive property
if ( a . equals ( b ) && b.equals(c) ) {
   assertTrue( a.equals(c) );
}
 
// consistency property
assertTrue ( a . equals ( b ) == a . equals ( b ) ) ;
 
// non-null property
assertFalse ( a . equals ( null ) ) ;

Para a prática recomendada, use as etapas abaixo para implementar seu método equals():

  • Use this == that para verificar a igualdade de referência
  • Use instanceof para testar o tipo de argumento correto
  • Transmita o argumento para o tipo correto
  • Comparar campos significativos para igualdade

Aqui está um Exemplo Completo.

CrunchifyImplementEqualsHashCode.java

Java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
package crunchify . com . tutorials ;
 
/**
*
* @author Crunchify.com
* How to Override equals() method in Java?
* How to Override hasCode() method in Java?
* version:1.2
*
*/
 
public class CrunchifyImplementEqualsHashCode {
 
public static void main ( String [ ] args ) {
 
CrunchifyImplementEqualsHashCode crunchifyTest = new CrunchifyImplementEqualsHashCode ( ) ;
Crunchify one = new Crunchify ( 1 ) ;
Crunchify two = new Crunchify ( 1 ) ;
crunchifyTest . test1 ( one , two ) ;
 
Crunchify three = new Crunchify ( 1 ) ;
Crunchify four = new Crunchify ( 2 ) ;
crunchifyTest . test2 ( three , four ) ;
}
 
public void test1 ( Crunchify one , Crunchify two ) {
if ( one . equals ( two ) ) {
System . out . println ( "Test1: One and Two are equal" ) ;
} else {
System . out . println ( "Test1: One and Two are not equal" ) ;
}
}
 
public void test2 ( Crunchify three , Crunchify four ) {
if ( three . equals ( four ) ) {
System . out . println ( "Test2: Three and Four are equal" ) ;
} else {
System . out . println ( "Test2: Three and Four are not equal" ) ;
}
}
}
 
class Crunchify {
private int value ;
 
Crunchify ( int val ) {
value = val ;
}
 
public int getValue ( ) {
return value ;
}
 
// The method does override or implement a method declared in a supertype.
@Override
public boolean equals ( Object o ) {
 
// null check
if ( o == null ) {
return false ;
}
 
// this instance check
if ( this == o ) {
return true ;
}
 
// instanceof Check and actual value check
if ( ( o instanceof Crunchify ) && (((Crunchify) o).getValue() == this.value)) {
return true;
} else {
return false ;
}
}
 
@Override
public int hashCode ( ) {
int result = 0 ;
result = ( int ) ( value / 11 ) ;
return result ;
}
}

Saída do console do Eclipse:

1
2
Test1 : One and Two are equal
Test2 : Three and Four are not equal