淺談Java中的hashcode方法
哈希表這個(gè)數據結構想必大多數人都不陌生,而且在很多地方都會(huì )利用到hash表來(lái)提高查找效率。在Java的Object類(lèi)中有一個(gè)方法:
1 | public native int hashCode(); |
根據這個(gè)方法的聲明可知,該方法返回一個(gè)int類(lèi)型的數值,并且是本地方法,因此在Object類(lèi)中并沒(méi)有給出具體的實(shí)現。
為何Object類(lèi)需要這樣一個(gè)方法?它有什么作用呢?今天我們就來(lái)具體探討一下hashCode方法。
對于包含容器類(lèi)型的程序設計語(yǔ)言來(lái)說(shuō),基本上都會(huì )涉及到hashCode。在Java中也一樣,hashCode方法的主要作用是為了配合基于散列的集合一起正常運行,這樣的散列集合包括HashSet、HashMap以及HashTable。
為什么這么說(shuō)呢?考慮一種情況,當向集合中插入對象時(shí),如何判別在集合中是否已經(jīng)存在該對象了?(注意:集合中不允許重復的元素存在)
也許大多數人都會(huì )想到調用equals方法來(lái)逐個(gè)進(jìn)行比較,這個(gè)方法確實(shí)可行。但是如果集合中已經(jīng)存在一萬(wàn)條數據或者更多的數據,如果采用equals方法去逐一比較,效率必然是一個(gè)問(wèn)題。此時(shí)hashCode方法的作用就體現出來(lái)了,當集合要添加新的對象時(shí),先調用這個(gè)對象的hashCode方法,得到對應的hashcode值,實(shí)際上在HashMap的具體實(shí)現中會(huì )用一個(gè)table保存已經(jīng)存進(jìn)去的對象的hashcode值,如果table中沒(méi)有該hashcode值,它就可以直接存進(jìn)去,不用再進(jìn)行任何比較了;如果存在該hashcode值, 就調用它的equals方法與新元素進(jìn)行比較,相同的話(huà)就不存了,不相同就散列其它的地址,所以這里存在一個(gè)沖突解決的問(wèn)題,這樣一來(lái)實(shí)際調用equals方法的次數就大大降低了,說(shuō)通俗一點(diǎn):Java中的hashCode方法就是根據一定的規則將與對象相關(guān)的信息(比如對象的存儲地址,對象的字段等)映射成一個(gè)數值,這個(gè)數值稱(chēng)作為散列值。下面這段代碼是java.util.HashMap的中put方法的具體實(shí)現:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | 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方法是用來(lái)向HashMap中添加新的元素,從put方法的具體實(shí)現可知,會(huì )先調用hashCode方法得到該元素的hashCode值,然后查看table中是否存在該hashCode值,如果存在則調用equals方法重新確定是否存在該元素,如果存在,則更新value值,否則將新的元素添加到HashMap中。從這里可以看出,hashCode方法的存在是為了減少equals方法的調用次數,從而提高程序效率。
如果對于hash表這個(gè)數據結構的朋友不清楚,可以參考這幾篇博文;
http://www.cnblogs.com/jiewei915/archive/2010/08/09/1796042.html
http://www.cnblogs.com/dolphin0520/archive/2012/09/28/2700000.html
http://www.java3z.com/cwbwebhome/article/article8/83560.html?id=4649
有些朋友誤以為默認情況下,hashCode返回的就是對象的存儲地址,事實(shí)上這種看法是不全面的,確實(shí)有些JVM在實(shí)現時(shí)是直接返回對象的存儲地址,但是大多時(shí)候并不是這樣,只能說(shuō)可能存儲地址有一定關(guān)聯(lián)。下面是HotSpot JVM中生成hash散列值的實(shí)現:
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 | static inline intptr_t get_next_hash(Thread * Self, oop obj) { intptr_t value = 0 ; if (hashCode == 0) { // This form uses an unguarded global Park-Miller RNG, // so it's possible for two threads to race and generate the same RNG. // On MP system we'll have lots of RW access to a global, so the // mechanism induces lots of coherency traffic. value = os::random() ; } else if (hashCode == 1) { // This variation has the property of being stable (idempotent) // between STW operations. This can be useful in some of the 1-0 // synchronization schemes. intptr_t addrBits = intptr_t(obj) >> 3 ; value = addrBits ^ (addrBits >> 5) ^ GVars.stwRandom ; } else if (hashCode == 2) { value = 1 ; // for sensitivity testing } else if (hashCode == 3) { value = ++GVars.hcSequence ; } else if (hashCode == 4) { value = intptr_t(obj) ; } else { // Marsaglia's xor-shift scheme with thread-specific state // This is probably the best overall implementation -- we'll // likely make this the default in future releases. unsigned t = Self->_hashStateX ; t ^= (t << 11) ; Self->_hashStateX = Self->_hashStateY ; Self->_hashStateY = Self->_hashStateZ ; Self->_hashStateZ = Self->_hashStateW ; unsigned v = Self->_hashStateW ; v = (v ^ (v >> 19)) ^ (t ^ (t >> 8)) ; Self->_hashStateW = v ; value = v ; } value &= markOopDesc::hash_mask; if (value == 0) value = 0xBAD ; assert (value != markOopDesc::no_hash, "invariant") ; TEVENT (hashCode: GENERATE) ; return value;} |
該實(shí)現位于hotspot/src/share/vm/runtime/synchronizer.cpp文件下。
因此有人會(huì )說(shuō),可以直接根據hashcode值判斷兩個(gè)對象是否相等嗎?肯定是不可以的,因為不同的對象可能會(huì )生成相同的hashcode值。雖然不能根據hashcode值判斷兩個(gè)對象是否相等,但是可以直接根據hashcode值判斷兩個(gè)對象不等,如果兩個(gè)對象的hashcode值不等,則必定是兩個(gè)不同的對象。如果要判斷兩個(gè)對象是否真正相等,必須通過(guò)equals方法。
也就是說(shuō)對于兩個(gè)對象,如果調用equals方法得到的結果為true,則兩個(gè)對象的hashcode值必定相等;
如果equals方法得到的結果為false,則兩個(gè)對象的hashcode值不一定不同;
如果兩個(gè)對象的hashcode值不等,則equals方法得到的結果必定為false;
如果兩個(gè)對象的hashcode值相等,則equals方法得到的結果未知。
在有些情況下,程序設計者在設計一個(gè)類(lèi)的時(shí)候為需要重寫(xiě)equals方法,比如String類(lèi),但是千萬(wàn)要注意,在重寫(xiě)equals方法的同時(shí),必須重寫(xiě)hashCode方法。為什么這么說(shuō)呢?
下面看一個(gè)例子:
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 | 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))); }} |
在這里我只重寫(xiě)了equals方法,也就說(shuō)如果兩個(gè)People對象,如果它的姓名和年齡相等,則認為是同一個(gè)人。
這段代碼本來(lái)的意愿是想這段代碼輸出結果為“1”,但是事實(shí)上它輸出的是“null”。為什么呢?原因就在于重寫(xiě)equals方法的同時(shí)忘記重寫(xiě)hashCode方法。
雖然通過(guò)重寫(xiě)equals方法使得邏輯上姓名和年齡相同的兩個(gè)對象被判定為相等的對象(跟String類(lèi)類(lèi)似),但是要知道默認情況下,hashCode方法是將對象的存儲地址進(jìn)行映射。那么上述代碼的輸出結果為“null”就不足為奇了。原因很簡(jiǎn)單,p1指向的對象和
System.out.println(hashMap.get(new People("Jack", 12)));這句中的new People("Jack", 12)生成的是兩個(gè)對象,它們的存儲地址肯定不同。下面是HashMap的get方法的具體實(shí)現:
1 2 3 4 5 6 7 8 9 10 11 12 13 | 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進(jìn)行g(shù)et操作時(shí),因為得到的hashcdoe值不同(注意,上述代碼也許在某些情況下會(huì )得到相同的hashcode值,不過(guò)這種概率比較小,因為雖然兩個(gè)對象的存儲地址不同也有可能得到相同的hashcode值),所以導致在get方法中for循環(huán)不會(huì )執行,直接返回null。
因此如果想上述代碼輸出結果為“1”,很簡(jiǎn)單,只需要重寫(xiě)hashCode方法,讓equals方法和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 | 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))); }} |
這樣一來(lái)的話(huà),輸出結果就為“1”了。
下面這段話(huà)摘自Effective Java一書(shū):
對于第二條和第三條很好理解,但是第一條,很多時(shí)候就會(huì )忽略。在《Java編程思想》一書(shū)中的P495頁(yè)也有同第一條類(lèi)似的一段話(huà):
“設計hashCode()時(shí)最重要的因素就是:無(wú)論何時(shí),對同一個(gè)對象調用hashCode()都應該產(chǎn)生同樣的值。如果在講一個(gè)對象用put()添加進(jìn)HashMap時(shí)產(chǎn)生一個(gè)hashCdoe值,而用get()取出時(shí)卻產(chǎn)生了另一個(gè)hashCode值,那么就無(wú)法獲取該對象了。所以如果你的hashCode方法依賴(lài)于對象中易變的數據,用戶(hù)就要當心了,因為此數據發(fā)生變化時(shí),hashCode()方法就會(huì )生成一個(gè)不同的散列碼”。
下面舉個(gè)例子:
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 | 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方法的時(shí)候,如果對象中的數據易變,則最好在equals方法和hashCode方法中不要依賴(lài)于該字段。
以上屬個(gè)人理解,如有不正之處,歡迎批評指正。
聯(lián)系客服