Baza wiedzyCentrum egzaminacyjne
PLPolski
Wybierz język13

CKTIS / Java

Nadpisywanie Object.hashCode() i kontrakt z equals()

Obiekty równe według `equals()` muszą mieć taki sam kod skrótu. Odwrotność nie zachodzi: ten sam kod skrótu nie dowodzi równości.

Wersja: Java SE 21

Składnia

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

Aby nadpisać odziedziczoną metodę Object.hashCode(), zadeklaruj w klasie public int hashCode() bez parametrów. Adnotacja @Override pozwala kompilatorowi sprawdzić, czy deklaracja rzeczywiście nadpisuje metodę. Gdy definiujesz równość według wartości za pomocą equals(Object), nadpisz też hashCode() zgodnie z tym samym kryterium. W przykładzie obie metody używają współrzędnych x i y.

Jeśli a.equals(b) zwraca true, wyrażenie a.hashCode() == b.hashCode() również musi dać true. Odwrotność nie zachodzi: nierówne obiekty mogą mieć ten sam kod skrótu. To kolizja, a nie naruszenie kontraktu.

W trakcie jednego uruchomienia programu kolejne wywołania hashCode() dla tego samego obiektu muszą zwracać tę samą wartość, dopóki nie zmieniają się dane używane przez equals(). Kontrakt nie gwarantuje takiego samego wyniku w osobnych uruchomieniach. Kod skrótu nie jest unikatowym identyfikatorem.

HashMap używa kodu skrótu, aby zawęzić wyszukiwanie, a equals() rozstrzyga równość różnych obiektów użytych jako klucze. Liczne kolizje mogą spowolnić wyszukiwanie. Nie zmieniaj danych wpływających na equals(), gdy obiekt jest kluczem w mapie: zachowanie mapy po takiej zmianie nie jest określone.

Przykłady

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

Wynik

true
true
false
true
first
second

`a` i `b` to osobne obiekty o współrzędnych `(1, 0)`, więc są równe według `equals()`. `c` ma współrzędne `(0, 31)` i nie jest równy `a`, choć oba kody skrótu wynoszą `31`. Szukanie przez `b` zwraca `first`, wartość zapisaną pod kluczem `a`, a szukanie przez `c` zwraca `second`.

Powiązane lekcje

  • Java · Lekcja 28 · Średniozaawansowany · Wersja: 2

Źródła