LinkedHashMap--JDK1.8源码分析

与HashMap的区别：内部维持了一个双向链表,可以保持顺序

LinkedHashMap继承自HashMap,很多操作都是跟HashMap一样，对于一样的地方就不再介绍，详细可参考HashMap - - JDK1.8 源码分析  ，下面主要介绍一下不同的地方。

数据结构

首先列出几个需要知晓的实例变量含义：

final boolean accessOrder;//该变量表示是否需要按照读取顺序排序;true为是，false为否，当为false时按照插入顺序排序;此处的读取包括更新（因为更新也意味着一次读取）和读取

transient LinkedHashMap.Entry<K,V> head;//表示该实例的头部节点

transient LinkedHashMap.Entry<K,V> tail;//表示该实例的尾部节点

开始源码分析

一、构造函数

    public LinkedHashMap(int initialCapacity, float loadFactor) {
        super(initialCapacity, loadFactor);//直接调用父类构造方法
        accessOrder = false;//默认为false
    }

    public LinkedHashMap(int initialCapacity) {
        super(initialCapacity);//直接调用父类构造方法
        accessOrder = false;//默认为false
    }
    
    public LinkedHashMap() {
        super();//直接调用父类构造方法
        accessOrder = false;//默认为false
    }

    public LinkedHashMap(Map<? extends K, ? extends V> m) {
        super();//直接调用父类构造方法
        accessOrder = false;//默认为false
        putMapEntries(m, false);//调用父类的存储元素方法
    }

    public LinkedHashMap(int initialCapacity,
                         float loadFactor,
                         boolean accessOrder) {
        super(initialCapacity, loadFactor);//直接调用父类构造方法
        this.accessOrder = accessOrder;//允许用户自定义
    }

对于调用父类的方法，此篇不再赘述，可看HashMap源码讲解那篇。

二、存储元素-put方法

LinkedHashMap的put方法直接调用的父类HashMap的put方法，不过重写了调用过程中的几个方法，下面重点分析下这几个方法。

    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);//被linkedhashmap重写
        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);//被linkedhashmap重写
                return oldValue;
            }
        }
        ++modCount;
        if (++size > threshold)
            resize();
        afterNodeInsertion(evict);//被linkedhashmap重写
        return null;
    }

1. newNode方法

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

    //linkedhashmap节点类
    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);//调用父类的构造函数
        }
    }

    private void linkNodeLast(LinkedHashMap.Entry<K,V> p) {
        //将之前的尾结点赋值给last
        LinkedHashMap.Entry<K,V> last = tail;
        //将p设置为该实例的尾节点变量
        tail = p;
        //如果之前尾节点为空，说明当前这个map是空的，把该节点设置为头节点
        if (last == null)
            head = p;
        else {//否则 把当前节点的前一节点设置为之前的尾节点，把之前的尾节点的下一节点设置为当前节点
            p.before = last;
            last.after = p;
        }
    }

2.afterNodeAccess方法

    //该方法是为了当accessOrder为true时，每次访问时更新被访问节点的位置，使其到链表尾端
    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;
        }
    }

上面的代码可用如下图所示（从图中可以看到，结点3链接到了双向链表原尾结点后面，变成了新的尾节点）：

3. afterNodeInsertion方法

    //该方法实现的是，如果evict为ture，并且removeEldestEntry返回也为true，则移除第一个节点，一般用于实现LRU（最近最少访问）策略的缓存
    //通过跟踪代码可知removeEldestEntry目前只会返回false，所以再不重写removeEldestEntry的方法时，该方法没有意义
    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);
        }
    }
    //目前直接返回的false
    protected boolean removeEldestEntry(Map.Entry<K,V> eldest) {
        return false;
    }

三、remove方法和hashmap一致

四、get方法

linkedHashMap中重写了get方法，但其中的getNod方法使用的还是hashMap中的getNode方法

    public V get(Object key) {
        Node<K,V> e;
        if ((e = getNode(hash(key), key)) == null)//还用了hashmap的getNode方法
            return null;
        if (accessOrder)//增加了如果accessOrder为true的情况，会将被访问对象更新到链的尾端
            afterNodeAccess(e);
        return e.value;
    }

附：LinkedHashMap实现LRU的例子可参考https://www.jianshu.com/p/816ea80a8cbc

文中部分图片来源于https://www.cnblogs.com/zfyang2429/p/10422628.html