LinkedHashMap的源码分析

参考文章：【Java集合源码剖析】LinkedHashmap源码剖析

LinkedHashMap概述

LinkedHashMap是HashMap的子类，与HashMap有着同样的存储结构，同样允许key和value为null，但它加入了一个双向链表的头结点，将所有put到LinkedHashmap的节点串成了一个双向循环链表，因此它保留了节点插入的顺序，可以使节点的输出顺序与输入顺序相同。

LinkedHashMap的数据结构

图示： 
 
 
实际上就是HashMap和LinkedList两个集合类的存储结构的结合。在LinkedHashMapMap中，所有put进来的Entry都保存在如第一个图所示的哈希表中，但它又额外定义了一个以head为头结点的空的双向循环链表，每次put进来Entry，除了将其保存到对哈希表中对应的位置上外，还要将其插入到双向循环链表的尾部。

LinkedHashMap的源码分析

LinkedHashMap并没有覆写HashMap中的put方法，而是覆写了put方法中调用的addEntry方法和recordAccess方法，我们回过头来再看下HashMap的put方法。

public V put(K key, V value) {     // HashMap允许存放null键和null值。     // 当key为null时，调用putForNullKey方法，将value放置在数组第一个位置。     if (key == null)         return putForNullKey(value);     // 当key不为null，计算key的hash值。     int hash = hash(key.hashCode());     // 搜索指定hash值在对应table中的索引。     int i = indexFor(hash, table.length);     // 如果 i 索引处的 Entry 不为 null，通过循环不断遍历 e 元素的下一个元素。     for (Entry<K,V> e = table[i]; e != null; e = e.next) {         Object k;        // 如果发现 i 索引处的链表的某个Entry的hash和新Entry的hash相等且两者的key相同，则新Entry覆盖旧Entry，返回。         if (e.hash == hash && ((k = e.key) == key || key.equals(k))) {             V oldValue = e.value;             e.value = value;             e.recordAccess(this);             return oldValue;         }     }     // 如果i索引处的Entry为null，表明此处还没有Entry。     modCount++;     // 将key、value添加到i索引处。     addEntry(hash, key, value, i);     return null; }
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26

我们先来看recordAccess方法：

      void recordAccess(HashMap<K,V> m) {            LinkedHashMap<K,V> lm = (LinkedHashMap<K,V>)m;      //如果链表中元素按照访问顺序排序，则将当前访问的Entry移到双向循环链表的尾部，      //如果是按照插入的先后顺序排序，则不做任何事情。            if (lm.accessOrder) {                lm.modCount++;          //移除当前访问的Entry                remove();          //将当前访问的Entry插入到链表的尾部                addBefore(lm.header);            }        } 
1
2
3
4
5
6
7
8
9
10
11
12

当要put进来的Entry的key在哈希表中已经在存在时，会调用recordAccess方法，当该key不存在时，则会调用addEntry方法将新的Entry插入到对应槽的单链表的头部。 
再来看addEntry方法：

   void addEntry(int hash, K key, V value, int bucketIndex) {      //创建新的Entry，并插入到LinkedHashMap中         createEntry(hash, key, value, bucketIndex);         //双向链表的第一个有效节点（header后的那个节点）为近期最少使用的节点         Entry<K,V> eldest = header.after;      //如果有必要，则删除掉该近期最少使用的节点，      //这要看对removeEldestEntry的覆写,由于默认为false，因此默认是不做任何处理的。         if (removeEldestEntry(eldest)) {             removeEntryForKey(eldest.key);         } else {          //扩容到原来的2倍             if (size >= threshold)                 resize(2 * table.length);         }     }     void createEntry(int hash, K key, V value, int bucketIndex) {      //创建新的Entry，并将其插入到数组对应槽的单链表的头结点处，这点与HashMap中相同         HashMap.Entry<K,V> old = table[bucketIndex];         Entry<K,V> e = new Entry<K,V>(hash, key, value, old);         table[bucketIndex] = e;      //每次插入Entry时，都将其移到双向链表的尾部，      //这便会按照Entry插入LinkedHashMap的先后顺序来迭代元素，      //同时，新put进来的Entry是最近访问的Entry，把其放在链表末尾 ，符合LRU算法的实现         e.addBefore(header);         size++;     }  
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28

同样是将新的Entry插入到table中对应槽所对应单链表的头结点中，但可以看出，在createEntry中，同样把新put进来的Entry插入到了双向链表的尾部，从插入顺序的层面来说，新的Entry插入到双向链表的尾部，可以实现按照插入的先后顺序来迭代Entry，而从访问顺序的层面来说，新put进来的Entry又是最近访问的Entry，也应该将其放在双向链表的尾部。 
LinkedHashMap覆写了HashMap的get方法：

   public V get(Object key) {         Entry<K,V> e = (Entry<K,V>)getEntry(key);         if (e == null)             return null;         e.recordAccess(this);         return e.value;     }  
1
2
3
4
5
6
7

先取得Entry，如果不为null，一样调用recordAccess方法，上面已经说得很清楚，这里不在多解释了。 
我们还注意源码中的accessOrder标志位：

    private final boolean accessOrder;  
1

当它false时，表示双向链表中的元素按照Entry插入LinkedHashMap到中的先后顺序排序，即每次put到LinkedHashMap中的Entry都放在双向链表的尾部，这样遍历双向链表时，Entry的输出顺序便和插入的顺序一致，这也是默认的双向链表的存储顺序。 
当它为true时，表示双向链表中的元素按照访问的先后顺序排列，可以看到，虽然Entry插入链表的顺序依然是按照其put到LinkedHashMap中的顺序，但put和get方法均有调用recordAccess方法（put方法在key相同，覆盖原有的Entry的情况下调用recordAccess方法），该方法判断accessOrder是否为true，如果是，则将当前访问的Entry（put进来的Entry或get出来的Entry）移到双向链表的尾部（key不相同时，put新Entry时，会调用addEntry，它会调用createEntry，该方法同样将新插入的元素放入到双向链表的尾部，既符合插入的先后顺序，又符合访问的先后顺序，因为这时该Entry也被访问了），否则，什么也不做。

最后总结一下LinkedHashMap是如何实现LRU的。首先，当accessOrder为true时，才会开启按访问顺序排序的模式，才能用来实现LRU算法。我们可以看到，无论是put方法还是get方法，都会导致目标Entry成为最近访问的Entry，因此便把该Entry加入到了双向链表的末尾（get方法通过调用recordAccess方法来实现，put方法在覆盖已有key的情况下，也是通过调用recordAccess方法来实现，在插入新的Entry时，则是通过createEntry中的addBefore方法来实现），这样便把最近使用了的Entry放入到了双向链表的后面，多次操作后，双向链表前面的Entry便是最近没有使用的，这样当节点个数满的时候，删除的最前面的Entry(head后面的那个Entry)便是最近最少使用的Entry。