Что нужно переопределить у объекта для работы с HashMap?

# Что нужно переопределить для работы объекта с HashMap?

Для корректной работы объекта в качестве ключа в HashMap нужно переопределить два метода:

1. hashCode() — для определения позиции в хеш-таблице
2. equals() — для проверки равенства ключей

Если объект используется только как значение, эти методы переопределять необязательно.

Почему нужны оба метода?

HashMap использует двухшаговый алгоритм поиска:

1. hashCode() → определяет бакет (корзину)
2. equals() → проверяет точное совпадение в бакете

Если переопределить только один метод, возникнут проблемы.

Пример: НЕПРАВИЛЬНО

public class Person {
    public String name;
    public int age;
    
    public Person(String name, int age) {
        this.name = name;
        this.age = age;
    }
    
    // Переопределили equals, но НЕ hashCode
    @Override
    public boolean equals(Object obj) {
        if (this == obj) return true;
        if (obj == null || getClass() != obj.getClass()) return false;
        Person person = (Person) obj;
        return age == person.age && Objects.equals(name, person.name);
    }
    // hashCode() НЕ переопределен!
}

// ПРОБЛЕМА
HashMap<Person, String> map = new HashMap<>();
Person p1 = new Person("Alice", 30);
Person p2 = new Person("Alice", 30);

map.put(p1, "Developer");
map.put(p2, "Engineer");

String value = map.get(p1);
System.out.println(value); // null (!)
// Хотя p1.equals(p2) = true, но hashCode разный!
// HashMap ищет в неправильном бакете

Пример: ПРАВИЛЬНО

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

// ПРАВИЛЬНО
HashMap<Person, String> map = new HashMap<>();
Person p1 = new Person("Alice", 30);
Person p2 = new Person("Alice", 30);

map.put(p1, "Developer");
map.put(p2, "Engineer");  // Перезапишет значение

String value = map.get(p1);
System.out.println(value); // Engineer (правильно!)
System.out.println(map.size()); // 1 (не 2)

Правило "Contract" между equals() и hashCode()

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

EST ЛИ a.equals(b) == true?
    → ТОГДА a.hashCode() == b.hashCode() (ДОЛЖНО быть)

ЕСТИ a.hashCode() == b.hashCode()?
    → НО a.equals(b) может быть false (коллизия, это нормально)

ПРАВИЛЬНО

String s1 = new String("hello");
String s2 = new String("hello");

System.out.println(s1.equals(s2));        // true
System.out.println(s1.hashCode() == s2.hashCode()); // true ✓

НЕПРАВИЛЬНО

public class BadPerson {
    private String name;
    
    @Override
    public boolean equals(Object obj) {
        // Сравнивает по имени
        return this.name.equals(((BadPerson)obj).name);
    }
    
    @Override
    public int hashCode() {
        // Возвращает случайное число
        return (int)(Math.random() * 1000);
    }
}

// ПРОБЛЕМА
BadPerson p1 = new Person("Alice", 30);
BadPerson p2 = new Person("Alice", 30);

System.out.println(p1.equals(p2));  // true (поле name одинаковое)
System.out.println(p1.hashCode() == p2.hashCode()); // false ✗

// HashMap будет искать в разных бакетах, хотя объекты равны

Пошаговый процесс поиска в HashMap

HashMap<Person, String> map = new HashMap<>();
Person alice = new Person("Alice", 30);

map.put(alice, "Developer");
// Шаг 1: Вычисляется hash = alice.hashCode()
// Шаг 2: Определяется бакет: bucketIndex = hash & (capacity - 1)
// Шаг 3: Элемент помещается в bucket[bucketIndex]

Person searchKey = new Person("Alice", 30);
String found = map.get(searchKey);
// Шаг 1: Вычисляется hash = searchKey.hashCode()
// Шаг 2: Определяется бакет: bucketIndex = hash & (capacity - 1)
// Шаг 3: В bucket[bucketIndex] ищутся элементы где:
//        foundKey.equals(searchKey) == true
// Шаг 4: Если найдено → возвращается значение
// Шаг 5: Если не найдено → возвращается null

Практический пример: ID объекта

public class User {
    private Long id;      // Уникальный ID
    private String name;
    private String email;
    
    public User(Long id, String name, String email) {
        this.id = id;
        this.name = name;
        this.email = email;
    }
    
    // Используем только ID для equals и hashCode
    @Override
    public boolean equals(Object obj) {
        if (this == obj) return true;
        if (obj == null || getClass() != obj.getClass()) return false;
        User user = (User) obj;
        return Objects.equals(id, user.id);
    }
    
    @Override
    public int hashCode() {
        return Objects.hash(id);
    }
}

// Использование
HashMap<User, String> roles = new HashMap<>();
User user1 = new User(1L, "Alice", "alice@email.com");
roles.put(user1, "Admin");

User user2 = new User(1L, "Alice Smith", "alice.smith@email.com");
// user2.equals(user1) == true (одинаковый ID)
// user2.hashCode() == user1.hashCode()

String role = roles.get(user2);
System.out.println(role); // Admin (правильно!)

Использование IDE для генерации

Bольшинство IDE могут автоматически сгенерировать equals() и hashCode():

IntelliJ IDEA

Right-click → Generate → equals() and hashCode()

Eclipse

Source → Generate hashCode() and equals()

Lombok (аннотации)

import lombok.EqualsAndHashCode;

@EqualsAndHashCode
public class Person {
    private String name;
    private int age;
}
// equals() и hashCode() генерируются автоматически

Когда нужно переопределить

НУЖНО переопределить, если:

• Объект используется как ключ в HashMap
• Объект используется в HashSet
• Объект используется как ключ в ConcurrentHashMap
• Нужна пользовательская логика для сравнения объектов

МОЖНО НЕ переопределять, если:

• Объект используется только как значение в HashMap
• Объект используется в List, ArrayList
• Нужна идентичность объектов (ссылка в памяти)

Таблица различий

Вывод

Для корректной работы объекта в HashMap в качестве ключа нужно переопределить:

1. equals() — для проверки логического равенства
2. hashCode() — для быстрого определения позиции в таблице

Правило: если переопределите equals(), обязательно переопределите hashCode() в соответствии с контрактом: если a.equals(b) == true, то a.hashCode() == b.hashCode().