Java容器源碼攻堅戰--第三戰：HashMap（一）

時間 2019-11-07

原文原文鏈接

零、前言：

HashMap怪複雜的，若是一開始就上網上一大堆的HashMap的元素圖，也沒什麼太大意思。
這裏從一個小測試開始提及，一步步debug在HashMap裏走一走。感受有時候看源碼有點像在風景區看風景,抱着的態度決定你的歷程，那些漫步於風景中的人會着眼當前，收穫每個瞬間帶給本身的感觸。那些苛求踏遍每一份土地，覽盡一切風光的人，卻是捉襟見肘，讓行程變得勞頓。後者或許覽盡風光而無憾，前者雖只覽片景卻仍收穫頗豐,然而這並無好壞之分，只有對你適合與否。----張風捷特烈
場景：模擬英語字典，有索引類和單詞類，索引做爲鍵，單詞做爲值放入HashMap中
因爲HashMap挺大的，本篇只說一下HashMap的插入操做，包括：擴容、鏈表插入、鏈表樹化。java

1、測試HashMap插入

1.索引類：WordIndex--包括單詞和頁數

這裏鍵的哈希函數直接使用頁碼git

/**
 * 做者：張風捷特烈
 * 時間：2018/10/3 0003:7:35
 * 郵箱：1981462002@qq.com
 * 說明：單詞索引類
 */
public class WordIndex {
    /**
     * 索引出的單詞
     */
    private String word;
    /**
     * 單詞所在頁數
     */
    private Integer page;

    public WordIndex(String word, Integer page) {
        this.word = word;
        this.page = page;
    }

    @Override
    public boolean equals(Object o) {
        if (this == o) return true;
        if (!(o instanceof WordIndex)) return false;
        WordIndex wordIndex = (WordIndex) o;
        return Objects.equals(getWord(), wordIndex.getWord()) &&
                Objects.equals(getPage(), wordIndex.getPage());
    }

    @Override
    public int hashCode() {
        return page;
    }
    //省略get、set、toString
}

2.單詞類：Word--包括單詞和釋意

/**
 * 做者：張風捷特烈
 * 時間：2018/10/3 0003:7:42
 * 郵箱：1981462002@qq.com
 * 說明：單詞類
 */
public class Word {
    /**
     * 單詞
     */
    private String word;
    /**
     * 釋意
     */
    private String desc;

    public Word(String word, String desc) {
        this.word = word;
        this.desc = desc;
    }
    //省略get、set、toString
}

HashMap測試類

/**
 * 做者：張風捷特烈
 * 時間：2018/10/2 0002:19:37
 * 郵箱：1981462002@qq.com
 * 說明：HashMap測試類
 */
public class HashMapTest {
    public static void main(String[] args) {
        WordIndex act_key = new WordIndex("act", 21);
        WordIndex arm_key = new WordIndex("arm", 80);
        WordIndex arise_key = new WordIndex("arise", 80);
        WordIndex a_key = new WordIndex("a", 1);

        Word act = new Word("act", "行動");
        Word arm = new Word("arm", "胳膊");
        Word arise = new Word("arise", "生起");
        Word a = new Word("a", "一個");

        HashMap<WordIndex, Word> dictionary = new HashMap<>();
        dictionary.put(act_key, act);
        dictionary.put(arm_key, arm);
        dictionary.put(a_key, a);
        dictionary.put(arise_key, arise);

        System.out.println(dictionary);
        //{WordIndex{word='a', page=1}=Word{word='a', desc='一個'},
        // WordIndex{word='act', page=21}=Word{word='act', desc='行動'},
        // WordIndex{word='arm', page=80}=Word{word='arm', desc='胳膊'},
        // WordIndex{word='arise', page=80}=Word{word='arise', desc='生起'}}
    }
}

2、HashMap分析前置準備

1.成員變量

//可見是一個Node類型的數組，名稱是[表]
    transient Node<K,V>[] table;

    //當前 HashMap 所能容納鍵值對數量的最大值，超過這個值，則需擴容
    //threshold = capacity * loadFactor
    int threshold;
    
    //表的最大容量 1 << 30 即2的30次方
    //表的容量必須是2的n次方
    static final int MAXIMUM_CAPACITY = 1 << 30;
    
    //默認容量(16):必須是2的n次方
    static final int DEFAULT_INITIAL_CAPACITY = 1 << 4; // aka 16
    
    //默認負載因子(0.75)--無參構造時使用
    static final float DEFAULT_LOAD_FACTOR = 0.75f;
    
    //負載因子
    final float loadFactor;

2.鏈表節點類：可見是一個單鏈表

static class Node<K,V> implements Map.Entry<K,V> {
        final int hash;
        final K key;
        V value;
        Node<K,V> next;

3.紅黑樹節點類

static final class TreeNode<K,V> extends LinkedHashMap.Entry<K,V> {
TreeNode<K,V> parent;  // red-black tree links
TreeNode<K,V> left;
TreeNode<K,V> right;
TreeNode<K,V> prev;    // needed to unlink next upon deletion
boolean red;
TreeNode(int hash, K key, V val, Node<K,V> next) {
    super(hash, key, val, next);
}

HashMap節點.png

可見TreeNode最終也是繼承自Node的github

3、HashMap插入第一個元素分析

dictionary.put(act_key, act);編程

m1:java.util.HashMap#put

添加時調用了putVal方法：見m1-1數組

* @param key 鍵：WordIndex{word='act', page=21}
    * @param value 值：Word{word='act', desc='行動'}
    
    public V put(K key, V value) {
        return putVal(hash(key), key, value, false, true);
    }

static final int hash(Object key) {
        int h;
        return (key == null) ? 0 : (h = key.hashCode()) ^ (h >>> 16);
    }

m1-1：java.util.HashMap#putVal

* @param hash 鍵的哈希值------21
     * @param key 鍵 --------------WordIndex{word='act', page=21}
     * @param value 值 ------------Word{word='act', desc='行動'}
     * @param onlyIfAbsent true時，不改變已存在的value-----false
     * @param evict if false, the table is in creation mode.--true
     * @return previous value, or null if none
     */
    final V putVal(int hash, K key, V value, boolean onlyIfAbsent,
                   boolean evict) {
         //tab：記錄當前表 //n:當前表的長度
        Node<K,V>[] tab; Node<K,V> p; int n, i;
        if ((tab = table) == null || (n = tab.length) == 0)
        //第一次插入爲表空時，執行resize擴容返回新表，容量16，見： m2
            n = (tab = resize()).length;//此時n=16
            //此處p爲table[i]的元素  此時i = 15 & 21 = 5
        if ((p = tab[i = (n - 1) & hash]) == null)//hash:傳入鍵的hash值
            //能夠看到添加元素而且沒有哈希碰撞時，將元素放入數組的i位
            tab[i] = newNode(hash, key, value, null);
        else {//不然，即哈希衝突了
           添加時哈希衝突見：m1-1-2
        }
        ++modCount;//修改次數+1
        if (++size > threshold)//元素總數+1後比擴容閥值大時，擴容
            resize();
        afterNodeInsertion(evict);//插入節點以後：見：m1-1-1
        return null;//返回空
    }

m1-1-1:可見是爲了LinkedHashMap而準備的回調函數，這裏都是空實現，因此無論了

// Callbacks to allow LinkedHashMap post-actions
void afterNodeAccess(Node<K,V> p) { }
void afterNodeInsertion(boolean evict) { }
void afterNodeRemoval(Node<K,V> p) { }

m2：java.util.HashMap#resize

final Node<K,V>[] resize() {
    //變量oldTab記錄當前表
    Node<K,V>[] oldTab = table;
    //變量oldCap記錄當前表的容量(表爲空時長度爲0)
    int oldCap = (oldTab == null) ? 0 : oldTab.length;
    //oldThr記錄當前擴容閥值
    int oldThr = threshold;
    //變量newCap，newThr
    int newCap, newThr = 0;
    if (oldCap > 0) {//舊容量大於0
        if (oldCap >= MAXIMUM_CAPACITY) {//舊容量大於最大容量時
            threshold = Integer.MAX_VALUE;//擴容閥值爲整數最大值
            return oldTab;//返回舊錶
        }
        //不然新容量爲舊容量的兩倍
        //新容量小於最大容量時而且舊容量大於等於默認容量
        else if ((newCap = oldCap << 1) < MAXIMUM_CAPACITY && oldCap >= DEFAULT_INITIAL_CAPACITY)
            //將擴容閥值變爲2倍
            newThr = oldThr << 1; // double threshold
    }
    //oldCap=0的時候
    else if (oldThr > 0) //舊的擴容閥值大於零，說明並非初始化
        newCap = oldThr;
    else {//☆☆☆這裏是添加第一個元素時擴容初始化的地方
        newCap = DEFAULT_INITIAL_CAPACITY;//讓新容量變爲默認容量(即16)
        //新的擴容閥值爲：默認負載因子*默認默認容量：即(0.75*16=12)
        newThr = (int)(DEFAULT_LOAD_FACTOR * DEFAULT_INITIAL_CAPACITY);
    }
    if (newThr == 0) {//新的擴容閥值爲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;//將臨時新表賦給HashMap的表：插播一幅圖
     if (oldTab != null) {//舊錶非空--表示不是初始化
        //暫略...詳見：m2-1
     }
     return newTab;//返回新表
}

HashMap初始化.png

2、插入分析

在索引爲5的地方插入了一個鏈表節點，索引位置由：[表容量-1 & 添加鍵的哈希值]決定
節點：hash=21----key：WordIndex{word='act', page=21}----value:Word{word='act', desc='行動'}----next爲空微信

HashMap插入第一個元素.png

第二個元素hash值80 ： 15 & 80 = 0 因此插入第0位
節點：hash=80----key：WordIndex{word='arm', page=80}----value:Word{word='arm', desc='胳膊'}----next爲空app

HashMap插入第二個元素.png

第三個元素hash值1 ： 1 & 80 = 1 因此插入第1位
節點：hash=1----key：WordIndex{word='1', page=1}----value:Word{word='1', desc='一個'}----next爲空ide

HashMap插入第三個元素.png

重點來了：插入第四個元素arise，它鍵的hash值和第二個元素：arm都是80，也就說明它們在同一頁函數

HashMap插入第四個元素.png

m1-1-2:插入時哈希衝突處理

Node<K,V> e; K k;
//此處p爲table[i]的元素，也就是table[15&80]=table[0]:即單詞--arm
//變量k記錄p節點的key,e記錄當前節點
if (p.hash == hash && ((k = p.key) == key || (key != null && key.equals(k))))
    e = p;//傳入鍵的hash值等於節點的hash字段，而且二者key不一樣
else if (p instanceof TreeNode)//若是是樹，按樹的插入
    e = ((TreeNode<K,V>)p).putTreeVal(this, tab, hash, key, value);
else {//不然，按鏈表的插入，
//關於bin:就像數組裏放了一個個垃圾桶(鏈表),來一個哈希衝突的就往裏扔一個，
//因此binCount就是鏈表的容量
    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;
        }
        if (e.hash == hash &&
            ((k = e.key) == key || (key != null && key.equals(k))))
            break;
        p = e;
    }
}
if (e != null) { // existing mapping for key
    V oldValue = e.value;
    if (!onlyIfAbsent || oldValue == null)
        e.value = value;
    afterNodeAccess(e);
    return oldValue;
}

節點內的單詞是這樣的post

HashMap插入第四個.png

關於：i = (n - 1) & hash 有點想不通這是幹嗎用的，而後查了一下

當 n = 2^y 時，x % n = (n - 1) & x

好比：

int x = 67444;
int i1 = 255 & x;//===>67444 % 255
int i2 = x % 256;//===>67444 % 256
System.out.println(i1);//166
System.out.println(i2);//166
System.out.println(i1 == i2);

又想到HashMap中屢次指出：表的長度必須是2的次方，因此二者結合豁然開朗：
其中n表明表的長度，是2的次方，知足當 n = 2^y 時，x % n = (n - 1) & x,因此：

i = (n - 1) & hash 即 i = n % hash

至於爲何如此：

1.添加時將[key的hash值]亦或[key的hash值無符號右移16位]

static final int hash(Object key) {
    int h;
    return (key == null) ? 0 : (h = key.hashCode()) ^ (h >>> 16);
}

2.使用取模爲了使元素分佈均勻，而且&運算符要比%運算符高效

3、鏈表的樹化

// 鏈表轉爲紅黑樹的閥值 
static final int TREEIFY_THRESHOLD = 8;
// 轉回鏈表閥值
static final int UNTREEIFY_THRESHOLD = 6;
// map總容量對轉爲紅黑樹的限定閥值
static final int MIN_TREEIFY_CAPACITY = 64; 好比總容量只有40,及時哈希碰撞很是集中，有條鏈表已經長30了,也不能轉爲紅黑樹。

final void treeifyBin(Node<K,V>[] tab, int hash) {
        int n, index; Node<K,V> e;
        //若是表的長度 < 64 (即樹化的最小容量限制)
        if (tab == null || (n = tab.length) < MIN_TREEIFY_CAPACITY)
            resize();//擴容
        //容量容量大於64等於時，知足樹化條件
        //臨時變量index記錄插入元素對應的鏈表所在的數組索引
        //臨時變量e記錄插入元素對應的鏈表表頭元素
        else if ((e = tab[index = (n - 1) & hash]) != null) {
            TreeNode<K,V> hd = null, tl = null;
            do {
                //根據頭結點e實例化出紅黑樹節點p
                TreeNode<K,V> p = replacementTreeNode(e, null);
                if (tl == null)//只有第一次纔會走這裏
                    hd = p;//臨時變量hd記錄紅黑樹節點p
                else {//將鏈表Node一個一個更換爲紅黑樹的TreeNode
                    p.prev = tl;//轉換過的TreeNode的前一位是tl(即上一個換過的TreeNode)
                    tl.next = p;//同理
                }
                tl = p;//臨時變量tl記錄紅黑樹節點p
            } while ((e = e.next) != null);
            if ((tab[index] = hd) != null)//至此該鏈表全部Node都換成了TreeNode，但仍是鏈表
                hd.treeify(tab);//這一步真正實現鏈表的樹化
        }
    }
    
    //根據一個鏈表節點實例化一個紅黑樹節點
    TreeNode<K,V> replacementTreeNode(Node<K,V> p, Node<K,V> next) {
        return new TreeNode<>(p.hash, p.key, p.value, next);
    }

紅黑樹節點的樹化方法

final void treeify(Node<K,V>[] tab) {
            //定義根節點
            TreeNode<K,V> root = null;
            //此處聲明兩個TreeNode類型變量：x和next ，並將x賦值爲當前節點
            //結束條件：x != null  完成一次循環執行x = next
            for (TreeNode<K,V> x = this, next; x != null; x = next) {
                //將x的下一節點賦值給next變量
                next = (TreeNode<K,V>)x.next;
                //將x的左右置空
                x.left = x.right = null;
                if (root == null) {
                    //根節點爲空時，初始化根節點
                    x.parent = null;
                    x.red = false;//根節點置爲黑色
                    root = x;//根節點爲鏈表頭結點
                }
                else {//說明已有根節點
                    K k = x.key;//節點鍵
                    int h = x.hash;//節點hash值
                    Class<?> kc = null;
                    //從根節點開始，對當前節點進行插入，此循環用break退出
                    for (TreeNode<K,V> p = root;;) {
                        int dir, ph;
                        K pk = p.key;
                        //比較h與父節點的大小
                        if ((ph = p.hash) > h)
                            dir = -1;//比父節點小--左子樹
                        else if (ph < h)
                            dir = 1;//比父節點大--右子樹
                        else if ((kc == null &&//等於父節點
                                  (kc = comparableClassFor(k)) == null) ||
                                 (dir = compareComparables(kc, k, pk)) == 0)
                            dir = tieBreakOrder(k, pk);
                        //xp記錄x的父親
                        TreeNode<K,V> xp = p;
                        if ((p = (dir <= 0) ? p.left : p.right) == null) {
                            x.parent = xp;
                            if (dir <= 0)
                                xp.left = x;
                            else
                                xp.right = x;//此時該節點與根節點間造成二分搜索樹
                            root = balanceInsertion(root, x);//維持二分搜索樹的紅黑平衡，成爲紅黑樹
                            break;
                        }
                    }
                }
            }
            moveRootToFront(tab, root);//將根節點置頂操做(維持平衡時旋轉操做可能使根節點改變)
        }