LinkedHashMap 源码分析（JDK1.8）

一.概述

LinkedHashMap继承自HashMap，在HashMap基础上，增加一个双向的链表，记录了元素遍历和插入的顺序，在实现上，很多直接继承HashMap的方法，仅为维护双向链表重写部分方法。

二.源码分析

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);
        }
    }

Entry元素继承了Node，并在此基础上，增加元素的两条引用，对前一个元素的引用before和对后一个元素的引用after。

1.链表的建立
链表的建立是在插入键值对开始的，开始时，链表的head和tail的引用指向新节点，意味着链表的建立，之后新节点接在tail后面，意味着链表的更新。

HashMap 的实现
 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)
            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) {
                  / /将新节点插入表的后面，LinkedHashMap重写newNode方法
                    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;
    }``
    /
    HashMap实现
  Node<K,V> newNode(int hash, K key, V value, Node<K,V> next) {
        return new Node<>(hash, key, value, next);
    }

LinkedHashMap直接调用HashMap的put方法，进行节点的插入。

   LinkedHashMap重写HashMap方法
  Node<K,V> newNode(int hash, K key, V value, Node<K,V> e) {
  //将Entry接在双向表尾部
        LinkedHashMap.Entry<K,V> p =
            new LinkedHashMap.Entry<>(hash, key, value, e);
        linkNodeLast(p);
        return p;
    }
    /
    LinkedHashMap实现
  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;
        }
    }

LinkedHashMap创建Entry，通过 linkNodeLast 方法将 Entry 接在双向链表的尾部，实现了双向链表的建立。

2.链表节点的删除

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;
    }
HashMap实现
       void afterNodeRemoval(Node<K,V> p) { }

LinkedHashMap重写afterNodeRemoval方法

   void afterNodeRemoval(Node<K,V> e) { // unlink
        LinkedHashMap.Entry<K,V> p =
            (LinkedHashMap.Entry<K,V>)e, b = p.before, a = p.after;
            //将p节点的前后引用变为空
        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的remove方法删除单链表的节点，再重写afterNodeRemoval方法，删除双向链表的节点。

3.访问顺序
LinkedHashMap的默认排序是按插入顺序，即boolean accessOrder为false，手动改为true时，按访问顺序排序，即每当访问一次元素，该元素就会被移动链表的最后面。

 LinkedHashMap重写
  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重写 
  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;
        }
    }

4.实现缓存

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;
}

当我们基于 LinkedHashMap 实现缓存时，通过覆写removeEldestEntry方法可以实现自定义策略的 LRU 缓存。比如我们可以根据节点数量判断是否移除最近最少被访问的节点，或者根据节点的存活时间判断是否移除该节点等。

附上链接：https://segmentfault.com/a/1190000012964859