JDK源碼學習筆記——HashMap

JDK版本：13

參考

建議大家直接看這篇，寫的太好了~

明星文章：美團技術團隊——Java 8系列之重新認識HashMap

1 類圖

HashMap

實現 java.util.Map 接口，繼承 java.util.AbstractMap 抽像類。
實現 java.io.Serializable 接口。
實現 java.lang.Cloneable 接口。

順便看看Map的4個常用實現類

HashMap：今天的主角
Hashtable：線程安全，但性能不如ConcurrentHashMap,沒必要繼續使用了
LinkedHashMap：HashMap的子類，保存了元素插入的順序。
TreeMap：能夠根據key排序。key必須實現Comparable接口或構造TreeMap時傳入自定義比較器。

2 概覽

HashMap底層是依靠數組+鏈表（jdk1.8後引入了紅黑樹）實現的。查詢操作如何實現O(1)的時間複雜度是我們最關心的問題。
來看它的幾個主要屬性：

Node<K,V>[] table 哈希桶數組
int threshold 擴容閾值
float loadFactor 負載因子
int size 保存的鍵值對的數量

簡單來講，HashMap內部維護了一個Node數組table，數組上的每一個位置叫做一個哈希桶。那麼如何利用數組的特性來存儲鍵值對？

對key求hash值就可以把key轉爲一個整數，以此作爲下標就可以存在數組裏了。但還不夠，數組長度不夠用怎麼辦？

那就把hash(key)對數組長度取模，用hash(key) % (table.length -1)作爲下標就好了。還是不夠，不同的key計算出來的值一樣怎麼辦？

這也就是哈希衝突了。HashMap採用了鏈表法處理。每一個哈希桶都對應一個鏈表，如果發生哈希衝突就把新的value放在鏈表末尾。這樣如果一個鏈表過長，還是會影響性能。從java8開始做了優化，當鏈表太長時，就轉爲紅黑樹。

而擴容也是查詢操作保持O(1)時間複雜度的重要手段，我們希望儘量每個桶裏都只放了一個元素。threshold是擴容閾值，指當size超過threshold時，HashMap會進行擴容。擴容閾值通過threshold = table.length * loadFactor計算得到。擴容操作是非常消耗性能的，在初始化HashMap時，最好估算大小，用 HashMap(int initialCapacity)方法構造，避免頻繁進行擴容。

loadFactor是對空間和時間的一種平衡選擇。數據量相同的情況下，loadFactor越小，HashMap佔用的空間越大，但越不容易哈希衝突，查詢效率越高。相反，loadFactor越大，佔用空間越小，查詢效率越低。loadFactor默認值0.75，除非在特殊情況下，不建議修改。

table的長度總是2的n次方。這樣hash(key) % (table.length -1)可以寫爲hash(key) & (table.length -1)，位運算要有更高的效率。

3 構造方法

3.1 默認構造方法 `HashMap()`

    static final int DEFAULT_INITIAL_CAPACITY = 1 << 4; // aka 16

    static final float DEFAULT_LOAD_FACTOR = 0.75f;
    
    public HashMap() {
        // 使用默認負載因子創建一個空的HashMap （table會在第一次使用時初始化，默認初始容量爲16）
        this.loadFactor = DEFAULT_LOAD_FACTOR; // all other fields defaulted
    }

3.2 給定容量的構造方法 `HashMap(int initialCapacity)`

    public HashMap(int initialCapacity) {
        // 創建一個指定容量（會計算得到2的冪）、默認負載因子的HashMap
        this(initialCapacity, DEFAULT_LOAD_FACTOR);
    }

3.3 給定容量和負載因子的構造方法 `HashMap(int initialCapacity, float loadFactor)`

    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); // 注意這個方法
    }
    
    /**
     * 容量必須是2的冪，通過此方法計算得到大於給定容量的最小的2的冪
     */
    static final int tableSizeFor(int cap) {
        // 從二進制cap的最左邊的1開始，全部設置爲 1 ，得到 n ，這樣 n + 1就是要求的值
        int n = -1 >>> Integer.numberOfLeadingZeros(cap - 1); // cap - 1 再計算避免cap假設剛好是8，但 n=16 這是不對的。
        // cap 是 0 或 1 的時候 n 是 -1，此時返回 1
        return (n < 0) ? 1 : (n >= MAXIMUM_CAPACITY) ? MAXIMUM_CAPACITY : n + 1;
    }

3.4 `HashMap(Map<? extends K, ? extends V> m)`

    public HashMap(Map<? extends K, ? extends V> m) {
        // 設置負載因子
        this.loadFactor = DEFAULT_LOAD_FACTOR;
        putMapEntries(m, false);
    }
    
    final void putMapEntries(Map<? extends K, ? extends V> m, boolean evict) {
        int s = m.size();
        if (s > 0) {
            // table 爲空，還未初始化
            if (table == null) { // pre-size
                // 由map大小和負載因子計算table大小
                float ft = ((float)s / loadFactor) + 1.0F; // 因爲下邊（int）向下取整
                int t = ((ft < (float)MAXIMUM_CAPACITY) ?
                         (int)ft : MAXIMUM_CAPACITY);
                // 新的容量大於擴容閾值，則計算新的擴容閾值
                if (t > threshold)
                    threshold = tableSizeFor(t);
            // 若不爲空 擴容直到夠用或達到最大值
            } else {
                // Because of linked-list bucket constraints, we cannot
                // expand all at once, but can reduce total resize
                // effort by repeated doubling now vs later
                while (s > threshold && table.length < MAXIMUM_CAPACITY)
                    resize();
            }

            // 遍歷，將元素挨個添加到HashMap中
            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);
            }
        }
    }

4 主要方法

4.1 添加單個元素 `V put(K key, V value)`

    /**
     * 鏈表轉爲紅黑樹的臨界值
     */
    static final int TREEIFY_THRESHOLD = 8;
    /**
     * 紅黑樹退化爲鏈表的臨界值
     */    
    static final int UNTREEIFY_THRESHOLD = 6;

    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;
        // table 未初始化或容量爲0 則擴容
        if ((tab = table) == null || (n = tab.length) == 0)
            n = (tab = resize()/*擴容*/).length;
        if ((p = tab[i = (n - 1) & hash]/*獲得對應位置的 Node 節點*/) == null)
            // 如果是空，直接new 一個新的 node 放在這個位置
            tab[i] = newNode(hash, key, value, null);
        else {
            // 如果不是空
            Node<K,V> e; // 目標node，存放新加入元素的node
            K k;
            // 如果 hash 值相等且 key 也相等，那這個 node 就是要找的 node
            if (p.hash == hash &&
                ((k = p.key) == key || (key != null && key.equals(k))))
                e = p;
            // 如果 p 是樹節點
            else if (p instanceof TreeNode)
                // 直接添加到樹中
                e = ((TreeNode<K,V>)p).putTreeVal(this, tab, hash, key, value);
            else {
                // 順序遍歷鏈表
                for (int binCount = 0; ; ++binCount) {
                    // 目標節點 e 指向 p 的下一個節點，如果已經遍歷到鏈表尾部，說明 key 不在 HashMap 中
                    if ((e = p.next) == null) {
                        // 創建新節點
                        p.next = newNode(hash, key, value, null);
                        // 如果鏈表長度達到 TREEIFY_THRESHOLD 時，轉爲樹
                        if (binCount >= TREEIFY_THRESHOLD - 1) // -1 for 1st
                            treeifyBin(tab, hash);
                        break; // 跳出循環
                    }
                    // 如果 hash 和 key 都相等，說明找到了目標 node
                    if (e.hash == hash &&
                        ((k = e.key) == key || (key != null && key.equals(k))))
                        break; // 跳出循環
                    p = e; // p指向下一個節點
                }
            }
            // 找到了 key 對應的節點
            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;
    }

4.2 擴容 `Node<K,V>[] 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;
        // oldCap > 0, table 非空
        if (oldCap > 0) {
            // 如果超過最大容量
            if (oldCap >= MAXIMUM_CAPACITY) {
                // 擴容閾值設爲最大值，返回舊table，不允許再擴容
                threshold = Integer.MAX_VALUE;
                return oldTab;
            }
            // 舊容量大於默認初始化容量且擴容兩倍後小於最大容量，則擴容兩倍
            else if ((newCap = oldCap << 1) < MAXIMUM_CAPACITY &&
                     oldCap >= DEFAULT_INITIAL_CAPACITY)
                newThr = oldThr << 1; // double threshold
        }
        // oldCap <= 0 , table 爲空，所以下邊是初始化的情況
        // oldThr > 0, 非默認構造函數的情況
        // 直接用oldThr 當做新的容量。oldThr由tableSizeFor()方法得出，一定是2的冪
        else if (oldThr > 0) // initial capacity was placed in threshold
            newCap = oldThr;
        // 默認構造函數的情況
        else {               // zero initial threshold signifies using defaults
            newCap = DEFAULT_INITIAL_CAPACITY;
            newThr = (int)(DEFAULT_LOAD_FACTOR * DEFAULT_INITIAL_CAPACITY);
        }
        // 如果上邊沒有給出新的擴容閾值，則用 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;
        @SuppressWarnings({"rawtypes","unchecked"})
        Node<K,V>[] newTab = (Node<K,V>[])new Node[newCap];
        // 用新的容量創建新的 table 並賦值
        table = newTab;
        // 如果舊 table 不是空，需要搬運數據
        if (oldTab != null) {
            for (int j = 0; j < oldCap; ++j) {
                // j 位置的節點
                Node<K,V> e;
                // 如果節點不爲空
                if ((e = oldTab[j]) != null) {
                    // 置空舊table
                    oldTab[j] = null;
                    // 如果只有一個元素，直接賦值
                    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;
                            // 擴容一倍後，原來位置的鏈表節點，要被分配到新 table 的兩個位置上去
                            // 如果去高位
                            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);
                        // 低位放在新 table j 位置
                        if (loTail != null) {
                            loTail.next = null;
                            newTab[j] = loHead;
                        }
                        // 高位放在新 table j + oldCap 位置
                        if (hiTail != null) {
                            hiTail.next = null;
                            newTab[j + oldCap] = hiHead;
                        }
                    }
                }
            }
        }
        return newTab;
    }

4.3 移除單個元素 `V remove(Object key)`

    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;
        // table非空校驗，拿到 hash 對應位置的 p 節點，並且 p 節點不爲null
        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; // 目標節點

            // 通過 hash 和 equals 判斷 p 節點 就是 目標節點
            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);
                }
            }
            // 如果找到了目標節點
            // 是否要校驗 value 相等，如果 matchValue 爲 true 則進行校驗
            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);
                // 如果node 就是 p ， 也就是鏈表的頭結點，則將下一個節點放在 table 該位置中，實現移除
                else if (node == p)
                    tab[index] = node.next;
                // 如果不是頭結點，把 p 的 next 指向 node 的 next，實現移除
                else
                    p.next = node.next;
                // 增加修改次數
                ++modCount;
                // size - 1
                --size;
                // 移除node的回調
                afterNodeRemoval(node);
                // 返回被移除的node
                return node;
            }
        }
        // 沒找到 就返回null
        return null;
    }

4.4 查找單個元素 `V get(Object 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 中對應位置的節點 p
        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;
    }

JDK源碼學習筆記——HashMap

參考

1 類圖

HashMap

順便看看Map的4個常用實現類

2 概覽

3 構造方法

3.1 默認構造方法 `HashMap()`

3.2 給定容量的構造方法 `HashMap(int initialCapacity)`

3.3 給定容量和負載因子的構造方法 `HashMap(int initialCapacity, float loadFactor)`

3.4 `HashMap(Map<? extends K, ? extends V> m)`

4 主要方法

4.1 添加單個元素 `V put(K key, V value)`

4.2 擴容 `Node<K,V>[] resize()`

4.3 移除單個元素 `V remove(Object key)`

4.4 查找單個元素 `V get(Object key)`

Shell/Python中的用戶名獲取

IDEA啓動報錯：Cannot Lock System Folders | java.net.BindException: Address already in use: bind

如何查看mysql隨機生成的初始密碼？

JDK13源碼學習筆記——ArrayList

JDK源碼學習筆記——HashMap

[算法學習筆記]——冒泡、插入、選擇排序算法

https://yachay.unat.edu.pe/blog/index.php?comment_area=format_blog&comment_component=blog&comment_co

linux以太網驅動總結

JDK源碼學習筆記——HashMap

參考

1 類圖

HashMap

順便看看Map的4個常用實現類

2 概覽

3 構造方法

3.1 默認構造方法 HashMap()

3.2 給定容量的構造方法 HashMap(int initialCapacity)

3.3 給定容量和負載因子的構造方法 HashMap(int initialCapacity, float loadFactor)

3.4 HashMap(Map<? extends K, ? extends V> m)

4 主要方法

4.1 添加單個元素 V put(K key, V value)

4.2 擴容 Node<K,V>[] resize()

4.3 移除單個元素 V remove(Object key)

4.4 查找單個元素 V get(Object key)

3.1 默認構造方法 `HashMap()`

3.2 給定容量的構造方法 `HashMap(int initialCapacity)`

3.3 給定容量和負載因子的構造方法 `HashMap(int initialCapacity, float loadFactor)`

3.4 `HashMap(Map<? extends K, ? extends V> m)`

4.1 添加單個元素 `V put(K key, V value)`

4.2 擴容 `Node<K,V>[] resize()`

4.3 移除單個元素 `V remove(Object key)`

4.4 查找單個元素 `V get(Object key)`