Зачем и как переопределять метод hashCode?

Метод hashCode используется для получения целочисленного хеш-кода объекта. Он необходим для правильной работы коллекций, основанных на хеш-таблицах, таких как HashMap, HashSet и HashTable. При добавлении объекта в такую коллекцию, его хеш-код используется для определения "корзины" (bucket), куда будет помещен объект. При поиске объекта, хеш-код снова вычисляется для быстрого определения корзины, которую необходимо просмотреть.

Переопределение hashCode необходимо, если вы переопределили метод equals. Согласно контракту между equals и hashCode:

1. Если два объекта равны по методу equals, то их хеш-коды, возвращаемые методом hashCode, должны быть одинаковыми.
2. Если два объекта не равны по методу equals, их хеш-коды, возвращаемые методом hashCode, не обязаны быть разными, но для лучшей производительности коллекций желательно, чтобы они были различными.

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

• Объекты, которые считаются равными по equals, будут помещены в разные корзины.
• Поиск равного объекта может завершиться неудачей, поскольку будет проверяться только одна корзина, определенная хеш-кодом искомого объекта.

Для переопределения hashCode обычно используется комбинация хеш-кодов полей объекта, которые участвуют в проверке равенства в методе equals.

Наиболее распространенные способы переопределения:

1. Использование Objects.hash() (с Java 7): Самый простой и рекомендуемый способ. Он безопасен для null и использует хеш-коды предоставленных полей.

   // Пример использования Objects.hash()
   import java.util.Objects;
   
   public class MyClass {
       private int field1;
       private String field2;
   
       // ... конструктор, геттеры, сеттеры
   
       @Override
       public boolean equals(Object o) {
           if (this == o) return true;
           if (o == null || getClass() != o.getClass()) return false;
           MyClass myClass = (MyClass) o;
           return field1 == myClass.field1 &&
                  Objects.equals(field2, myClass.field2);
       }
   
       @Override
       public int hashCode() {
           return Objects.hash(field1, field2); // Передаем поля, участвующие в equals
       }
   }
   

2. Вручную (с использованием простого алгоритма): Более низкоуровневый подход, который может быть полезен для понимания, но более подвержен ошибкам. Обычно используется простое умножение и сложение.

   // Пример ручного переопределения hashCode
   public class MyClass {
       private int field1;
       private String field2;
   
       // ... конструктор, геттеры, сеттеры
   
       @Override
       public boolean equals(Object o) {
           if (this == o) return true;
           if (o == null || getClass() != o.getClass()) return false;
           MyClass myClass = (MyClass) o;
           return field1 == myClass.field1 &&
                  Objects.equals(field2, myClass.field2);
       }
   
       @Override
       public int hashCode() {
           int result = 17; // Начальное значение (любое нечетное число)
           result = 31 * result + field1; // Умножаем на нечетное простое число (31 - стандарт) и добавляем хеш-код поля
           result = 31 * result + (field2 != null ? field2.hashCode() : 0); // Обрабатываем null для объектов
   
           return result;
       }
   }
   

   Стандартное нечетное простое число (31) используется, потому что умножение на 31 может быть оптимизировано компилятором (31 * i == (i << 5) - i).

3. Использование IDE: Большинство современных IDE (IntelliJ IDEA, Eclipse) имеют функции для автоматической генерации методов equals() и hashCode(). Это самый безопасный и рекомендуемый подход, так как они генерируют код в соответствии с лучшими практиками.

Главная цель переопределения hashCode — гарантировать, что равные объекты имеют одинаковые хеш-коды, что критически важно для корректной работы коллекций, основанных на хешировании.