Каков контракт между методами hashCode() и equals() в Java

Контракт между hashCode() и equals() в Java

Основной контракт

В Java существует строгий контракт между методами equals() и hashCode(), определённый в Object классе:

Если два объекта равны по equals(), то они ДОЛЖНЫ иметь одинаковый hashCode().

equals() совпадают → hashCode() совпадают (ОБЯЗАТЕЛЬНО)
hashCode() совпадают → equals() могут совпадать или нет (необязательно)

Детальное объяснение контракта

Правило 1: Рефлексивность (Reflexivity)

// Объект всегда равен самому себе
x.equals(x) == true;
x.hashCode() == x.hashCode();

Правило 2: Симметричность (Symmetry)

// Если x равен y, то y равен x
if (x.equals(y)) {
    y.equals(x) == true;
    x.hashCode() == y.hashCode();
}

Правило 3: Транзитивность (Transitivity)

// Если x равен y и y равен z, то x равен z
if (x.equals(y) && y.equals(z)) {
    x.equals(z) == true;
    x.hashCode() == z.hashCode();
}

Правило 4: Консистентность (Consistency)

// Результат equals() и hashCode() не меняется, если объект не изменился
x.equals(y) == x.equals(y); // Одинаковый результат при повторном вызове
x.hashCode() == x.hashCode();

Правило 5: Null

// Сравнение с null всегда false
x.equals(null) == false;

Почему это важно?

Контракт критичен потому, что hashCode() и equals() используются в хеш-таблицах:

HashMap, HashSet, Hashtable, ConcurrentHashMap и др.

// Процесс поиска в HashMap:
1. Вычисляется hash = key.hashCode()
2. Находится бакет по hash
3. В бакете ищут элемент через equals()

Если контракт нарушен, поиск может не найти элемент, хотя он есть!

Неправильная реализация

❌ Плохо: только equals(), без hashCode()

public class User {
    private String email;
    private int age;
    
    @Override
    public boolean equals(Object o) {
        if (this == o) return true;
        if (!(o instanceof User)) return false;
        User user = (User) o;
        return email.equals(user.email) && age == user.age;
    }
    
    // hashCode() не переопределён — проблема!
}

// Использование
User user1 = new User("john@example.com", 30);
User user2 = new User("john@example.com", 30);

System.out.println(user1.equals(user2)); // true
System.out.println(user1.hashCode() == user2.hashCode()); // false!

Set<User> set = new HashSet<>();
set.add(user1);
set.add(user2); // Добавится ещё раз, хотя должны быть равны!

System.out.println(set.size()); // 2 (ОШИБКА, должно быть 1)

❌ Плохо: только hashCode(), без equals()

public class User {
    private String email;
    
    @Override
    public int hashCode() {
        return email.hashCode();
    }
    
    // equals() не переопределён — ещё хуже!
}

// Использование
User user1 = new User("john@example.com");
User user2 = new User("john@example.com");

System.out.println(user1.hashCode() == user2.hashCode()); // true
System.out.println(user1.equals(user2)); // false (использует ==)

// Проблема с поиском в HashMap!
Map<User, String> map = new HashMap<>();
map.put(user1, "John");
System.out.println(map.get(user2)); // null (ОШИБКА!)

Правильная реализация

✅ Хорошо: equals() и hashCode() вместе

public class User {
    private String email;
    private int age;
    
    @Override
    public boolean equals(Object o) {
        if (this == o) return true;
        if (!(o instanceof User)) return false;
        User user = (User) o;
        return age == user.age && 
               Objects.equals(email, user.email);
    }
    
    @Override
    public int hashCode() {
        return Objects.hash(email, age);
    }
}

// Использование
User user1 = new User("john@example.com", 30);
User user2 = new User("john@example.com", 30);

System.out.println(user1.equals(user2)); // true
System.out.println(user1.hashCode() == user2.hashCode()); // true

Set<User> set = new HashSet<>();
set.add(user1);
set.add(user2);
System.out.println(set.size()); // 1 (ПРАВИЛЬНО!)

Map<User, String> map = new HashMap<>();
map.put(user1, "John");
System.out.println(map.get(user2)); // "John" (ПРАВИЛЬНО!)

Использование Objects.hash()

Удобный способ для генерации hashCode():

@Override
public int hashCode() {
    // Objects.hash() генерирует хороший hashCode
    return Objects.hash(email, age, name);
}

// Эквивалентно (но менее красиво):
@Override
public int hashCode() {
    int result = email.hashCode();
    result = 31 * result + age;
    result = 31 * result + name.hashCode();
    return result;
}

IDE помощники (IntelliJ IDEA)

// IntelliJ IDEA может сгенерировать оба метода:
// Right-click → Generate → equals() and hashCode()

public class User {
    private String email;
    private int age;
    
    @Override
    public boolean equals(Object o) {
        if (this == o) return true;
        if (o == null || getClass() != o.getClass()) return false;
        User user = (User) o;
        return age == user.age && 
               Objects.equals(email, user.email);
    }
    
    @Override
    public int hashCode() {
        return Objects.hash(email, age);
    }
}

Lombok аннотация

@Data // Генерирует equals() и hashCode()
@EqualsAndHashCode(of = {"email", "age"})
public class User {
    private String email;
    private int age;
    private String password; // Исключается из equals/hashCode
}

Типичные ошибки

❌ Включение изменяемых полей в hashCode()

public class User {
    private String email; // Неизменяемо
    private List<String> tags; // ИЗМЕНЯЕМО!
    
    @Override
    public int hashCode() {
        // ❌ ПЛОХО — если tags изменится, hashCode изменится
        return Objects.hash(email, tags);
    }
}

User user = new User("john@example.com");
Set<User> set = new HashSet<>();
set.add(user);

user.getTags().add("admin"); // Изменили объект в Set!
set.contains(user); // Может не найти, потому что hashCode изменился!

✅ Правильно — только неизменяемые поля

@Override
public int hashCode() {
    return Objects.hash(email); // Только неизменяемое поле
}

❌ Неправильный hashCode()

// ❌ Слишком простой hashCode() — много коллизий
@Override
public int hashCode() {
    return 1; // Все объекты в одном бакете!
}

// ❌ Неправильная реализация
@Override
public int hashCode() {
    return (int) System.currentTimeMillis();
}

Производительность

// ✅ Быстрый hashCode()
@Override
public int hashCode() {
    return Objects.hash(id, email);
}

// ⚠️ Медленный hashCode() с тяжёлыми вычислениями
@Override
public int hashCode() {
    return email.toUpperCase().hashCode() + 
           Objects.hash(complexCalculation());
}

Контракт в таблице

Вывод

1. Всегда переопределяй оба метода вместе
2. Используй Objects.hash() для простоты
3. Включай в hashCode() только неизменяемые поля
4. Помни о контракте: equals() совпадают → hashCode() совпадают
5. Используй IDE для генерирования или Lombok
6. Тестируй поведение в HashMap/HashSet

Правильная реализация контракта между equals() и hashCode() — основа правильной работы с коллекциями в Java.