當我們要學習hashcode()方法時,我們需要一步一步弄清楚以下這幾個方面:
1.hashcode()的由來
hashcode是jdk根據物件的地址或字串或數字算出來的int類型的數值,那麼是透過什麼算出來的呢?答案是hashtable(雜湊表),雜湊表就是根據關鍵碼值(Key value)而直接進行存取的資料結構。這樣的話可能太過於官方,在這裡說一下我的理解,hashcode就是透過一個函數映射得到的值,這個函數叫哈希函數,我們向函數中傳入一個key值,就會得到一個value值,通過哈希函數得到的value就是哈希值,即value=f(key)。那麼理解了hashcode之後,我們就知道hashcode()方法是做什麼用的了,hashcode()方法就是為了計算並回傳hashcode方法。
2.hashcode()的作用
雜湊表的主要好處就是它能夠提高查找效率。透過查看API我們可以發現,hashcode()是Object的方法,也可以說正常情況下所有類別的物件都夠調用hashcode()方法,在Java中,根據他能夠提高查找效率的特點,我們主要應用在為了配合基於雜湊的集合一起正常運行,這樣的雜湊集合包括HashSet、HashMap以及HashTable。集合中不允許重複的元素存在,那麼當我們需要加入一個新的元素時,如何判斷該元素已經存在了呢?也許大多數人都會想到呼叫equals方法來逐一比較,這個方法確實可行。但如果集合中已經存在一萬條數據或更多的數據,如果採用equals方法去逐一比較,效率必然是一個問題。此時hashCode方法的作用就體現出來了,當集合要新增新的物件時,先呼叫這個物件的hashCode方法,得到對應的hashcode值,實際上在HashMap的具體實作中會用一個table保存已經存進去的物件的hashcode值,如果table中沒有該hashcode值,它就可以直接存進去,不用再進行任何比較了;如果存在該hashcode值, 就調用它的equals方法與新元素進行比較,相同的話就不存了,不相同就散列其它的位址,所以這裡有一個衝突解決的問題,這樣一來實際呼叫equals方法的次數就大大降低了。下面這段程式碼是java.util.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中加入新的元素,從put方法的具體實作可知,會先呼叫hashCode方法得到該元素的hashCode值,然後查看table中是否存在該hashCode值,如果存在則呼叫equals方法重新確定是否存在該元素,如果存在,則更新value值,否則將新的元素新增至HashMap中。從這裡可以看出,hashCode方法的存在是為了減少equals方法的呼叫次數,進而提高程式效率。
3.hashcode()方法與equals()方法
在這裡需要注意幾個問題。判斷物件相等是否可以用hashcode()方法,答案是不可以必須用equals()方法。兩個不同物件可能hashcode相等,但兩個不同hashcode的物件一定不同。
另一個注意的問題:設計一個類別的時候為需要重寫equals方法,例如String類,但是千萬要注意,在重寫equals方法的同時,必須重寫hashCode方法。下面看一個只重寫了equals方法的例子:
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))); } }
如果兩個People對象,如果它的姓名和年齡相等,則認為是同一個人。這段程式碼本來的意願是想這段程式碼輸出結果為“1”,但事實上它輸出的是“null”。
雖然透過重寫equals方法使得邏輯上姓名和年齡相同的兩個物件被判定為相等的物件(跟String類別類似),但是要知道預設情況下,hashCode方法是將物件的儲存位址進行映射。那麼上述程式碼的輸出結果為「null」就不足為奇了。原因很簡單,p1指向的物件和System.out.println(hashMap.get(new People("Jack", 12)));這句中的new People("Jack", 12)產生的是兩個對象,它們的儲存位址肯定不同。所以在hashmap進行get操作時,因為得到的hashcdoe值不同直接回傳null。如果想上述程式碼輸出結果為“1”,很簡單,只需要重寫hashCode方法,讓equals方法和hashCode方法始終在邏輯上保持一致性。
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))); } }
下面引用Effective Java一書:
在程式執行期間,只要equals方法的比較操作用到的資訊沒有被修改,那麼對這同一個物件呼叫多次,hashCode方法必須一致地返回同一個整數。
如果兩個物件根據equals方法比較是相等的,那麼呼叫兩個物件的hashCode方法必須傳回相同的整數結果。
如果兩個物件根據equals方法比較是不等的,則hashCode方法不一定得傳回不同的整數。
對於第二條和第三條很好理解,但是第一條,很多時候就會忽略。在《Java程式設計思想》一書中的P495頁也有同第一條類似的一段話:
「設計hashCode()時最重要的因素是:無論何時,對同一個物件呼叫hashCode()都應該產生同樣的值。如果在講一個物件用put()加進HashMap時產生一個hashCdoe值,而用get()取出時卻產生了另一個hashCode值,那麼就無法取得該物件了。 ,hashCode()方法就會產生一個不同的雜湊碼」。