【JDK】JDK源碼分析-LinkedHashMap
- 2019 年 10 月 3 日
- 筆記
概述
前文「JDK源碼分析-HashMap(1)」分析了 HashMap 主要方法的實現原理（其他問題以後分析），本文分析下 LinkedHashMap。
先看一下 LinkedHashMap 的類繼承結構圖：
可以看到 LinkedHashMap 繼承了 HashMap。
我們知道 HashMap 是無序的，即迭代器的順序與插入順序沒什麼關係。而 LinkedHashMap 在 HashMap 的基礎上增加了順序：分別為「插入順序」和「訪問順序」。即遍歷 LinkedHashMap 時，可以保持與插入順序一致的順序；或者與訪問順序一致的順序。
LinkedHashMap 內部如何實現這兩種順序的呢？它是通過一個雙鏈表來維持的。因此可以將 LinkedHashMap 理解為「雙鏈表 + 散列表」，或者“有序的散列表”。
代碼分析
節點類 Entry
LinkedHashMap 內部有一個嵌套類 Entry，它繼承自 HashMap 中的 Node 類，如下：
static class Entry<K,V> extends HashMap.Node<K,V> { Entry<K,V> before, after; Entry(int hash, K key, V value, Node<K,V> next) { super(hash, key, value, next); } }
static class Node<K,V> implements Map.Entry<K,V> { final int hash; final K key; V value; Node<K,V> next; Node(int hash, K key, V value, Node<K,V> next) { this.hash = hash; this.key = key; this.value = value; this.next = next; } // ... }
該 Entry 類就是 LinkedHashMap 中的節點類。可以看到，它在 Node 類的基礎上又增加了 before 和 after 兩個變量，它們保存的是節點的前驅和後繼（從字面意思也可以進行推測），從而來維護 LinkedHashMap 的順序。
成員變量
/** * The head (eldest) of the doubly linked list. */ transient LinkedHashMap.Entry<K,V> head; /** * The tail (youngest) of the doubly linked list. */ transient LinkedHashMap.Entry<K,V> tail; /** * The iteration ordering method for this linked hash map: true * for access-order, false for insertion-order. * LinkedHashMap 的迭代順序：true 為訪問順序；false 為插入順序。 */ final boolean accessOrder;
構造器
構造器1：
/** * Constructs an empty insertion-ordered LinkedHashMap instance * with the default initial capacity (16) and load factor (0.75). */ public LinkedHashMap() { super(); accessOrder = false; }
這裡的 super() 方法調用了 HashMap 的無參構造器。該構造器方法構造了一個容量為 16（默認初始容量）、負載因子為 0.75（默認負載因子）的空 LinkedHashMap，其順序為插入順序。
構造器 2、3、4、5：
public LinkedHashMap(int initialCapacity) { super(initialCapacity); accessOrder = false; } public LinkedHashMap(int initialCapacity, float loadFactor) { super(initialCapacity, loadFactor); 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; }
可以看到上面幾個構造器都是通過調用父類（HashMap）的構造器方法初始化，對此不再進行分析。前面 4 個構造器的 accessOrder 變量默認值都為 false；最後一個稍微不一樣，它的 accessOrder 可以在初始化時指定，即指定 LinkedHashMap 的順序（插入或訪問順序）。
put 方法
LinkedHashMap 本身沒有實現 put 方法，它通過調用父類（HashMap）的方法來進行讀寫操作。這裡再貼下 HashMap 的 put 方法：
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; if ((tab = table) == null || (n = tab.length) == 0) n = (tab = resize()).length; if ((p = tab[i = (n - 1) & hash]) == null) // 新的 bin 節點 tab[i] = newNode(hash, key, value, null); else { Node<K,V> e; K k; // key 已存在 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; }
這個方法哪個地方跟 LinkedHashMap 有聯繫呢？如何能保持 LinkedHashMap 的順序呢？且看其中的 newNode() 方法，它在 HashMap 中的代碼如下：Node<K,V> newNode(int hash, K key, V value, Node<K,V> next) { return new Node<>(hash, key, value, next); }
但是，LinkedHashMap 重寫了該方法：
// 新建一個 LinkedHashMap.Entry 節點 Node<K,V> newNode(int hash, K key, V value, Node<K,V> e) { LinkedHashMap.Entry<K,V> p = new LinkedHashMap.Entry<K,V>(hash, key, value, e); // 將新節點連接到列表末尾 linkNodeLast(p); return p; }
// link at the end of list private void linkNodeLast(LinkedHashMap.Entry<K,V> p) { LinkedHashMap.Entry<K,V> last = tail; tail = p; // list 為空 if (last == null) head = p; else { // 將新節點插入到 list 末尾 p.before = last; last.after = p; } }
可以看到，每次插入新節點時，都會存到列表的末尾。原來如此，LinkedHashMap 的插入順序就是在這裡實現的。
此外，上文分析 HashMap 時提到兩個回調方法：afterNodeAccess 和 afterNodeInsertion。它們在 HashMap 中是空的：
// Callbacks to allow LinkedHashMap post-actions void afterNodeAccess(Node<K,V> p) { } void afterNodeInsertion(boolean evict) { }
同樣，LinkedHashMap 對它們進行了重寫。先來分析 afterNodeAccess 方法：
void afterNodeAccess(Node<K,V> e) { // move node to last LinkedHashMap.Entry<K,V> last; // accessOrder 為 true 表示訪問順序 if (accessOrder && (last = tail) != e) { // p 為訪問的節點，b 為其前驅，a 為其後繼 LinkedHashMap.Entry<K,V> p = (LinkedHashMap.Entry<K,V>)e, b = p.before, a = p.after; p.after = null; // p 是頭節點 if (b == null) head = a; else b.after = a; if (a != null) a.before = b; else last = b; if (last == null) head = p; else { p.before = last; last.after = p; } tail = p; ++modCount; } }
為了便於分析和理解，這裡畫出了兩個操作示意圖：
這裡描述了進行該操作前後的兩種情況。可以看到，該方法執行後，節點 p 被移到了 list 的末尾。
get 方法
LinkedHashMap 重寫了 HashMap 的 get 方法，主要是為了維持訪問順序，代碼如下：
public V get(Object key) { Node<K,V> e; if ((e = getNode(hash(key), key)) == null) return null; // 若為訪問順序，將訪問的節點移到列表末尾 if (accessOrder) afterNodeAccess(e); return e.value; }
這裡的 getNode 方法是父類的（HashMap）。若 accessOrder 為 true（即指定為訪問順序），則將訪問的節點移到列表末尾。
LinkedHashMap 中重寫的 afterNodeInsertion 方法：
void afterNodeInsertion(boolean evict) { // possibly remove eldest LinkedHashMap.Entry<K,V> first; if (evict && (first = head) != null && removeEldestEntry(first)) { K key = first.key; removeNode(hash(key), key, null, false, true); } } // LinkedHashMap 中默認的返回值為 false，即這裡的 removeNode 方法不執行 protected boolean removeEldestEntry(Map.Entry<K,V> eldest) { return false; }
removeNode 方法是父類 HashMap 中的。
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 值所在位置不為空 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; // 給定 key 對應的節點，在數組中第一個位置 if (p.hash == hash && ((k = p.key) == key || (key != null && key.equals(k)))) node = p; // 給定的 key 所在位置為紅黑樹或鏈表 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); } } // 刪除節點 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); else if (node == p) tab[index] = node.next; else p.next = node.next; ++modCount; --size; // 刪除節點後的操作 afterNodeRemoval(node); return node; } } return null; }
afterNodeRemoval 方法在 HashMap 中的實現也是空的：
void afterNodeRemoval(Node<K,V> p) { }
LinkedHashMap 重寫了該方法：
void afterNodeRemoval(Node<K,V> e) { // unlink LinkedHashMap.Entry<K,V> p = (LinkedHashMap.Entry<K,V>)e, b = p.before, a = p.after; p.before = p.after = null; if (b == null) head = a; else b.after = a; if (a == null) tail = b; else a.before = b; }
該方法就是雙鏈表刪除一個節點的操作。
代碼演練
LinkedHashMap 用法
我們知道 HashMap 是無序的，例如：
Map<String, String> map = new HashMap<>(); map.put("bush", "a"); map.put("obama", "b"); map.put("trump", "c"); map.put("lincoln", "d"); System.out.println(map); // 輸出結果（無序）： // {obama=b, trump=c, lincoln=d, bush=a}
而若換成 LinkedHashMap，則可以保持插入的順序：
Map<String, String> map = new LinkedHashMap<>(); map.put("bush", "a"); map.put("obama", "b"); map.put("trump", "c"); map.put("lincoln", "d"); System.out.println(map); // 輸出結果（插入順序）： // {bush=a, obama=b, trump=c, lincoln=d}
指定 LinkedHashMap 的順序為訪問順序：
Map<String, String> map = new LinkedHashMap<>(2, 0.75f, true); map.put("bush", "a"); map.put("obama", "b"); map.put("trump", "c"); map.put("lincoln", "d"); System.out.println(map); map.get("obama"); System.out.println(map); // 輸出結果（插入順序）： // {bush=a, obama=b, trump=c, lincoln=d} // 訪問 obama 後，obama 移到了末尾 // {bush=a, trump=c, lincoln=d, obama=b}
實現 LRU 緩存
private static class LRUCache<K, V> extends LinkedHashMap<K, V> { private int capacity; public LRUCache(int capacity) { super(16, 0.75f, true); this.capacity = capacity; } @Override protected boolean removeEldestEntry(Map.Entry<K, V> eldest) { return size() > capacity; } }
使用舉例：
LRUCache<String, String> lruCache = new LRUCache<>(2); lruCache.put("bush", "a"); lruCache.put("obama", "b"); lruCache.put("trump", "c"); System.out.println(lruCache); // 輸出結果： // {obama=b, trump=c}
這裡定義的 LRUCache 類中，對 removeEldestEntry 方法進行了重寫，當緩存中的容量大於 2，時會把最早插入的元素 “bush” 刪除。因此只剩下兩個值。
小結
1. LinkedHashMap 繼承自 HashMap，其結構可以理解為「雙鏈表 + 散列表」；
2. 可以維護兩種順序：插入順序或訪問順序；
3. 可以方便的實現 LRU 緩存；
4. 線程不安全。
Stay hungry, stay foolish.
PS: 本文首發於微信公眾號【WriteOnRead】。
