Base de conhecimentoCentro de Exames
PT · PTPortuguês (Portugal)
Escolher idioma13

CKTIS / Java

Redefinir Object.hashCode() e respeitar o contrato de equals()

Objetos iguais segundo `equals()` têm de ter o mesmo código hash. O inverso não é válido: códigos hash iguais não demonstram que os objetos são iguais.

Versão: Java SE 21

Sintaxe

@Override
public int hashCode() {
    return 31 * x + y;
}

Para redefinir o método herdado Object.hashCode(), declara public int hashCode() sem parâmetros na tua classe. Com @Override, o compilador verifica se a declaração redefine de facto um método. Se definires a igualdade por valor com equals(Object), redefine também hashCode() de forma coerente. No exemplo, os dois métodos usam as coordenadas x e y.

Se a.equals(b) devolver true, então a.hashCode() == b.hashCode() também tem de resultar em true. O inverso não é válido: objetos que não são iguais podem ter o mesmo código hash. Isso é uma colisão, não uma violação do contrato.

Durante a mesma execução, chamadas repetidas de hashCode() sobre o mesmo objeto têm de dar o mesmo resultado enquanto os dados usados por equals() não mudarem. O contrato não garante o mesmo resultado entre execuções. Um código hash não é um identificador único.

HashMap usa o código hash para restringir a pesquisa e equals() para decidir se dois objetos distintos usados como chaves são iguais. Muitas colisões podem tornar as pesquisas mais lentas. Não alteres os dados que afetam equals() enquanto um objeto for chave do mapa: o comportamento do mapa após essa alteração não está especificado.

Exemplos

import java.util.HashMap;
import java.util.Map;

public class Main {
    private static final class Point {
        private final int x;
        private final int y;

        Point(int x, int y) {
            this.x = x;
            this.y = y;
        }

        @Override
        public boolean equals(Object obj) {
            return obj instanceof Point other && x == other.x && y == other.y;
        }

        @Override
        public int hashCode() {
            return 31 * x + y;
        }
    }

    public static void main(String[] args) {
        Point a = new Point(1, 0);
        Point b = new Point(1, 0);
        Point c = new Point(0, 31);

        System.out.println(a.equals(b));
        System.out.println(a.hashCode() == b.hashCode());
        System.out.println(a.equals(c));
        System.out.println(a.hashCode() == c.hashCode());

        Map<Point, String> labels = new HashMap<>();
        labels.put(a, "first");
        labels.put(c, "second");
        System.out.println(labels.get(b));
        System.out.println(labels.get(c));
    }
}

Resultado

true
true
false
true
first
second

`a` e `b` são objetos distintos com coordenadas `(1, 0)`, pelo que são iguais segundo `equals()`. `c` tem coordenadas `(0, 31)` e não é igual a `a`, embora ambos os códigos hash sejam `31`. A pesquisa com `b` devolve `first`, o valor guardado com a chave `a`, e a pesquisa com `c` devolve `second`.

Lições relacionadas

  • Java · Lição 28 · Intermédio · Versão: 2

Fontes