hashCode与equals的区别与联系

为什么覆盖(不是重载)equals方法一定要覆盖hashCode方法

因为如果只覆盖了equals而没有覆盖hashCode, 则两个不同的instance a和b虽然equals结果(业务逻辑上)相等,但却会有不同的hashcode,这样hashmap里面会同时存在a和b,而实际上我们需要hashmap里面只能保存其中一个,因为从业务逻辑方向看它们是相等的. 

equals方法和hashCode方法如果不同时按你自己逻辑覆盖的话，HashMap就会出问题。比如你只覆盖了equals方法而没有覆盖hashCode方法，那么HashMap在第一步寻找链表的时候会出错，有同样值的两个对象Key1和Key2并不会指向同一个链表或桶，因为你没有提供自己的hashCode方法，那么就会使用Object的hashCode方法，该方法是根据内存地址来比较两个对象是否一致，由于Key1和Key2有不桶的内存地址，所以会指向不同的链表，这样HashMap会认为key2不存在，虽然我们期望Key1和Key2是同一个对象；反之如果只覆盖了hashCode方法而没有覆盖equals方法，那么虽然第一步操作会使Key1和Key2找到同一个链表，但是由于equals没有覆盖，那么在遍历链表的元素时，key1.equals(key2)也会失败(事实上Object的equals方法也是比较内存地址)，从而HashMap认为不存在Key2对象，这同样也是不正确的。

一、equals方法的作用

   1、默认情况（没有覆盖equals方法）下equals方法都是调用Object类的equals方法，而Object的equals方法主要用于判断对象的内存地址引用是不是同一个地址（是不是同一个对象）。

2 、要是类中覆盖了equals方法，那么就要根据具体的代码来确定equals方法的作用了，覆盖后一般都是通过对象的内容是否相等来判断对象是否相等。

没有覆盖equals方法代码如下：

[java] view plain copy

1. //学生类  
2. public class Student {  
3.     private int age;  
4.     private String name;  
5.       
6.     public Student() {  
7.     }  
8.     public Student(int age, String name) {  
9.         super();  
10.         this.age = age;  
11.         this.name = name;  
12.     }  
13.     public int getAge() {  
14.         return age;  
15.     }  
16.     public String getName() {  
17.         return name;  
18.     }  
19.     public void setAge(int age) {  
20.         this.age = age;  
21.     }  
22.     public void setName(String name) {  
23.         this.name = name;  
24.     }  
25. }  

测试 代码如下：

[java] view plain copy

1. import java.util.HashSet;  
2. import java.util.LinkedList;  
3. import java.util.Set;  
4.   
5.   
6. public class EqualsTest {  
7.     public static void main(String[] args) {  
8.         LinkedList<Student> list = new LinkedList<Student>();  
9.         Set<Student> set = new HashSet<Student>();  
10.         Student stu1  = new Student(3,"张三");  
11.         Student stu2  = new Student(3,"张三");  
12.         System.out.println("stu1 == stu2 : "+(stu1 == stu2));  
13.         System.out.println("stu1.equals(stu2) : "+stu1.equals(stu2));  
14.         list.add(stu1);  
15.         list.add(stu2);  
16.         System.out.println("list size:"+ list.size());  
17.           
18.         set.add(stu1);  
19.         set.add(stu2);  
20.         System.out.println("set size:"+ set.size());  
21.     }  
22.   
23. }  

运行结果：

stu1 == stu2 : false
stu1.equals(stu2) :  false
list size:2
set size:2

结果分析：Student类没有覆盖equals方法，stu1调用equals方法实际上调用的是Object的equals方法。所以采用对象内存地址是否相等来判断对象是否相等。因为是两个新对象所以对象的内存地址不相等，所以stu1.equals(stu2) 是false。

3、我们覆盖一下equals方法（age和name属性），让Student类其通过判断对象的内容是否相等来确定对象是否相等。

覆盖后的Student类：

[java] view plain copy

1. //学生类  
2. public class Student {  
3.     private int age;  
4.     private String name;  
5.       
6.     public Student() {  
7.     }  
8.     public Student(int age, String name) {  
9.         super();  
10.         this.age = age;  
11.         this.name = name;  
12.     }  
13.     public int getAge() {  
14.         return age;  
15.     }  
16.     public String getName() {  
17.         return name;  
18.     }  
19.     public void setAge(int age) {  
20.         this.age = age;  
21.     }  
22.     public void setName(String name) {  
23.         this.name = name;  
24.     }  
25.     @Override  
26.     public boolean equals(Object obj) {  
27.         if (this == obj)  
28.             return true;  
29.         if (obj == null)  
30.             return false;  
31.         if (getClass() != obj.getClass())  
32.             return false;  
33.         Student other = (Student) obj;  
34.         if (age != other.age)  
35.             return false;  
36.         if (name == null) {  
37.             if (other.name != null)  
38.                 return false;  
39.         } else if (!name.equals(other.name))  
40.             return false;  
41.         return true;  
42.     }  
43.       
44. }  

运行结果：

stu1 == stu2 : false
stu1.equals(stu2) : true
list size:2
set size:2

结果分析：因为Student两个对象的age和name属性相等，而且又是通过覆盖equals方法来判断的，所示stu1.equals(stu2) 为true。注意以上几次测试list和set的size都是2

二、HashCode

4、通过以上的代码运行，我们知道equals方法已经生效。接下来我们在覆盖一下hashCode方法（通过age和name属性来生成hashcode）并不覆盖equals方法，其中Hash码是通过age和name生成的。

覆盖hashcode后的Student类：

[java] view plain copy

1. //学生类  
2. public class Student {  
3.     private int age;  
4.     private String name;  
5.       
6.     public Student() {  
7.     }  
8.     public Student(int age, String name) {  
9.         super();  
10.         this.age = age;  
11.         this.name = name;  
12.     }  
13.     public int getAge() {  
14.         return age;  
15.     }  
16.     public String getName() {  
17.         return name;  
18.     }  
19.     public void setAge(int age) {  
20.         this.age = age;  
21.     }  
22.     public void setName(String name) {  
23.         this.name = name;  
24.     }  
25.     @Override  
26.     public int hashCode() {  
27.         final int prime = 31;  
28.         int result = 1;  
29.         result = prime * result + age;  
30.         result = prime * result + ((name == null) ? 0 : name.hashCode());  
31.         return result;  
32.     }     
33. }  

运行结果：

stu1 == stu2 : false
stu1.equals(stu2) : false
list size:2
hashCode :775943
hashCode :775943
set size:2

结果分析：我们并没有覆盖equals方法只覆盖了hashCode方法，两个对象虽然hashCode一样，但在将stu1和stu2放入set集合时由于equals方法比较的两个对象是false，所以就没有在比较两个对象的hashcode值。

5、我们覆盖一下equals方法和hashCode方法。

Student代码如下：

[java] view plain copy

1. //学生类  
2. public class Student {  
3.     private int age;  
4.     private String name;  
5.     public Student() {  
6.     }  
7.     public Student(int age, String name) {  
8.         super();  
9.         this.age = age;  
10.         this.name = name;  
11.     }  
12.     public int getAge() {  
13.         return age;  
14.     }  
15.     public String getName() {  
16.         return name;  
17.     }  
18.     public void setAge(int age) {  
19.         this.age = age;  
20.     }  
21.     public void setName(String name) {  
22.         this.name = name;  
23.     }  
24.     @Override  
25.     public int hashCode() {  
26.         final int prime = 31;  
27.         int result = 1;  
28.         result = prime * result + age;  
29.         result = prime * result + ((name == null) ? 0 : name.hashCode());  
30.         System.out.println("hashCode : "+ result);  
31.         return result;  
32.     }  
33.     @Override  
34.     public boolean equals(Object obj) {  
35.         if (this == obj)  
36.             return true;  
37.         if (obj == null)  
38.             return false;  
39.         if (getClass() != obj.getClass())  
40.             return false;  
41.         Student other = (Student) obj;  
42.         if (age != other.age)  
43.             return false;  
44.         if (name == null) {  
45.             if (other.name != null)  
46.                 return false;  
47.         } else if (!name.equals(other.name))  
48.             return false;  
49.         return true;  
50.     }  
51.       
52. }  

运行结果：

stu1 == stu2 : false

stu1.equals(stu2) :true

list size:2

hashCode :775943

hashCode :775943

set size:1

结果分析：stu1和stu2通过equals方法比较相等，而且返回的hashCode值一样，所以放入set集合中时只放入了一个对象。

6、下面我们让两个对象equals方法比较相等，但hashCode值不相等试试。

Student类的代码如下：

[java] view plain copy

1. //学生类  
2. public class Student {  
3.     private int age;  
4.     private String name;  
5.     <span style="color:#ff0000;">private static int index=5;</span>  
6.     public Student() {  
7.     }  
8.     public Student(int age, String name) {  
9.         super();  
10.         this.age = age;  
11.         this.name = name;  
12.     }  
13.     public int getAge() {  
14.         return age;  
15.     }  
16.     public String getName() {  
17.         return name;  
18.     }  
19.     public void setAge(int age) {  
20.         this.age = age;  
21.     }  
22.     public void setName(String name) {  
23.         this.name = name;  
24.     }  
25.     @Override  
26.     public int hashCode() {  
27.         final int prime = 31;  
28.         int result = 1;  
29.         result = prime * result + <span style="color:#ff0000;">(age+index++)</span>;  
30.         result = prime * result + ((name == null) ? 0 : name.hashCode());  
31.         <span style="color:#ff0000;">System.out.println("result :"+result);</span>  
32.         return result;  
33.     }  
34.     @Override  
35.     public boolean equals(Object obj) {  
36.         if (this == obj)  
37.             return true;  
38.         if (obj == null)  
39.             return false;  
40.         if (getClass() != obj.getClass())  
41.             return false;  
42.         Student other = (Student) obj;  
43.         if (age != other.age)  
44.             return false;  
45.         if (name == null) {  
46.             if (other.name != null)  
47.                 return false;  
48.         } else if (!name.equals(other.name))  
49.             return false;  
50.         return true;  
51.     }  
52.       
53. }  

运行结果：

stu1 == stu2 : falsestu1.equals(stu2) : truelist size:2hashCode :776098hashCode :776129set size:2

结果分析：虽然stu1和stu2通过equals方法比较相等，但两个对象的hashcode的值并不相等，所以在将stu1和stu2放入set集合中时认为是两个不同的对象。

7、修改stu1的某个属性值

Student代码如下：

[java] view plain copy

1. //学生类  
2. public class Student {  
3.     private int age;  
4.     private String name;  
5.     public Student() {  
6.     }  
7.     public Student(int age, String name) {  
8.         super();  
9.         this.age = age;  
10.         this.name = name;  
11.     }  
12.     public int getAge() {  
13.         return age;  
14.     }  
15.     public String getName() {  
16.         return name;  
17.     }  
18.     public void setAge(int age) {  
19.         this.age = age;  
20.     }  
21.     public void setName(String name) {  
22.         this.name = name;  
23.     }  
24.     @Override  
25.     public int hashCode() {  
26.         final int prime = 31;  
27.         int result = 1;  
28.         result = prime * result + age;  
29.         result = prime * result + ((name == null) ? 0 : name.hashCode());  
30.         System.out.println("hashCode : "+ result);  
31.         return result;  
32.     }  
33.     @Override  
34.     public boolean equals(Object obj) {  
35.         if (this == obj)  
36.             return true;  
37.         if (obj == null)  
38.             return false;  
39.         if (getClass() != obj.getClass())  
40.             return false;  
41.         Student other = (Student) obj;  
42.         if (age != other.age)  
43.             return false;  
44.         if (name == null) {  
45.             if (other.name != null)  
46.                 return false;  
47.         } else if (!name.equals(other.name))  
48.             return false;  
49.         return true;  
50.     }  
51.       
52. }  

测试代码如下：

[java] view plain copy

1. import java.util.HashSet;  
2. import java.util.LinkedList;  
3. import java.util.Set;  
4.   
5.   
6. public class EqualsTest {  
7.     public static void main(String[] args) {  
8.         LinkedList<Student> list = new LinkedList<Student>();  
9.         Set<Student> set = new HashSet<Student>();  
10.         Student stu1  = new Student(3,"张三");  
11.         Student stu2  = new Student(3,"张三");  
12.         System.out.println("stu1 == stu2 : "+(stu1 == stu2));  
13.         System.out.println("stu1.equals(stu2) : "+stu1.equals(stu2));  
14.         list.add(stu1);  
15.         list.add(stu2);  
16.         System.out.println("list size:"+ list.size());  
17.           
18.         set.add(stu1);  
19.         set.add(stu2);  
20.         System.out.println("set size:"+ set.size());  
21.         stu1.setAge(34);  
22.         System.out.println("remove stu1 : "+set.remove(stu1));  
23.         System.out.println("set size:"+ set.size());  
24.     }  
25.   
26. }  

运行结果：

stu1 == stu2 : falsestu1.equals(stu2) : truelist size:2hashCode : 775943hashCode : 775943set size:1hashCode : 776904remove stu1 : falseset size:1

结果分析：

当我们将某个对象存到set中时，如果该对象的属性参与了hashcode的计算，那么以后就不能修改该对象参与hashcode计算的那些属性了，否则会引起意向不到的错误的。正如测试中，不能够移除stu1对象。

map是一种以key value形式保存数据的结构，remove方法接收的参数是指map的key值。

总结：

1、equals方法用于比较对象的内容是否相等（覆盖以后）

2、hashcode方法只有在集合中用到

3、当覆盖了equals方法时，比较对象是否相等将通过覆盖后的equals方法进行比较（判断对象的内容是否相等）。

4、将对象放入到集合中时，首先判断要放入对象的hashcode值与集合中的任意一个元素的hashcode值是否相等，如果不相等直接将该对象放入集合中。如果hashcode值相等，然后再通过equals方法判断要放入对象与集合中的任意一个对象是否相等，如果equals判断不相等，直接将该元素放入到集合中，否则不放入。

5、将元素放入集合的流程图：

6、HashSet中add方法源代码：

[java] view plain copy

1. public boolean add(E e) {  
2.     return map.put(e, PRESENT)==null;  
3.     }  

map.put源代码: [java] view plain copy

1. <pre name="code" class="java"> public V put(K key, V value) {  
2.         if (key == null)  
3.             return putForNullKey(value);  
4.         int hash = hash(key.hashCode());  
5.         int i = indexFor(hash, table.length);  
6.         for (Entry<K,V> e = table[i]; e != null; e = e.next) {  
7.             Object k;  
8.             if (e.hash == hash && ((k = e.key) == key || key.equals(k))) {  
9.                 V oldValue = e.value;  
10.                 e.value = value;  
11.                 e.recordAccess(this);  
12.                 return oldValue;  
13.             }  
14.         }  
15.   
16.         modCount++;  
17.         addEntry(hash, key, value, i);  
18.         return null;  
19.     }</pre>  
20. <pre></pre>  
21. <pre></pre>  
22.