《Java源码分析》：LinkedHashMap

《Java源码分析》：LinkedHashMap

最近也即将要参加校招，因此，就准备花几天的时间专门来将我们用的比较多的集合类的源码都看下，并以写博客的形式来记录相关思路。便于以后复习。

前面刚看了下HashMap类的源码，博客在这里：http://blog.csdn.net/u010412719/article/details/51980632

Hashtable类的源码分析，博客在这里：http://blog.csdn.net/u010412719/article/details/51972602

此篇博客就是关于LinkedHashMap类的源码分析。

1、LinkedHashMap的继承结构

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

从结构可以看出，LinkedHashMap继承HashMap并实现了Map接口。

2、LInkedHashMap构造函数

下面几个是LinkedHashMap的构造函数，每个构造函数都是直接调用父类HashMap的构造函数来完成相应的初始化工作。唯一的不同在于对变量：accessOrder 指定为 false。

    public LinkedHashMap(int initialCapacity, float loadFactor) {
super(initialCapacity, loadFactor);
        accessOrder = false;
    }

public LinkedHashMap(int initialCapacity) {
super(initialCapacity);
        accessOrder = false;
    }

public LinkedHashMap() {
super();
        accessOrder = false;
    }


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

构造函数中所提到的accessOrder

   /**
 * The iteration ordering method for this linked hash map: <tt>true</tt>
 * for access-order, <tt>false</tt> for insertion-order.
 *
 * @serial
 */
final boolean accessOrder;

根据注释，理解如下：

accessOrder,简单说就是这个用来控制元素的顺序，
accessOrder为true: 表示按照访问的顺序来，也就是谁最先访问，就排在第一位
accessOrder为false表示按照存放顺序来，就是你put元素的时候的顺序。

3、LinkedHashMap类中的内部类Entry

Entry类继承的是HashMap.Node类，且引入了两个属性before/after，HashMap就是利用HashMap.Node类实现的单链表，再加上借助一个存储HashMap.Node的数组就实现了“数组链表”的结合体。而LinkedHashMap引入before/after两个属性，可以看出，是准备实现双向链表的，因此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);
        }
    }
//下面为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;
        }
    }

4、put方法

既然是集合，肯定会有put方法来往容器中添加元素，在LinkedHashMap搜索了半天，没有找到，在找put方法的过程中，发现有get方法，怎么会没有put方法呢？？想了下，唯一的可能就是LinkedHashMap继承了HashMap没有重写HashMap中的put方法也。

下面我们贴出HashMap的put方法，看看这个put方法在LinkedHashMap中是如何来工作的。

    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;//重新开辟一个Node<K,V>的数组
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;
    }

上面就是HashMap中put方法的代码，在看LinkedHashMap源码之前看HashMap的时候，看到put方法中调用afterNodeAccess(e)和afterNodeInsertion(evict);而这两个方法在HashMap是两个空实现的方法：

    // Callbacks to allow LinkedHashMap post-actions
void afterNodeAccess(Node<K,V> p) { }
void afterNodeInsertion(boolean evict) { }

当时，还在郁闷，为什么调用了两个空实现的函数呢？？

现在，看了LinkedHashMap的源码，原来这两个函数是专门给LinkedHashMap重写用的。只要LinkedHashMap重写了这两个函数，也就完成了LinkedHashMap自己的put方法实现。

put方法的思路在HashMap中已经分析过了，大致如下：根据key的hash值得到存储位置，然后判断该存储位置是否已经有了元素，如果有了，则在该位置的链表中，找是否含有该key，如果有该key，则更新value。如果没有找到，则将节点插入到该位置的链表头。

现在，由于针对的是LinkedHashMap，因此思路稍微发生了点变化，在链表中找到key之后调用了afterNodeAccess函数，LinkedHashMap中的此函数不再为空，如果没有找到key，在插入节点之后返回之前，调用了afterNodeInsertion方法。

下面我们就来看下这两个函数的具体内容。

afterNodeAccess(Node

    void afterNodeAccess(Node<K,V> e) { // move node to last
        LinkedHashMap.Entry<K,V> last;
//accessOrder 为true时，才会进入下面if的语句块中
if (accessOrder && (last = tail) != e) {
            LinkedHashMap.Entry<K,V> p =
                (LinkedHashMap.Entry<K,V>)e, b = p.before, a = p.after;
            p.after = null;
/*
 调整链表指向，将e的前一个节点和后一个节点连接起来
 */
if (b == null)//前一个节点为null的情况
                head = a;
else
                b.after = a;
if (a != null)//后一个节点不为null的情况
                a.before = b;
else
                last = b;

//将p节点放在链表的最后面
if (last == null)
                head = p;
else {
                p.before = last;
                last.after = p;
            }
            tail = p;
            ++modCount;
        }
    }

下面介绍afterNodeInsertion(boolean evict)

从源码中可以看到，这个函数相当于什么都没有做。

原因为：removeEldestEntry函数一直返回false，导致这个函数afterNodeInsertion的if条件也就一直为false。

因此，不知道这个函数为什么这么写，分析了下，由于LinkedHashMap当accessOrder为false时，要按照添加元素的顺序进行维护链表，而HashMap就是直接将新节点放入到链表头，因此这个函数也就不需要做什么了。

    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的put方法，

LinkedHashMap与HashMap的区别真心不大，从put方法上可以看出，唯一的区别在于，如果我们设置了accessOrder = true，则会将访问的节点放入到链表的尾结点处，其它的都一样。

5、get方法

get方法的思路虽然对HashMap的get方法进行了重写，但基本与HashMap的思路一致：也是直接调用getNode获取到节点对象，然后返回其值。

但是，在LinkedHashMap中，由于需要有顺序需要维护，因此，当accessOrder = true 时，则需要调用afterNodeAccess(e)方法将此节点放到双向链表的末尾。而如果accessOrder = false.则完全与HashMap类中的get方法一模一样。

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

6、getOrDefault方法

getOrDefault方法与get方法唯一的区别在于，如果key不存在，则返回默认值而不是返回null。

   public V getOrDefault(Object key, V defaultValue) {
       Node<K,V> e;
if ((e = getNode(hash(key), key)) == null)
return defaultValue;
if (accessOrder)
           afterNodeAccess(e);
return e.value;
   }

LinkedHashMap类中其它的方法基本与HashMap类中的方法差不多，这里就不再进行介绍。

小结

LinkedHashMap 和hashMap 功能基本一样，都是维护的键值对集合，连遍历 以及方法都类似，唯一的区别在于HashMap 里面的元素是根据hash值来决定存放位置的，是无序的，而LinkedHashMap 维护的是一个按顺序存放的双向链表，是有序的。

因此，记住，他们的区别在于：LinkedHashMap是“数组和双向链表”的结合体，而HashMap是“数组和单向链表”的结合体就够了。