LinkedHashMap源碼解讀
- 2020 年 3 月 14 日
- 筆記
1. 前言
還是從面試中來，到面試中去。面試官在面試 Redis 的時候經常會問到，Redis 的 LRU 是如何實現的？如果讓你實現 LRU 算法，你會怎麼實現呢？除了用現有的結構 LinkedHashMap 實現，你可以自己實現一個嗎？跳躍表、小頂堆行不行…
閱讀這篇文章前建議大家先熟悉下Java 面試必問之 Hashmap 底層實現原理(JDK1.8)。LinkedHashMap 基於 HashMap 實現，其中很多方法都是在 HashMap 上進行了增強。
2. 使用 LinkedHashMap 實現 LRU 緩存
實現代碼如下:
public class LRUCache<K, V> extends LinkedHashMap<K, V> { private int cacheSize; public LRUCache(int cacheSize) { super(16, (float) 0.75, true); this.cacheSize = cacheSize; } /** * 判斷節點數是否超限 * @param eldest * @return 超限返回 true，否則返回 false */ @Override protected boolean removeEldestEntry(Map.Entry<K, V> eldest) { return size() > cacheSize; } }測試代碼如下:
/** * 輸出結果: * 17:44:31.635 [main] INFO com.demo.cache.Test - 所有的緩存:{key0=0, key1=1, key2=2} * 17:44:31.641 [main] INFO com.demo.cache.Test - 訪問key0後的緩存:{key1=1, key2=2, key0=0} * 17:44:31.642 [main] INFO com.demo.cache.Test - 測試熱點緩存:{key2=2, key0=0, key3=3} */ @Slf4j public class Test { public static void main(String[] args) { LRUCache<Object, Object> lruCache = new LRUCache<>(3); for (int i=0; i<3; i++) { lruCache.put("key" + i, i); } log.info("所有的緩存:{}", lruCache); // 理論上剛訪問過key0，key0應該放在鏈表尾部，代表最近使用，刪除策略從頭部刪除 lruCache.get("key0"); log.info("訪問key0後的緩存:{}", lruCache); // 新插入緩存，超過了緩存閾值，理論上會刪除鏈表頭部元素，並將新緩存放置在鏈表尾部。 lruCache.put("key3", 3); log.info("測試熱點緩存:{}", lruCache); } }3. 源碼分析
Redis 中 LRU 的實現暫時沒有研究，大家可以看下別人的分析，這裡只做 java 部分的分析。
筆者的代碼環境是 OpenJDK8
LinkedHashMap 底層依舊基於 HashMap 實現，同時增加了一條雙向鏈表，使得上面的結構可以保持鍵值對的插入順序。同時通過對鏈表進行相應的操作，實現了訪問順序相關邏輯。
3.1 基礎節點 Entry
static class Entry<K,V> extends HashMap.Node<K,V> { Entry<K,V> before, after; // 構造方法直接復用Hashmap的構造方法 Entry(int hash, K key, V value, Node<K,V> next) { super(hash, key, value, next); } }基礎節點的繼承自 HashMap 的 Node 節點.
3.2 新增節點
查看源碼方法列表可以看出，源碼中沒有 put()方法，那一定是繼承父類 Hashmap 的 put()方法。
這裡我們再看下鏈表的插入邏輯
// HashMap方法 public V put(K key, V value) { return putVal(hash(key), key, value, false, true); } // HashMap方法 final V putVal(int hash, K key, V value, boolean onlyIfAbsent, boolean evict) { Node<K,V>[] tab; Node<K,V> p; int n, i; // 判斷數組是否為空，長度是否為0，是則進行擴容數組初始化 if ((tab = table) == null || (n = tab.length) == 0) n = (tab = resize()).length; // 通過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 = p; // 該數組元素在鏈表長度>8後形成紅黑樹結構的對象,p為樹結構已存在的對象 else if (p instanceof TreeNode) e = ((TreeNode<K,V>)p).putTreeVal(this, tab, hash, key, value); else { // 該數組元素hash相等，key不等，同時鏈表長度<8.進行遍歷尋找元素，有就覆蓋無則新建 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 // 鏈表長度>=8 結構轉為 紅黑樹 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; // onlyIfAbsent默認false if (!onlyIfAbsent || oldValue == null) e.value = value; // 需要子類實現 afterNodeAccess(e); return oldValue; } } ++modCount; // 判斷是否需要擴容 if (++size > threshold) resize(); // 需要子類實現，默認是true afterNodeInsertion(evict); return null; } // 覆蓋HashMap方法,新創建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; } // 將元素插入到雙端鏈表尾部 private void linkNodeLast(LinkedHashMap.Entry<K,V> p) { LinkedHashMap.Entry<K,V> last = tail; tail = p; // 數組和鏈表都為空，首尾指針指向當前節點 if (last == null) head = p; else { // 移動尾指針指向新節點 p.before = last; last.after = p; } } // 將被訪問節點移動到鏈表最後(覆蓋舊節點value的走這裡，包括鏈表和紅黑樹) void afterNodeAccess(Node<K,V> e) { // move node to last LinkedHashMap.Entry<K,V> last; if (accessOrder && (last = tail) != e) { LinkedHashMap.Entry<K,V> p = (LinkedHashMap.Entry<K,V>)e, b = p.before, a = p.after; p.after = null; 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; } } // 根據條件判斷是否移除最近最少被訪問的節點 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); } } // 覆蓋此方法可實現不同的策略緩存, protected boolean removeEldestEntry(Map.Entry<K,V> eldest) { return false; }基本插入邏輯和 HashMap 是相同的，我把需要子類覆寫的地方用不同顏色表示出來了，具體見下圖:
3.3 刪除節點
// HashMap實現 public V remove(Object key) { Node<K,V> e; return (e = removeNode(hash(key), key, null, false, true)) == null ? null : e.value; } // 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; 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; 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); } } 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; } // 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; }刪除節點的邏輯比較簡單，和 HashMap 基本一樣，刪除節點後重新維護前後節點指針即可。
3.4 獲取節點(最近使用節點移動至尾節點)
// 重寫HashMap方法 public V get(Object key) { Node<K,V> e; if ((e = getNode(hash(key), key)) == null) return null; // 如果accessOrder=true,則獲取節點元素後將該節點移動至鏈表尾部(刪除舊節點從頭部刪除) if (accessOrder) afterNodeAccess(e); return e.value; } // LinkedHashMap 中覆寫。將被訪問節點移動到鏈表最後(覆蓋舊節點value的走這裡，包括鏈表和紅黑樹) // 將被訪問節點移動到鏈表最後(覆蓋舊節點value的走這裡，包括鏈表和紅黑樹) void afterNodeAccess(Node<K,V> e) { // move node to last LinkedHashMap.Entry<K,V> last; if (accessOrder && (last = tail) != e) { LinkedHashMap.Entry<K,V> p = (LinkedHashMap.Entry<K,V>)e, b = p.before, a = p.after; p.after = null; if (b == null) head = a; else // 移除節點e,並重新維護前後節點鏈表指針 b.after = a; if (a != null) // 移除節點e,並重新維護前後節點鏈表指針 a.before = b; else last = b; if (last == null) head = p; else { // 將節點e移動到鏈表尾部 p.before = last; last.after = p; } tail = p; ++modCount; } }從代碼中可以看到，每次調用 get 方法時，如果開啟了 accessOrder，則會將當前元素移動到鏈表尾部。
4. 總結
本來源碼加配圖學習會更加容易明白，奈何繪圖功底有限。大家有什麼比較好用的工具可以推薦一下。到此，本篇文章就寫完了，感謝大家的閱讀！如果您覺得對您有幫助，請關注公眾號【當我遇上你】。
