LinkedHashMap 詳解及原始碼簡析

仰簡發表於2019-01-27

一、前言

HashMap詳解以及原始碼分析 這篇文章中,對 HashMap 的實現原理進行了比較深入的分析。而在 HashMap 大家族中,另一個重要的且常常被拿來比較的類 LinkedHashMap 也非常的重要。相比較 HashMap,其最大的特點是其預設按插入順序進行排序。

在閱讀這篇文章之前,建義先過一遍 HashMap詳解以及原始碼分析。正如 LinkedHashMap 是繼承自 HashMap 一樣,這篇文章也是基於 HashMap 進行分析。

二、程式碼分析

1. demo 及其簡析

LinkedHashMap<String,String> linkedHashMap = new LinkedHashMap<>();

        linkedHashMap.put(null,"北京");
        linkedHashMap.put("beijing","北京");
        linkedHashMap.put("shanghai","上海");
        linkedHashMap.put("tianjin","天津");
        linkedHashMap.put("hangzhou","杭州");
        linkedHashMap.put("changsha","長沙");
        linkedHashMap.put("wuhan","武漢");
        linkedHashMap.put("guangzhou","廣州");
        linkedHashMap.put("shenzhen","深圳");

        Set<LinkedHashMap.Entry<String,String>> sets = linkedHashMap.entrySet();
        for (LinkedHashMap.Entry<String,String> set : sets) {
            Log.d(TAG, "linkedHashMapSample: key = " + set.getKey() + ";value = " + set.getValue());
        }
複製程式碼

demo 執行結果

linkedHashMapSample: key = null;value = 北京
linkedHashMapSample: key = beijing;value = 北京
linkedHashMapSample: key = shanghai;value = 上海
linkedHashMapSample: key = tianjin;value = 天津
linkedHashMapSample: key = hangzhou;value = 杭州
linkedHashMapSample: key = changsha;value = 長沙
linkedHashMapSample: key = wuhan;value = 武漢
linkedHashMapSample: key = guangzhou;value = 廣州
linkedHashMapSample: key = shenzhen;value = 深圳
複製程式碼

從執行結果可以看出,LinkedHashMap 輸出的結果的順序與其 put 時的順序時一致的。

2.原始碼分析

LinkedHashMap 的類圖結果在分析 HashMap 的時候已經有了解過,這裡再複習一下Map大家族。

Map大家族簡版.jpg

  • LinkedHashMap 的初始化
public LinkedHashMap(int initialCapacity, float loadFactor) {
        super(initialCapacity, loadFactor);
        accessOrder = false;
    }
public LinkedHashMap(int initialCapacity) {
        super(initialCapacity);
        accessOrder = false;
    }
public LinkedHashMap() {
        super();
        accessOrder = false;
    }
public LinkedHashMap(Map<? extends K, ? extends V> m) {
        super();
        accessOrder = false;
        putMapEntries(m, false);
    }
public LinkedHashMap(int initialCapacity,
                         float loadFactor,
                         boolean accessOrder) {
        super(initialCapacity, loadFactor);
        this.accessOrder = accessOrder;
    }
複製程式碼

LinkedHashMap 根據引數的不同過載了 5 個不同的構造方法,但其作用基本相同,只是賦值一些預設值而已,如初始容量,負載因子以及是否按訪問排序,其預設是按插入排序的。

  • LinkedHashMap 插入元素 put() 方法 LinkedHashMap 本身並沒有實現,是共用父類 HashMap 的,也就是這個 put 方法是來自於 HashMap 的。在分析 HashMap 的時候已經瞭解,put() 又是進一步呼叫了 putVal() 方法,下面簡單來過一下 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;
        if ((tab = table) == null || (n = tab.length) == 0)
            n = (tab = resize()).length;
        if ((p = tab[i = (n - 1) & hash]) == null)
            tab[i] = newNode(hash, key, value, null);
        else {
            Node<K,V> e; K k;
            if (p.hash == hash &&
                ((k = p.key) == key || (key != null && key.equals(k))))
                e = p;
            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;
                    }
                    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;
            }
        }
        ++modCount;
        if (++size > threshold)
            resize();
        afterNodeInsertion(evict);
        return null;
    }
複製程式碼

putVal() 裡面作的事情比較多,這裡也再來複習一下。 (1)通過對 hash(key) 計算出來的 hash 值,計算出雜湊 index。

(2)如果沒碰撞衝突直接放到 table 裡。

(3)如果碰撞衝突了,先以連結串列的形式解決衝突,並把新的 node 插入到鏈尾。

(4)如果碰撞衝突導致連結串列過長(>= TREEIFY_THRESHOLD),就把連結串列轉換成紅黑樹,提高查詢效率。

(5)如果節點已經存在,即key的 hash() 值相等且 key 的內容相等,就替換 old value,從而保證 key 的唯一性。

(6)如果 table 滿了( > load factor*capacity),就要擴容resize()。

這裡 LinkedHashMap 差異的地方在於建立新的 Node,也就是 Entry,而 LinkedHashMap 的 Entry 也是不一樣的,其有自己定義的 LinkedHashMapEntry。

    static class LinkedHashMapEntry<K,V> extends HashMap.Node<K,V> {
        LinkedHashMapEntry<K,V> before, after;
        LinkedHashMapEntry(int hash, K key, V value, Node<K,V> next) {
            super(hash, key, value, next);
        }
    }
複製程式碼

LinkedHashMapEntry 繼承自 HashMap.Node,在經基本上其增加了 before 以及 after 兩個指標,以此便可以構造出一個雙向連結串列。再來看看它的 newNode() 實現便可以知道它是如何構建雙向連結串列的了。

    Node<K,V> newNode(int hash, K key, V value, Node<K,V> e) {
        LinkedHashMapEntry<K,V> p =
            new LinkedHashMapEntry<K,V>(hash, key, value, e);
        linkNodeLast(p);
        return p;
    }
複製程式碼

這裡有個關鍵的呼叫 linkNodeLast() 方法。

private void linkNodeLast(LinkedHashMapEntry<K,V> p) {
        LinkedHashMapEntry<K,V> last = tail;
        tail = p;
        if (last == null)
            head = p;
        else {
            p.before = last;
            last.after = p;
        }
    }
複製程式碼

先取出 tial 指標,再令當前節點為 tial 指標,然後當前指標指向 tial 指標,tail 指標又指向當前指標。意思就是當前的 tail 指標與當前指標 p 建立起前後指向關係,然後令當前的 p 指標為 tail 指標,從而便構造出了雙向連結串列。

  • LinkedHashMap 獲取元素 get() 方法與remove() 方法 LinkedHashMap 的 get() 方法與 remove() 方法基本與 HashMap 是一致的,只是在 remove() 時注意還要從 LinkedHashMapEntry 所構成的雙向連結串列中將其也一併移除。

  • LinkedHashMap 的遍歷 在分析 HashMap 的時候我們知道,遍歷最主要的實現在集合自己所實現的 Iterator 中,而 Iterator 中最關鍵的又在 nextNode() 方法中。

final LinkedHashMapEntry<K,V> nextNode() {
            LinkedHashMapEntry<K,V> e = next;
            if (modCount != expectedModCount)
                throw new ConcurrentModificationException();
            if (e == null)
                throw new NoSuchElementException();
            current = e;
            next = e.after;
            return e;
        }
複製程式碼

從程式碼裡可以看出,這就是對一個連結進行遍歷的基本操作了,這裡根本就不需要考慮到 key 以及 value 本身是如何儲存的,而只是通過連結串列進行基本的遍歷就可以了。

三、總結

在瞭解了 HashMap 的原理後,再來看 LinkedHashMap 的話是非常簡單的。LinkedHashMap 是繼承自 HashMap 的,所以 LinkedHashMap 包含了 HashMap 所有的功能以及特性。而在此基礎上,LinkedHashMap 又將每個 LinkedHashMapEntry 連結成了一個雙向連結串列。而我們之所以能得到一個有序的結果輸出,其原因就在於其 Iterator 的實現。我們對 LinkedHashMap 的遍歷就是對 LinkedHashMapEntry 所構成的連結串列進行遍歷。預設情況下,連結串列就是按照插入順序進行構造的,新插入的結點都會被放到 tial,這也就是自然保證了插入時的順序了。

最後,感謝你能讀到並讀完此文章,如果分析的過程中存在錯誤或者疑問都歡迎留言討論。如果我的分享能夠幫助到你,還請記得幫忙點個贊吧,謝謝。

相關文章