1. 程式人生 > 實用技巧 >HashMap原始碼閱讀

HashMap原始碼閱讀

目錄


HashMap在JDK 1.7的時候,底層的實現機制是陣列+連結串列,利用連結串列來解決雜湊衝突。連結串列的查詢複雜度是O(n),如果連結串列很長的話,查詢的時間是比較大的,所以在JDK 1.8對HashMap做了優化,其底層的實現機制變成了陣列+連結串列+紅黑樹。當連結串列的長度超過某個閾值,就會把連結串列變形成紅黑樹,紅黑樹的查詢複雜度是O(log n),這樣在元素很多的情況下可以保證查詢效能。
另外,HashMap是執行緒不安全的,主要體現在(1)JDK 1.7的實現版本,多個執行緒同時觸發擴容機制的時候,可能會導致出現連結串列節點迴圈引用的現象,從而導致查詢的時候出現死迴圈。(2)JDK 1.8中put放置元素的時候可能會出現資料丟失的情況。想要解決HashMap執行緒不安全,可以使用JUC包下的concurrentHashMap
,或者使用Collections.synchronizedMap()返回一個執行緒安全的map。

1、關鍵的幾個static引數

    //初始容量:2的4次方
    static final int DEFAULT_INITIAL_CAPACITY = 1 << 4; // aka 16
    //最大容量:2的30次方
    static final int MAXIMUM_CAPACITY = 1 << 30;
    //裝載因子0.75,設定為0.75是在查詢時間和空間利用上做的平衡
    static final float DEFAULT_LOAD_FACTOR = 0.75f;
    //樹化閾值
    static final int TREEIFY_THRESHOLD = 8;
    //非樹化閾值
    static final int UNTREEIFY_THRESHOLD = 6;
    //最小的樹化容量
    static final int MIN_TREEIFY_CAPACITY = 64;

2、內部類定義Node節點

    //內部類,定義Node節點,key-value
    static class Node<K,V> implements Map.Entry<K,V> {
        final int hash;//final
        final K key;   //final
        V value;
        Node<K,V> next; //指向下一個節點


        Node(int hash, K key, V value, Node<K,V> next) {
            this.hash = hash;
            this.key = key;
            this.value = value;
            this.next = next;
        }

        public final K getKey()        { return key; }
        public final V getValue()      { return value; }
        public final String toString() { return key + "=" + value; }
        //計算當前節點的hashcode,key的hashcode和value的hashcode做異或操作
        public final int hashCode() {
            return Objects.hashCode(key) ^ Objects.hashCode(value);
        }

        public final V setValue(V newValue) {
            V oldValue = value;
            value = newValue;
            return oldValue;
        }
        //equals方法,指標相等 || key和value都相等
        public final boolean equals(Object o) {
            if (o == this)
                return true;
            if (o instanceof Map.Entry) {
                Map.Entry<?,?> e = (Map.Entry<?,?>)o;
                if (Objects.equals(key, e.getKey()) &&
                    Objects.equals(value, e.getValue()))
                    return true;
            }
            return false;
        }
    }

3、成員變數

    //transient 不能序列化 ,陣列存放Node節點,這個就是hashmap底層的陣列
    transient Node<K,V>[] table;
    //entrySet集合
    transient Set<Map.Entry<K,V>> entrySet;

    //hashmap中元素的個數
    transient int size;
    //修改次數
    transient int modCount;
    int threshold; //擴容閾值
    //裝載因子
    final float loadFactor;

4、靜態方法

    //計算hash值,>>>無符號右移運算,用key的hashcode值和右移十六位的hashcode值做運算
    static final int hash(Object key) {
        int h;
        return (key == null) ? 0 : (h = key.hashCode()) ^ (h >>> 16);
    }
    //對於給定的目標容量,返回兩倍大小的冪。
    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;
    }

5、HashMap的四個構造方法

    //指定初始容量和裝填因子
    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;
        //擴容閾值用靜態方法tableSizeFor()計算得到
        this.threshold = tableSizeFor(initialCapacity);
    }

    //指定初始容量,裝填因子採用預設值0.75
    public HashMap(int initialCapacity) {
        this(initialCapacity, DEFAULT_LOAD_FACTOR);
    }

    //無參構造方法,初始容量和裝填因子均採用預設值,16和0.75
    public HashMap() {
        this.loadFactor = DEFAULT_LOAD_FACTOR; // all other fields defaulted
    }

    //利用一個Map構造HashMap
    public HashMap(Map<? extends K, ? extends V> m) {
        this.loadFactor = DEFAULT_LOAD_FACTOR;
        putMapEntries(m, false);
    }

注意到HashMap的最後一個構造方法,利用了一個Map來構造HashMap,其中呼叫了putMapEntries()方法。注意到putMapEntries()最後呼叫了putVal()方法,putVal()方法在put操作部分進行介紹。

    //把一個Map中元素批量新增到當前的HashMap中
    final void putMapEntries(Map<? extends K, ? extends V> m, boolean evict) {
        //s是另一個Map大小
        int s = m.size();
        //如果另一個map不為空
        if (s > 0) {
            //如果當前的hashmap為空,就就根據map m的引數計算當前hashmap的擴容閾值
            if (table == null) { // pre-size
                float ft = ((float)s / loadFactor) + 1.0F;
                int t = ((ft < (float)MAXIMUM_CAPACITY) ?
                         (int)ft : MAXIMUM_CAPACITY);
                if (t > threshold)
                    threshold = tableSizeFor(t);
            }
            //map m的大小超過了當前hashmap的擴容閾值,則進行擴容
            else if (s > threshold)
                resize();
            //對map m中的每一對key-value,都呼叫putVal函式將其放入到當前的hashMap中
            for (Map.Entry<? extends K, ? extends V> e : m.entrySet()) {
                K key = e.getKey();
                V value = e.getValue();
                //放置元素到當前的HashMap中
                putVal(hash(key), key, value, false, evict);
            }
        }
    }

6、put方法

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

    //第四個引數是,只有當key對應的位置為空的時候,才進行替換,一般設定為false
    //第五個引數如果是false,表示是在第一次放置+初始化陣列容量的時候呼叫。
    final V putVal(int hash, K key, V value, boolean onlyIfAbsent,
                   boolean evict) {
        Node<K,V>[] tab; Node<K,V> p; int n, i;
        //如果table陣列為空,則進行第一次resize,擴容到初始容量
        if ((tab = table) == null || (n = tab.length) == 0)
            n = (tab = resize()).length;
        //如果key在陣列中對映的位置上的元素為空,沒有產生雜湊衝突,則直接放置
        if ((p = tab[i = (n - 1) & hash]) == null)
            tab[i] = newNode(hash, key, value, null);

        else {
            Node<K,V> e; K k;
            //如果key值相同,則直接覆蓋
            if (p.hash == hash &&
                ((k = p.key) == key || (key != null && key.equals(k))))
                e = p;
            //如果key值不同,則產生了雜湊衝突,需要解決衝突
            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);
                        //判斷需不需要進行變形,把連結串列變成紅黑樹,提高查詢效率
                        if (binCount >= TREEIFY_THRESHOLD - 1) // -1 for 1st
                            treeifyBin(tab, hash);
                        break;
                    }
                    //如果當前的key值和連結串列上的某個key值相同
                    if (e.hash == hash &&
                        ((k = e.key) == key || (key != null && key.equals(k))))
                        break;
                    //指標移動
                    p = e;
                }
            }
            //如果迴圈結束後,e不等於null,則e的value值需要被替換成新的value值
            if (e != null) { // existing mapping for key
                V oldValue = e.value;
                if (!onlyIfAbsent || oldValue == null)
                    e.value = value;
                //HashMap的這個函式是空的,LinkedHashMap繼承HashMap重寫了這個方法,用來實現插入有序,或者LRU訪問
                afterNodeAccess(e);
                return oldValue;
            }
        }
        //修改數++
        ++modCount;
        //如果當前陣列的容量超過了擴容的閾值,則進行擴容
        if (++size > threshold)
            resize();
        afterNodeInsertion(evict);
        return null;
    }

下面的圖總結了put操作的邏輯,一圖勝千言(圖片來源:美團技術團隊)

7、擴容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;
        //如果舊錶的容量大於0,則不是第一次擴容,那麼新表的容量就設定為舊錶的2倍。新表的擴容閾值也是舊錶的擴容閾值的2倍。
        if (oldCap > 0) {
            //如果舊錶的容量已經大於等於最大容量,則不再進行擴容,直接返回舊錶
            //此時依然可以裝新的元素,只不過map陣列的容量不再發生變化
            if (oldCap >= MAXIMUM_CAPACITY) {
                threshold = Integer.MAX_VALUE;
                return oldTab;
            }
            //新容量擴大為原來的2倍,新的擴容閾值也擴大為舊的擴容閾值的2倍。
            else if ((newCap = oldCap << 1) < MAXIMUM_CAPACITY &&
                     oldCap >= DEFAULT_INITIAL_CAPACITY)
                newThr = oldThr << 1; // double threshold
        }
        //如果舊錶的容量等於0,oldThr>0意味著指定了構造因子,並初始了擴容閾值
        //此時將新表容量直接賦值為舊錶的擴容閾值
        else if (oldThr > 0) // initial capacity was placed in threshold
            newCap = oldThr;
        //如果舊錶容量=0,舊錶擴容閾值=0
        else {               // zero initial threshold signifies using defaults
            newCap = DEFAULT_INITIAL_CAPACITY;
            newThr = (int)(DEFAULT_LOAD_FACTOR * DEFAULT_INITIAL_CAPACITY);
        }
        //如果新的庫容閾值為0,對應的是舊錶為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;
        //舊錶不為空的情況下,需要把舊錶中的每個元素都重新插入到新表中
        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);
                    //如果當前元素是連結串列節點,
                    else { // preserve order
                        //因為新表容量是翻倍,則原連結串列上的節點分成兩部分
                        //要麼放在原來的下標的位置,要麼在新表的下標位置

                        //低位連結串列(原來的下標)的頭結點和尾節點
                        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;
                            //注意,高位連結串列的位置,是j+oldCap,也就是原來的下標+一箇舊表大小的偏移量
                            newTab[j + oldCap] = hiHead;
                        }
                    }
                }
            }
        }
        return newTab;
    }

8、get方法

    //根據key值獲取
    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;
        //table陣列不為空,且length>0,且hash值和陣列長度做&運算得到的那個bucket不為空
        if ((tab = table) != null && (n = tab.length) > 0 &&
            (first = tab[(n - 1) & hash]) != null) {
            //如果是第一個節點,則直接返回第一個節點
            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;
    }

9、remove操作

    public V remove(Object key) {
        Node<K,V> e;
        return (e = removeNode(hash(key), key, null, false, true)) == null ?
            null : e.value;
    }

    //看過put方法,removeNode方法的邏輯就非常簡單
    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;
        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);
                }
            }
            if (node != null && (!matchValue || (v = node.value) == value ||
                                 (value != null && value.equals(v)))) {
                if (node instanceof TreeNode)
                    ((TreeNode<K,V>)node).removeTreeNode(this, tab, movable);
                else if (node == p)
                    tab[index] = node.next;
                else
                    p.next = node.next;
                ++modCount;
                --size;
                afterNodeRemoval(node);
                return node;
            }
        }
        return null;
    }

10、參考連結

搞懂java HashMap原始碼
HashMap的負載因子初始值為什麼是0.75?
JDK1.7和JDK1.8中HashMap為什麼是執行緒不安全的?