LinkedHashMap 详解及源码简析
一、前言
在 HashMap详解以及源码分析 这篇文章中，对 HashMap 的实现原理进行了比较深入的分析。而在 HashMap 大家族中，另一个重要的且常常被拿来比较的类 LinkedHashMap 也非常的重要。相比较 HashMap，其最大的特点是其默认按插入顺序进行排序。
在阅读这篇文章之前，建义先过一遍 HashMap详解以及源码分析。正如 LinkedHashMap 是继承自 HashMap 一样，这篇文章也是基于 HashMap 进行分析。
二、代码分析
1. demo 及其简析
LinkedHashMap<String,String> linkedHashMap = new LinkedHashMap<>();
linkedHashMap.put(null,"北京");
linkedHashMap.put("beijing","北京");
linkedHashMap.put("shanghai","上海");
linkedHashMap.put("tianjin","天津");
linkedHashMap.put("hangzhou","杭州");
linkedHashMap.put("changsha","长沙");
linkedHashMap.put("wuhan","武汉");
linkedHashMap.put("guangzhou","广州");
linkedHashMap.put("shenzhen","深圳");
Set<LinkedHashMap.Entry<String,String>> sets = linkedHashMap.entrySet();
for (LinkedHashMap.Entry<String,String> set : sets) {
Log.d(TAG, "linkedHashMapSample: key = " + set.getKey() + ";value = " + set.getValue());
}
demo 运行结果
linkedHashMapSample: key = null;value = 北京
linkedHashMapSample: key = beijing;value = 北京
linkedHashMapSample: key = shanghai;value = 上海
linkedHashMapSample: key = tianjin;value = 天津
linkedHashMapSample: key = hangzhou;value = 杭州
linkedHashMapSample: key = changsha;value = 长沙
linkedHashMapSample: key = wuhan;value = 武汉
linkedHashMapSample: key = guangzhou;value = 广州
linkedHashMapSample: key = shenzhen;value = 深圳
从运行结果可以看出，LinkedHashMap 输出的结果的顺序与其 put 时的顺序时一致的。
2.源码分析
LinkedHashMap 的类图结果在分析 HashMap 的时候已经有了解过，这里再复习一下Map大家族。
Map大家族简版.jpg
- LinkedHashMap 的初始化
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;
}
LinkedHashMap 根据参数的不同重载了 5 个不同的构造方法，但其作用基本相同，只是赋值一些默认值而已，如初始容量，负载因子以及是否按访问排序，其默认是按插入排序的。
-
LinkedHashMap 插入元素 put() 方法
LinkedHashMap 本身并没有实现，是共用父类 HashMap 的，也就是这个 put 方法是来自于 HashMap 的。在分析 HashMap 的时候已经了解，put() 又是进一步调用了 putVal() 方法，下面简单来过一下 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;
afterNodeAccess(e);
return oldValue;
}
}
++modCount;
if (++size > threshold)
resize();
afterNodeInsertion(evict);
return null;
}
putVal() 里面作的事情比较多，这里也再来复习一下。
(1)通过对 hash(key) 计算出来的 hash 值，计算出散列 index。
(2)如果没碰撞冲突直接放到 table 里。
(3)如果碰撞冲突了，先以链表的形式解决冲突，并把新的 node 插入到链尾。
(4)如果碰撞冲突导致链表过长(>= TREEIFY_THRESHOLD)，就把链表转换成红黑树，提高查询效率。
(5)如果节点已经存在，即key的 hash() 值相等且 key 的内容相等，就替换 old value，从而保证 key 的唯一性。
(6)如果 table 满了( > load factor*capacity)，就要扩容resize()。
这里 LinkedHashMap 差异的地方在于创建新的 Node，也就是 Entry，而 LinkedHashMap 的 Entry 也是不一样的，其有自己定义的 LinkedHashMapEntry。
static class LinkedHashMapEntry<K,V> extends HashMap.Node<K,V> {
LinkedHashMapEntry<K,V> before, after;
LinkedHashMapEntry(int hash, K key, V value, Node<K,V> next) {
super(hash, key, value, next);
}
}
LinkedHashMapEntry 继承自 HashMap.Node，在经基本上其增加了 before 以及 after 两个指针，以此便可以构造出一个双向链表。再来看看它的 newNode() 实现便可以知道它是如何构建双向链表的了。
Node<K,V> newNode(int hash, K key, V value, Node<K,V> e) {
LinkedHashMapEntry<K,V> p =
new LinkedHashMapEntry<K,V>(hash, key, value, e);
linkNodeLast(p);
return p;
}
这里有个关键的调用 linkNodeLast() 方法。
private void linkNodeLast(LinkedHashMapEntry<K,V> p) {
LinkedHashMapEntry<K,V> last = tail;
tail = p;
if (last == null)
head = p;
else {
p.before = last;
last.after = p;
}
}
先取出 tial 指针，再令当前节点为 tial 指针，然后当前指针指向 tial 指针，tail 指针又指向当前指针。意思就是当前的 tail 指针与当前指针 p 建立起前后指向关系，然后令当前的 p 指针为 tail 指针，从而便构造出了双向链表。
-
LinkedHashMap 获取元素 get() 方法与remove() 方法
LinkedHashMap 的 get() 方法与 remove() 方法基本与 HashMap 是一致的，只是在 remove() 时注意还要从 LinkedHashMapEntry 所构成的双向链表中将其也一并移除。 -
LinkedHashMap 的遍历
在分析 HashMap 的时候我们知道，遍历最主要的实现在集合自己所实现的 Iterator 中，而 Iterator 中最关键的又在 nextNode() 方法中。
final LinkedHashMapEntry<K,V> nextNode() {
LinkedHashMapEntry<K,V> e = next;
if (modCount != expectedModCount)
throw new ConcurrentModificationException();
if (e == null)
throw new NoSuchElementException();
current = e;
next = e.after;
return e;
}
从代码里可以看出，这就是对一个链接进行遍历的基本操作了，这里根本就不需要考虑到 key 以及 value 本身是如何存储的，而只是通过链表进行基本的遍历就可以了。
三、总结
在了解了 HashMap 的原理后，再来看 LinkedHashMap 的话是非常简单的。LinkedHashMap 是继承自 HashMap 的，所以 LinkedHashMap 包含了 HashMap 所有的功能以及特性。而在此基础上，LinkedHashMap 又将每个 LinkedHashMapEntry 链接成了一个双向链表。而我们之所以能得到一个有序的结果输出，其原因就在于其 Iterator 的实现。我们对 LinkedHashMap 的遍历就是对 LinkedHashMapEntry 所构成的链表进行遍历。默认情况下，链表就是按照插入顺序进行构造的，新插入的结点都会被放到 tial，这也就是自然保证了插入时的顺序了。
最后，感谢你能读到并读完此文章，如果分析的过程中存在错误或者疑问都欢迎留言讨论。如果我的分享能够帮助到你，还请记得帮忙点个赞吧，谢谢。
