重写 Java 中的 equals() 和 hashCode() 方法
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
以执行数值比较等。由于JavaHashMap
还依赖和方法来比较它们的和,因此 Java 提供了以下规则来重写这些方法: HashTable
equals()
hashCode()
key
values
- 自反性:对象必须等于其自身。
- 对称:如果
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
.
Java中equals和hashCode的约定
- 如果方法执行结果相同
equals
,那么它们hashcode
一定是相同的。 - 如果对象在方法执行的结果中不相等
equals
,那么它们hashcode
可以相同也可以不同。但是,为了提高性能,最好让不同的对象返回不同的代码。
Java中如何重写equals方法
-
@Override public boolean equals(Object obj) { /*1. Check*/
if (obj == this) { /*and return */ return true; }
-
Проверьте an object на
null
, а также проверьте, чтобы an objectы были одного типа. Не делайте проверку с помощьюinstanceof
так How такая проверка будет возвращатьtrue
для подклассов и будет работать правильно только в случае если ваш класс объявлен Howimmutable
. Вместо этого можно использовать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
определен Howpublic boolean equals(Object obj)
, но многие программисты ненароком перегружают метод:public boolean equals(Person obj)
- instead ofObject
в качестве аргумента используют Name своего класса (напр. Person). Эту ошибку сложно обнаружить из-заstatic binding
. Таким образом, если вы вызовете этот метод для an object своего класса, то метод не просто скомпorруется, а даже сделает это корректно. Однако, если вы положите ваш an object в коллекцию, напримерArrayList
и вызовете методcontains()
, работа которого основана на методеequals()
, то методcontains
не сможет обнаружить ваш an object. -
При переопределении метода
equals()
не проверять наnull
переменные, что в конечном итоге заканчиваетсяNullPointerException
при вызовеequals()
. Ниже представлен корректный code.firstname == guest.firstname || (firstname != null && firstname.equals(guest.firstname));
-
Третья распространенная ошибка это не переопределять метод
hashCode()
, а толькоequals()
. Вы обязаны переопределять оба методаequals()
иhashCode()
в Java. МетодhashCode
используется вhash
-коллекциях(напримерHashSet
), и чем меньше будет коллизий (одинаковый code при разных an objectх) тем эффективнее эти коллекции будут работать с an objectми вашего класса. -
Последняя распространенная ошибка программистов в том, что при переопределении метода
equals()
не сохраняется соответствие между методамиequals()
иcompareTo()
, что является неформальным требованием для избежания хранения дубликатов вSet (SortedSet, TreeSet)
.
Подсказки How писать в Java метод equals
-
Большинство IDE такие How NetBeans, Eclipse и IntelliJ IDEA обеспечивают поддержку генерации методов
equals()
иhashCode()
. В Eclipse нажмите правую кнопку -> source ->generate equals()
иhashCode()
. -
Если в классе есть уникальный бизнес-ключ, то будет достаточно сделать проверку только на equalsство этих полей. Как в нашем примере “id” - уникальный номер для каждого Person.
-
При переопределении
hashCode()
в Java удостоверьтесь в использовании всех полей, что были использованы в методеequals()
. -
String
和包装类等Integer
,Float
并Double
重写方法equals()
,但StringBuffer
不重写。 -
只要有可能,在 Java 中
immutable
使用final
变量来创建字段。 -
比较
String
对象时,请使用equals()
. 运算符==
。 -
逻辑上相等但从不同对象加载的两个对象
ClassLoader
不能相等。请记住,如果加载器类不同,则检查getClass()
将返回。false
-
在 . 方法上也使用
@Override
注释hashCode
,因为这可以防止微妙的错误,例如 . 的返回值int
。但是,有些程序员会返回long
.
GO TO FULL VERSION