关于 equals() 和 hashcode() 你需要知道的一切

1. equal() 和 == 的区别是什么?

要理解 equals() 方法,就必须从 == 开始讲起了。

== 的作用很简单,就是判断两个对象的地址是不是相等(基本数据类型比较的是值,引用数据类型比较的是地址)。

那么 equal() 方法呢?它是 Object 对象的一个方法,因为所有类都继承自 Object,所以所有类都有 equal() 方法。我们可以看看 Object 的源码中的 equal() 方法到底是长什么样的:

1
2
3
public boolean equals(Object obj) {
return (this == obj);
}

你会想,这不就是和 == 一样??是的,的确是一模一样,那么为什么还需要多弄出一个 equals() 方法呢?其实 equals() 方法就是 Java 提供给我们让我们重写的。一般,我们使用 equals() 方法来比较两个对象的内容是否相等,来看下面这个例子:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
/**
* @Author shenghai
* @Date 4/19 19:03
*/
public class test {
public static void main(String[] args) {
Person p1 = new Person("abc", 111);
Person p2 = new Person("abc", 111);
System.out.printf("p1.equals(p2) : %s\n", p1.equals(p2));
System.out.printf("p1==p2 : %s\n", p1==p2);
}

private static class Person {
int age;
String name;

public Person(String name, int age) {
this.name = name;
this.age = age;
}

@Override
public boolean equals(Object obj){
if(obj == null) {
return false;
}

if(this == obj) {
return true;
}

// 一般都需要判断是否类型相同
if(this.getClass() != obj.getClass()) {
return false;
}

Person person = (Person) obj;
return name.equals(person.name) && age==person.age; //这里name后的equals是String类重写的
}
}
}

/**
* 运行结果:
* p1.equals(p2) : true
* p1==p2 : false
*/

可以看到,在 Person 对象中,我们重写了 equals() 方法,主要的逻辑在最后一句,判断 Person 类的字段 nameage是否都相等。这样,我们就使用了新的规则来判断两个 Person 对象是否相等,而不是使用原始的 == 来判断两个 Person 对象的地址是否相等。

2. hashCode() 的作用

和 equals() 一样,hashCode() 也是 Object 类中的一个方法,它是一个 native 方法(即JNI方法,Java Native Interface,源码用C写的)。

1
public native int hashCode();

hashCode() 的作用是获取哈希码,它实际上是返回一个int整数。这个哈希码的作用是确定该对象在哈希表中的位置。因此,hashCode() 只有在哈希表中才有用,在其他情况下都是没用的。这里的哈希表包括 HashMap、HashSet、HashTable等。

那么为什么要有 hashCode 呢?

以稍微简单一些的 HashSet 为例,当你将对象加入 HashSet 时,HashSet 会先计算对象的hashCode值来获得对象加入的位置,同时也会与该位置其他已经加入的对象的hashCode值进行比较,这个时候就会调用 equals() 方法来检查 hashCode 相等的对象是否“真的相等”(即用我们自己重写的 equals() 方法来判断)。如果“真的相等”,HashSet 就不会让其加入操作成功。如果不相等,那么就发生了哈希碰撞,会将这个对象重哈希到其他位置。

3. hashCode() 与 equals() 的关系

这里需要分为两种情况来讨论。

3.1 没有在哈希表中使用

这里的意思是说,假设我们有一个对象Obj,但是我们没有在HashSet, Hashtable, HashMap等等这些本质是散列表的数据结构中,用到这个对象。

那么,这种情况下,无论你怎么重写 equals() 方法,都跟hashCode() 方法一点关系都没有!!

3.2 在哈希表中使用

但是,如果我们使用到了哈希表,我们就需要保证:如果两个对象相等,那么它们的 hashCode 值一定相同(这里的相等是指,通过equals()比较两个对象时返回true)。

因此,在这样的情况下,如果要判断两个对象是否相等,除了要重写 equals() 方法外,也要重写 hashCode() 方法。

假设我们只重写了 equals() 方法,没有重写 hashCode() 方法,那么即使在两个对象相等的时候( equals() 方法返回true),这两个对象还是没有办法哈希到同一个地址下,这时候使用哈希表就会出问题。

举个例子:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
import java.util.HashSet;

/**
* @Author shenghai
* @Date 4/20 13:20
*/
public class test1 {
public static void main(String[] args) {
// 新建Person对象,
Person p1 = new Person("abc", 111);
Person p2 = new Person("abc", 111);
Person p3 = new Person("ccc", 200);

// 新建HashSet对象
HashSet<Person> set = new HashSet<>();
set.add(p1);
set.add(p2);
set.add(p3);

// 比较p1 和 p2, 并打印它们的hashCode()
System.out.printf("p1.equals(p2) : %s; p1(%d) p2(%d)\n", p1.equals(p2), p1.hashCode(), p2.hashCode());
// 打印set
System.out.printf("set:%s\n", set);
}

private static class Person {
int age;
String name;

public Person(String name, int age) {
this.name = name;
this.age = age;
}

@Override
public boolean equals(Object obj) {
if(obj == null) {
return false;
}

if(this == obj) {
return true;
}

// 一般都需要判断是否类型相同
if(this.getClass() != obj.getClass()) {
return false;
}

Person person = (Person)obj;
return name.equals(person.name) && age==person.age;
}
}
}

/**
* 运行结果:
* p1.equals(p2) : true; p1(460141958) p2(1163157884)
* set:[euqalsAndHashcode.test1$Person@74a14482, euqalsAndHashcode.test1$Person@4554617c,
* euqalsAndHashcode.test1$Person@1b6d3586]
*/

这个时候,尽管我们使用 equals() 方法能够返回true。但是显然,在将 p1 和 p2 添加进 HashSet 的时候,HashSet 仍然判定这两个对象不相等。

为什么会出现这种情况呢?这是因为虽然 p1 和 p2 的内容相等,但是它们的hashCode()不等;所以,HashSet在添加p1和p2的时候,认为它们不相等。所以,我们现在重写 hashCode() 方法试试。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
import java.util.HashSet;
import java.util.Objects;

/**
* @Author shenghai
* @Date 4/20 13:20
*/
public class test2 {
public static void main(String[] args) {
// 新建Person对象,
Person p1 = new Person("abc", 111);
Person p2 = new Person("abc", 111);
Person p3 = new Person("ccc", 200);

// 新建HashSet对象
HashSet<Person> set = new HashSet<>();
set.add(p1);
set.add(p2);
set.add(p3);

// 比较p1 和 p2, 并打印它们的hashCode()
System.out.printf("p1.equals(p2) : %s; p1(%d) p2(%d)\n", p1.equals(p2), p1.hashCode(), p2.hashCode());
// 打印set
System.out.printf("set:%s\n", set);
}

private static class Person {
int age;
String name;

public Person(String name, int age) {
this.name = name;
this.age = age;
}

@Override
public boolean equals(Object obj) {
if(obj == null) {
return false;
}

if(this == obj) {
return true;
}

// 一般都需要判断是否类型相同
if(this.getClass() != obj.getClass()) {
return false;
}

Person person = (Person)obj;
return name.equals(person.name) && age==person.age;
}

@Override
public int hashCode() {
return Objects.hash(age, name);
}
}
}

/**
* 运行结果:
* p1.equals(p2) : true; p1(100756) p2(100756)
* set:[euqalsAndHashcode.test2$Person@18994, euqalsAndHashcode.test2$Person@19bfc]
*/

重写了 equals() 方法和 hashCode() 方法之后,一切就都没有问题啦~

最后,总结一下 equals() 方法和 hashCode() 方法的相关规定:

  1. 如果两个对象相等,则它们的hashCode一定也是相同的。
  2. 如果两个对象相等,那么对它们分别调用 equals() 方法一定都返回true
  3. 如果两个对象有相同的 hashCode 值,它们也不一定相等。
  4. 如果用到了哈希表,且 euqals() 方法被重写,则 hashCode() 方法也必须要重写。