詳解HashMap原始碼解析(下)

小碼code發表於2022-07-05

上文詳解HashMap原始碼解析(上)介紹了HashMap整體介紹了一下資料結構,主要屬性欄位,獲取陣列的索引下標,以及幾個構造方法。本文重點講解元素的新增查詢擴容等主要方法。

新增元素

put(K key, V value)

public V put(K key, V value) {
    return putVal(hash(key), key, value, false, true);
}

首先算出key的雜湊碼,呼叫hash方法,獲取到hash值。

  • 呼叫putVal()
    /**
     * @param hash hash for key       hash 值
     * @param key the key             key 值
     * @param value the value to put  value 值
     * @param onlyIfAbsent if true, don't change existing value   只有不存在,才不改變他的值
     * @param evict if false, the table is in creation mode.          
     * @return previous value, or null if none                                返回上一個值,如果不存在返回null
     */
    final V putVal(int hash, K key, V value, boolean onlyIfAbsent,
                   boolean evict) {
        // 宣告一個node陣列 tab,node 節點 
        Node<K,V>[] tab; Node<K,V> p; int n, i;
        // 如果 table 為 null 或者 tab的長度為 0 ,|| 兩邊都要做一下判斷,table 為空,或者table的長度為0
        if ((tab = table) == null || (n = tab.length) == 0)
            // table 初始化
            n = (tab = resize()).length;
        //  不存在,直接新建一個Node節點
        if ((p = tab[i = (n - 1) & hash]) == null)
            // 新建節點
            tab[i] = newNode(hash, key, value, null);
        else {
            // 存在節點
            Node<K,V> e; K k;
            // hash值 和 p 節點的hash值一致,(鍵值的地址)一致或者(鍵的值)一致,直接替換
            if (p.hash == hash &&
                ((k = p.key) == key || (key != null && key.equals(k))))
                e = p;
            // 節點是紅黑樹
            else if (p instanceof TreeNode)
                e = ((TreeNode<K,V>)p).putTreeVal(this, tab, hash, key, value);
            else {
                // 節點是連結串列,從前往後遍歷
                for (int binCount = 0; ; ++binCount) {
                    // 遍歷連結串列的最後一個節點
                    if ((e = p.next) == null) {
                        p.next = newNode(hash, key, value, null);
                        // 連結串列個數大於等於 8,因為從零開始所以要減一
                        if (binCount >= TREEIFY_THRESHOLD - 1) // -1 for 1st
                            // 轉成紅黑樹
                            treeifyBin(tab, hash);
                        break;
                    }
                    // hash一致 或者 值一致 
                    if (e.hash == hash &&
                        ((k = e.key) == key || (key != null && key.equals(k))))
                        break;
                    p = e;
                }
            }
           // e不為空,直接替換賦值
            if (e != null) { // existing mapping for key
                V oldValue = e.value;
                if (!onlyIfAbsent || oldValue == null)
                   // 原來的值為空,賦值
                    e.value = value;
                afterNodeAccess(e);
                return oldValue;
            }
        }
        ++modCount;
        if (++size > threshold)
            resize();
        afterNodeInsertion(evict);
        return null;
    }
  • 首先判斷雜湊陣列table是否為null,如果為null,就擴容。
  • (n - 1) & hash對應的下標是否存在節點。
    • 不存在節點,就建立新的節點並賦值。
    • 存在節點
      • 節點key值是否相等,相等就替換 value
      • 是否為紅黑樹,新增資料到紅黑樹中。
      • 上面都不符合,就是普通連結串列,遍歷連結串列,如果連結串列存在相同key就替換,否則在連結串列最後新增資料。

流程圖:

putAll(Map<? extends K, ? extends V> m)

putAll 是將集合元素全部新增到HashMap中,putAll呼叫了putMapEntries方法,putMapEntries先判斷是否需要擴容,然後遍歷元素,呼叫putVal新增元素,下面是新增元素程式碼:

for (Map.Entry<? extends K, ? extends V> e : m.entrySet()) {
    K key = e.getKey();
    V value = e.getValue();
    putVal(hash(key), key, value, false, evict);
}

獲取資料

get(Object key)

通過key找到雜湊表的中Node節點的value值。

// 返回map對映對應的value值
public V get(Object key) {
    Node<K,V> e;
    return (e = getNode(hash(key), key)) == null ? null : e.value;
}

首先使用hash方法算出雜湊值,然後再呼叫getNode()獲取資料:

final Node<K,V> getNode(int hash, Object key) {
    Node<K,V>[] tab; Node<K,V> first, e; int n; K k;
    // 判斷tab有資料,並且對應下標存在資料
    if ((tab = table) != null && (n = tab.length) > 0 &&
        (first = tab[(n - 1) & hash]) != null) {
        // hash相等以及key相等(key地址相等或者key的值相等),找的就是第一個元素
        if (first.hash == hash && // always check first node
            ((k = first.key) == key || (key != null && key.equals(k))))
            return first;
        // 遍歷連結串列    
        if ((e = first.next) != null) {
            // 紅黑樹找到當前key所在的節點位置 
            if (first instanceof TreeNode)
                return ((TreeNode<K,V>)first).getTreeNode(hash, key);
            do {
                // 普通連結串列,往後遍歷,直到找到資料或者遍歷到連結串列末尾為止
                if (e.hash == hash &&
                    ((k = e.key) == key || (key != null && key.equals(k))))
                    return e;
            } while ((e = e.next) != null);
        }
    }
    return null;
}
  • 判斷雜湊陣列是否不為null並且陣列下標(n - 1) & hash處不為null,如果都有值,就查詢首節點first,否則返回null
  • 找到首節點,匹配上相等的hashkey,返回首節點。
  • 連結串列有多個元素,是否為紅黑樹
    • 是紅黑樹,在紅黑樹查詢
    • 不是紅黑樹,就遍歷普通連結串列,直到匹配到相同的hashkey值。

流程圖:

resize 擴容

當雜湊陣列為null,或元素個數超過了閾值,就呼叫resize擴容方法:

final Node<K,V>[] resize() {
    // 記錄原陣列
    Node<K,V>[] oldTab = table;
    // 原陣列長度 
    int oldCap = (oldTab == null) ? 0 : oldTab.length;
    // 原閾值(陣列長度達到閾值)
    int oldThr = threshold;
    // 新容量,新閾值
    int newCap, newThr = 0;
    if (oldCap > 0) {
        // 陣列長度大於或者等於MAXIMUM_CAPACITY(1>>30)不做擴容操作。
        if (oldCap >= MAXIMUM_CAPACITY) {
            threshold = Integer.MAX_VALUE;
            return oldTab;
        }
        // 擴容後長度小於MAXIMUM_CAPACITY(1>>30)並且陣列原來長度大於16
        // 閾值和新容量都翻倍
        else if ((newCap = oldCap << 1) < MAXIMUM_CAPACITY &&
                 oldCap >= DEFAULT_INITIAL_CAPACITY)
            newThr = oldThr << 1; // double threshold
    }
    // 閾值大於零,舊閾值替換成新容量
    else if (oldThr > 0) // initial capacity was placed in threshold
        newCap = oldThr;
    else {               // zero initial threshold signifies using defaults
        // oldCap 和 oldThr 都小於等於0,說明是呼叫無參構造方法,賦值預設容量16,預設閾值12。
        newCap = DEFAULT_INITIAL_CAPACITY;
        newThr = (int)(DEFAULT_LOAD_FACTOR * DEFAULT_INITIAL_CAPACITY);
    }
    if (newThr == 0) {
        // 新閾值為零,計算閾值
        float ft = (float)newCap * loadFactor;
        newThr = (newCap < MAXIMUM_CAPACITY && ft < (float)MAXIMUM_CAPACITY ?
                  (int)ft : Integer.MAX_VALUE);
    }
    threshold = newThr;
    @SuppressWarnings({"rawtypes","unchecked"})
    // 新建Node陣列。呼叫無參構造方法,並不會建立陣列,在第一次呼叫put方法,才會呼叫resize方法,才會建立陣列,延遲載入,提高效率。
    Node<K,V>[] newTab = (Node<K,V>[])new Node[newCap];
    table = newTab;
    // 原來的陣列不為空,把原來的陣列的元素重新分配到新的陣列中
    // 如果是第一次呼叫resize方法,就不需要重新分配陣列。
    if (oldTab != null) {
        // 舊陣列遍歷 
        for (int j = 0; j < oldCap; ++j) {
            Node<K,V> e;
            // 存在下標下的第一個元素
            if ((e = oldTab[j]) != null) {
                oldTab[j] = null;
                // 當前元素下一個元素為空,說明此處只有一個元素,直接使用元素的hash值和新陣列的容量取模,獲得新下標的位置
                if (e.next == null)
                    newTab[e.hash & (newCap - 1)] = e;
                // 紅黑樹,拆分紅黑樹,必要時可能退化為連結串列    
                else if (e instanceof TreeNode)
                    ((TreeNode<K,V>)e).split(this, newTab, j, oldCap);
                // 長度大於1的普通連結串列    
                else { // preserve order
                    // loHead、loTail分別代表舊位置的頭尾節點
                    Node<K,V> loHead = null, loTail = null;
                    // hiHead、hiTail分別代表新位置的頭尾節點
                    Node<K,V> hiHead = null, hiTail = null;
                    Node<K,V> next;
                    // 遍歷連結串列
                    do {
                        next = e.next;
                        // & 與運算,兩個都會1,結果才為1
                        // 元素的hash值和oldCap與運算為0,原位置不變
                        if ((e.hash & oldCap) == 0) {
                            if (loTail == null)
                                loHead = e;
                            else
                                loTail.next = e;
                            loTail = e;
                        }
                        // 移動到原來位置 + oldCap
                        else {
                            if (hiTail == null)
                                hiHead = e;
                            else
                                hiTail.next = e;
                            hiTail = e;
                        }
                    } while ((e = next) != null);
                    if (loTail != null) {
                        loTail.next = null;
                        newTab[j] = loHead;
                    }
                    if (hiTail != null) {
                        hiTail.next = null;
                        newTab[j + oldCap] = hiHead;
                    }
                }
            }
        }
    }
    return newTab;
}

  • 原容量是否為空
    • 不為空,是否大於最大容量
      • 大於最大容量,不做擴容
      • 小於最大容量,並且大於預設容量16。閾值和容量都翻倍。
    • 為空,原閾值大於零, 就閾值賦值給新容量。
  • 原容量和原閾值都小於等於零,賦值預設容量16和預設閾值12。
  • 做完閾值和容量的賦值之後,遍歷陣列。
  • 有值,是否只有一個元素,如果是就放入新陣列n-1&hash下標處。
  • 如果是紅黑樹就拆分紅黑樹。
  • 上面兩個都不符合就是普通連結串列。
  • 遍歷連結串列,如果hash&陣列原長度為0
    • 放在陣列原下標處。
    • 不為零,放在原位置+原陣列長度處。

流程圖:

總結

本文主要講解了元素的新增查詢擴容等主要方法,其中新增查詢都需要先獲取陣列的下標,然後進行對應的操作。

put新增

  • 首次新增資料需要對陣列進行擴容。
  • 對應下標是否有值
    • 沒有值,直接賦值
    • 有值
      • key一致,替換value值。
      • key不一致
        • 是紅黑樹,在紅黑樹新增資料。
        • 不是紅黑樹,就是連結串列,遍歷連結串列,存在相同節點key,替換。否者新增在連結串列的尾部。

get查詢

  • 下標是否有值
    • 沒有值,返回null
    • 有值
      *hashkey相等的話,返回節點。
      • 是否是多連結串列。
        • 不是,返回null
        • 是的話,是否是紅黑樹。
          • 紅黑樹,在紅黑樹中查詢
          • 否則就是普通連結串列,遍歷連結串列知道匹配到相同的hashkey

resize 擴容

  • 容量大於零
    • 大於最大容量值,不再擴容。
    • 介於最大和預設容量之間,閾值和容量都翻倍。
  • 初始化的時候,設定預設容量和預設閾值。
  • 遍歷原陣列
  • 節點有值,並且只有一個值,賦值給新陣列n-1&hash處。
  • 如果是紅黑樹,就拆分紅黑樹。
  • 以上都不符合,就是普通連結串列,遍歷連結串列。因為陣列長度都是2的冪次方,擴容後元素的位置*要麼是在原位置,要麼是在原位置再移動2次冪的位置
    • hash&與運算原陣列長度,等於0,存在原來的位置。
    • 不等於0,就存放下標原來位置+原陣列長度位置處。

相關文章