Переопределение методов equals() и hashCode() в Java
Equals
и hashCode
являются фундаментальными методами объявленные в классе Object
и содержатся в стандартных библиотеках Java.
Метод еquals()
используется для сравнения объектов, а hashCode
- для генерации целочисленного кода объекта.
Эти методы широко используются в стандартных библиотеках Java при вставке и извлечении объектов в HashMap
. Метод equal
также используется для обеспечения хранения только уникальных объектов в HashSet
и других Set
реализациях, а также в любых других случаях, когда нужно сравнивать объекты.
Реализация по умолчанию метода equals()
в классе java.lang.Object
сравнивает ссылки на адреса в памяти, которые хранят переменные, и возвращает true
только в том случае, если адреса совпадают, другими словами переменные ссылаются на один и тот же объект.
Java рекомендует переопределять методы equals()
и hashCode()
, если предполагается, что сравнение должно осуществляться в соответсвии с естественной логикой или бизнес-логикой. Многие классы в стандартных библиотеках Java переопределяют их, например в классе String
переопределяется equals
таким образом, что возвращается true
, если содержимое двух сравниваемых объектов одинаковое. В классе-обертке Integer
метод equal
переопределяется для выполнения численного сравнения, и так далее.
Так как HashMap
и HashTable
в Java полагаются на методы equals()
и hashCode()
для сравнения своих key
и values
, то Java предлагает следующие правила для переопределения этих методов:
- Рефлексивность: Объект должен равняться себе самому.
- Симметричность: если
a.equals(b)
возвращаетtrue
, тоb.equals(a)
должен тоже вернутьtrue
. - Транзитивность: если
a.equals(b)
возвращаетtrue
иb.equals(c)
тоже возвращаетtrue
, тоc.equals(a)
тоже должен возвращатьtrue
. - Согласованность: повторный вызов метода
equals()
должен возвращать одно и тоже значение до тех пор, пока какое-либо значение свойств объекта не будет изменено. То есть, если два объекта равны в Java, то они будут равны пока их свойства остаются неизменными. - Сравнение
null
: объект должны быть проверен наnull
. Если объект равенnull
, то метод должен вернутьfalse
, а неNullPointerException
. Например,a.equals(null)
должен вернутьfalse
.
Соглашение между equals и hashCode в Java
- Если объекты равны по результатам выполнения метода
equals
, тогда ихhashcode
должны быть одинаковыми. - Если объекты не равны по результатам выполнения метода
equals
, тогда ихhashcode
могут быть как одинаковыми, так и разными. Однако для повышения производительности, лучше, чтобы разные объекты возвращали разные коды.
Как переопределять метод equals в Java
-
@Override public boolean equals(Object obj) { /*1. Проверьте*/
if (obj == this) { /*и верните */ return true; }
Проверьте объект на
null
, а также проверьте, чтобы объекты были одного типа. Не делайте проверку с помощьюinstanceof
так как такая проверка будет возвращатьtrue
для подклассов и будет работать правильно только в случае если ваш класс объявлен какimmutable
. Вместо этого можно использоватьgetClass()
;if (obj == null || obj.getClass() != this.getClass()) { return false; }
Объявите переменную типа, который вы сравниваете, и приведите
obj
к этому типу. Потом сравнивайте каждый атрибут типа начиная с численных атрибутов (если имеются) потому что численные атрибуты проверяются быстрей. Сравнивайте атрибуты с помощью операторов И и ИЛИ (так называемыеshort-circuit logical operators
) для объединения проверок с другими атрибутами.Person guest = (Person) obj; return id == guest.id && (firstName == guest.firstName || (firstName != null && firstName.equals(guest.getFirstName()))) && (lastName == guest.lastName || (lastName != null && lastName .equals(guest.getLastName()))); }
/** * Person class with equals and hashcode implementation in Java * @author Javin Paul */
public class Person {
private int id;
private String firstName;
private String lastName;
public int getId() { return id; }
public void setId(int id) { this.id = id;}
public String getFirstName() { return firstName; }
public void setFirstName(String firstName) { this.firstName = firstName; }
public String getLastName() { return lastName; }
public void setLastName(String lastName) { this.lastName = lastName; }
@Override
public boolean equals(Object obj) {
if (obj == this) {
return true;
}
if (obj == null || obj.getClass() != this.getClass()) {
return false;
}
Person guest = (Person) obj;
return id == guest.id
&& (firstName == guest.firstName
|| (firstName != null &&firstName.equals(guest.getFirstName()))) && (lastName == guest.lastName
|| (lastName != null && lastName .equals(guest.getLastName())
));
}
@Override
public int hashCode() {
final int prime = 31;
int result = 1;
result = prime * result + ((firstName == null) ? 0 : firstName.hashCode()); result = prime * result + id; result = prime * result +
((lastName == null) ? 0 : lastName.hashCode()); return result;
}
}
Распространенные ошибки при переопределении equals в Java
Вместо того, чтобы переопределять метод
equals (Override)
программист перегружает его(Overload)
Синтаксис методаequals()
в классеObject
определен какpublic boolean equals(Object obj)
, но многие программисты ненароком перегружают метод:public boolean equals(Person obj)
- вместоObject
в качестве аргумента используют имя своего класса (напр. Person). Эту ошибку сложно обнаружить из-заstatic binding
. Таким образом, если вы вызовете этот метод для объекта своего класса, то метод не просто скомпилируется, а даже сделает это корректно. Однако, если вы положите ваш объект в коллекцию, напримерArrayList
и вызовете методcontains()
, работа которого основана на методеequals()
, то методcontains
не сможет обнаружить ваш объект.При переопределении метода
equals()
не проверять наnull
переменные, что в конечном итоге заканчиваетсяNullPointerException
при вызовеequals()
. Ниже представлен корректный код.firstname == guest.firstname || (firstname != null && firstname.equals(guest.firstname));
Третья распространенная ошибка это не переопределять метод
hashCode()
, а толькоequals()
. Вы обязаны переопределять оба методаequals()
иhashCode()
в Java. МетодhashCode
используется вhash
-коллекциях(напримерHashSet
), и чем меньше будет коллизий (одинаковый код при разных объектах) тем эффективнее эти коллекции будут работать с объектами вашего класса.Последняя распространенная ошибка программистов в том, что при переопределении метода
equals()
не сохраняется соответствие между методамиequals()
иcompareTo()
, что является неформальным требованием для избежания хранения дубликатов вSet (SortedSet, TreeSet)
.
Подсказки как писать в Java метод equals
Большинство IDE такие как NetBeans, Eclipse и IntelliJ IDEA обеспечивают поддержку генерации методов
equals()
иhashCode()
. В Eclipse нажмите правую кнопку -> source ->generate equals()
иhashCode()
.Если в классе есть уникальный бизнес-ключ, то будет достаточно сделать проверку только на равенство этих полей. Как в нашем примере “id” - уникальный номер для каждого Person.
При переопределении
hashCode()
в Java удостоверьтесь в использовании всех полей, что были использованы в методеequals()
.String
и классы-оболочки такие какInteger
,Float
иDouble
переопределяют методequals()
, ноStringBuffer
не переопределяет.При любой возможности делайте поля
immutable
используяfinal
переменные в Java.При сравнении
String
объектов используйтеequals()
вместо оператора==
.Два объекта которые логически равны, но загружены из разных
ClassLoader
не могут быть равными. Помните, что проверка с помощьюgetClass()
вернетfalse
если класс-загрузчик разный.Используйте
@Override
аннотацию также для методаhashCode
, так как это предупреждает неуловимые ошибки, например возвращаемое значение методаint
, однако некоторые программисты возвращаютlong
.
ПЕРЕЙДИТЕ В ПОЛНУЮ ВЕРСИЮ