JDK1.8原始碼分析之HashMap

zhuangwei發表於2019-04-18

一、前言

比較之前的jdk版本,這次1.8版本,對於hashMap做了很大的優化。最重要的一個優化就是桶中的元素不在唯一按照連結串列組合,也可以使用紅黑樹進行儲存,總之,目標只有一個,那就是在安全和功能性完備的情況下其速度更快,提升效能。

二、HashMap資料結構

JDK1.8原始碼分析之HashMap
說明:展示了hashMap的資料結構(陣列+連結串列+紅黑樹),桶中的結構可能是連結串列,也可能是紅黑樹,紅黑樹的引入是為了提高效率。

三、HashMap原始碼分析

3.1類的繼承關係

public class HashMap<K,V> extends AbstractMap<K,V>
    implements Map<K,V>, Cloneable, Serializable
複製程式碼

可以看到HashMap繼承自父類(AbstractMap),實現了Map、Cloneable、Serializable介面。其中,Map介面定義了一組通用的操作;Cloneable介面則表示進行拷貝,在HashMap中,實現的是淺層次拷貝,即對拷貝物件的改變會影響被拷貝的物件;Serializable介面表示HashMap實現序列化,即可以將HashMap物件儲存本地,之後可以恢復狀態。

3.2類的屬性

public class HashMap<K,V> extends AbstractMap<K,V> implements Map<K,V>, Cloneable, Serializable {
    // 序列號
    private static final long serialVersionUID = 362498820763181265L;    
    // 預設的初始容量是16
    static final int DEFAULT_INITIAL_CAPACITY = 1 << 4;   
    // 最大容量
    static final int MAXIMUM_CAPACITY = 1 << 30; 
    // 預設的填充因子
    static final float DEFAULT_LOAD_FACTOR = 0.75f;
    // 當桶(bucket)上的結點數大於這個值時會轉成紅黑樹
    static final int TREEIFY_THRESHOLD = 8; 
    // 當桶(bucket)上的結點數小於這個值時樹轉連結串列
    static final int UNTREEIFY_THRESHOLD = 6;
    // 桶中結構轉化為紅黑樹對應的table的最小大小
    static final int MIN_TREEIFY_CAPACITY = 64;
    // 儲存元素的陣列,總是2的冪次倍
    transient Node<k,v>[] table; 
    // 存放具體元素的集
    transient Set<map.entry<k,v>> entrySet;
    // 存放元素的個數,注意這個不等於陣列的長度。
    transient int size;
    // 每次擴容和更改map結構的計數器
    transient int modCount;   
    // 臨界值 當實際大小(容量*填充因子)超過臨界值時,會進行擴容
    int threshold;
    // 填充因子
    final float loadFactor;
}
複製程式碼

3.3 類的建構函式

1.HashMap(int,float)型建構函式

public HashMap(int initialCapacity, float loadFactor) {
    // 初始容量不能小於0,否則報錯
    if (initialCapacity < 0)
        throw new IllegalArgumentException("Illegal initial capacity: " +
                                            initialCapacity);
    // 初始容量不能大於最大值,否則為最大值
    if (initialCapacity > MAXIMUM_CAPACITY)
        initialCapacity = MAXIMUM_CAPACITY;
    // 填充因子不能小於或等於0,不能為非數字
    if (loadFactor <= 0 || Float.isNaN(loadFactor))
        throw new IllegalArgumentException("Illegal load factor: " +
                                            loadFactor);
    // 初始化填充因子                                        
    this.loadFactor = loadFactor;
    // 初始化threshold大小
    this.threshold = tableSizeFor(initialCapacity);    
}
複製程式碼

說明:tableSizeFor(initialCapacity)返回大於等於initialCapacity的最小的二次冪數值。

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;
    }
複製程式碼

說明:>>> 操作符表示無符號右移,高位取0。

2.HashMap(int)型建構函式

public HashMap(int initialCapacity) {
    // 呼叫HashMap(int, float)型建構函式
    this(initialCapacity, DEFAULT_LOAD_FACTOR);
}
複製程式碼

3.HashMap()型建構函式

public HashMap() {
    // 初始化填充因子
    this.loadFactor = DEFAULT_LOAD_FACTOR; 
}
複製程式碼

4.HashMap(Map)型建構函式

public HashMap(Map<? extends K, ? extends V> m) {
    // 初始化填充因子
    this.loadFactor = DEFAULT_LOAD_FACTOR;
    // 將m中的所有元素新增至HashMap中
    putMapEntries(m, false);
}
複製程式碼

說明:putMapEntries(Map m,boolean evict)函式將m的所有元素存入本地HashMap示例中。

final void putMapEntries(Map<? extends K, ? extends V> m, boolean evict) {
    int s = m.size();
    if (s > 0) {
        // 判斷table是否已經初始化
        if (table == null) { // pre-size
            // 未初始化,s為m的實際元素個數
            float ft = ((float)s / loadFactor) + 1.0F;
            int t = ((ft < (float)MAXIMUM_CAPACITY) ?
                    (int)ft : MAXIMUM_CAPACITY);
            // 計算得到的t大於閾值,則初始化閾值
            if (t > threshold)
                threshold = tableSizeFor(t);
        }
        // 已初始化,並且m元素個數大於閾值,進行擴容處理
        else if (s > threshold)
            resize();
        // 將m中的所有元素新增至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);
        }
    }
}
複製程式碼

3.4重要函式分析

1.putVal函式

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;
    // (n - 1) & hash 確定元素存放在哪個桶中,桶為空,新生成結點放入桶中(此時,這個結點是放在陣列中)
    if ((p = tab[i = (n - 1) & hash]) == null)
        tab[i] = newNode(hash, key, value, null);
    // 桶中已經存在元素
    else {
        Node<K,V> e; K k;
        // 比較桶中第一個元素(陣列中的結點)的hash值相等,key相等
        if (p.hash == hash &&
            ((k = p.key) == key || (key != null && key.equals(k))))
                // 將第一個元素賦值給e,用e來記錄
                e = p;
        // hash值不相等,即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;
                // 用於遍歷桶中的連結串列,與前面的e = p.next組合,可以遍歷連結串列
                p = e;
            }
        }
        // 表示在桶中找到key值、hash值與插入元素相等的結點
        if (e != null) { 
            // 記錄e的value
            V oldValue = e.value;
            // onlyIfAbsent為false或者舊值為null
            if (!onlyIfAbsent || oldValue == null)
                //用新值替換舊值
                e.value = value;
            // 訪問後回撥
            afterNodeAccess(e);
            // 返回舊值
            return oldValue;
        }
    }
    // 結構性修改
    ++modCount;
    // 實際大小大於閾值則擴容
    if (++size > threshold)
        resize();
    // 插入後回撥
    afterNodeInsertion(evict);
    return null;
}
複製程式碼

說明:HashMap並沒有直接提供putVal介面給使用者呼叫,而是提供的put函式,而put函式就是通過putVal來插入元素的。

2.getNode函式

final Node<K,V> getNode(int hash, Object key) {
    Node<K,V>[] tab; Node<K,V> first, e; int n; K k;
    // table已經初始化,長度大於0,根據hash尋找table中的項也不為空
    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;
}
複製程式碼

說明:HashMap並沒有直接提供getNode介面給使用者,而是提供的get函式,而get函式就是通過getNode來取得元素的。

3.resize函式

final Node<K,V>[] resize() {
    // 當前table儲存
    Node<K,V>[] oldTab = table;
    // 儲存table大小
    int oldCap = (oldTab == null) ? 0 : oldTab.length;
    // 儲存當前閾值 
    int oldThr = threshold;
    int newCap, newThr = 0;
    // 之前table大小大於0
    if (oldCap > 0) {
        // 之前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
    }
    // 之前閾值大於0
    else if (oldThr > 0)
        newCap = oldThr;
    // oldCap = 0並且oldThr = 0,使用預設值(如使用HashMap()建構函式,之後再插入一個元素會呼叫resize函式,會進入這一步)
    else {           
        newCap = DEFAULT_INITIAL_CAPACITY;
        newThr = (int)(DEFAULT_LOAD_FACTOR * DEFAULT_INITIAL_CAPACITY);
    }
    // 新閾值為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"})
    // 初始化table
    Node<K,V>[] newTab = (Node<K,V>[])new Node[newCap];
    table = newTab;
    // 之前的table已經初始化過
    if (oldTab != null) {
        // 複製元素,重新進行hash
        for (int j = 0; j < oldCap; ++j) {
            Node<K,V> e;
            if ((e = oldTab[j]) != null) {
                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;
                    // 將同一桶中的元素根據(e.hash & oldCap)是否為0進行分割,分成兩個不同的連結串列,完成rehash
                    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;
                        newTab[j + oldCap] = hiHead;
                    }
                }
            }
        }
    }
    return newTab;
}
複製程式碼

說明:進行擴容,會伴隨著一次重新hash分配,並且會遍歷hash表中所有的元素,是非常耗時的。在編寫程式中,要儘量避免resize。

在resize前和resize後的元素佈局如下:

JDK1.8原始碼分析之HashMap
說明:上圖只是針對了陣列下標為2的桶中的各個元素在擴容後的分配佈局,其他各個桶中的元素佈局可以以此類推。


四、針對HashMap的思考

4.1 關於擴容的思考 從putVal原始碼中我們可以知道,當插入一個元素的時候size就加一,若size大於threshold的時候,就會進行擴容。假設我們的capacity大小為32,loadFator為0.75,則threshold為24=32*0.75,此時,插入25個元素,並且插入25個元素都在同一個桶中,桶中的資料結構為紅黑樹,則還有31個桶是空的,也會進行擴容處理,其實,此時,還有31個桶是空的,好像似乎不需要進行擴容處理的,因為此時我們的capacity大小可能不適當。

我們前面知道,擴容處理會遍歷所有的元素,時間複雜度很高;前面還知道,經過一次擴容處理後,元素會更加均勻的分佈在各個桶中農,會提升訪問效率。所以,說盡量避免進行擴容處理,也就意味著,遍歷元素所帶來的壞處大於元素在桶中均勻分佈所帶來的好處。


五、總結

至此,HashMap的原始碼就分析到這裡了,其中理解了其中的核心函式和資料結構,那麼理解HashMap的原始碼就不困難了。當然,此次分析中還有一些知識點沒有涉及到,如紅黑樹、序列化、拷貝等,後面的博文會繼續補充分析這些內容的。

相關文章