Java:這是一份詳細&全面的HashMap 1.7 原始碼分析

Carson_Ho發表於2018-03-14

前言

  • HashMapJavaAndroid 開發中非常常見
  • 今天,我將帶來HashMap 的全部原始碼分析,希望你們會喜歡。
  1. 本文基於版本 JDK 1.7,即 Java 7
  2. 關於版本 JDK 1.8,即 Java 8,具體請看文章Java原始碼分析:關於 HashMap 1.8 的重大更新

目錄

示意圖


1. 簡介

  • 類定義
public class HashMap<K,V>
         extends AbstractMap<K,V> 
         implements Map<K,V>, Cloneable, Serializable
複製程式碼
  • 主要介紹

示意圖

  • HashMap 的實現在 JDK 1.7JDK 1.8 差別較大
  • 今天,我將主要講解 JDK 1.7HashMap 的原始碼解析

關於 JDK 1.8HashMap 的原始碼解析請看文章:Java原始碼分析:關於 HashMap 1.8 的重大更新


2. 資料結構

2.1 具體描述

HashMap 採用的資料結構 = 陣列(主) + 單連結串列(副),具體描述如下

該資料結構方式也稱:拉鍊法

示意圖

2.2 示意圖

示意圖

2.3 儲存流程

注:為了讓大家有個感性的認識,只是簡單的畫出儲存流程,更加詳細 & 具體的儲存流程會在下面原始碼分析中給出

示意圖

2.4 陣列元素 & 連結串列節點的 實現類

  • HashMap中的陣列元素 & 連結串列節點 採用 Entry類 實現,如下圖所示

示意圖

  1. HashMap的本質 = 1個儲存Entry類物件的陣列 + 多個單連結串列
  2. Entry物件本質 = 1個對映(鍵 - 值對),屬性包括:鍵(key)、值(value) & 下1節點( next) = 單連結串列的指標 = 也是一個Entry物件,用於解決hash衝突
  • 該類的原始碼分析如下

具體分析請看註釋

/** 
 * Entry類實現了Map.Entry介面
 * 即 實現了getKey()、getValue()、equals(Object o)和hashCode()等方法
**/  
static class Entry<K,V> implements Map.Entry<K,V> {
    final K key;  // 鍵
    V value;  // 值
    Entry<K,V> next; // 指向下一個節點 ,也是一個Entry物件,從而形成解決hash衝突的單連結串列
    int hash;  // hash值
  
    /** 
     * 構造方法,建立一個Entry 
     * 引數:雜湊值h,鍵值k,值v、下一個節點n 
     */  
    Entry(int h, K k, V v, Entry<K,V> n) {  
        value = v;  
        next = n;  
        key = k;  
        hash = h;  
    }  
  
    // 返回 與 此項 對應的鍵
    public final K getKey() {  
        return key;  
    }  

    // 返回 與 此項 對應的值
    public final V getValue() {  
        return value;  
    }  
  
    public final V setValue(V newValue) {  
        V oldValue = value;  
        value = newValue;  
        return oldValue;  
    }  
    
   /** 
     * equals()
     * 作用:判斷2個Entry是否相等,必須key和value都相等,才返回true  
     */ 
      public final boolean equals(Object o) {  
        if (!(o instanceof Map.Entry))  
            return false;  
        Map.Entry e = (Map.Entry)o;  
        Object k1 = getKey();  
        Object k2 = e.getKey();  
        if (k1 == k2 || (k1 != null && k1.equals(k2))) {  
            Object v1 = getValue();  
            Object v2 = e.getValue();  
            if (v1 == v2 || (v1 != null && v1.equals(v2)))  
                return true;  
        }  
        return false;  
    }  
    
    /** 
     * hashCode() 
     */ 
    public final int hashCode() { 
        return Objects.hashCode(getKey()) ^ Objects.hashCode(getValue());  
    }  
  
    public final String toString() {  
        return getKey() + "=" + getValue();  
    }  
  
    /** 
     * 當向HashMap中新增元素時,即呼叫put(k,v)時, 
     * 對已經在HashMap中k位置進行v的覆蓋時,會呼叫此方法 
     * 此處沒做任何處理 
     */  
    void recordAccess(HashMap<K,V> m) {  
    }  
  
    /** 
     * 當從HashMap中刪除了一個Entry時,會呼叫該函式 
     * 此處沒做任何處理 
     */  
    void recordRemoval(HashMap<K,V> m) {  
    } 

}
複製程式碼

3. 具體使用

3.1 主要使用API(方法、函式)

V get(Object key); // 獲得指定鍵的值
V put(K key, V value);  // 新增鍵值對
void putAll(Map<? extends K, ? extends V> m);  // 將指定Map中的鍵值對 複製到 此Map中
V remove(Object key);  // 刪除該鍵值對

boolean containsKey(Object key); // 判斷是否存在該鍵的鍵值對;是 則返回true
boolean containsValue(Object value);  // 判斷是否存在該值的鍵值對;是 則返回true
 
Set<K> keySet();  // 單獨抽取key序列,將所有key生成一個Set
Collection<V> values();  // 單獨value序列,將所有value生成一個Collection

void clear(); // 清除雜湊表中的所有鍵值對
int size();  // 返回雜湊表中所有 鍵值對的數量 = 陣列中的鍵值對 + 連結串列中的鍵值對
boolean isEmpty(); // 判斷HashMap是否為空;size == 0時 表示為 空 

複製程式碼

3.2 使用流程

  • 在具體使用時,主要流程是:
  1. 宣告1個 HashMap的物件
  2. HashMap 新增資料(成對 放入 鍵 - 值對)
  3. 獲取 HashMap 的某個資料
  4. 獲取 HashMap 的全部資料:遍歷HashMap
  • 示例程式碼
import java.util.Collection;
import java.util.HashMap;
import java.util.Iterator;
import java.util.Map;
import java.util.Set;

public class HashMapTest {

    public static void main(String[] args) {
      /**
        * 1. 宣告1個 HashMap的物件
        */
        Map<String, Integer> map = new HashMap<String, Integer>();

      /**
        * 2. 向HashMap新增資料(成對 放入 鍵 - 值對)
        */
        map.put("Android", 1);
        map.put("Java", 2);
        map.put("iOS", 3);
        map.put("資料探勘", 4);
        map.put("產品經理", 5);

       /**
        * 3. 獲取 HashMap 的某個資料
        */
        System.out.println("key = 產品經理時的值為:" + map.get("產品經理"));

      /**
        * 4. 獲取 HashMap 的全部資料:遍歷HashMap
        * 核心思想:
        * 步驟1:獲得key-value對(Entry) 或 key 或 value的Set集合
        * 步驟2:遍歷上述Set集合(使用for迴圈 、 迭代器(Iterator)均可)
        * 方法共有3種:分別針對 key-value對(Entry) 或 key 或 value
        */

        // 方法1:獲得key-value的Set集合 再遍歷
        System.out.println("方法1");
        // 1. 獲得key-value對(Entry)的Set集合
        Set<Map.Entry<String, Integer>> entrySet = map.entrySet();

        // 2. 遍歷Set集合,從而獲取key-value
        // 2.1 通過for迴圈
        for(Map.Entry<String, Integer> entry : entrySet){
            System.out.print(entry.getKey());
            System.out.println(entry.getValue());
        }
        System.out.println("----------");
        // 2.2 通過迭代器:先獲得key-value對(Entry)的Iterator,再迴圈遍歷
        Iterator iter1 = entrySet.iterator();
        while (iter1.hasNext()) {
            // 遍歷時,需先獲取entry,再分別獲取key、value
            Map.Entry entry = (Map.Entry) iter1.next();
            System.out.print((String) entry.getKey());
            System.out.println((Integer) entry.getValue());
        }


        // 方法2:獲得key的Set集合 再遍歷
        System.out.println("方法2");

        // 1. 獲得key的Set集合
        Set<String> keySet = map.keySet();

        // 2. 遍歷Set集合,從而獲取key,再獲取value
        // 2.1 通過for迴圈
        for(String key : keySet){
            System.out.print(key);
            System.out.println(map.get(key));
        }

        System.out.println("----------");

        // 2.2 通過迭代器:先獲得key的Iterator,再迴圈遍歷
        Iterator iter2 = keySet.iterator();
        String key = null;
        while (iter2.hasNext()) {
            key = (String)iter2.next();
            System.out.print(key);
            System.out.println(map.get(key));
        }


        // 方法3:獲得value的Set集合 再遍歷
        System.out.println("方法3");

        // 1. 獲得value的Set集合
        Collection valueSet = map.values();

        // 2. 遍歷Set集合,從而獲取value
        // 2.1 獲得values 的Iterator
        Iterator iter3 = valueSet.iterator();
        // 2.2 通過遍歷,直接獲取value
        while (iter3.hasNext()) {
            System.out.println(iter3.next());
        }

    }


}

// 注:對於遍歷方式,推薦使用針對 key-value對(Entry)的方式:效率高
// 原因:
   // 1. 對於 遍歷keySet 、valueSet,實質上 = 遍歷了2次:1 = 轉為 iterator 迭代器遍歷、2 = 從 HashMap 中取出 key 的 value 操作(通過 key 值 hashCode 和 equals 索引)
   // 2. 對於 遍歷 entrySet ,實質 = 遍歷了1次 = 獲取儲存實體Entry(儲存了key 和 value )
複製程式碼
  • 執行結果
方法1
Java2
iOS3
資料探勘4
Android1
產品經理5
----------
Java2
iOS3
資料探勘4
Android1
產品經理5
方法2
Java2
iOS3
資料探勘4
Android1
產品經理5
----------
Java2
iOS3
資料探勘4
Android1
產品經理5
方法3
2
3
4
1
5
複製程式碼

下面,我們按照上述的使用過程,對一個個步驟進行原始碼解析


4. 基礎知識:HashMap中的重要引數(變數)

  • 在進行真正的原始碼分析前,先講解HashMap中的重要引數(變數)
  • HashMap中的主要引數 = 容量、載入因子、擴容閾值
  • 具體介紹如下
// 1. 容量(capacity): HashMap中陣列的長度
// a. 容量範圍:必須是2的冪 & <最大容量(2的30次方)
// b. 初始容量 = 雜湊表建立時的容量
  // 預設容量 = 16 = 1<<4 = 00001中的1向左移4位 = 10000 = 十進位制的2^4=16
  static final int DEFAULT_INITIAL_CAPACITY = 1 << 4;
  // 最大容量 =  2的30次方(若傳入的容量過大,將被最大值替換)
  static final int MAXIMUM_CAPACITY = 1 << 30;

// 2. 載入因子(Load factor):HashMap在其容量自動增加前可達到多滿的一種尺度
// a. 載入因子越大、填滿的元素越多 = 空間利用率高、但衝突的機會加大、查詢效率變低(因為連結串列變長了)
// b. 載入因子越小、填滿的元素越少 = 空間利用率小、衝突的機會減小、查詢效率高(連結串列不長)
  // 實際載入因子
  final float loadFactor;
  // 預設載入因子 = 0.75
  static final float DEFAULT_LOAD_FACTOR = 0.75f;

// 3. 擴容閾值(threshold):當雜湊表的大小 ≥ 擴容閾值時,就會擴容雜湊表(即擴充HashMap的容量) 
// a. 擴容 = 對雜湊表進行resize操作(即重建內部資料結構),從而雜湊表將具有大約兩倍的桶數
// b. 擴容閾值 = 容量 x 載入因子
  int threshold;

// 4. 其他
 // 儲存資料的Entry型別 陣列,長度 = 2的冪
 // HashMap的實現方式 = 拉鍊法,Entry陣列上的每個元素本質上是一個單向連結串列
  transient Entry<K,V>[] table = (Entry<K,V>[]) EMPTY_TABLE;  
 // HashMap的大小,即 HashMap中儲存的鍵值對的數量
  transient int size;
 

複製程式碼
  • 引數示意圖

示意圖

  • 此處 詳細說明 載入因子

示意圖


5. 原始碼分析

  • 本次的原始碼分析主要是根據 使用步驟 進行相關函式的詳細分析
  • 主要分析內容如下:

示意圖

  • 下面,我將對每個步驟內容的主要方法進行詳細分析

步驟1:宣告1個 HashMap的物件

/**
  * 函式使用原型
  */
  Map<String,Integer> map = new HashMap<String,Integer>();

 /**
   * 原始碼分析:主要是HashMap的建構函式 = 4個
   * 僅貼出關於HashMap建構函式的原始碼
   */
  public class HashMap<K,V>
      extends AbstractMap<K,V>
      implements Map<K,V>, Cloneable, Serializable{

    // 省略上節闡述的引數
    
  /**
     * 建構函式1:預設建構函式(無參)
     * 載入因子 & 容量 = 預設 = 0.75、16
     */
    public HashMap() {
        // 實際上是呼叫建構函式3:指定“容量大小”和“載入因子”的建構函式
        // 傳入的指定容量 & 載入因子 = 預設
        this(DEFAULT_INITIAL_CAPACITY, DEFAULT_LOAD_FACTOR); 
    }

    /**
     * 建構函式2:指定“容量大小”的建構函式
     * 載入因子 = 預設 = 0.75 、容量 = 指定大小
     */
    public HashMap(int initialCapacity) {
        // 實際上是呼叫指定“容量大小”和“載入因子”的建構函式
        // 只是在傳入的載入因子引數 = 預設載入因子
        this(initialCapacity, DEFAULT_LOAD_FACTOR);
        
    }

    /**
     * 建構函式3:指定“容量大小”和“載入因子”的建構函式
     * 載入因子 & 容量 = 自己指定
     */
    public HashMap(int initialCapacity, float loadFactor) {

        // HashMap的最大容量只能是MAXIMUM_CAPACITY,哪怕傳入的 > 最大容量
        if (initialCapacity > MAXIMUM_CAPACITY)
            initialCapacity = MAXIMUM_CAPACITY;

        // 設定 載入因子
        this.loadFactor = loadFactor;
        // 設定 擴容閾值 = 初始容量
        // 注:此處不是真正的閾值,是為了擴充套件table,該閾值後面會重新計算,下面會詳細講解  
        threshold = initialCapacity;   

        init(); // 一個空方法用於未來的子物件擴充套件
    }

    /**
     * 建構函式4:包含“子Map”的建構函式
     * 即 構造出來的HashMap包含傳入Map的對映關係
     * 載入因子 & 容量 = 預設
     */

    public HashMap(Map<? extends K, ? extends V> m) {

        // 設定容量大小 & 載入因子 = 預設
        this(Math.max((int) (m.size() / DEFAULT_LOAD_FACTOR) + 1,
                DEFAULT_INITIAL_CAPACITY), DEFAULT_LOAD_FACTOR);

        // 該方法用於初始化 陣列 & 閾值,下面會詳細說明
        inflateTable(threshold);

        // 將傳入的子Map中的全部元素逐個新增到HashMap中
        putAllForCreate(m);
    }
}
複製程式碼
  • 注:
    1. 此處僅用於接收初始容量大小(capacity)、載入因子(Load factor),但仍無真正初始化雜湊表,即初始化儲存陣列table
    2. 此處先給出結論:真正初始化雜湊表(初始化儲存陣列table)是在第1次新增鍵值對時,即第1次呼叫put()時。下面會詳細說明

至此,關於HashMap的建構函式講解完畢。


步驟2:向HashMap新增資料(成對 放入 鍵 - 值對)

  • 新增資料的流程如下

注:為了讓大家有個感性的認識,只是簡單的畫出儲存流程,更加詳細 & 具體的儲存流程會在下面原始碼分析中給出

示意圖

  • 原始碼分析
 /**
   * 函式使用原型
   */
   map.put("Android", 1);
        map.put("Java", 2);
        map.put("iOS", 3);
        map.put("資料探勘", 4);
        map.put("產品經理", 5);

   /**
     * 原始碼分析:主要分析: HashMap的put函式
     */
    public V put(K key, V value)
(分析1)// 1. 若 雜湊表未初始化(即 table為空) 
        // 則使用 建構函式時設定的閾值(即初始容量) 初始化 陣列table  
        if (table == EMPTY_TABLE) { 
        inflateTable(threshold); 
    }  
        // 2. 判斷key是否為空值null
(分析2)// 2.1 若key == null,則將該鍵-值 存放到陣列table 中的第1個位置,即table [0]
        // (本質:key = Null時,hash值 = 0,故存放到table[0]中)
        // 該位置永遠只有1個value,新傳進來的value會覆蓋舊的value
        if (key == null)
            return putForNullKey(value);

(分析3) // 2.2 若 key ≠ null,則計算存放陣列 table 中的位置(下標、索引)
        // a. 根據鍵值key計算hash值
        int hash = hash(key);
        // b. 根據hash值 最終獲得 key對應存放的陣列Table中位置
        int i = indexFor(hash, table.length);

        // 3. 判斷該key對應的值是否已存在(通過遍歷 以該陣列元素為頭結點的連結串列 逐個判斷)
        for (Entry<K,V> e = table[i]; e != null; e = e.next) {
            Object k;
(分析4)// 3.1 若該key已存在(即 key-value已存在 ),則用 新value 替換 舊value
            if (e.hash == hash && ((k = e.key) == key || key.equals(k))) {
                V oldValue = e.value;
                e.value = value;
                e.recordAccess(this);
                return oldValue; //並返回舊的value
            }
        }

        modCount++;

(分析5)// 3.2 若 該key不存在,則將“key-value”新增到table中
        addEntry(hash, key, value, i);
        return null;
    }
複製程式碼
  • 根據原始碼分析所作出的流程圖

示意圖

  • 下面,我將根據上述流程的5個分析點進行詳細講解

分析1:初始化雜湊表

即 初始化陣列(table)、擴容閾值(threshold

   /**
     * 函式使用原型
     */
      if (table == EMPTY_TABLE) { 
        inflateTable(threshold); 
    }  

   /**
     * 原始碼分析:inflateTable(threshold); 
     */
     private void inflateTable(int toSize) {  
    
    // 1. 將傳入的容量大小轉化為:>傳入容量大小的最小的2的次冪
    // 即如果傳入的是容量大小是19,那麼轉化後,初始化容量大小為32(即2的5次冪)
    int capacity = roundUpToPowerOf2(toSize);->>分析1   

    // 2. 重新計算閾值 threshold = 容量 * 載入因子  
    threshold = (int) Math.min(capacity * loadFactor, MAXIMUM_CAPACITY + 1);  

    // 3. 使用計算後的初始容量(已經是2的次冪) 初始化陣列table(作為陣列長度)
    // 即 雜湊表的容量大小 = 陣列大小(長度)
    table = new Entry[capacity]; //用該容量初始化table  

    initHashSeedAsNeeded(capacity);  
}  

    /**
     * 分析1:roundUpToPowerOf2(toSize)
     * 作用:將傳入的容量大小轉化為:>傳入容量大小的最小的2的冪
     * 特別注意:容量大小必須為2的冪,該原因在下面的講解會詳細分析
     */

     private static int roundUpToPowerOf2(int number) {  
   
       //若 容量超過了最大值,初始化容量設定為最大值 ;否則,設定為:>傳入容量大小的最小的2的次冪
       return number >= MAXIMUM_CAPACITY  ? 
            MAXIMUM_CAPACITY  : (number > 1) ? Integer.highestOneBit((number - 1) << 1) : 1;  
複製程式碼
  • 再次強調:真正初始化雜湊表(初始化儲存陣列table)是在第1次新增鍵值對時,即第1次呼叫put()

分析2:當 key ==null時,將該 key-value 的儲存位置規定為陣列table 中的第1個位置,即table [0]

   /**
     * 函式使用原型
     */
      if (key == null)
           return putForNullKey(value);

   /**
     * 原始碼分析:putForNullKey(value)
     */
      private V putForNullKey(V value) {  
        // 遍歷以table[0]為首的連結串列,尋找是否存在key==null 對應的鍵值對
        // 1. 若有:則用新value 替換 舊value;同時返回舊的value值
        for (Entry<K,V> e = table[0]; e != null; e = e.next) {  
          if (e.key == null) {   
            V oldValue = e.value;  
            e.value = value;  
            e.recordAccess(this);  
            return oldValue;  
        }  
    }  
    modCount++;  

    // 2 .若無key==null的鍵,那麼呼叫addEntry(),將空鍵 & 對應的值封裝到Entry中,並放到table[0]中
    addEntry(0, null, value, 0); 
    // 注:
    // a. addEntry()的第1個引數 = hash值 = 傳入0
    // b. 即 說明:當key = null時,也有hash值 = 0,所以HashMap的key 可為null
    // c. 對比HashTable,由於HashTable對key直接hashCode(),若key為null時,會丟擲異常,所以HashTable的key不可為null
    // d. 此處只需知道是將 key-value 新增到HashMap中即可,關於addEntry()的原始碼分析將等到下面再詳細說明,
    return null;  

}     
複製程式碼

從此處可以看出:

  • HashMap的鍵key 可為null(區別於 HashTablekey 不可為null
  • HashMap的鍵key 可為null且只能為1個,但值value可為null且為多個

分析3:計算存放陣列 table 中的位置(即 陣列下標 or 索引)

   /**
     * 函式使用原型
     * 主要分為2步:計算hash值、根據hash值再計算得出最後陣列位置
     */
        // a. 根據鍵值key計算hash值 ->> 分析1
        int hash = hash(key);
        // b. 根據hash值 最終獲得 key對應存放的陣列Table中位置 ->> 分析2
        int i = indexFor(hash, table.length);

   /**
     * 原始碼分析1:hash(key)
     * 該函式在JDK 1.7 和 1.8 中的實現不同,但原理一樣 = 擾動函式 = 使得根據key生成的雜湊碼(hash值)分佈更加均勻、更具備隨機性,避免出現hash值衝突(即指不同key但生成同1個hash值)
     * JDK 1.7 做了9次擾動處理 = 4次位運算 + 5次異或運算
     * JDK 1.8 簡化了擾動函式 = 只做了2次擾動 = 1次位運算 + 1次異或運算
     */

     // JDK 1.7實現:將 鍵key 轉換成 雜湊碼(hash值)操作  = 使用hashCode() + 4次位運算 + 5次異或運算(9次擾動)
     static final int hash(int h) {
        h ^= k.hashCode(); 
        h ^= (h >>> 20) ^ (h >>> 12);
        return h ^ (h >>> 7) ^ (h >>> 4);
     }

      // JDK 1.8實現:將 鍵key 轉換成 雜湊碼(hash值)操作 = 使用hashCode() + 1次位運算 + 1次異或運算(2次擾動)
      // 1. 取hashCode值: h = key.hashCode() 
     //  2. 高位參與低位的運算:h ^ (h >>> 16)  
      static final int hash(Object key) {
           int h;
            return (key == null) ? 0 : (h = key.hashCode()) ^ (h >>> 16);
            // a. 當key = null時,hash值 = 0,所以HashMap的key 可為null      
            // 注:對比HashTable,HashTable對key直接hashCode(),若key為null時,會丟擲異常,所以HashTable的key不可為null
            // b. 當key ≠ null時,則通過先計算出 key的 hashCode()(記為h),然後 對雜湊碼進行 擾動處理: 按位 異或(^) 雜湊碼自身右移16位後的二進位制
     }

   /**
     * 函式原始碼分析2:indexFor(hash, table.length)
     * JDK 1.8中實際上無該函式,但原理相同,即具備類似作用的函式
     */
      static int indexFor(int h, int length) {  
          return h & (length-1); 
          // 將對雜湊碼擾動處理後的結果 與運算(&) (陣列長度-1),最終得到儲存在陣列table的位置(即陣列下標、索引)
}
複製程式碼
  • 總結 計算存放在陣列 table 中的位置(即陣列下標、索引)的過程
    示意圖

在瞭解 如何計算存放陣列table 中的位置 後,所謂 知其然 而 需知其所以然,下面我將講解為什麼要這樣計算,即主要解答以下3個問題:

  1. 為什麼不直接採用經過hashCode()處理的雜湊碼 作為 儲存陣列table的下標位置?
  2. 為什麼採用 雜湊碼 與運算(&) (陣列長度-1) 計算陣列下標?
  3. 為什麼在計算陣列下標前,需對雜湊碼進行二次處理:擾動處理?

在回答這3個問題前,請大家記住一個核心思想:

所有處理的根本目的,都是為了提高 儲存key-value的陣列下標位置 的隨機性 & 分佈均勻性,儘量避免出現hash值衝突。即:對於不同key,儲存的陣列下標位置要儘可能不一樣

問題1:為什麼不直接採用經過hashCode()處理的雜湊碼 作為 儲存陣列table的下標位置?

  • 結論:容易出現 雜湊碼 與 陣列大小範圍不匹配的情況,即 計算出來的雜湊碼可能 不在陣列大小範圍內,從而導致無法匹配儲存位置
  • 原因描述

示意圖

  • 為了解決 “雜湊碼與陣列大小範圍不匹配” 的問題,HashMap給出瞭解決方案:雜湊碼 與運算(&) (陣列長度-1);請繼續問題2

問題2:為什麼採用 雜湊碼 與運算(&) (陣列長度-1) 計算陣列下標?

  • 結論:根據HashMap的容量大小(陣列長度),按需取 雜湊碼一定數量的低位 作為儲存的陣列下標位置,從而 解決 “雜湊碼與陣列大小範圍不匹配” 的問題

  • 具體解決方案描述

示意圖

問題3:為什麼在計算陣列下標前,需對雜湊碼進行二次處理:擾動處理?

  • 結論:加大雜湊碼低位的隨機性,使得分佈更均勻,從而提高對應陣列儲存下標位置的隨機性 & 均勻性,最終減少Hash衝突

  • 具體描述

示意圖

至此,關於怎麼計算 key-value 值儲存在HashMap陣列位置 & 為什麼要這麼計算,講解完畢。


分析4:若對應的key已存在,則 使用 新value 替換 舊value

注:當發生 Hash衝突時,為了保證 鍵key的唯一性雜湊表並不會馬上在連結串列中插入新資料,而是先查詢該 key是否已存在,若已存在,則替換即可

   /**
     * 函式使用原型
     */
// 2. 判斷該key對應的值是否已存在(通過遍歷 以該陣列元素為頭結點的連結串列 逐個判斷)
        for (Entry<K,V> e = table[i]; e != null; e = e.next) {
            Object k;
            // 2.1 若該key已存在(即 key-value已存在 ),則用 新value 替換 舊value
            if (e.hash == hash && ((k = e.key) == key || key.equals(k))) {
                V oldValue = e.value;
                e.value = value;
                e.recordAccess(this);
                return oldValue; //並返回舊的value
            }
        }

        modCount++;

        // 2.2 若 該key不存在,則將“key-value”新增到table中
        addEntry(hash, key, value, i);
        return null;
複製程式碼
  • 此處無複雜的原始碼分析,但此處的分析點主要有2個:替換流程 & key是否存在(即key值的對比)

分析1:替換流程

具體如下圖:

示意圖

分析2:key值的比較

採用 equals() 或 "==" 進行比較,下面給出其介紹 & 與 “==”使用的對比

示意圖


分析5:若對應的key不存在,則將該“key-value”新增到陣列table的對應位置中

  • 函式原始碼分析如下
      /**
        * 函式使用原型
        */
       // 2. 判斷該key對應的值是否已存在
        for (Entry<K,V> e = table[i]; e != null; e = e.next) {
            Object k;
            // 2.1 若該key對應的值已存在,則用新的value取代舊的value
            if (e.hash == hash && ((k = e.key) == key || key.equals(k))) {
                V oldValue = e.value;
                e.value = value;
                e.recordAccess(this); 
                return oldValue; 
            }
        }

        modCount++;

        // 2.2 若 該key對應的值不存在,則將“key-value”新增到table中
        addEntry(hash, key, value, i);

   /**
     * 原始碼分析:addEntry(hash, key, value, i)
     * 作用:新增鍵值對(Entry )到 HashMap中
     */
      void addEntry(int hash, K key, V value, int bucketIndex) {  
          // 引數3 = 插入陣列table的索引位置 = 陣列下標
          
          // 1. 插入前,先判斷容量是否足夠
          // 1.1 若不足夠,則進行擴容(2倍)、重新計算Hash值、重新計算儲存陣列下標
          if ((size >= threshold) && (null != table[bucketIndex])) {  
            resize(2 * table.length); // a. 擴容2倍  --> 分析1
            hash = (null != key) ? hash(key) : 0;  // b. 重新計算該Key對應的hash值
            bucketIndex = indexFor(hash, table.length);  // c. 重新計算該Key對應的hash值的儲存陣列下標位置
    }  

    // 1.2 若容量足夠,則建立1個新的陣列元素(Entry) 並放入到陣列中--> 分析2
    createEntry(hash, key, value, bucketIndex);  
}  

 /**
   * 分析1:resize(2 * table.length)
   * 作用:當容量不足時(容量 > 閾值),則擴容(擴到2倍)
   */ 
   void resize(int newCapacity) {  
    
    // 1. 儲存舊陣列(old table) 
    Entry[] oldTable = table;  

    // 2. 儲存舊容量(old capacity ),即陣列長度
    int oldCapacity = oldTable.length; 

    // 3. 若舊容量已經是系統預設最大容量了,那麼將閾值設定成整型的最大值,退出    
    if (oldCapacity == MAXIMUM_CAPACITY) {  
        threshold = Integer.MAX_VALUE;  
        return;  
    }  
  
    // 4. 根據新容量(2倍容量)新建1個陣列,即新table  
    Entry[] newTable = new Entry[newCapacity];  

    // 5. 將舊陣列上的資料(鍵值對)轉移到新table中,從而完成擴容 ->>分析1.1 
    transfer(newTable); 

    // 6. 新陣列table引用到HashMap的table屬性上
    table = newTable;  

    // 7. 重新設定閾值  
    threshold = (int)(newCapacity * loadFactor); 
} 

 /**
   * 分析1.1:transfer(newTable); 
   * 作用:將舊陣列上的資料(鍵值對)轉移到新table中,從而完成擴容
   * 過程:按舊連結串列的正序遍歷連結串列、在新連結串列的頭部依次插入
   */ 
void transfer(Entry[] newTable) {
      // 1. src引用了舊陣列
      Entry[] src = table; 

      // 2. 獲取新陣列的大小 = 獲取新容量大小                 
      int newCapacity = newTable.length;

      // 3. 通過遍歷 舊陣列,將舊陣列上的資料(鍵值對)轉移到新陣列中
      for (int j = 0; j < src.length; j++) { 
      	  // 3.1 取得舊陣列的每個元素  
          Entry<K,V> e = src[j];           
          if (e != null) {
              // 3.2 釋放舊陣列的物件引用(for迴圈後,舊陣列不再引用任何物件)
              src[j] = null; 

              do { 
                  // 3.3 遍歷 以該陣列元素為首 的連結串列
                  // 注:轉移連結串列時,因是單連結串列,故要儲存下1個結點,否則轉移後連結串列會斷開
                  Entry<K,V> next = e.next; 
                 // 3.4 重新計算每個元素的儲存位置
                 int i = indexFor(e.hash, newCapacity); 
                 // 3.5 將元素放在陣列上:採用單連結串列的頭插入方式 = 在連結串列頭上存放資料 = 將陣列位置的原有資料放在後1個指標、將需放入的資料放到陣列位置中
                 // 即 擴容後,可能出現逆序:按舊連結串列的正序遍歷連結串列、在新連結串列的頭部依次插入
                 e.next = newTable[i]; 
                 newTable[i] = e;  
                 // 3.6 訪問下1個Entry鏈上的元素,如此不斷迴圈,直到遍歷完該連結串列上的所有節點
                 e = next;             
             } while (e != null);
             // 如此不斷迴圈,直到遍歷完陣列上的所有資料元素
         }
     }
 }

 /**
   * 分析2:createEntry(hash, key, value, bucketIndex);  
   * 作用: 若容量足夠,則建立1個新的陣列元素(Entry) 並放入到陣列中
   */  
void createEntry(int hash, K key, V value, int bucketIndex) { 

    // 1. 把table中該位置原來的Entry儲存  
    Entry<K,V> e = table[bucketIndex];

    // 2. 在table中該位置新建一個Entry:將原頭結點位置(陣列上)的鍵值對 放入到(連結串列)後1個節點中、將需插入的鍵值對 放入到頭結點中(陣列上)-> 從而形成連結串列
    // 即 在插入元素時,是在連結串列頭插入的,table中的每個位置永遠只儲存最新插入的Entry,舊的Entry則放入到連結串列中(即 解決Hash衝突)
    table[bucketIndex] = new Entry<>(hash, key, value, e);  

    // 3. 雜湊表的鍵值對數量計數增加
    size++;  
}   
複製程式碼

此處有2點需特別注意:鍵值對的新增方式 & 擴容機制

1. 鍵值對的新增方式:單連結串列的頭插法

  • 即 將該位置(陣列上)原來的資料放在該位置的(連結串列)下1個節點中(next)、在該位置(陣列上)放入需插入的資料-> 從而形成連結串列
  • 如下示意圖

示意圖

2. 擴容機制

  • 具體流程如下:

示意圖

  • 擴容過程中的轉移資料示意圖如下

示意圖

在擴容resize()過程中,在將舊陣列上的資料 轉移到 新陣列上時,轉移操作 = 按舊連結串列的正序遍歷連結串列、在新連結串列的頭部依次插入,即在轉移資料、擴容後,容易出現連結串列逆序的情況

設重新計算儲存位置後不變,即擴容前 = 1->2->3,擴容後 = 3->2->1

  • 此時若(多執行緒)併發執行 put()操作,一旦出現擴容情況,則 容易出現 環形連結串列,從而在獲取資料、遍歷連結串列時 形成死迴圈(Infinite Loop),即 死鎖的狀態 = 執行緒不安全

下面最後1節會對上述情況詳細說明

總結

  • HashMap 新增資料(成對 放入 鍵 - 值對)的全流程

示意圖

  • 示意圖
    示意圖

至此,關於 “向 HashMap 新增資料(成對 放入 鍵 - 值對)“講解完畢


步驟3:從HashMap中獲取資料

  • 假如理解了上述put()函式的原理,那麼get()函式非常好理解,因為二者的過程原理幾乎相同
  • get()函式的流程如下:

示意圖

  • 具體原始碼分析如下
/**
   * 函式原型
   * 作用:根據鍵key,向HashMap獲取對應的值
   */ 
   map.get(key);


 /**
   * 原始碼分析
   */ 
   public V get(Object key) {  

    // 1. 當key == null時,則到 以雜湊表陣列中的第1個元素(即table[0])為頭結點的連結串列去尋找對應 key == null的鍵
    if (key == null)  
        return getForNullKey(); --> 分析1

    // 2. 當key ≠ null時,去獲得對應值 -->分析2
    Entry<K,V> entry = getEntry(key);
  
    return null == entry ? null : entry.getValue();  
}  


 /**
   * 分析1:getForNullKey()
   * 作用:當key == null時,則到 以雜湊表陣列中的第1個元素(即table[0])為頭結點的連結串列去尋找對應 key == null的鍵
   */ 
private V getForNullKey() {  

    if (size == 0) {  
        return null;  
    }  

    // 遍歷以table[0]為頭結點的連結串列,尋找 key==null 對應的值
    for (Entry<K,V> e = table[0]; e != null; e = e.next) {  

        // 從table[0]中取key==null的value值 
        if (e.key == null)  
            return e.value; 
    }  
    return null;  
}  
 
 /**
   * 分析2:getEntry(key)
   * 作用:當key ≠ null時,去獲得對應值
   */  
final Entry<K,V> getEntry(Object key) {  

    if (size == 0) {  
        return null;  
    }  

    // 1. 根據key值,通過hash()計算出對應的hash值
    int hash = (key == null) ? 0 : hash(key);  

    // 2. 根據hash值計算出對應的陣列下標
    // 3. 遍歷 以該陣列下標的陣列元素為頭結點的連結串列所有節點,尋找該key對應的值
    for (Entry<K,V> e = table[indexFor(hash, table.length)];  e != null;  e = e.next) {  

        Object k;  
        // 若 hash值 & key 相等,則證明該Entry = 我們要的鍵值對
        // 通過equals()判斷key是否相等
        if (e.hash == hash &&  
            ((k = e.key) == key || (key != null && key.equals(k))))  
            return e;  
    }  
    return null;  
}  
複製程式碼

至此,關於 “向 HashMap 獲取資料 “講解完畢


步驟4:對HashMap的其他操作

即 對其餘使用API(函式、方法)的原始碼分析

  • HashMap除了核心的put()get()函式,還有以下主要使用的函式方法
void clear(); // 清除雜湊表中的所有鍵值對
int size();  // 返回雜湊表中所有 鍵值對的數量 = 陣列中的鍵值對 + 連結串列中的鍵值對
boolean isEmpty(); // 判斷HashMap是否為空;size == 0時 表示為 空 

void putAll(Map<? extends K, ? extends V> m);  // 將指定Map中的鍵值對 複製到 此Map中
V remove(Object key);  // 刪除該鍵值對

boolean containsKey(Object key); // 判斷是否存在該鍵的鍵值對;是 則返回true
boolean containsValue(Object value);  // 判斷是否存在該值的鍵值對;是 則返回true
 
複製程式碼
  • 下面將簡單介紹上面幾個函式的原始碼分析
  /**
   * 函式:isEmpty()
   * 作用:判斷HashMap是否為空,即無鍵值對;size == 0時 表示為 空 
   */

public boolean isEmpty() {  
    return size == 0;  
} 

 /**
   * 函式:size()
   * 作用:返回雜湊表中所有 鍵值對的數量 = 陣列中的鍵值對 + 連結串列中的鍵值對
   */

   public int size() {  
    return size;  
}  

 /**
   * 函式:clear()
   * 作用:清空雜湊表,即刪除所有鍵值對
   * 原理:將陣列table中儲存的Entry全部置為null、size置為0
   */ 
public void clear() {  
    modCount++;  
    Arrays.fill(table, null);
    size = 0;
}  

/**
   * 函式:putAll(Map<? extends K, ? extends V> m)
   * 作用:將指定Map中的鍵值對 複製到 此Map中
   * 原理:類似Put函式
   */ 

    public void putAll(Map<? extends K, ? extends V> m) {  
    // 1. 統計需複製多少個鍵值對  
    int numKeysToBeAdded = m.size();  
    if (numKeysToBeAdded == 0)  
        return; 

    // 2. 若table還沒初始化,先用剛剛統計的複製數去初始化table  
    if (table == EMPTY_TABLE) {  
        inflateTable((int) Math.max(numKeysToBeAdded * loadFactor, threshold));  
    }  
  
    // 3. 若需複製的數目 > 閾值,則需先擴容 
    if (numKeysToBeAdded > threshold) {  
        int targetCapacity = (int)(numKeysToBeAdded / loadFactor + 1);  
        if (targetCapacity > MAXIMUM_CAPACITY)  
            targetCapacity = MAXIMUM_CAPACITY;  
        int newCapacity = table.length;  
        while (newCapacity < targetCapacity)  
            newCapacity <<= 1;  
        if (newCapacity > table.length)  
            resize(newCapacity);  
    }  
    // 4. 開始複製(實際上不斷呼叫Put函式插入)  
    for (Map.Entry<? extends K, ? extends V> e : m.entrySet())  
        put(e.getKey(), e.getValue());
}  

 /**
   * 函式:remove(Object key)
   * 作用:刪除該鍵值對
   */ 

public V remove(Object key) {  
    Entry<K,V> e = removeEntryForKey(key);  
    return (e == null ? null : e.value);  
}  
  
final Entry<K,V> removeEntryForKey(Object key) {  
    if (size == 0) {  
        return null;  
    }  
    // 1. 計算hash值
    int hash = (key == null) ? 0 : hash(key);  
    // 2. 計算儲存的陣列下標位置
    int i = indexFor(hash, table.length);  
    Entry<K,V> prev = table[i];  
    Entry<K,V> e = prev;  
  
    while (e != null) {  
        Entry<K,V> next = e.next;  
        Object k;  
        if (e.hash == hash &&  
            ((k = e.key) == key || (key != null && key.equals(k)))) {  
            modCount++;  
            size--; 
            // 若刪除的是table陣列中的元素(即連結串列的頭結點) 
            // 則刪除操作 = 將頭結點的next引用存入table[i]中  
            if (prev == e) 
                table[i] = next;

            //否則 將以table[i]為頭結點的連結串列中,當前Entry的前1個Entry中的next 設定為 當前Entry的next(即刪除當前Entry = 直接跳過當前Entry)
            else  
                prev.next = next;   
            e.recordRemoval(this);  
            return e;  
        }  
        prev = e;  
        e = next;  
    }  
  
    return e;  
} 

 /**
   * 函式:containsKey(Object key)
   * 作用:判斷是否存在該鍵的鍵值對;是 則返回true
   * 原理:呼叫get(),判斷是否為Null
   */
   public boolean containsKey(Object key) {  
    return getEntry(key) != null; 
} 

 /**
   * 函式:containsValue(Object value)
   * 作用:判斷是否存在該值的鍵值對;是 則返回true
   */   
public boolean containsValue(Object value) {  
    // 若value為空,則呼叫containsNullValue()  
    if (value == null)
        return containsNullValue();  
    
    // 若value不為空,則遍歷連結串列中的每個Entry,通過equals()比較values 判斷是否存在
    Entry[] tab = table;
    for (int i = 0; i < tab.length ; i++)  
        for (Entry e = tab[i] ; e != null ; e = e.next)  
            if (value.equals(e.value)) 
                return true;//返回true  
    return false;  
}  
  
// value為空時呼叫的方法  
private boolean containsNullValue() {  
    Entry[] tab = table;  
    for (int i = 0; i < tab.length ; i++)  
        for (Entry e = tab[i] ; e != null ; e = e.next)  
            if (e.value == null)
                return true;  
    return false;  
} 

複製程式碼

至此,關於HashMap的底層原理 & 主要使用API(函式、方法)講解完畢。


6. 原始碼總結

下面,用3個圖總結整個原始碼內容:

總結內容 = 資料結構、主要引數、新增 & 查詢資料流程、擴容機制

  • 資料結構 & 主要引數

    示意圖

  • 新增 & 查詢資料流程

    示意圖

  • 擴容機制

    示意圖


7. 與 JDK 1.8的區別

HashMap 的實現在 JDK 1.7JDK 1.8 差別較大,具體區別如下

JDK 1.8 的優化目的主要是:減少 Hash衝突 & 提高雜湊表的存、取效率;關於 JDK 1.8HashMap 的原始碼解析請看文章:Java原始碼分析:關於 HashMap 1.8 的重大更新

7.1 資料結構

示意圖

7.2 存入資料時(獲取資料 類似)

示意圖

7.3 擴容機制

示意圖


8. 額外補充:關於HashMap的其他問題

  • 有幾個小問題需要在此補充

示意圖

  • 具體如下

8.1 雜湊表如何解決Hash衝突

示意圖

8.2 為什麼HashMap具備下述特點:鍵-值(key-value)都允許為空、執行緒不安全、不保證有序、儲存位置隨時間變化

  • 具體解答如下

示意圖

  • 下面主要講解 HashMap 執行緒不安全的其中一個重要原因:多執行緒下容易出現resize()死迴圈 本質 = 併發 執行 put()操作導致觸發 擴容行為,從而導致 環形連結串列,使得在獲取資料遍歷連結串列時形成死迴圈,即Infinite Loop

  • 先看擴容的原始碼分析resize()

關於resize()的原始碼分析已在上文詳細分析,此處僅作重點分析:transfer()

/**
   * 原始碼分析:resize(2 * table.length)
   * 作用:當容量不足時(容量 > 閾值),則擴容(擴到2倍)
   */ 
   void resize(int newCapacity) {  
    
    // 1. 儲存舊陣列(old table) 
    Entry[] oldTable = table;  

    // 2. 儲存舊容量(old capacity ),即陣列長度
    int oldCapacity = oldTable.length; 

    // 3. 若舊容量已經是系統預設最大容量了,那麼將閾值設定成整型的最大值,退出    
    if (oldCapacity == MAXIMUM_CAPACITY) {  
        threshold = Integer.MAX_VALUE;  
        return;  
    }  
  
    // 4. 根據新容量(2倍容量)新建1個陣列,即新table  
    Entry[] newTable = new Entry[newCapacity];  

    // 5. (重點分析)將舊陣列上的資料(鍵值對)轉移到新table中,從而完成擴容 ->>分析1.1 
    transfer(newTable); 

    // 6. 新陣列table引用到HashMap的table屬性上
    table = newTable;  

    // 7. 重新設定閾值  
    threshold = (int)(newCapacity * loadFactor); 
} 

 /**
   * 分析1.1:transfer(newTable); 
   * 作用:將舊陣列上的資料(鍵值對)轉移到新table中,從而完成擴容
   * 過程:按舊連結串列的正序遍歷連結串列、在新連結串列的頭部依次插入
   */ 
void transfer(Entry[] newTable) {
      // 1. src引用了舊陣列
      Entry[] src = table; 

      // 2. 獲取新陣列的大小 = 獲取新容量大小                 
      int newCapacity = newTable.length;

      // 3. 通過遍歷 舊陣列,將舊陣列上的資料(鍵值對)轉移到新陣列中
      for (int j = 0; j < src.length; j++) { 
          // 3.1 取得舊陣列的每個元素  
          Entry<K,V> e = src[j];           
          if (e != null) {
              // 3.2 釋放舊陣列的物件引用(for迴圈後,舊陣列不再引用任何物件)
              src[j] = null; 

              do { 
                  // 3.3 遍歷 以該陣列元素為首 的連結串列
                  // 注:轉移連結串列時,因是單連結串列,故要儲存下1個結點,否則轉移後連結串列會斷開
                  Entry<K,V> next = e.next; 
                 // 3.3 重新計算每個元素的儲存位置
                 int i = indexFor(e.hash, newCapacity); 
                 // 3.4 將元素放在陣列上:採用單連結串列的頭插入方式 = 在連結串列頭上存放資料 = 將陣列位置的原有資料放在後1個指標、將需放入的資料放到陣列位置中
                 // 即 擴容後,可能出現逆序:按舊連結串列的正序遍歷連結串列、在新連結串列的頭部依次插入
                 e.next = newTable[i]; 
                 newTable[i] = e;  
                 // 訪問下1個Entry鏈上的元素,如此不斷迴圈,直到遍歷完該連結串列上的所有節點
                 e = next;             
             } while (e != null);
             // 如此不斷迴圈,直到遍歷完陣列上的所有資料元素
         }
     }
 }
複製程式碼

從上面可看出:在擴容resize()過程中,在將舊陣列上的資料 轉移到 新陣列上時,轉移資料操作 = 按舊連結串列的正序遍歷連結串列、在新連結串列的頭部依次插入,即在轉移資料、擴容後,容易出現連結串列逆序的情況

設重新計算儲存位置後不變,即擴容前 = 1->2->3,擴容後 = 3->2->1

  • 此時若(多執行緒)併發執行 put()操作,一旦出現擴容情況,則 容易出現 環形連結串列,從而在獲取資料、遍歷連結串列時 形成死迴圈(Infinite Loop),即 死鎖的狀態,具體請看下圖:

初始狀態、步驟1、步驟2

示意圖

示意圖

示意圖

注:由於 JDK 1.8 轉移資料操作 = 按舊連結串列的正序遍歷連結串列、在新連結串列的尾部依次插入,所以不會出現連結串列 逆序、倒置的情況,故不容易出現環形連結串列的情況。

JDK 1.8 還是執行緒不安全,因為 無加同步鎖保護

8.3 為什麼 HashMap 中 String、Integer 這樣的包裝類適合作為 key 鍵

示意圖

8.4 HashMap 中的 keyObject型別, 則需實現哪些方法?

示意圖

至此,關於HashMap的所有知識講解完畢。


9. 總結

  • 本文主要講解 JavaHashMap原始碼 & 相關知識
  • 下面我將繼續對JavaAndroid中的其他知識 深入講解 ,有興趣可以繼續關注Carson_Ho的安卓開發筆記

請點贊!因為你的鼓勵是我寫作的最大動力!


歡迎關注carson_ho的微信公眾號

示意圖

示意圖

相關文章