HashMap 和 HashSet

本文轉載http://alex09.iteye.com/blog/539545  僅限個人學習筆記

HashMap 和 HashSet 是 Java Collection Framework 的兩個重要成員，其中 HashMap 是 Map 接口的常用實作類，HashSet 是 Set 接口的常用實作類。雖然 HashMap 和 HashSet 實作的接口規範不同，但它們底層的 Hash 存儲機制完全一樣，甚至 HashSet 本身就采用 HashMap 來實作的。 

通過 HashMap、HashSet 的源代碼分析其 Hash 存儲機制

實際上，HashSet 和 HashMap 之間有很多相似之處，對于 HashSet 而言，系統采用 Hash 算法決定集合元素的存儲位置，這樣可以保證能快速存、取集合元素；對于 HashMap 而言，系統 key-value 當成一個整體進行處理，系統總是根據 Hash 算法來計算 key-value 的存儲位置，這樣可以保證能快速存、取 Map 的 key-value 對。

在介紹集合存儲之前需要指出一點：雖然集合号稱存儲的是 Java 對象，但實際上并不會真正将 Java 對象放入 Set 集合中，隻是在 Set 集合中保留這些對象的引用而言。也就是說：Java 集合實際上是多個引用變量所組成的集合，這些引用變量指向實際的 Java 對象。 

集合和引用 

就像引用類型的數組一樣，當我們把 Java 對象放入數組之時，并不是真正的把 Java 對象放入數組中，隻是把對象的引用放入數組中，每個數組元素都是一個引用變量。 

HashMap 的存儲實作

當程式試圖将多個 key-value 放入 HashMap 中時，以如下代碼片段為例： 

Java代碼  

1. HashMap<String , Double> map = new HashMap<String , Double>();   
2. map.put("國文" , 80.0);   
3. map.put("數學" , 89.0);   
4. map.put("英語" , 78.2);   

HashMap 采用一種所謂的“Hash 算法”來決定每個元素的存儲位置。 

當程式執行 map.put("國文" , 80.0); 時，系統将調用"國文"的 hashCode() 方法得到其 hashCode 值——每個 Java 對象都有 hashCode() 方法，都可通過該方法獲得它的 hashCode 值。得到這個對象的 hashCode 值之後，系統會根據該 hashCode 值來決定該元素的存儲位置。 

我們可以看 HashMap 類的 put(K key , V value) 方法的源代碼： 

1. public V put(K key, V value)   
2. {   
3.  // 如果 key 為 null，調用 putForNullKey 方法進行處理  
4.  if (key == null)   
5.      return putForNullKey(value);   
6.  // 根據 key 的 keyCode 計算 Hash 值  
7.  int hash = hash(key.hashCode());   
8.  // 搜尋指定 hash 值在對應 table 中的索引  
9.      int i = indexFor(hash, table.length);  
10.  // 如果 i 索引處的 Entry 不為 null，通過循環不斷周遊 e 元素的下一個元素  
11.  for (Entry<K,V> e = table[i]; e != null; e = e.next)   
12.  {   
13.      Object k;   
14.      // 找到指定 key 與需要放入的 key 相等（hash 值相同  
15.      // 通過 equals 比較放回 true）  
16.      if (e.hash == hash && ((k = e.key) == key   
17.          || key.equals(k)))   
18.      {   
19.          V oldValue = e.value;   
20.          e.value = value;   
21.          e.recordAccess(this);   
22.          return oldValue;   
23.      }   
24.  }   
25.  // 如果 i 索引處的 Entry 為 null，表明此處還沒有 Entry   
26.  modCount++;   
27.  // 将 key、value 添加到 i 索引處  
28.  addEntry(hash, key, value, i);   
29.  return null;   
30. }   

上面程式中用到了一個重要的内部接口：Map.Entry，每個 Map.Entry 其實就是一個 key-value 對。從上面程式中可以看出：當系統決定存儲 HashMap 中的 key-value 對時，完全沒有考慮 Entry 中的 value，僅僅隻是根據 key 來計算并決定每個 Entry 的存儲位置。這也說明了前面的結論：我們完全可以把 Map 集合中的 value 當成 key 的附屬，當系統決定了 key 的存儲位置之後，value 随之儲存在那裡即可。 

上面方法提供了一個根據 hashCode() 傳回值來計算 Hash 碼的方法：hash()，這個方法是一個純粹的數學計算，其方法如下： 

1. static int hash(int h)   
3.     h ^= (h >>> 20) ^ (h >>> 12);   
4.     return h ^ (h >>> 7) ^ (h >>> 4);   

對于任意給定的對象，隻要它的 hashCode() 傳回值相同，那麼程式調用 hash(int h) 方法所計算得到的 Hash 碼值總是相同的。接下來程式會調用 indexFor(int h, int length) 方法來計算該對象應該儲存在 table 數組的哪個索引處。indexFor(int h, int length) 方法的代碼如下： 

1. static int indexFor(int h, int length)   
3.     return h & (length-1);   
4. }  

這個方法非常巧妙，它總是通過 h &(table.length -1) 來得到該對象的儲存位置——而 HashMap 底層數組的長度總是 2 的 n 次方，這一點可參看後面關于 HashMap 構造器的介紹。 

當 length 總是 2 的倍數時，h & (length-1) 将是一個非常巧妙的設計：假設 h=5,length=16, 那麼 h & length - 1 将得到 5；如果 h=6,length=16, 那麼 h & length - 1 将得到 6 ……如果 h=15,length=16, 那麼 h & length - 1 将得到 15；但是當 h=16 時 , length=16 時，那麼 h & length - 1 将得到 0 了；當 h=17 時 , length=16 時，那麼 h & length - 1 将得到 1 了……這樣保證計算得到的索引值總是位于 table 數組的索引之内。 

根據上面 put 方法的源代碼可以看出，當程式試圖将一個 key-value 對放入 HashMap 中時，程式首先根據該 key 的 hashCode() 傳回值決定該 Entry 的存儲位置：如果兩個 Entry 的 key 的 hashCode() 傳回值相同，那它們的存儲位置相同。如果這兩個 Entry 的 key 通過 equals 比較傳回 true，新添加 Entry 的 value 将覆寫集合中原有 Entry 的 value，但 key 不會覆寫。如果這兩個 Entry 的 key 通過 equals 比較傳回 false，新添加的 Entry 将與集合中原有 Entry 形成 Entry 鍊，而且新添加的 Entry 位于 Entry 鍊的頭部——具體說明繼續看 addEntry() 方法的說明。 

當向 HashMap 中添加 key-value 對，由其 key 的 hashCode() 傳回值決定該 key-value 對（就是 Entry 對象）的存儲位置。當兩個 Entry 對象的 key 的 hashCode() 傳回值相同時，将由 key 通過 eqauls() 比較值決定是采用覆寫行為（傳回 true），還是産生 Entry 鍊（傳回 false）。 

上面程式中還調用了 addEntry(hash, key, value, i); 代碼，其中 addEntry 是 HashMap 提供的一個包通路權限的方法，該方法僅用于添加一個 key-value 對。下面是該方法的代碼： 

1. void addEntry(int hash, K key, V value, int bucketIndex)   
3.     // 擷取指定 bucketIndex 索引處的 Entry   
4.     Entry<K,V> e = table[bucketIndex];     // ①  
5.     // 将新建立的 Entry 放入 bucketIndex 索引處，并讓新的 Entry 指向原來的 Entry   
6.     table[bucketIndex] = new Entry<K,V>(hash, key, value, e);   
7.     // 如果 Map 中的 key-value 對的數量超過了極限  
8.     if (size++ >= threshold)   
9.         // 把 table 對象的長度擴充到 2 倍。  
10.         resize(2 * table.length);    // ②  

上面方法的代碼很簡單，但其中包含了一個非常優雅的設計：系統總是将新添加的 Entry 對象放入 table 數組的 bucketIndex 索引處——如果 bucketIndex 索引處已經有了一個 Entry 對象，那新添加的 Entry 對象指向原有的 Entry 對象（産生一個 Entry 鍊），如果 bucketIndex 索引處沒有 Entry 對象，也就是上面程式①号代碼的 e 變量是 null，也就是新放入的 Entry 對象指向 null，也就是沒有産生 Entry 鍊。 

JDK 源碼 

在 JDK 安裝目錄下可以找到一個 src.zip 壓縮檔案，該檔案裡包含了 Java 基礎類庫的所有源檔案。隻要讀者有學習興趣，随時可以打開這份壓縮檔案來閱讀 Java 類庫的源代碼，這對提高讀者的程式設計能力是非常有幫助的。需要指出的是：src.zip 中包含的源代碼并沒有包含像上文中的中文注釋，這些注釋是筆者自己添加進去的。 

Hash 算法的性能選項 

根據上面代碼可以看出，在同一個 bucket 存儲 Entry 鍊的情況下，新放入的 Entry 總是位于 bucket 中，而最早放入該 bucket 中的 Entry 則位于這個 Entry 鍊的最末端。 

上面程式中還有這樣兩個變量： 

    * size：該變量儲存了該 HashMap 中所包含的 key-value 對的數量。 

    * threshold：該變量包含了 HashMap 能容納的 key-value 對的極限，它的值等于 HashMap 的容量乘以負載因子（load factor）。 

從上面程式中②号代碼可以看出，當 size++ >= threshold 時，HashMap 會自動調用 resize 方法擴充 HashMap 的容量。每擴充一次，HashMap 的容量就增大一倍。 

上面程式中使用的 table 其實就是一個普通數組，每個數組都有一個固定的長度，這個數組的長度就是 HashMap 的容量。HashMap 包含如下幾個構造器： 

    * HashMap()：建構一個初始容量為 16，負載因子為 0.75 的 HashMap。 

    * HashMap(int initialCapacity)：建構一個初始容量為 initialCapacity，負載因子為 0.75 的 HashMap。 

    * HashMap(int initialCapacity, float loadFactor)：以指定初始容量、指定的負載因子建立一個 HashMap。 

當建立一個 HashMap 時，系統會自動建立一個 table 數組來儲存 HashMap 中的 Entry，下面是 HashMap 中一個構造器的代碼： 

1. // 以指定初始化容量、負載因子建立 HashMap   
2.  public HashMap(int initialCapacity, float loadFactor)   
4.      // 初始容量不能為負數  
5.      if (initialCapacity < 0)   
6.          throw new IllegalArgumentException(   
7.         "Illegal initial capacity: " +   
8.              initialCapacity);   
9.      // 如果初始容量大于最大容量，讓出示容量  
10.      if (initialCapacity > MAXIMUM_CAPACITY)   
11.          initialCapacity = MAXIMUM_CAPACITY;   
12.      // 負載因子必須大于 0 的數值  
13.      if (loadFactor <= 0 || Float.isNaN(loadFactor))   
15.          loadFactor);   
16.      // 計算出大于 initialCapacity 的最小的 2 的 n 次方值。  
17.      int capacity = 1;   
18.      while (capacity < initialCapacity)   
19.          capacity <<= 1;   
20.      this.loadFactor = loadFactor;   
21.      // 設定容量極限等于容量 * 負載因子  
22.      threshold = (int)(capacity * loadFactor);   
23.      // 初始化 table 數組  
24.      table = new Entry[capacity];            // ①  
25.      init();   

上面代碼中粗體字代碼包含了一個簡潔的代碼實作：找出大于 initialCapacity 的、最小的 2 的 n 次方值，并将其作為 HashMap 的實際容量（由 capacity 變量儲存）。例如給定 initialCapacity 為 10，那麼該 HashMap 的實際容量就是 16。 

程式①号代碼處可以看到：table 的實質就是一個數組，一個長度為 capacity 的數組。 

對于 HashMap 及其子類而言，它們采用 Hash 算法來決定集合中元素的存儲位置。當系統開始初始化 HashMap 時，系統會建立一個長度為 capacity 的 Entry 數組，這個數組裡可以存儲元素的位置被稱為“桶（bucket）”，每個 bucket 都有其指定索引，系統可以根據其索引快速通路該 bucket 裡存儲的元素。 

無論何時，HashMap 的每個“桶”隻存儲一個元素（也就是一個 Entry），由于 Entry 對象可以包含一個引用變量（就是 Entry 構造器的的最後一個參數）用于指向下一個 Entry，是以可能出現的情況是：HashMap 的 bucket 中隻有一個 Entry，但這個 Entry 指向另一個 Entry ——這就形成了一個 Entry 鍊。如圖 1 所示： 

圖 1. HashMap 的存儲示意 

HashMap 的讀取實作 

當 HashMap 的每個 bucket 裡存儲的 Entry 隻是單個 Entry ——也就是沒有通過指針産生 Entry 鍊時，此時的 HashMap 具有最好的性能：當程式通過 key 取出對應 value 時，系統隻要先計算出該 key 的 hashCode() 傳回值，在根據該 hashCode 傳回值找出該 key 在 table 數組中的索引，然後取出該索引處的 Entry，最後傳回該 key 對應的 value 即可。看 HashMap 類的 get(K key) 方法代碼： 

1. public V get(Object key)   
3.  // 如果 key 是 null，調用 getForNullKey 取出對應的 value   
5.      return getForNullKey();   
6.  // 根據該 key 的 hashCode 值計算它的 hash 碼  
8.  // 直接取出 table 數組中指定索引處的值，  
9.  for (Entry<K,V> e = table[indexFor(hash, table.length)];   
10.      e != null;   
11.      // 搜尋該 Entry 鍊的下一個 Entr   
12.      e = e.next)         // ①  
15.      // 如果該 Entry 的 key 與被搜尋 key 相同  
18.          return e.value;