LinkedHashMap源码分析

基于jdk1.8进行分析的。

HashMap源码已经分析过了，如果不了的，可以去看之前博主写的博客，大致了解一下。当然也只是主要的一些，如果有时间的话，还是自己翻一下比较好。话不多说，开始正题。

继承结构

public class LinkedHashMap<K,V>
    extends HashMap<K,V>
    implements Map<K,V>

继承了HashMap，实现了Map接口。

构造函数

    //指定初始化时的容量，和扩容的加载因子
    public LinkedHashMap(int initialCapacity, float loadFactor) {
        super(initialCapacity, loadFactor);
        accessOrder = false;
    }
    
    //指定初始化时的容量，
    public LinkedHashMap(int initialCapacity) {
        super(initialCapacity);
        accessOrder = false;
    }

    public LinkedHashMap() {
        super();
        accessOrder = false;
    }
    
    //利用另一个Map 来构建，
    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的构造函数来完成相应的初始化工作。唯一的不同在于对变量：accessOrder 指定为 false。accessOrder,简单说就是这个用来控制元素的顺序。

• true: 表示按照访问的顺序来，也就是谁最先访问，就排在第一位 
• false表示按照存放顺序来，就是你put元素的时候的顺序

可见上面前四个构造方法都是直接为false，只有最后一个可以传入指定的accessOrder进行参数控制。

内部类

Entry<K,V>

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

从上面可以看到继承了HashMap的Node类。下面看一下HashMap中Node内部类的定义。

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

        public final K getKey()        { return key; }
        public final V getValue()      { return value; }
        public final String toString() { return key + "=" + value; }

        public final int hashCode() {
            return Objects.hashCode(key) ^ Objects.hashCode(value);
        }

        public final V setValue(V newValue) {
            V oldValue = value;
            value = newValue;
            return oldValue;
        }

        public final boolean equals(Object o) {
            if (o == this)
                return true;
            if (o instanceof Map.Entry) {
                Map.Entry<?,?> e = (Map.Entry<?,?>)o;
                if (Objects.equals(key, e.getKey()) &&
                    Objects.equals(value, e.getValue()))
                    return true;
            }
            return false;
        }
    }

不同于HashMap的Node的地方是：引入了两个属性before/after。

HashMap就是利用HashMap.Node类实现的单链表，再加上借助一个存储HashMap.Node的数组就实现了“数组链表”的结合体。而LinkedHashMap引入before/after两个属性，可以看出，是准备实现双向链表的，因此LinkedHashMap将是“数组和双链表”的结合体。

成员属性

    //序列化使用到    
    private static final long serialVersionUID = 3801124242820219131L;
    
    //记录头结点
    transient LinkedHashMap.Entry<K,V> head;
    
    //记录尾节点
    transient LinkedHashMap.Entry<K,V> tail;
    
    //控制节点访问顺序
    final boolean accessOrder;

成员方法

put方法

因为在继承结构图中我们可以看到继承了HashMap类，其put方法没有进行重写。以下是HashMap的put方法。

    //put方法的实现
    public V put(K key, V value) {
        return putVal(hash(key), key, value, false, true);
    }
    //put方法最终调用putVal方法实现的
    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) {
                    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;
                //1------LinkedHashMap
                afterNodeAccess(e);
                return oldValue;
            }
        }
        ++modCount;
        if (++size > threshold)
            resize();
        //2、LinkedHashMap
        afterNodeInsertion(evict);
        return null;
    }

上面的实现思路大致如下：根据key的hash值得到存储位置，然后判断该存储位置是否已经有了元素，如果没有，直接创建一个新的元素节点；如果有了，则在该位置的链表中，找是否含有该key，如果有该key，则更新value。如果没有找到，则将节点插入到该位置的链表头。具体代码分析详见HashMap源码分析。

上面标注中afterNodeAccess和afterNodeInsertion方法源码如下：

     void afterNodeAccess(Node<K,V> p) { }
    void afterNodeInsertion(boolean evict) { }

都是空方法并没有进行实现。那么我们看一下LinkedHashMap中的实现。

afterNodeAccess(Node<K,V> e) 

用来将当前被访问到的节点e，移动至内部的双向链表的尾部。

    void afterNodeAccess(Node<K, V> e) { // move node to last
        LinkedHashMap.Entry<K, V> last;
        //如果按照访问顺序排序，并且添加的元素不是双向链表的尾节点
        if (accessOrder && (last = tail) != e) {
            //记录当前节点为p，前后节点b，a;
            LinkedHashMap.Entry<K, V> p =
                    (LinkedHashMap.Entry<K, V>) e, b = p.before, a = p.after;
            //GC
            p.after = null;
            //如果当前节点没有前节点
            if (b == null)
                //将当前节点的后节点设置为头节点
                head = a;
                //如果有前节点
            else
                //将当前节点的后节点设置为当前节点的前节点的后节点
                b.after = a;

            //如果当前节点有后节点
            if (a != null)
                //将当前节点的前节点设置为当前节点的后节点的前节点
                a.before = b;
                //如果没有后节点
            else
                //将当前节点的前节点设置为最后一个节点
                last = b;
            //如果尾节点为null
            if (last == null)
                //将当前节点设置为首节点
                head = p;
            //尾节点不为null
            else {
                //将最后一个节点设置为当前节点的前节点
                p.before = last;
                //将当前节点设置为最后一个节点的后节点
                last.after = p;
            }
            //将当前节点p设置为尾节点
            tail = p;
            ++modCount;
            //此方法的逻辑就是，将当前节点，移动到双向链表的尾部，
            //每次有元素被访问的时候，就会按照访问先后来排序，
        }
    }

 afterNodeInsertion(boolean evict)

    //当evict为true时，删除双向链表的头节点
    //回调函数，新节点插入之后回调
    //根据evict判断是否需要删除最老插入的节点。如果实现LruCache会用到这个方法。
    void afterNodeInsertion(boolean evict) { // possibly remove eldest
        LinkedHashMap.Entry<K,V> first;
        //LinkedHashMap 默认返回false 则不删除节点
        if (evict && (first = head) != null && removeEldestEntry(first)) {
            K key = first.key;
            removeNode(hash(key), key, null, false, true);
        }
    }

afterNodeRemoval(Node<K, V> e)  

删除元素也是调用HashMap的remove方法，通过上面类似的方法查看HashMap中的remove方法中，afterNodeRemoval(node)通过查看源码，发现此方法也并未实现，是一个空方法。在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;
    }

以上三个方法是用来维护双向链表关系的定义的方法。因为代码注释已经写在里面了，所以就不一一赘述了。

get(Object key) 

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

根据对应的key返回null或者value。实现思路很简单，直接调用getNode获取到节点对象，然后返回其值。但是，在LinkedHashMap中，由于需要有顺序需要维护，因此，当accessOrder = true 时，则需要调用afterNodeAccess(e)方法将此节点放到双向链表的末尾。而如果accessOrder = false.则完全与HashMap类中的get方法一模一样。

containsValue(Object value)

相比HashMap的实现，更为高效。

     public boolean containsValue(Object value) {
        for (LinkedHashMap.Entry<K,V> e = head; e != null; e = e.after) {
            V v = e.value;
            if (v == value || (value != null && value.equals(v)))
                return true;
        }
        return false;
    }

而在HashMap中实现如下：

    public boolean containsValue(Object value) {
        Node<K,V>[] tab; V v;
        if ((tab = table) != null && size > 0) {
            for (int i = 0; i < tab.length; ++i) {
                for (Node<K,V> e = tab[i]; e != null; e = e.next) {
                    if ((v = e.value) == value ||
                        (value != null && value.equals(v)))
                        return true;
                }
            }
        }
        return false;
    }

可见是通过两个for循环实现的。

 entrySet()

用来进行遍历

    public Set<Map.Entry<K,V>> entrySet() {
        Set<Map.Entry<K,V>> es;
        return (es = entrySet) == null ? (entrySet = new LinkedEntrySet()) : es;
    }

对于LinkedEntrySet源码如下：

final class LinkedEntrySet extends AbstractSet<Map.Entry<K,V>> {
    public final Iterator<Map.Entry<K,V>> iterator() {
        return new LinkedEntryIterator();
    }
}

iterator实现是通过LinkedEntryIterator实现的。

    final class LinkedEntryIterator extends LinkedHashIterator
        implements Iterator<Map.Entry<K,V>> {
        public final Map.Entry<K,V> next() { return nextNode(); }
    }

next方法中，调用的nextNode源码如下： 

    final LinkedHashMap.Entry<K,V> nextNode() {
            LinkedHashMap.Entry<K,V> e = next;
            if (modCount != expectedModCount)
                throw new ConcurrentModificationException();
            if (e == null)
                throw new NoSuchElementException();
            current = e;
            next = e.after;
            return e;
        }

从源码可以看出，就是一个双向链表的遍历。

以上就是大致上LinkedHashMap中比较重要的实现。大体上可以看出，LinkedHashMap是继承自HashMap，很多方法都未自己覆盖重写，而是在实现的具体的细节的某些地方进行控制修改。如果您已经阅读过HashMap源码，相信LinkedHashMap源码应该也不是什么大问题。如果有不对的地方还请指正。