從原始碼看Android常用的資料結構 ( 七, SDK28下的HashMap )

YouCii發表於2019-04-05

相關銜接

此係列文章放在了我的專欄裡, 歡迎檢視 blog.csdn.net/column/deta…

從原始碼看Android常用的資料結構 ( SDK23版本 ) ( 一 , 總述 )

從原始碼看Android常用的資料結構 ( SDK23版本 ) ( 二, List篇 )

從原始碼看Android常用的資料結構 ( SDK23版本 ) ( 三 , Queue篇)

從原始碼看Android常用的資料結構 ( SDK23版本 ) ( 四, Set篇 )

從原始碼看Android常用的資料結構 ( SDK23版本 ) ( 五, Map篇 )

從原始碼看Android常用的資料結構 ( SDK23版本 ) ( 六, ConcurrentHashMap )

從原始碼看Android常用的資料結構 ( 七, SDK28下的HashMap )

Github裡有一份Android使用到的小技術, 歡迎檢視: github.com/YouCii/Lear…

前言

Java1.8 和 Android SDK28 對 HashMap 做了大量優化, 與之前版本的主要區別在於以下兩點:

  • hash碰撞超過8時把原連結串列轉化為紅黑樹, 提高查詢效率;
  • resize時對連結串列節點的重定位演算法無需重hash計算, 而是通過判斷&操作的高位來判斷是放在低位cap還是高位cap;

新版本的HashMap結合了連結串列和紅黑樹的優化, 以達到最優的時間空間效率平衡, 這種精雕細琢的精神值得好好學習!

下面詳細說明

先看關鍵引數

    /**
     * The table, initialized on first use, and resized as
     * necessary. When allocated, length is always a power of two.
     * 
     * 資料儲存集合, 必要時會resize, 重分配後大小為2的n次方.
     * 新增transient關鍵字以遮蔽預設serializable, 自主實現read/write.
     */
    transient Node<K,V>[] table;

    /**
     * Holds cached entrySet(). Note that AbstractMap fields are used
     * for keySet() and values().
     * 
     * 快取entrySet.
     */
    transient Set<Map.Entry<K,V>> entrySet;

    /**
     * The number of key-value mappings contained in this map.
     * 
     * map內實際儲存的元素數目
     */
    transient int size;

    /**
     * The number of times this HashMap has been structurally modified
     * Structural modifications are those that change the number of mappings in
     * the HashMap or otherwise modify its internal structure (e.g.,
     * rehash).  This field is used to make iterators on Collection-views of
     * the HashMap fail-fast.  (See ConcurrentModificationException).
     * 
     * HashMap結構修改的次數. 結構修改是指元素數量改變或者以其他方式修改其內部
     * 結構等操作(例如rehash). 
     * 執行結構修改時modCount++, 在執行遍歷等非原子操作前快取modCount, 遍歷過程
     * 中或之後如果modCount與原快取值不同, 說明出現了併發修改, 丟擲異常
     */
    transient int modCount;

    /**
     * The next size value at which to resize (capacity * load factor).
     * 閾值, 觸發resize的臨界容量, 初始化時為最小的超過容量的2的指數, 後續更改為
     * newCap * loadFactor
     */
    int threshold;

    /**
     * The load factor for the hash table.
     * 載入因子, 用於判斷threshold
     */
    final float loadFactor;
複製程式碼

核心方法Get/Put/Remove

GET方法

    public V get(Object key) {
        Node<K,V> e;
        return (e = getNode(hash(key), key)) == null ? null : e.value;
    }
    
    /**
     * 計算key的hash值, 使用hashcode的高16位異或低16位. 看註釋的意思是可能會發生碰撞,
     * 但是考慮到碰撞的元素使用較高效率的tree來儲存, 所以hash演算法採用了較輕量的方式.
     */
    static final int hash(Object key) {
        int h;
        return (key == null) ? 0 : (h = key.hashCode()) ^ (h >>> 16);
    }
    
    /**
     * Implements Map.get and related methods
     *
     * @param hash hash for key
     * @param key  the key
     * @return the node, or null if none
     */
    final Node<K, V> getNode(int hash, Object key) {
        Node<K, V>[] tab;
        Node<K, V> first, e;
        int n;
        K k;
        // 如果(n-1)&hash位置存在元素
        if ((tab = table) != null && (n = tab.length) > 0 && (first = tab[(n - 1) & hash]) != null) {
            // 如果hash相等, key相等, 返回第一個
            if (first.hash == hash && ((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;
    }
複製程式碼

Put相關

    public V put(K key, V value) {
        return putVal(hash(key), key, value, false, true);
    }
    
    /**
     * 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) {
        Node<K, V>[] tab;
        Node<K, V> parent;
        int tabLength, position;
        // 如果還未初始化, 呼叫resize來初始化一下, resize見下方方法
        if ((tab = table) == null || (tabLength = tab.length) == 0)
            tabLength = (tab = resize()).length;
        // 如果該位置未存有元素, 第一位新建node存入
        if ((parent = tab[position = (tabLength - 1) & hash]) == null)
            tab[position] = newNode(hash, key, value, null);
            // 如果該位置已有元素, 分為三種情況:
        else {
            Node<K, V> exitMapping;
            K k;
            // 該位置頭節點就是對應節點
            if (parent.hash == hash && ((k = parent.key) == key || (key != null && key.equals(k))))
                exitMapping = parent;
                // 如果是樹, 去樹內查詢
            else if (parent instanceof TreeNode)
                exitMapping = ((TreeNode<K, V>) parent).putTreeVal(this, tab, hash, key, value);
                // 連結串列
            else {
                for (int binCount = 0; ; ++binCount) {
                    // 如果直到連結串列末尾也沒找到已存在的點, 則直接插入到末尾, 退出迴圈
                    if ((exitMapping = parent.next) == null) {
                        parent.next = newNode(hash, key, value, null);
                        // 如果碰撞次數超過了轉化為tree的閾值(8), 轉化為紅黑樹
                        if (binCount >= TREEIFY_THRESHOLD - 1) // -1 for 1st
                            treeifyBin(tab, hash);
                        break;
                    }
                    // 找到了對應節點
                    if (exitMapping.hash == hash && ((k = exitMapping.key) == key || (key != null && key.equals(k))))
                        break;
                    parent = exitMapping;
                }
            }
            // 如果已存在節點, 在這裡做value替換; 不存在對應節點的情況在前面for迴圈中已經插入了新節點
            if (exitMapping != null) { // existing mapping for key
                V oldValue = exitMapping.value;
                // 如果允許替換值, 替換
                if (!onlyIfAbsent || oldValue == null)
                    exitMapping.value = value;
                // 用於linkedHashMap
                afterNodeAccess(exitMapping);
                return oldValue;
            }
        }
        // 發生了結構化修改
        ++modCount;
        // 如果大小超過了tab閾值, resize為double
        if (++size > threshold)
            resize();
        // 用於linkedHashMap
        afterNodeInsertion(evict);
        return null;
    }
    
    /**
     * Initializes or doubles table size.  If null, allocates in
     * accord with initial capacity target held in field threshold.
     * Otherwise, because we are using power-of-two expansion, the
     * elements from each bin must either stay at same index, or move
     * with a power of two offset in the new table.
     * 某元素只可能保持在當前位置或者2次方位置
     *
     * @return the table
     */
    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) {
            // 如果舊容量超過了2的30次方, 則閾值*2即int的最大值, 也就是2的31次方, 也不重新分配bin了, resize直接完成
            if (oldCap >= MAXIMUM_CAPACITY) {
                threshold = Integer.MAX_VALUE;
                return oldTab;
            }
            // 新容量首先變為兩倍, 如果舊容量超過了預設容量16, 新閾值double
            else if ((newCap = oldCap << 1) < MAXIMUM_CAPACITY && oldCap >= DEFAULT_INITIAL_CAPACITY)
                newThr = oldThr << 1; // double threshold
        }
        // 以下兩種情況均是初始化
        else if (oldThr > 0) {
            // 舊容量為0, 閾值不為0, 就把新的容量被設定為舊閾值
            newCap = oldThr;
        } else {
            // 容量閾值均使用預設值
            newCap = DEFAULT_INITIAL_CAPACITY;
            newThr = (int) (DEFAULT_LOAD_FACTOR * DEFAULT_INITIAL_CAPACITY);
        }
        // 上面設定好了新的容量, 如果新閾值還是0的話(主要是針對上面三種情況的第二種), 設定為newCap * 過載因子loadFactor
        if (newThr == 0) {
            float ft = (float) newCap * loadFactor;
            newThr = (newCap < MAXIMUM_CAPACITY && ft < (float) MAXIMUM_CAPACITY ? (int) ft : Integer.MAX_VALUE);
        }
        threshold = newThr;

        // 通過上面的處理, 新的容量和閾值已經配置好了, 下面的邏輯是把舊錶裡的節點放入新表中
        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> header; // 某位置的連結串列頭節點
                if ((header = oldTab[j]) != null) {
                    oldTab[j] = null;
                    // 如果只有頭節點, 就重hash放入新表中
                    if (header.next == null) {
                        newTab[header.hash & (newCap - 1)] = header;
                    }
                    // 樹形結構的修剪
                    else if (header instanceof TreeNode) {
                        // 把樹切為低位和高位兩部分, 如果某一部分size小於6了, 轉化為連結串列
                        ((TreeNode<K, V>) header).split(this, newTab, j, oldCap);
                    }
                    // 連結串列節點切分(!精髓!), (header.hash & oldCap) == 0 的節點放在前oldCap位, 其餘的放在後半部分
                    // 原來的hash計算是 header.hash & (oldCap- 1), doubleSize後計算 header.hash & oldCap,
                    //
                    // 因為oldCap肯定是2的冪次, 所以只有一個高位1, 而計算 hash&(oldCap-1)時忽略了header.hash的最高位, 所以這一堆連結串列節點才會在這一個連結串列裡
                    // 而header.hash & oldCap的結果反應的就是hash值的對應高位是否為1, 如果為1則插入高位, 為0說明本來就該在低位
                    else {
                        // 放在新table低位的連結串列頭尾
                        Node<K, V> loHead = null, loTail = null;
                        // 放在新table高位的連結串列頭尾
                        Node<K, V> hiHead = null, hiTail = null;
                        Node<K, V> next;
                        do {
                            next = header.next;
                            // 無需重hash的精髓!!
                            if ((header.hash & oldCap) == 0) {
                                if (loTail == null)
                                    loHead = header;
                                else
                                    loTail.next = header;
                                loTail = header;
                            } else {
                                if (hiTail == null)
                                    hiHead = header;
                                else
                                    hiTail.next = header;
                                hiTail = header;
                            }
                        } while ((header = next) != null);
                        // 低尾節點不為null, 把低頭節點放在新table的低位
                        if (loTail != null) {
                            loTail.next = null;
                            newTab[j] = loHead;
                        }
                        // 高尾節點不為null, 把高頭節點放在新table的高位
                        if (hiTail != null) {
                            hiTail.next = null;
                            newTab[j + oldCap] = hiHead;
                        }
                    }
                }
            }
        }
        return newTab;
    }  

    /**
    * 把連結串列轉化為樹
    */ 
    final void treeifyBin(Node<K, V>[] tab, int hash) {
        int tabLength, index;
        Node<K, V> e; // 遍歷node
        // 如果tab太小, 直接呼叫resize, 可能就不用轉化為tree了
        if (tab == null || (tabLength = tab.length) < MIN_TREEIFY_CAPACITY) {
            resize();
        }
        // 正常tableSize, 需要轉化. 首先找到對應位置
        else if ((e = tab[index = (tabLength - 1) & hash]) != null) {
            TreeNode<K, V> header = null, tail = null;
            do {
                // 依次轉化為TreeNode
                TreeNode<K, V> p = replacementTreeNode(e, null);
                if (tail == null)
                    header = p;
                else {
                    p.prev = tail;
                    tail.next = p;
                }
                tail = p;
            } while ((e = e.next) != null);
            if ((tab[index] = header) != null)
                // 格式化treeNode, 令其滿足紅黑樹規則
                header.treeify(tab);
        }
    }  
複製程式碼

Remove相關

    /**
     * Removes the mapping for the specified key from this map if present.
     *
     * @param key key whose mapping is to be removed from the map
     * @return the previous value associated with <tt>key</tt>, or
     * <tt>null</tt> if there was no mapping for <tt>key</tt>.
     * (A <tt>null</tt> return can also indicate that the map
     * previously associated <tt>null</tt> with <tt>key</tt>.)
     */
    public V remove(Object key) {
        Node<K, V> e;
        return (e = removeNode(hash(key), key, null, false, true)) == null ? null : e.value;
    }

    /**
     * Implements Map.remove and related methods
     *
     * @param hash       hash for key
     * @param key        the key
     * @param value      the value to match if matchValue, else ignored
     * @param matchValue if true only remove if value is equal
     * @param movable    if false do not move other nodes while removing
     * @return the node, or null if none
     */
    final Node<K, V> removeNode(int hash, Object key, Object value, boolean matchValue, boolean movable) {
        Node<K, V>[] tab;
        Node<K, V> header; // 對應位置的頭節點
        int n, index;
        // 如果有該hash對應的節點
        if ((tab = table) != null && (n = tab.length) > 0 && (header = tab[index = (n - 1) & hash]) != null) {
            // 待刪除的點
            Node<K, V> node = null;
            // 用於遍歷的node
            Node<K, V> e;
            K k;
            V v;
            // 恰好是第一位
            if (header.hash == hash && ((k = header.key) == key || (key != null && key.equals(k))))
                node = header;
            else if ((e = header.next) != null) {
                // 樹結構查詢
                if (header instanceof TreeNode)
                    node = ((TreeNode<K, V>) header).getTreeNode(hash, key);
                else {
                    // 連結串列遍歷
                    do {
                        if (e.hash == hash && ((k = e.key) == key || (key != null && key.equals(k)))) {
                            node = e;
                            break;
                        }
                        header = e;
                    } while ((e = e.next) != null);
                }
            }
            // 找到了這個點
            if (node != null && (!matchValue || (v = node.value) == value || (value != null && value.equals(v)))) {
                // 呼叫紅黑樹的remove
                if (node instanceof TreeNode)
                    ((TreeNode<K, V>) node).removeTreeNode(this, tab, movable);
                // 以下兩種情況均是連結串列前移
                else if (node == header)
                    tab[index] = node.next;
                else
                    header.next = node.next;
                ++modCount;
                --size;
                afterNodeRemoval(node);
                return node;
            }
        }
        return null;
    }
複製程式碼

相關文章