Метод hashCode в Java. Его переопределение

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

Это случайное уникальное число, которое генерируется этим методом по умолчанию.

Вот например мы только что записали в set объект new MyClass(1, 34) и у нас в классе MyClass пока не переопределен hashCode и если мы теперь запишем в этот же set такой же объект new MyClass(1, 34) еще раз вот так – set.add(new MyClass(1, 34));, то в set уже будет ДВА элемента.

Почему же если мы записываем в hashset идентичные объекты, как ключи, то hashset рассматривает их как разные ключи?

То есть если мы создаем объект new MyClass(1, 34) в первый раз, то у него будет свой hashCode, когда мы создаем new MyClass(1, 34) второй раз, у него уже будет другой hashCode.

Если hashCode у добавляемых объектов разный, значит эти объекты с наибольшей вероятностью попадут в разные linkedlist-ы в 16 linkedlist-ах, если же они одинаковые, то объекты будут попадать в один и тот же linkedlist.

Нам нужно переопределить hashCode так, чтобы он возвращал данные объекта представленные одним восьмибитным числом.

То есть все значения полей объекта нам нужно каким-то образом скомпановать в одно восьмибитное число, которое будет возвращать hashCode.

И теперь hashCode всех идентичных объектов, например, new MyClass(1, 34) всегда будет возвращать один и тот же hashCode, так как он является скомпонованными полями объекта, а поля у идентичных объектов new MyClass(1, 34) одинаковые – 1 и 34.

HashSet еще будет сравнивать добавляемый в него объект со всеми уже присутствующими в hashset элементами методом equals и если он НЕ найдет там методом equals идентичный элемент, но при этом объект с таким hashCode уже там присутствует, то в hashset всё равно добавиться этот добавляемый объект и в итоге в нем будет два элемента с одинаковыми hashCode.

---

Переопределение HashCode

Пример программы:

import java.util.*; class MyClass implements Cloneable { int myA; SomeClass myB; MyClass(int myA, SomeClass myB){ this.myA = myA; this.myB = myB; } // hashCode – данные класса представлены одним восьмибитным числом. // По умолчанию, если не переопределять, это случайное уникальное число. @Override public int hashCode() { System.out.println(“HashCode is called: ” + this); // Это стандартное переопределение. Не заморачивайтесь почему 31, // почему умножение. нам лишь важно в result // добавить все поля класса, так как result это и есть // это самое восьмибитное число, состоящее из полей класса. final int prime = 31; int result = 1; // Числовые переменные просто добавляем. result = prime * result + myA; // У полей объектов вызываем hashCode. // Метод hashCode в классе этих объектов // тоже должен быть определен таким же образом. result = prime * result + myB.hashCode(); return result; } // equals обязательно тоже переопределяем, как уже было сказано @Override public boolean equals(Object obj) { System.out.println(“Equals is called:” + this + ” : ” + obj); if (this == obj) return true; if (obj == null) return false; if (getClass() != obj.getClass()) return false; MyClass other = (MyClass) obj; if (myA != other.myA) return false; if (!myB.equals(other.myB)) return false; return true; } @Override public String toString() { return “MyClass{” + “myA=” + myA + “, myB='” + myB + ‘\” + ‘}’; } @Override public SomeClass clone() throws CloneNotSupportedException { Object obj = super.clone(); SomeClass someClass = (SomeClass) obj; return someClass; } } class SomeClass implements Cloneable { int someVar; SomeClass(int someVar){ this.someVar = someVar; } // Здесь тоже переопределены hashCode и equals @Override public int hashCode() { System.out.println(“HashCode is called:” + this); final int prime = 31; int result = 1; result = prime * result + someVar; return result; } @Override public boolean equals(Object obj) { System.out.println(“Equals is called:” + this + ” : ” + obj); if (this == obj) return true; if (obj == null) return false; if (getClass() != obj.getClass()) return false; SomeClass other = (SomeClass) obj; if (someVar != other.someVar) return false; return true; } @Override public SomeClass clone() throws CloneNotSupportedException { Object obj = super.clone(); SomeClass someclass = (SomeClass)obj; return someclass; } public String toString(){ return “SomeClass{” + “someVar=” + someVar + ‘}’; } } public class hashCodeLesson { public static void main(String[] args) throws CloneNotSupportedException { Set< MyClass > set = new HashSet<>(); set.add(new MyClass(1, new SomeClass(34))); set.add(new MyClass(1, new SomeClass(36))); set.add(new MyClass(1, new SomeClass(34))); set.add(new MyClass(2, new SomeClass(26))); set.add(new MyClass(3, new SomeClass(75))); System.out.println(“SIZE:” + set.size()); // По результатам можно увидеть, что размер коллекции 4, // так как для 1 и 3 элементов хеш-коды одинаковые, // и equals сравнил поля, которые оказались одинаковыми. // Если бы hashCode не был переопределен, элементов было бы 5. } }

Вывод:

---

Последовательность добавления элементов в HashSet

Также стоит упомянуть некоторые детали последовательности добавления элементов в HashSet.

При добавлении ключа в HashSet и расчета его hashCode происходит сравнение этого hashCode с hashCode каждого элемента в HashSet, и если hashCode очередного добавляемого объекта отличается от всех остальных уже присутствующих в коллекции, то ключ добавляется СРАЗУ, без сравнения по equals.

Если же такой же hashCode нашелся, то происходит сравнение по equals, и если этим методом не найдет такого же элемента, то произойдет добавление.

В этом уроке был приведен пример стандартного переопределения hashCode.