java中重寫equals方法為什麼要重寫hashcode方法
參考博文:https://www.cnblogs.com/dolphin0520/p/3681042.html
hashcode方法作用
hashcode方法是Object類的本地方法,public native int hashcode(); Java中hashcode方法主要用於雜湊型別集合的正常執行,包括HashSet、HashMap以及HashTable。
如何判斷一個物件是否儲存在hashmap中?
當向集合中插入資料時,例如hashmap型別集合,如果直接呼叫equals方法一一比較,當資料量大時,會效率較低,向hashmap中存放的值會根據一定的規則生成hashcode值(也就是雜湊值),這個hashcode值放在類似table的結構中,當向hashmap中插入資料時,先從table中比較hashcode是否相等,如不相等則不插入,如相等則比較equals是否相等,如equals方法相等則不插入,如equals方法不相等則插入。hashmap的put方法實現如下:
public V put(K key, V value) { if (key == null) return putForNullKey(value); int hash = hash(key.hashCode()); int i = indexFor(hash, table.length); for (Entry<K,V> e = table[i]; e != null; e = e.next) { Object k; if (e.hash == hash && ((k = e.key) == key || key.equals(k))) { V oldValue = e.value; e.value = value; e.recordAccess(this); return oldValue; } } modCount++; addEntry(hash, key, value, i); return null; }
上面程式碼表示,put方法是用來向HashMap中新增新元素,會先呼叫hashCode方法得到該元素的hashCode值,然後檢視table中是否存在該hashCode值,如果存在則呼叫equals方法重新確定是否存在該元素,如果存在,則更新value值,否則將新的元素新增到HashMap中。從這裡可以看出,hashCode方法的存在是為了減少equals方法的呼叫次數,從而提高程式效率。
hashcode返回的不一定是物件的儲存地址,返回的值只是與儲存地址值有關聯,可以理解是儲存地址的對映,不同的JVM生產hashcode值的規則不同。
可以直接根據hashcode值判斷兩個物件是否相等嗎?肯定是不可以的,因為不同的物件可能會生成相同的hashcode值。雖然不能根據hashcode值判斷兩個物件是否相等,但是可以直接根據hashcode值判斷兩個物件不等,如果兩個物件的hashcode值不等,則必定是兩個不同的物件。如果要判斷兩個物件是否真正相等,必須通過equals方法。
也就是說對於兩個物件,如果呼叫equals方法得到的結果為true,則兩個物件的hashcode值必定相等;
如果equals方法得到的結果為false,則兩個物件的hashcode值不一定不同;
如果兩個物件的hashcode值不等,則equals方法得到的結果必定為false;
如果兩個物件的hashcode值相等,則equals方法得到的結果未知。
在重寫equals方法的同時,必須重寫hashCode方法。
package com.cxh.test1;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Set;
class People{
private String name;
private int age;
public People(String name,int age) {
this.name = name;
this.age = age;
}
public void setAge(int age){
this.age = age;
}
@Override
public boolean equals(Object obj) {
// TODO Auto-generated method stub
return this.name.equals(((People)obj).name) && this.age== ((People)obj).age;
}
}
public class Main {
public static void main(String[] args) {
People p1 = new People("Jack", 12);
System.out.println(p1.hashCode());
HashMap<People, Integer> hashMap = new HashMap<People, Integer>();
hashMap.put(p1, 1);
System.out.println(hashMap.get(new People("Jack", 12)));
}
}
在這裡我只重寫了equals方法,也就說如果兩個People物件,如果它的姓名和年齡相等,則認為是同一個人。
這段程式碼本來的意願是想這段程式碼輸出結果為“1”,但是事實上它輸出的是“null”。為什麼呢?原因就在於重寫equals方法的同時忘記重寫hashCode方法。
雖然通過重寫equals方法使得邏輯上姓名和年齡相同的兩個物件被判定為相等的物件(跟String類類似),但是要知道預設情況下,hashCode方法是將物件的儲存地址進行對映。那麼上述程式碼的輸出結果為“null”就不足為奇了。原因很簡單,p1指向的物件和
System.out.println(hashMap.get(new People("Jack", 12)));這句中的new People("Jack", 12)生成的是兩個物件,它們的儲存地址肯定不同。下面是HashMap的get方法的具體實現:
public V get(Object key) {
if (key == null)
return getForNullKey();
int hash = hash(key.hashCode());
for (Entry<K,V> e = table[indexFor(hash, table.length)];
e != null;
e = e.next) {
Object k;
if (e.hash == hash && ((k = e.key) == key || key.equals(k)))
return e.value;
}
return null;
}
所以在hashmap進行get操作時,因為得到的hashcdoe值不同(注意,上述程式碼也許在某些情況下會得到相同的hashcode值,不過這種概率比較小,因為雖然兩個物件的儲存地址不同也有可能得到相同的hashcode值),所以導致在get方法中for迴圈不會執行,直接返回null。
因此如果想上述程式碼輸出結果為“1”,很簡單,只需要重寫hashCode方法,讓equals方法和hashCode方法始終在邏輯上保持一致性。
package com.cxh.test1;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Set;
class People{
private String name;
private int age;
public People(String name,int age) {
this.name = name;
this.age = age;
}
public void setAge(int age){
this.age = age;
}
@Override
public int hashCode() {
// TODO Auto-generated method stub
return name.hashCode()*37+age;
}
@Override
public boolean equals(Object obj) {
// TODO Auto-generated method stub
return this.name.equals(((People)obj).name) && this.age== ((People)obj).age;
}
}
public class Main {
public static void main(String[] args) {
People p1 = new People("Jack", 12);
System.out.println(p1.hashCode());
HashMap<People, Integer> hashMap = new HashMap<People, Integer>();
hashMap.put(p1, 1);
System.out.println(hashMap.get(new People("Jack", 12)));
}
}
這樣一來的話,輸出結果就為“1”了。
下面這段話摘自Effective Java一書:
- 在程式執行期間,只要equals方法的比較操作用到的資訊沒有被修改,那麼對這同一個物件呼叫多次,hashCode方法必須始終如一地返回同一個整數。
- 如果兩個物件根據equals方法比較是相等的,那麼呼叫兩個物件的hashCode方法必須返回相同的整數結果。
- 如果兩個物件根據equals方法比較是不等的,則hashCode方法不一定得返回不同的整數。
對於第二條和第三條很好理解,但是第一條,很多時候就會忽略。在《Java程式設計思想》一書中的P495頁也有同第一條類似的一段話:
“設計hashCode()時最重要的因素就是:無論何時,對同一個物件呼叫hashCode()都應該產生同樣的值。如果在講一個物件用put()新增進HashMap時產生一個hashCdoe值,而用get()取出時卻產生了另一個hashCode值,那麼就無法獲取該物件了。所以如果你的hashCode方法依賴於物件中易變的資料,使用者就要當心了,因為此資料發生變化時,hashCode()方法就會生成一個不同的雜湊碼”。
package com.cxh.test1;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Set;
class People{
private String name;
private int age;
public People(String name,int age) {
this.name = name;
this.age = age;
}
public void setAge(int age){
this.age = age;
}
@Override
public int hashCode() {
// TODO Auto-generated method stub
return name.hashCode()*37+age;
}
@Override
public boolean equals(Object obj) {
// TODO Auto-generated method stub
return this.name.equals(((People)obj).name) && this.age== ((People)obj).age;
}
}
public class Main {
public static void main(String[] args) {
People p1 = new People("Jack", 12);
System.out.println(p1.hashCode());
HashMap<People, Integer> hashMap = new HashMap<People, Integer>();
hashMap.put(p1, 1);
p1.setAge(13);
System.out.println(hashMap.get(p1));
}
}
這段程式碼輸出的結果為“null”,想必其中的原因大家應該都清楚了。
因此,在設計hashCode方法和equals方法的時候,如果物件中的資料易變,則最好在equals方法和hashCode方法中不要依賴於該欄位。