淺談Java中的hashcode方法

淺談Java中的hashcode方法

　　哈希表這個數據結構想必大多數人都不陌生，並且在不少地方都會利用到hash表來提升查找效率。在Java的Object類中有一個方法:

1	public native int hashCode();

　　根據這個方法的聲明可知，該方法返回一個int類型的數值，而且是本地方法，所以在Object類中並無給出具體的實現。

　　爲什麼Object類須要這樣一個方法？它有什麼做用呢？今天咱們就來具體探討一下hashCode方法。

一.hashCode方法的做用

　　對於包含容器類型的程序設計語言來講，基本上都會涉及到hashCode。在Java中也同樣，hashCode方法的主要做用是爲了配合基於散列的集合一塊兒正常運行，這樣的散列集合包括HashSet、HashMap以及HashTable。

　　爲何這麼說呢？考慮一種狀況，當向集合中插入對象時，如何判別在集合中是否已經存在該對象了？（注意：集合中不容許重複的元素存在）

　　也許大多數人都會想到調用equals方法來逐個進行比較，這個方法確實可行。可是若是集合中已經存在一萬條數據或者更多的數據，若是採用equals方法去逐一比較，效率必然是一個問題。此時hashCode方法的做用就體現出來了，當集合要添加新的對象時，先調用這個對象的hashCode方法，獲得對應的hashcode值，實際上在HashMap的具體實現中會用一個table保存已經存進去的對象的hashcode值，若是table中沒有該hashcode值，它就能夠直接存進去，不用再進行任何比較了；若是存在該hashcode值， 就調用它的equals方法與新元素進行比較，相同的話就不存了，不相同就散列其它的地址，因此這裏存在一個衝突解決的問題，這樣一來實際調用equals方法的次數就大大下降了，說通俗一點：Java中的hashCode方法就是根據必定的規則將與對象相關的信息（好比對象的存儲地址，對象的字段等）映射成一個數值，這個數值稱做爲散列值。下面這段代碼是java.util.HashMap的中put方法的具體實現：

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方法是用來向HashMap中添加新的元素，從put方法的具體實現可知，會先調用hashCode方法獲得該元素的hashCode值，而後查看table中是否存在該hashCode值，若是存在則調用equals方法從新肯定是否存在該元素，若是存在，則更新value值，不然將新的元素添加到HashMap中。從這裏能夠看出，hashCode方法的存在是爲了減小equals方法的調用次數，從而提升程序效率。

　　若是對於hash表這個數據結構的朋友不清楚，能夠參考這幾篇博文;

　　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返回的就是對象的存儲地址，事實上這種見解是不全面的，確實有些JVM在實現時是直接返回對象的存儲地址，可是大多時候並非這樣，只能說可能存儲地址有必定關聯。下面是HotSpot JVM中生成hash散列值的實現：

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; }

　　該實現位於hotspot/src/share/vm/runtime/synchronizer.cpp文件下。

　　所以有人會說，能夠直接根據hashcode值判斷兩個對象是否相等嗎？確定是不能夠的，由於不一樣的對象可能會生成相同的hashcode值。雖然不能根據hashcode值判斷兩個對象是否相等，可是能夠直接根據hashcode值判斷兩個對象不等，若是兩個對象的hashcode值不等，則一定是兩個不一樣的對象。若是要判斷兩個對象是否真正相等，必須經過equals方法。

　　也就是說對於兩個對象，若是調用equals方法獲得的結果爲true，則兩個對象的hashcode值一定相等；

　　若是equals方法獲得的結果爲false，則兩個對象的hashcode值不必定不一樣；

　　若是兩個對象的hashcode值不等，則equals方法獲得的結果一定爲false；

　　若是兩個對象的hashcode值相等，則equals方法獲得的結果未知。

二.equals方法和hashCode方法

　　在有些狀況下，程序設計者在設計一個類的時候爲須要重寫equals方法，好比String類，可是千萬要注意，在重寫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

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方法的具體實現：

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進行get操做時，由於獲得的hashcdoe值不一樣（注意，上述代碼也許在某些狀況下會獲得相同的hashcode值，不過這種機率比較小，由於雖然兩個對象的存儲地址不一樣也有可能獲得相同的hashcode值），因此致使在get方法中for循環不會執行，直接返回null。

　　所以若是想上述代碼輸出結果爲「1」，很簡單，只須要重寫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)));     } }

　　這樣一來的話，輸出結果就爲「1」了。

　　下面這段話摘自Effective Java一書：

• 在程序執行期間，只要equals方法的比較操做用到的信息沒有被修改，那麼對這同一個對象調用屢次，hashCode方法必須始終如一地返回同一個整數。
• 若是兩個對象根據equals方法比較是相等的，那麼調用兩個對象的hashCode方法必須返回相同的整數結果。
• 若是兩個對象根據equals方法比較是不等的，則hashCode方法不必定得返回不一樣的整數。

　　對於第二條和第三條很好理解，可是第一條，不少時候就會忽略。在《Java編程思想》一書中的P495頁也有同第一條相似的一段話：

　　「設計hashCode()時最重要的因素就是：不管什麼時候，對同一個對象調用hashCode()都應該產生一樣的值。若是在講一個對象用put()添加進HashMap時產生一個hashCdoe值，而用get()取出時卻產生了另外一個hashCode值，那麼就沒法獲取該對象了。因此若是你的hashCode方法依賴於對象中易變的數據，用戶就要小心了，由於此數據發生變化時，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

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方法中不要依賴於該字段。

　　以上屬我的理解，若有不正之處，歡迎批評指正。