1. 程式人生 > >JDK原始碼分析系列--HashMap(1.8)

JDK原始碼分析系列--HashMap(1.8)

HashMap的儲存結構

變數定義

    /**
     * 預設的初始化容量,必須是2的n次冪
     */
    static final int DEFAULT_INITIAL_CAPACITY = 1 << 4; // aka 16

    /**
     * 最大的容量是2的30次冪
     */
    static final int MAXIMUM_CAPACITY = 1 << 30;

    /**
     * 預設的負載因子
     */
    static final float DEFAULT_LOAD_FACTOR = 0.75f;

    /**
     * 連結串列轉紅黑樹的閥值,當HashMap中某一個槽位中的連結串列長度達到了這個閥值,那麼連結串列可能會轉化為紅黑樹,也可能直接擴容
     */
    static final int TREEIFY_THRESHOLD = 8;

    /**
     * 紅黑樹退化為連結串列的閥值
     */
    static final int UNTREEIFY_THRESHOLD = 6;

    /**
     * 最小的連結串列轉化為紅黑樹的陣列容量,如果連結串列達到了轉紅黑樹閥值,但是陣列(槽)長度還沒有達到該閥值,那麼要先擴容
     * 為了避免擴容與樹形化的衝突,該值不小於4*TREEIFY_THRESHOLD
     */
    static final int MIN_TREEIFY_CAPACITY = 64;
    /**
     * 雜湊桶陣列,首次使用的時候初始化,並根據需要調整大小,分配時,長度始終是2的n次冪
     */
    transient HashMap.Node<K,V>[] table;

    /**
     * 保持快取到entrySet()
     */
    transient Set<Map.Entry<K,V>> entrySet;

    /**
     * HashMap 中實際儲存的 key-value 鍵值對數量
     */
    transient int size;

    /**
     * 此HashMap結構已經修改的次數,
     */
    transient int modCount;

    /**
     * 用於判斷是否需要擴容的閥值(capacity * load factor).
     *
     */
    int threshold;

    /**
     * 負載因子實際大小
     */
    final float loadFactor;

 連結串列結構

    /**
     * 基本的hash連結串列節點,用於大多數
     */
    static class Node<K,V> implements Map.Entry<K,V> {
        final int hash;         //定位陣列索引位置
        final K key;            //元素的key
        V value;                //元素的值
        HashMap.Node<K,V> next; //元素的下個節點

        Node(int hash, K key, V value, HashMap.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; }

        public final int hashCode() {
            return Objects.hashCode(key) ^ Objects.hashCode(value);
        }

        public final V setValue(V newValue) {
            V oldValue = value;
            value = newValue;
            return oldValue;
        }

        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;
        }
    }

putVal方法

    /**
     * Implements Map.put and related methods
     *
     * @param hash hash for key
     * @param key the key
     * @param value the value to put
     * @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
     */
    final V putVal(int hash, K key, V value, boolean onlyIfAbsent,
                   boolean evict) {
        HashMap.Node<K,V>[] tab; HashMap.Node<K,V> p; int n, i;
        //table為空或者length==0時,按照預設大小擴容
        if ((tab = table) == null || (n = tab.length) == 0)
            n = (tab = resize()).length;
        //通過(n-1)&hash來定位儲存陣列的下標i,如果該下標下沒有元素時直接插入
        if ((p = tab[i = (n - 1) & hash]) == null)
            tab[i] = newNode(hash, key, value, null);
        else {//若i的位置上的值不為空,
            HashMap.Node<K,V> e; K k;
            //當前位置上的Node p的key與要插入的key相同,直接覆蓋value
            if (p.hash == hash &&
                    ((k = p.key) == key || (key != null && key.equals(k))))
                e = p;
            //當前節點時紅黑樹,直接在紅黑樹中插入該節點
            else if (p instanceof HashMap.TreeNode)
                e = ((HashMap.TreeNode<K,V>)p).putTreeVal(this, tab, hash, key, value);
            else {//當前節點時普通連結串列,執行連結串列的插入
                for (int binCount = 0; ; ++binCount) {
                    if ((e = p.next) == null) {//遍歷到最後一個節點,還沒有匹配到key,則直接建立一個新節點新增到連結串列最後
                        p.next = newNode(hash, key, value, null);
                        //連結串列長度大於8時,需要進行連結串列轉紅黑樹的處理
                        if (binCount >= TREEIFY_THRESHOLD - 1)
                            treeifyBin(tab, hash);
                        break;
                    }
                    //遍歷中發現key已經存在直接覆蓋value並退出迴圈
                    if (e.hash == hash &&
                            ((k = e.key) == key || (key != null && key.equals(k))))
                        break;
                    p = e;
                }
            }
            //已經存在該key的情況時,將對應的節點的value設定為新的value
            if (e != null) {
                V oldValue = e.value;
                if (!onlyIfAbsent || oldValue == null)
                    e.value = value;
                afterNodeAccess(e);
                return oldValue;
            }
        }
        ++modCount;
        //插入成功後,判斷實際存在的鍵值對數量 size 是否超多了最大容量 threshold,如果超過,進行擴容
        if (++size > threshold)
            resize();
        afterNodeInsertion(evict);
        return null;
    }

resize()擴容方法

    /**
     * 初始化或者兩倍雜湊槽的大小。如果為空,根據預設的值初始化。
     * 否則,由於是用2的n次冪,則元素的下標或者在和以前一致,或者移動到(當前index + 老capacity)位置
     */
    final HashMap.Node<K,V>[] resize() {
        // 將欄位引用copy到區域性變量表,這樣在之後的使用時可以減少getField指令的呼叫
        HashMap.Node<K,V>[] oldTab = table;
        // oldCap為原陣列的大小或當空時為0
        int oldCap = (oldTab == null) ? 0 : oldTab.length;
        int oldThr = threshold;
        int newCap, newThr = 0;
        if (oldCap > 0) {
            // 如果超過最大容量1>>30,無法再擴充table,只能改變閾值
            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
        }
        else if (oldThr > 0) // initial capacity was placed in threshold
            newCap = oldThr;
        else {//初始化
            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;
        // 建立容量為newCap的newTab,並將oldTab中的Node遷移過來,這裡需要考慮連結串列和tree兩種情況。
        HashMap.Node<K,V>[] newTab = (HashMap.Node<K,V>[])new HashMap.Node[newCap];
        table = newTab;
        if (oldTab != null) {// 將原陣列中的陣列複製到新陣列中
            for (int j = 0; j < oldCap; ++j) {
                HashMap.Node<K,V> e;
                if ((e = oldTab[j]) != null) {
                    oldTab[j] = null;
                    if (e.next == null)
                        // 如果e是該雜湊槽的唯一一個元素,則直接賦值到新陣列中
                        newTab[e.hash & (newCap - 1)] = e;
                    else if (e instanceof HashMap.TreeNode)
                        // split方法會將樹分割為lower 和upper tree兩個樹,如果子樹的節點數小於了UNTREEIFY_THRESHOLD閾值,
                        // 則將樹untreeify,將節點都存放在newTab中。
                        // TreeNode的情況則使用TreeNode中的split方法將這個樹分成兩個小樹
                        ((HashMap.TreeNode<K,V>)e).split(this, newTab, j, oldCap);
                    else { //保持順序
                        //建立兩個連結串列用來存放要放的資料,
                        // hash值&oldCap為0的(即oldCap的1的位置的和hash值的同樣的位置都是1,
                        // 同樣是基於capacity是2的次方這一前提)為low連結串列,反之為high連結串列,
                        // 通過這種方式將舊的資料分到兩個連結串列中再放到各自對應餘數的位置
                        HashMap.Node<K,V> loHead = null, loTail = null;
                        HashMap.Node<K,V> hiHead = null, hiTail = null;
                        HashMap.Node<K,V> next;
                        do {
                            next = e.next;
                            // 按照e.hash值區分放在loTail後還是hiTail後
                            if ((e.hash & oldCap) == 0) {
                                // 運算結果為0的元素,用lo記錄並連線成新的連結串列
                                if (loTail == null)
                                    loHead = e;
                                else
                                    loTail.next = e;
                                loTail = e;
                            }
                            else {// 運算結果不為0的資料,用hi記錄
                                if (hiTail == null)
                                    hiHead = e;
                                else
                                    hiTail.next = e;
                                hiTail = e;
                            }
                        } while ((e = next) != null);
                        // 處理完之後放到新陣列中
                        if (loTail != null) {
                            loTail.next = null;
                            // lo仍然放在“原處”,這個“原處”是根據新的hash值算出來的
                            newTab[j] = loHead;
                        }
                        if (hiTail != null) {
                            hiTail.next = null;
                            // hi放在j+oldCap位置
                            newTab[j + oldCap] = hiHead;
                        }
                    }
                }
            }
        }
        return newTab;
    }