Java Hashcode
哈希值這個應該都聽過,並且用於hashMap, hashSet, HashTable.後面對這三個進行詳細說明。
哈希表這個數據結構想必大多數人都不陌生,而且在很多地方都會利用到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方法的具體實現:JDK1.8之前code, JDK1.8對put又進行了重寫。
1 public V put(K key, V value) { 2 if (table == EMPTY_TABLE) { 3 inflateTable(threshold); 4 } 5 if (key == null) 6 return putForNullKey(value); 7 int hash = hash(key); 8 int i = indexFor(hash, table.length); 9 for(Entry<K,V> e = table[i]; e != null; e = e.next) { 10 Object k; 11 if (e.hash == hash && ((k = e.key) == key || key.equals(k))) { 12 V oldValue = e.value; 13 e.value = value; 14 e.recordAccess(this); 15 return oldValue; 16 } 17 } 18 19 modCount++; 20 addEntry(hash, key, value, i); 21 return null; 22 }
put方法是用來向HashMap中添加新的元素,從put方法的具體實現可知,會先調用hashCode方法得到該元素的hashCode值,然後查看table中是否存在該hashCode值,如果存在則調用equals方法重新確定是否存在該元素,如果存在,則更新value值,否則將新的元素添加到HashMap中。從這裏可以看出,hashCode方法的存在是為了減少equals方法的調用次數,從而提高程序效率。
有些朋友誤以為默認情況下,hashCode返回的就是對象的存儲地址,事實上這種看法是不全面的,確實有些JVM在實現時是直接返回對象的存儲地址,但是大多時候並不是這樣,只能說可能存儲地址有一定關聯。
因此有人會說,可以直接根據hashcode值判斷兩個對象是否相等嗎?肯定是不可以的,因為不同的對象可能會生成相同的hashcode值。雖然不能根據hashcode值判斷兩個對象是否相等,但是可以直接根據hashcode值判斷兩個對象不等,如果兩個對象的hashcode值不等,則必定是兩個不同的對象。如果要判斷兩個對象是否真正相等,必須通過equals方法。
也就是說對於兩個對象,如果調用equals方法得到的結果為true,則兩個對象的hashcode值必定相等;
如果equals方法得到的結果為false,則兩個對象的hashcode值不一定不同;
如果兩個對象的hashcode值不等,則equals方法得到的結果必定為false;
如果兩個對象的hashcode值相等,則equals方法得到的結果未知。
二.equals方法和hashCode方法
在有些情況下,程序設計者在設計一個類的時候為需要重寫equals方法,比如String類,但是千萬要註意,在重寫equals方法的同時,必須重寫hashCode方法。為什麽這麽說呢?
看下面這個例子:
1 package lesson1216; 2 3 public class Person { 4 5 private String name; 6 private int age; 7 8 public Person() { 9 // TODO Auto-generated constructor stub 10 } 11 12 public Person(String name, int age) { 13 this.age = age; 14 this.name = name; 15 } 16 17 /** 18 * @return the name 19 */ 20 public String getName() { 21 return name; 22 } 23 24 /** 25 * @param name the name to set 26 */ 27 public void setName(String name) { 28 this.name = name; 29 } 30 31 /** 32 * @return the age 33 */ 34 public int getAge() { 35 return age; 36 } 37 38 /** 39 * @param age the age to set 40 */ 41 public void setAge(int age) { 42 this.age = age; 43 } 44 45 /* (non-Javadoc) 46 * @see java.lang.Object#equals(java.lang.Object) 47 */ 48 @Override 49 public boolean equals(Object obj) { 50 return this.name.equals(((Person)obj).name) && this.age == ((Person)obj).age; 51 } 52 53 } 54 55 package lesson1216; 56 57 import java.util.HashMap; 58 59 public class HashDemo { 60 61 public static void main(String[] args) { 62 Person p1 = new Person("Jack",20); 63 System.out.println(p1.hashCode()); 64 65 HashMap map = new HashMap(); 66 map.put(p1, 1); 67 //雖然相等,但是是不同的對象,所以hashCode肯定不一樣,估計get不出值來 68 System.out.println(map.get(new Person("Jack",20))); //null 69 } 70 }
在這裏我只重寫了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 public V get(Object key) { 2 if (key == null) 3 return getForNullKey(); 4 int hash = hash(key.hashCode()); //這個地方調用了hashCode() 5 for (Entry<K,V> e = table[indexFor(hash, table.length)]; 6 e != null; 7 e = e.next) { 8 Object k; 9 if (e.hash == hash && ((k = e.key) == key || key.equals(k))) 10 return e.value; 11 } 12 return null; 13 }
所以在hashmap進行get操作時,因為得到的hashcdoe值不同(註意,上述代碼也許在某些情況下會得到相同的hashcode值,不過這種概率比較小,因為雖然兩個對象的存儲地址不同也有可能得到相同的hashcode值),所以導致在get方法中for循環不會執行,直接返回null。
因此如果想上述代碼輸出結果為“1”,很簡單,只需要重寫hashCode方法,讓equals方法和hashCode方法始終在邏輯上保持一致性。
1 /* (non-Javadoc) 2 * @see java.lang.Object#hashCode() 3 */ 4 @Override 5 public int hashCode() { 6 // TODO Auto-generated method stub 7 return name.hashCode() + age;
//return 520520; 甚至可以直接返回一個固定值。 8 }
這樣一來的話,輸出結果就為“1”了。至於怎麽重寫hashCode(),這個就看具體需求了。
下面這段話摘自Effective Java一書:
- 在程序執行期間,只要equals方法的比較操作用到的信息沒有被修改,那麽對這同一個對象調用多次,hashCode方法必須始終如一地返回同一個整數。
- 如果兩個對象根據equals方法比較是相等的,那麽調用兩個對象的hashCode方法必須返回相同的整數結果。
- 如果兩個對象根據equals方法比較是不等的,則hashCode方法不一定得返回不同的整數。
對於第二條和第三條很好理解,但是第一條,很多時候就會忽略。在《Java編程思想》一書中的P495頁也有同第一條類似的一段話:
“設計hashCode()時最重要的因素就是:無論何時,對同一個對象調用hashCode()都應該產生同樣的值。如果在講一個對象用put()添加進HashMap時產生一個hashCdoe值,而用get()取出時卻產生了另一個hashCode值,那麽就無法獲取該對象了。所以如果你的hashCode方法依賴於對象中易變的數據,用戶就要當心了,因為此數據發生變化時,hashCode()方法就會生成一個不同的散列碼”。
還用上面那個例子:
1 package lesson1216; 2 3 public class Person { 4 5 private String name; 6 private int age; 7 8 public Person() { 9 // TODO Auto-generated constructor stub 10 } 11 12 public Person(String name, int age) { 13 this.age = age; 14 this.name = name; 15 } 16 17 /** 18 * @return the name 19 */ 20 public String getName() { 21 return name; 22 } 23 24 /** 25 * @param name the name to set 26 */ 27 public void setName(String name) { 28 this.name = name; 29 } 30 31 /** 32 * @return the age 33 */ 34 public int getAge() { 35 return age; 36 } 37 38 /** 39 * @param age the age to set 40 */ 41 public void setAge(int age) { 42 this.age = age; 43 } 44 45 /* (non-Javadoc) 46 * @see java.lang.Object#equals(java.lang.Object) 47 */ 48 @Override 49 public boolean equals(Object obj) { 50 return this.name.equals(((Person)obj).name) && this.age == ((Person)obj).age; 51 } 52 53 /* (non-Javadoc) 54 * @see java.lang.Object#hashCode() 55 */ 56 @Override 57 public int hashCode() { 58 return name.hashCode() + age; 59 //return 520520; 60 } 61 } 62 63 package lesson1216; 64 65 import java.util.HashMap; 66 67 public class HashDemo { 68 69 public static void main(String[] args) { 70 Person p1 = new Person("Jack",20); 71 System.out.println(p1.hashCode()); 72 73 HashMap map = new HashMap(); 74 map.put(p1, 1); 75 p1.setAge(30); 76 77 System.out.println(map.get(p1)); //null 78 } 79 }
這段代碼輸出的結果為“null”,想必其中的原因大家應該都清楚了。
因此,在設計hashCode方法和equals方法的時候,如果對象中的數據易變,則最好在equals方法和hashCode方法中不要依賴於該字段。
主要是理解hashCode和equal在集合中的應用,他們都是Object的方法。 每個類都會繼承這個方法,然後根據具體要求看地搜要進行重寫。
Java Hashcode