前段时间有朋友问我:“你重写过
hashcode
和equals
么,为什么重写equals
时必须重写hashCode
方法?”
之前的学习中有深入了解过,后来很久没复习了,淡忘许多,回答的时候也有很多地方卡壳,干脆就总结一下这方面的知识点,也方便以后查看复习。
hashCode()介绍
首先先介绍一下
hashCode()
,hashCode()
的作用是获取哈希码,也称为散列码;它实际上是返回一个int
整数。这个哈希码的作用是确定该对象在哈希表中的索引位置。hashCode()
定义 在 JDK 的Object.java
中,这就意味着
Java 中的任何类都包含有hashCode()
函数。
散列表存储的是键值对(key-value)
,它的特点是:能根据“键”快速的检索出对应的“值”。这其中就利用到了散列码!(可以快速找到所需要的对象)
为什么要有hashCode()
我们以“HashSet 如何检查重复”为例子来说明为什么要有
hashCode
:
当你把对象加入HashSet
时,HashSet
会先计算对象的hashcode
值来判断对象加入的位置,同时也会与其他已经加入的对象的hashcode
值作比较,如果没有相符的hashcode
,HashSet
会假设对象没有重复出现。但是如果发现有相同hashcode
值的对象,这时会调用equals()
方法来检查hashcode
相等的对象是否真的相同。如果两者相同,HashSet
就不会让其加入操作成功。
如果不同的话,就会重新散列到其他位置。(摘自我的 Java 启蒙书《Headfirst java》第二版)。这样我们就大大减少了equals
的次数,相应就大大提高了执行速度。
equals方法介绍
Object
类中的equals
方法用于检测一个对象是否等于另外一个对象。在Object
类中,这个方法将判断两个对象是否具有相同的引用。如果两个对象具有相同的引用,它们一定是相等的。
equals 方法的实现源码如下:
public boolean equals(Object obj) {
return (this == obj);
}
通常情况下,我们要判断两个对象是否相等,一定要重写 equals
方法,这就是为什么要重写 equals
方法的原因。
介绍完hashCode
方法以及equals
方法后,那么为什么要设计成hashCode
方法和equals
方法共同协作来判断两个对象是否相等?原因就出在“性能”二字上!!
当我们对比两个对象是否相等时,我们就可以先使用
hashCode
进行比较,如果比较的结果是true
,那么就可以使用equals
再次确认两个对象是否相等,如果比较的结果是true
,那么这两个对象就是相等的,否则其他情况就认为两个对象不相等。这样就大大的提升了对象比较的效率,这也是为什么Java
设计使用hashCode
和equals
协同的方式,来确认两个对象是否相等的原因。
能不能直接使用hashCode
方法就确定两个对象是否相等呢?
答:不能,这是因为不同对象的
hashCode
可能相同;但hashCode
不同的对象一定不相等,所以使用hashCode
可以起到快速初次判断对象是否相等的作用。
接下来回答我们最开始的问题。
为什么要一起重写?
我们来看一个例子:Set 集合的“异常”(我们都知道Set具有去重的作用)
import java.util.HashSet;
import java.util.Objects;
import java.util.Set;
public class EqualsExample {
public static void main(String[] args) {
// 对象 1
Persion p1 = new Persion();
p1.setName("Java");
p1.setAge(18);
// 对象 2
Persion p2 = new Persion();
p2.setName("Java");
p2.setAge(18);
// 创建 Set 集合
Set<Persion> set = new HashSet<Persion>();
set.add(p1);
set.add(p2);
// 打印 Set 中的所有数据
set.forEach(p -> {
System.out.println(p);
});
}
}
class Persion {
private String name;
private int age;
// 只重写了 equals 方法
@Override
public boolean equals(Object o) {
if (this == o) return true; // 引用相等返回 true
// 如果等于 null,或者对象类型不同返回 false
if (o == null || getClass() != o.getClass()) return false;
// 强转为自定义 Persion 类型
Persion persion = (Persion) o;
// 如果 age 和 name 都相等,就返回 true
return age == persion.age &&
Objects.equals(name, persion.name);
}
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public int getAge() {
return age;
}
public void setAge(int age) {
this.age = age;
}
@Override
public String toString() {
return "Persion{" +
"name='" + name + '\'' +
", age=" + age +
'}';
}
}
以上程序的执行结果,如下图所示:
从上述代码和上述图片可以看出,即使两个对象是相等的,Set 集合竟然没有将二者进行去重与合并。这就是重写了 equals 方法,但没有重写 hashCode 方法的问题所在。
为了尝试解决这个问题,我们试着来把hashCode方法也重写,实现代码如下:
import java.util.HashSet;
import java.util.Objects;
import java.util.Set;
public class EqualsToListExample {
public static void main(String[] args) {
// 对象 1
Persion p1 = new Persion();
p1.setName("Java");
p1.setAge(18);
// 对象 2
Persion p2 = new Persion();
p2.setName("Java");
p2.setAge(18);
// 创建 Set 对象
Set<Persion> set = new HashSet<Persion>();
set.add(p1);
set.add(p2);
// 打印 Set 中的所有数据
set.forEach(p -> {
System.out.println(p);
});
}
}
class Persion {
private String name;
private int age;
@Override
public boolean equals(Object o) {
if (this == o) return true; // 引用相等返回 true
// 如果等于 null,或者对象类型不同返回 false
if (o == null || getClass() != o.getClass()) return false;
// 强转为自定义 Persion 类型
Persion persion = (Persion) o;
// 如果 age 和 name 都相等,就返回 true
return age == persion.age &&
Objects.equals(name, persion.name);
}
@Override
public int hashCode() {
// 对比 name 和 age 是否相等
return Objects.hash(name, age);
}
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public int getAge() {
return age;
}
public void setAge(int age) {
this.age = age;
}
@Override
public String toString() {
return "Persion{" +
"name='" + name + '\'' +
", age=" + age +
'}';
}
}
以上程序的执行结果,如下图所示:
通过上述结果可以看出,当我们一起重写了两个方法之后,奇迹的事情又发生了,Set 集合又恢复正常了,这是为什么呢?
原因分析
出现以上问题的原因是,如果只重写了
equals
方法,那么默认情况下,Set
进行去重操作时,会先判断两个对象的hashCode
是否相同,此时因为没有重写hashCode
方法,所以会直接执行Object
中的hashCode
方法,而Object
中的hashCode
方法对比的是两个不同引用地址的对象,所以结果是false
,那么equals
方法就不用执行了,直接返回的结果就是false
:两个对象不是相等的,于是就在Set
集合中插入了两个相同的对象。
但是,如果在重写equals
方法时,也重写了hashCode
方法,那么在执行判断时会去执行重写的hashCode
方法,此时对比的是两个对象的所有属性的hashCode
是否相同,于是调用hashCode
返回的结果就是true
,再去调用equals
方法,发现两个对象确实是相等的,于是就返回true
了,因此Set
集合就不会存储两个一模一样的数据了,于是整个程序的执行就正常了。
最后总结
hashCode
和equals
两个方法是用来协同判断两个对象是否相等的,采用这种方式的原因是可以提高程序插入和查询的速度,如果在重写equals
时,不重写hashCode
,就会导致在某些场景下,例如将两个相等的自定义对象存储在Set
集合时,就会出现程序执行的异常,为了保证程序的正常执行,所以我们就需要在重写equals
时,也一并重写hashCode
方法才行。
hashCode()与 equals()的相关规定
- 如果两个对象相等,则
hashcode
一定也是相同的- 两个对象相等,对两个对象分别调用
equals
方法都返回true
- 两个对象有相同的
hashcode
值,它们也不一定是相等的- 因此,
equals
方法被覆盖过,则hashCode
方法也必须被覆盖hashCode()
的默认行为是对堆上的对象产生独特值。如果没有重写hashCode()
,则该class
的两 个对象无论如何都不会相等(即使这两个对象指向相同的数据)
最后感谢一下我的老师磊哥,很多地方老师上课都讲过,很久没用就老忘记,最后不得不翻阅老师的笔记之后才总结出来。