LinkedHashMap源码学习总结

1，概述

      我们大学中学到的双向链表知识对本章学习很有帮助，LinkedHashMap 是一个关联数组、哈希表，它是线程不安全的，允许key为null,value为null。它继承自HashMap，实现了Map<K,V>接口。其  内部还维护了一个双向链表，在每次插入数据，或者访问、修改数据时，会增加节点、或调整链表的节点顺序。以决定迭代时输出的顺序。默认情况，遍历时的顺序是按照插入节点的顺序。这也是其与HashMap最大的区别。也可以在构造时传入accessOrder参数，使得其遍历顺序按照访问的顺序输出。默认是false，则迭代时输出的顺序是插入节点的顺序。若为true则输出的顺序是按照访问节点的顺序。
   我们知道HashMap不存在保存顺序的机制，本章介绍的LinkedHashMap转为此特征而生，LinkedHashMap中可以保持两种顺序，分别是插入顺序和访问顺序，通过accessOrder参数指定，accessOrder=false（默认）时，为按照插入节点的顺序；accessOrder=true时，为访问顺序。

 案例：
        1）按照插入节点的顺序
       public static void main(String[] args) {
Map<String,String> linkedHashMap = new LinkedHashMap<>();
linkedHashMap.put("化学", "93");
linkedHashMap.put("数学", "98");
linkedHashMap.put("生物", "92");
                linkedHashMap.put("英语", "97");
                linkedHashMap.put("物理", "94");
                linkedHashMap.put("历史", "96");
                linkedHashMap.put("语文", "99");
                linkedHashMap.put("地理", "95");
for(Map.Entry<String, String> en :linkedHashMap.entrySet()) {
System.out.println(en.getKey()+":"+en.getValue());
}
}

2，实现原理

  LinkedHashMap在HashMap(维护了一个数组，链表和二叉树)基础上，另外维护了一个双向链表，HashMap中的每个节点都进行了双向的链接，维持插入的顺序，LinkedHashMap中定义了一个head用于指向第一个节点，定义了一个tail用于指向最后一个节点。

 LinkedHashMap是HashMap的一个子类，LinkedHashMap继承Map<K,V>接口，LinkedHashMap中的节点元素Entry<K,V>,直接继承HashMap.Node<K,V>,LinkedHashMap对HashMap中的空方法(afterNodeAccess,afterNodeInsertion,afterNodeRemovel)进行了实现和对newNode方法进行了重写，UML图如下：

3，源码分析

3.1 节点构造方法
刚刚看LinkedHashMap的实现的时候有个疑问。LinkedHashMap继承HashMap，HashMap中的数组是Node<K,V>[]类型的，在LinkedHashMap中定义了Entry<K,V>继承Node<K,V>[]，但是在LinkedHashMap中并没有找到新建节点的方法。仔细研究之后发现，在HashMap类的put方法中，新建节点是使用的newNode方法。而在LinkedHashMap没有重写父类的put方法，而是重写了newNode方法来构建自己的节点对象。HashMap中的newNode方法：

    Node<K,V> newNode(int hash, K key, V value, Node<K,V> next) {
        return new Node<>(hash, key, value, next);

    }

LinkedHashMap中的newNode方法：
//用在put方法中
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;
    }

3.2 put方法
在LinkedHashMap类使用的仍然是父类HashMap的put方法，所以插入节点对象的流程基本一致。不同的是，LinkedHashMap重写了afterNodeInsertion和afterNodeAccess方法。
afterNodeInsertion方法用于移除链表中的最旧的节点对象，也就是链表头部的对象。但是在JDK1.8版本中，可以看到removeEldestEntry一直返回false，所以该方法并不生效。如果存在特定的需求，比如链表中长度固定，并保持最新的N的节点数据，可以通过重写该方法来进行实现。

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;

}

afterNodeAccess方法实现的逻辑，是把入参的节点放置在链表的尾部，这样对节点就可以进行按访问排序

void afterNodeAccess(Node<K,V> e) { // move node to last
    LinkedHashMap.Entry<K,V> last;
    //p:新添加进来的节点    b:新节点的上一个节点   a:新节点的下一个节点
    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 get方法
LinkedHashMap中的get方法与父类HashMap处理逻辑相似，不同之处在于增加了一处链表更新的逻辑。如果LinkedHashMap中存在要寻找的节点，那么判断如果设置了accessOrder，则在返回值之前，将该节点移动到对应桶中链表的尾部。

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;
}
3.4 remove方法
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.before = p.after = null;
    if (b == null)
        head = a;
    else  //如果删除节点有上一个节点，则该节点b指向下一个节点a，也就是b的下一个节点是a
        b.after = a;
    if (a == null) //如果删除节点没有下一个节点，则tail指向删除节点的上一个节点
        tail = b; 
    else //如果删除节点有下一个节点，则删除节点的下一个节点指向删除节点的上一个节点
        a.before = b; //a的上一个节点是b
}

4.小结

LinkedHashMap相对于HashMap，增加了双链表的结果（即节点中增加了前后指针），其他处理逻辑与HashMap一致，同样也没有锁保护，多线程使用存在风险。