HashMap原始碼分析 —— 一篇文章搞定HashMap面試

桑小年發表於2019-03-19

本篇文章已授權微信公眾號 guolin_blog (郭霖)獨家釋出

HashMap是Map中最為常用的一種,面試中也經常會被問到相關的問題。由於HashMap資料結構較為複雜,回答相關問題的時候往往不盡人意,尤其是在JDK1.8之後,又引入了紅黑樹結構,其資料結構變的更加複雜,本文就JDK1.8原始碼為例,對HashMap進行分析;

1、原始碼分析

1.1 老規矩,先上構造方法

  
    public HashMap(int initialCapacity, float loadFactor) {
        if (initialCapacity < 0)
            throw new IllegalArgumentException("Illegal initial capacity: " +
                                               initialCapacity);
        if (initialCapacity > MAXIMUM_CAPACITY)
            initialCapacity = MAXIMUM_CAPACITY;
        if (loadFactor <= 0 || Float.isNaN(loadFactor))
            throw new IllegalArgumentException("Illegal load factor: " +
                                               loadFactor);
        this.loadFactor = loadFactor;
        this.threshold = tableSizeFor(initialCapacity);
    }
 
    public HashMap(int initialCapacity) {
        this(initialCapacity, DEFAULT_LOAD_FACTOR);
    }

  
    public HashMap() {
        this.loadFactor = DEFAULT_LOAD_FACTOR; // all other fields defaulted
    }
     
    public HashMap(Map<? extends K, ? extends V> m) {
        this.loadFactor = DEFAULT_LOAD_FACTOR;
        putMapEntries(m, false);
    }
複製程式碼

構造方法一共過載了四個,主要初始化了三個引數:

  • initialCapacity 初始容量(預設16): hashMap底層由陣列實現+連結串列(或紅黑樹)實現,但是還是從陣列開始,所以當儲存的資料越來越多的時候,就必須進行擴容操作,如果在知道需要儲存資料大小的情況下,指定合適的初始容量,可以避免不必要的擴容操作,提升效率
  • threshold 閾值:hashMap所能容納的最大價值對數量,如果超過則需要擴容,計算方式:threshold=initialCapacity*loadFactor(構造方法中直接通過tableSizeFor(initialCapacity)方法進行了賦值,主要原因是在構造方法中,陣列table並沒有初始化,put方法中進行初始化,同時put方法中也會對threshold進行重新賦值,這個會在後面的原始碼中進行分析)
  • loadFactor 載入因子(預設0.75):當負載因子較大時,去給table陣列擴容的可能性就會少,所以相對佔用記憶體較少(空間上較少),但是每條entry鏈上的元素會相對較多,查詢的時間也會增長(時間上較多)。反之就是,負載因子較少的時候,給table陣列擴容的可能性就高,那麼記憶體空間佔用就多,但是entry鏈上的元素就會相對較少,查出的時間也會減少。所以才有了負載因子是時間和空間上的一種折中的說法。所以設定負載因子的時候要考慮自己追求的是時間還是空間上的少。(一般情況下不需要設定,系統給的預設值已經比較適合了)

我們最常使用的是無參構造,在這個構造方法裡面僅僅設定了載入因子為預設值,其他兩個引數會在resize方法裡面進行初始化,在這裡知道這個結論就可以了,下面會在原始碼裡面進行分析; 另外一個帶有兩個引數的構造方法,裡面對初始容量和閾值進行了初始化,對閾值的初始化方法為 tableSizeFor(int cap),看一下原始碼:

    /**
     * 找到大於或等於 cap 的最小2的冪
     */
    static final int tableSizeFor(int cap) {
        int n = cap - 1;
        n |= n >>> 1;
        n |= n >>> 2;
        n |= n >>> 4;
        n |= n >>> 8;
        n |= n >>> 16;
        return (n < 0) ? 1 : (n >= MAXIMUM_CAPACITY) ? MAXIMUM_CAPACITY : n + 1;
    }
複製程式碼

第一次看大這個方法的時候,我當時的心情是:

HashMap原始碼分析 —— 一篇文章搞定HashMap面試

接下來分析一下這個方法,對於無符號右移運算子不瞭解的,可以看一下這篇文章瞭解一下,下面偷一張圖(真的是借別人的圖,google搜尋的,不知道是誰的,如果大佬覺得太可恥,私信我我刪了他)以10為例進行分析:

HashMap原始碼分析 —— 一篇文章搞定HashMap面試
另外,需要注意一下的是,第一步 int n = cap - 1; 這個操作,執行這個操作的主要原因是為了防止在cap已經是2的n次冪的情況下,經過運算後得到的結果是cap的二倍的結果,例如如果n為l6,經過一系列運算之後,得到的結果是0001 1111,此時最後一步n+1 執行之後,就會返回32,有興趣的可以自己進行嘗試;

1.2 put方法

在hashMap原始碼中,put方法邏輯是最為複雜的,接下來先看一下原始碼:

  public V put(K key, V value) {
        return putVal(hash(key), key, value, false, true);
    }
    
    final V putVal(int hash, K key, V value, boolean onlyIfAbsent,
                   boolean evict) {
        Node<K,V>[] tab; Node<K,V> p; int n, i;
        if ((tab = table) == null || (n = tab.length) == 0)
             //如果table尚未初始化,則此處進行初始化陣列,並賦值初始容量,重新計算閾值
            n = (tab = resize()).length;
        if ((p = tab[i = (n - 1) & hash]) == null)
            //通過hash找到下標,如果hash值指定的位置資料為空,則直接將資料存放進去
            tab[i] = newNode(hash, key, value, null);
        else {
            //如果通過hash找到的位置有資料,發生碰撞
            Node<K,V> e; K k;
            if (p.hash == hash &&
                ((k = p.key) == key || (key != null && key.equals(k))))
                //如果需要插入的key和當前hash值指定下標的key一樣,先將e陣列中已有的資料
                e = p;
            else if (p instanceof TreeNode)
                //如果此時桶中資料型別為 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);

                        //如果連結串列過長,達到樹化閾值,將連結串列轉化成紅黑樹
                        if (binCount >= TREEIFY_THRESHOLD - 1) // -1 for 1st
                            treeifyBin(tab, hash);
                        break;
                    }
                    //如果連結串列中有新插入的節點位置資料不為空,則此時e 賦值為節點的值,跳出迴圈
                    if (e.hash == hash &&
                        ((k = e.key) == key || (key != null && key.equals(k))))
                        break;
                    p = e;
                }
            }

            //經過上面的迴圈後,如果e不為空,則說明上面插入的值已經存在於當前的hashMap中,那麼更新指定位置的鍵值對
            if (e != null) { // existing mapping for key
                V oldValue = e.value;
                if (!onlyIfAbsent || oldValue == null)
                    e.value = value;
                afterNodeAccess(e);
                return oldValue;
            }
        }
        ++modCount;
        //如果此時hashMap size大於閾值,則進行擴容
        if (++size > threshold)
            resize();
        afterNodeInsertion(evict);
        return null;
    }

複製程式碼

從程式碼看,put方法分為三種情況:

  • table尚未初始化,對資料進行初始化

  • table已經初始化,且通過hash演算法找到下標所在的位置資料為空,直接將資料存放到指定位置

  • table已經初始化,且通過hash演算法找到下標所在的位置資料不為空,發生hash衝突(碰撞),發生碰撞後,會執行以下操作:

    • 判斷插入的key如果等於當前位置的key的話,將 e 指向該鍵值對
    • 如果此時桶中資料型別為 treeNode,使用紅黑樹進行插入
    • 如果是連結串列,則進行迴圈判斷, 如果連結串列中包含該節點,跳出迴圈,如果連結串列中不包含該節點,則把該節點插入到連結串列末尾,同時,如果連結串列長度超過樹化閾值(TREEIFY_THRESHOLD)且table容量超過最小樹化容量(MIN_TREEIFY_CAPACITY),則進行連結串列轉紅黑樹(由於table容量越小,越容易發生hash衝突,因此在table容量<MIN_TREEIFY_CAPACITY 的時候,如果連結串列長度>TREEIFY_THRESHOLD,會優先選擇擴容,否則會進行連結串列轉紅黑樹操作)

首先分析table尚未初始化的情況:

1.2.1 table尚未初始化
n = (tab = resize()).length;
複製程式碼

從程式碼可以看出,table尚未初始化的時候,會呼叫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;

        //1、table已經初始化,且容量 > 0
        if (oldCap > 0) {
            if (oldCap >= MAXIMUM_CAPACITY) {
                //如果舊的容量已近達到最大值,則不再擴容,閾值直接設定為最大值
                threshold = Integer.MAX_VALUE;
                return oldTab;
            }
            else if ((newCap = oldCap << 1) < MAXIMUM_CAPACITY &&
                     oldCap >= DEFAULT_INITIAL_CAPACITY)
                //如果舊的容量不小於預設的初始容量,則進行擴容,容量擴張為原來的二倍
                newThr = oldThr << 1; // double threshold
        }
        //2、閾值大於0 threshold 使用 threshold 變數暫時儲存 initialCapacity 引數的值
        else if (oldThr > 0) // initial capacity was placed in threshold
            newCap = oldThr;
        //3 threshold 和 table 皆未初始化情況,此處即為首次進行初始化
        //也就在此處解釋了構造方法中沒有對threshold 和 初始容量進行賦值的問題
        else {               // zero initial threshold signifies using defaults
            //如果閾值為零,表示使用預設的初始化值
            //這種情況在呼叫無參構造的時候會出現,此時使用預設的容量和閾值
            newCap = DEFAULT_INITIAL_CAPACITY;
            //此處閾值即為 threshold=initialCapacity*loadFactor
            newThr = (int)(DEFAULT_LOAD_FACTOR * DEFAULT_INITIAL_CAPACITY);
        }
        // newThr 為 0 時,按閾值計算公式進行計算,容量*負載因子
        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<K,V>[] newTab = (Node<K,V>[])new Node[newCap];
        table = newTab;

        //如果之前的陣列桶裡面已經存在資料,由於table容量發生變化,hash值也會發生變化,需要重新計算下標
        if (oldTab != null) {
            for (int j = 0; j < oldCap; ++j) {
                Node<K,V> e;
                //如果指定下標下有資料
                if ((e = oldTab[j]) != null) {
                    //1、將指定下標資料置空
                    oldTab[j] = null;
                    //2、指定下標只有一個資料
                    if (e.next == null)
                        //直接將資料存放到新計算的hash值下標下
                        newTab[e.hash & (newCap - 1)] = e;
                    //3、如果是TreeNode資料結構
                    else if (e instanceof TreeNode)

                        ((TreeNode<K,V>)e).split(this, newTab, j, oldCap);
                    //4、對於連結串列,資料結構
                    else { // preserve order
                        //如果是連結串列,重新計算hash值,根據新的下標重新分組
                        Node<K,V> loHead = null, loTail = null;
                        Node<K,V> hiHead = null, hiTail = null;
                        Node<K,V> next;
                        do {
                            next = e.next;
                            if ((e.hash & oldCap) == 0) {
                                if (loTail == null)
                                    loHead = e;
                                else
                                    loTail.next = e;
                                loTail = e;
                            }
                            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;
    }
複製程式碼

resize方法邏輯比較複雜,需要靜下心來一步步的分析,但是總的下來,分為以下幾步:

  • 首先先判斷當前table是否進行過初始化,如果沒有進行過初始化,此處就解決了呼叫無參構造方法時候,threshold和initialCapacity 未初始化的問題,如果已經初始化過了,則進行擴容,容量為原來的二倍
  • 擴容後建立新的table,並對所有的資料進行遍歷
    • 如果新計算的位置資料為空,則直接插入
    • 如果新計算的位置為連結串列,則通過hash演算法重新計算下標,對連結串列進行分組
    • 如果是紅黑樹,則需要進行拆分操作

1.3 get方法,查詢

put方法分析完成之後,剩下的就很簡單了,先看一下原始碼:

    public V get(Object key) {
        Node<K,V> e;
        return (e = getNode(hash(key), key)) == null ? null : e.value;
    }
    
    final Node<K,V> getNode(int hash, Object key) {
        Node<K,V>[] tab; Node<K,V> first, e; int n; K k;
        if ((tab = table) != null && (n = tab.length) > 0 &&
            (first = tab[(n - 1) & hash]) != null) {

            //1、根據hash演算法找到對應位置的第一個資料,如果是指定的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) {
                //如果該節點為紅黑樹,則通過樹進行查詢
                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;
    }

複製程式碼

get方法相對於put來說,邏輯實在是簡單太多了

  1. 根據hash值查詢到指定位置的資料
  2. 校驗指定位置第一個節點的資料是key是否為傳入的key,如果是直接返回第一個節點,否則繼續查詢第二個節點
  3. 如果資料是TreeNode(紅黑樹結構),直接通過紅黑樹查詢節點資料並返回
  4. 如果是連結串列結構,迴圈查詢所有節點,返回資料
  5. 如果沒有找到符合要求的節點,返回null

在這個方法裡面,需要注意的有兩個地方:hash(key)和hash的取模運算 (n - 1) & hash

1.3.1 hash(key)的原始碼
 static final int hash(Object key) {
        int h;
        return (key == null) ? 0 : (h = key.hashCode()) ^ (h >>> 16);
    }
複製程式碼

這段程式碼叫做擾動函式,也是hashMap中的hash運算,主要分為下面幾步:

  • key.hashCode(),獲取key的hashCode值,如果不進行重寫的話返回的是根據記憶體地址得到的一個int值
  • key.hashCode() 獲取到的hashcode無符號右移16位並和元hashCode進行^ ,這樣做的目的是為了讓高位與低進行混合,讓兩者都參與運算,以便讓hash值分佈更加均勻
1.3.2 取模運算 (n - 1) & hash

在hashMap的程式碼中,在很多地方都會看到類似的程式碼:

first = tab[(n - 1) & hash]) 
複製程式碼

hash演算法中,為了使元素分佈的更加均勻,很多都會使用取模運算,在hashMap中並沒有使用hash%n這樣進行取模運算,而是使用(n - 1) & hash進行代替,原因是在計算機中,&的效率要遠高於%;需要注意的是,只有容量為2的n次冪的時候,(n - 1) & hash 才能等效hash%n,這也是hashMap 初始化初始容量時,無論傳入任何值,都會通過tableSizeFor(int cap) 方法轉化成2的n次冪的原因,這種巧妙的設計真的很令人驚歎; 至於為什麼只有2的n次冪才能這樣進行取模運算,這裡就不再詳細敘述了,有興趣的可以看一下一位大佬寫的文章:由HashMap雜湊演算法引出的求餘%和與運算&轉換問題

1.4 remove方法,刪除

瞭解完get方法之後,我們再最後瞭解一下remove方法:

  public V remove(Object key) {
        Node<K,V> e;
        return (e = removeNode(hash(key), key, null, false, true)) == null ?
            null : e.value;
    }
    
    final Node<K,V> removeNode(int hash, Object key, Object value,
                               boolean matchValue, boolean movable) {
        Node<K,V>[] tab; Node<K,V> p; int n, index;

        //根據key和key的hash值,查詢到對應的元素
        if ((tab = table) != null && (n = tab.length) > 0 &&
            (p = tab[index = (n - 1) & hash]) != null) {
            Node<K,V> node = null, e; K k; V v;
            if (p.hash == hash &&
                ((k = p.key) == key || (key != null && key.equals(k))))
                node = p;
            else if ((e = p.next) != null) {
                if (p instanceof TreeNode)
                    node = ((TreeNode<K,V>)p).getTreeNode(hash, key);
                else {
                    do {
                        if (e.hash == hash &&
                            ((k = e.key) == key ||
                             (key != null && key.equals(k)))) {
                            node = e;
                            break;
                        }
                        p = e;
                    } while ((e = e.next) != null);
                }
            }

            //如果查詢的了元素node,移除即可
            if (node != null && (!matchValue || (v = node.value) == value ||
                                 (value != null && value.equals(v)))) {
                //如果是TreeNode,通過樹進行移除
                if (node instanceof TreeNode)
                    ((TreeNode<K,V>)node).removeTreeNode(this, tab, movable);
                //如果是第一個節點,移除第一個節點,將index下標的位置指向第二個節點
                else if (node == p)
                    tab[index] = node.next;
                else
                    //如果不是連結串列的第一個節點,則移除該節點
                    p.next = node.next;
                ++modCount;
                --size;
                afterNodeRemoval(node);
                return node;
            }
        }
        return null;
    }
複製程式碼

從原始碼可以看出來,通過key找到需要移除的元素操作過程和get方法幾乎一致,最後在查詢到key對應的節點之後,根據節點的位置和型別,進行相應的移除操作就完成了,過程非常簡單

1.4.0 其他原始碼

到這裡,hashMap的原始碼基本就解析完成了,其餘的方法和原始碼邏輯相對非常簡單,大部分還是使用上述程式碼來實現的,例如containsKey(jey),就是使用get方法中的getNode()來判斷的,由於篇幅原因就不一一介紹。

另外,中間有很部分不影響邏輯理解的程式碼被一筆帶過,比如 紅黑樹的轉化,查詢,刪除等操作,有興趣的可以自己進行學習,不過還有一些其他的特性需要提醒一下

最後總結一下:

  • HashMap 底層資料結構在JDK1.7之前是由陣列+連結串列組成的,1.8之後又加入了紅黑樹;連結串列長度小於8的時候,發生Hash衝突後會增加連結串列的長度,當連結串列長度大於8的時候,會先判讀陣列的容量,如果容量小於64會先擴容(原因是陣列容量越小,越容易發生碰撞,因此當容量過小的時候,首先要考慮的是擴容),如果容量大於64,則會將連結串列轉化成紅黑樹以提升效率
  • hashMap 的容量是2的n次冪,無論在初始化的時候傳入的初始容量是多少,最終都會轉化成2的n次冪,這樣做的原因是為了在取模運算的時候可以使用&運算子,而不是%取餘,可以極大的提上效率,同時也降低hash衝突
  • HashMap是非執行緒安全的,在多執行緒的操作下會存在異常情況(如形成閉環(1.7),1.8已修復閉環問題,但仍不安全),可以使用HashTable或者ConcurrentHashMap進行代替

相關文章