LinkedHashMap 源码详细分析（JDK1.8）
1. 概述
LinkedHashMap 继承自 HashMap，在 HashMap 基础上，经过维护一条双向链表，解决了 HashMap 不能随时保持遍历顺序和插入顺序一致的问题。除此以外，LinkedHashMap 对访问顺序也提供了相关支持。在一些场景下，该特性颇有用，好比缓存。在实现上，LinkedHashMap 不少方法直接继承自 HashMap，仅为维护双向链表覆写了部分方法。因此，要看懂 LinkedHashMap 的源码，须要先看懂 HashMap 的源码。关于 HashMap 的源码分析，本文并不打算展开讲了。你们能够参考我以前的一篇文章“HashMap 源码详细分析(JDK1.8)”。在那篇文章中，我配了十多张图帮助你们学习 HashMap 源码。java
本篇文章的结构与我以前两篇关于 Java 集合类（集合框架）的源码分析文章不一样，本文将再也不分析集合类的基本操做（查找、遍历、插入、删除），而是把重点放在双向链表的维护上。包括链表的创建过程，删除节点的过程，以及访问顺序维护的过程等。好了，接下里开始分析吧。node
2. 原理
上一章说了 LinkedHashMap 继承自 HashMap，因此它的底层仍然是基于拉链式散列结构。该结构由数组和链表或红黑树组成，结构示意图大体以下：数组
LinkedHashMap 在上面结构的基础上，增长了一条双向链表，使得上面的结构能够保持键值对的插入顺序。同时经过对链表进行相应的操做，实现了访问顺序相关逻辑。其结构可能以下图：缓存
上图中，淡蓝色的箭头表示前驱引用，红色箭头表示后继引用。每当有新键值对节点插入，新节点最终会接在 tail 引用指向的节点后面。而 tail 引用则会移动到新的节点上，这样一个双向链表就创建起来了。数据结构
上面的结构并非很难理解，虽然引入了红黑树，致使结构看起来略为复杂了一些。但你们彻底能够忽略红黑树，而只关注链表结构自己。好了，接下来进入细节分析吧。app
3. 源码分析
3.1 Entry 的继承体系
在对核心内容展开分析以前，这里先插队分析一下键值对节点的继承体系。先来看看继承体系结构图：框架
上面的继承体系乍一看仍是有点复杂的，同时也有点让人迷惑。HashMap 的内部类 TreeNode 不继承它的了一个内部类 Node，却继承自 Node 的子类 LinkedHashMap 内部类 Entry。这里这样作是有必定缘由的，这里先不说。先来简单说明一下上面的继承体系。LinkedHashMap 内部类 Entry 继承自 HashMap 内部类 Node，并新增了两个引用，分别是 before 和 after。这两个引用的用途不难理解，也就是用于维护双向链表。同时，TreeNode 继承 LinkedHashMap 的内部类 Entry 后，就具有了和其余 Entry 一块儿组成链表的能力。可是这里须要你们考虑一个问题。当咱们使用 HashMap 时，TreeNode 并不须要具有组成链表能力。若是继承 LinkedHashMap 内部类 Entry ，TreeNode 就多了两个用不到的引用，这样作不是会浪费空间吗？简单说明一下这个问题（水平有限，不保证彻底正确），这里这么作确实会浪费空间，但与 TreeNode 经过继承获取的组成链表的能力相比，这点浪费是值得的。在 HashMap 的设计思路注释中，有这样一段话：ide
Because TreeNodes are about twice the size of regular nodes, we
use them only when bins contain enough nodes to warrant use
(see TREEIFY_THRESHOLD). And when they become too small (due to
removal or resizing) they are converted back to plain bins. In
usages with well-distributed user hashCodes, tree bins are
rarely used.
大体的意思是 TreeNode 对象的大小约是普通 Node 对象的2倍，咱们仅在桶（bin）中包含足够多的节点时再使用。当桶中的节点数量变少时（取决于删除和扩容），TreeNode 会被转成 Node。当用户实现的 hashCode 方法具备良好分布性时，树类型的桶将会不多被使用。源码分析
经过上面的注释，咱们能够了解到。通常状况下，只要 hashCode 的实现不糟糕，Node 组成的链表不多会被转成由 TreeNode 组成的红黑树。也就是说 TreeNode 使用的并很少，浪费那点空间是可接受的。假如 TreeNode 机制继承自 Node 类，那么它要想具有组成链表的能力，就须要 Node 去继承 LinkedHashMap 的内部类 Entry。这个时候就得不偿失了，浪费不少空间去获取不必定用获得的能力。post
说到这里，你们应该能明白节点类型的继承体系了。这里单独拿出来讲一下，为下面的分析作铺垫。叙述略为啰嗦，见谅。
3.1 链表的创建过程
链表的创建过程是在插入键值对节点时开始的，初始状况下，让 LinkedHashMap 的 head 和 tail 引用同时指向新节点，链表就算创建起来了。随后不断有新节点插入，经过将新节点接在 tail 引用指向节点的后面，便可实现链表的更新。
Map 类型的集合类是经过 put(K,V) 方法插入键值对，LinkedHashMap 自己并无覆写父类的 put 方法，而是直接使用了父类的实现。但在 HashMap 中，put 方法插入的是 HashMap 内部类 Node 类型的节点，该类型的节点并不具有与 LinkedHashMap 内部类 Entry 及其子类型节点组成链表的能力。那么，LinkedHashMap 是怎样创建链表的呢？在展开说明以前，咱们先看一下 LinkedHashMap 插入操做相关的代码：
// HashMap 中实现
public V put(K key, V value) {
return putVal(hash(key), key, value, false, true);
}
// HashMap 中实现
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) {...}
// 经过节点 hash 定位节点所在的桶位置，并检测桶中是否包含节点引用
if ((p = tab[i = (n - 1) & hash]) == 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) {...}
else {
// 遍历链表，并统计链表长度
for (int binCount = 0; ; ++binCount) {
// 未在单链表中找到要插入的节点，将新节点接在单链表的后面
if ((e = p.next) == null) {
p.next = newNode(hash, key, value, null);
if (binCount >= TREEIFY_THRESHOLD - 1) {...}
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) {...}
afterNodeAccess(e); // 回调方法，后续说明
return oldValue;
}
}
++modCount;
if (++size > threshold) {...}
afterNodeInsertion(evict); // 回调方法，后续说明
return null;
}
// HashMap 中实现
Node<K,V> newNode(int hash, K key, V value, Node<K,V> next) {
return new Node<>(hash, key, value, next);
}
// LinkedHashMap 中覆写
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);
// 将 Entry 接在双向链表的尾部
linkNodeLast(p);
return p;
}
// LinkedHashMap 中实现
private void linkNodeLast(LinkedHashMap.Entry<K,V> p) {
LinkedHashMap.Entry<K,V> last = tail;
tail = p;
// last 为 null，代表链表还未创建
if (last == null)
head = p;
else {
// 将新节点 p 接在链表尾部
p.before = last;
last.after = p;
}
}
上面就是 LinkedHashMap 插入相关的源码，这里省略了部分非关键的代码。我根据上面的代码，能够知道 LinkedHashMap 插入操做的调用过程。以下：
我把 newNode 方法红色背景标注了出来，这一步比较关键。LinkedHashMap 覆写了该方法。在这个方法中，LinkedHashMap 建立了 Entry，并经过 linkNodeLast 方法将 Entry 接在双向链表的尾部，实现了双向链表的创建。双向链表创建以后，咱们就能够按照插入顺序去遍历 LinkedHashMap，你们能够本身写点测试代码验证一下插入顺序。
以上就是 LinkedHashMap 维护插入顺序的相关分析。本节的最后，再额外补充一些东西。你们若是仔细看上面的代码的话，会发现有两个以after开头方法，在上文中没有被说起。在 JDK 1.8 HashMap 的源码中，相关的方法有3个：
// Callbacks to allow LinkedHashMap post-actions
void afterNodeAccess(Node<K,V> p) { }
void afterNodeInsertion(boolean evict) { }
void afterNodeRemoval(Node<K,V> p) { }
根据这三个方法的注释能够看出，这些方法的用途是在增删查等操做后，经过回调的方式，让 LinkedHashMap 有机会作一些后置操做。上述三个方法的具体实如今 LinkedHashMap 中，本节先不分析这些实现，相关分析会在后续章节中进行。
3.2 链表节点的删除过程
与插入操做同样，LinkedHashMap 删除操做相关的代码也是直接用父类的实现。在删除节点时，父类的删除逻辑并不会修复 LinkedHashMap 所维护的双向链表，这不是它的职责。那么删除及节点后，被删除的节点该如何从双链表中移除呢？固然，办法还算是有的。上一节最后提到 HashMap 中三个回调方法运行 LinkedHashMap 对一些操做作出响应。因此，在删除及节点后，回调方法 afterNodeRemoval 会被调用。LinkedHashMap 覆写该方法，并在该方法中完成了移除被删除节点的操做。相关源码以下：
// HashMap 中实现
public V remove(Object key) {
Node<K,V> e;
return (e = removeNode(hash(key), key, null, false, true)) == null ?
null : e.value;
}
// HashMap 中实现
final Node<K,V> removeNode(int hash, Object key, Object value,
boolean matchValue, boolean movable) {
Node<K,V>[] tab; Node<K,V> p; int n, index;
if ((tab = table) != null && (n = tab.length) > 0 &&
(p = tab[index = (n - 1) & hash]) != null) {
Node<K,V> node = null, e; K k; V v;
if (p.hash == hash &&
((k = p.key) == key || (key != null && key.equals(k))))
node = p;
else if ((e = p.next) != null) {
if (p instanceof TreeNode) {...}
else {
// 遍历单链表，寻找要删除的节点，并赋值给 node 变量
do {
if (e.hash == hash &&
((k = e.key) == key ||
(key != null && key.equals(k)))) {
node = e;
break;
}
p = e;
} while ((e = e.next) != null);
}
}
if (node != null && (!matchValue || (v = node.value) == value ||
(value != null && value.equals(v)))) {
if (node instanceof TreeNode) {...}
// 将要删除的节点从单链表中移除
else if (node == p)
tab[index] = node.next;
else
p.next = node.next;
++modCount;
--size;
afterNodeRemoval(node); // 调用删除回调方法进行后续操做
return node;
}
}
return null;
}
// 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 节点的前驱后后继引用置空
p.before = p.after = null;
// b 为 null，代表 p 是头节点
if (b == null)
head = a;
else
b.after = a;
// a 为 null，代表 p 是尾节点
if (a == null)
tail = b;
else
a.before = b;
}
删除的过程并不复杂，上面这么多代码其实就作了三件事：
- 根据 hash 定位到桶位置
- 遍历链表或调用红黑树相关的删除方法
- 从 LinkedHashMap 维护的双链表中移除要删除的节点
举个例子说明一下，假如咱们要删除下图键值为 3 的节点。
根据 hash 定位到该节点属于3号桶，而后在对3号桶保存的单链表进行遍历。找到要删除的节点后，先从单链表中移除该节点。以下：
而后再双向链表中移除该节点：
删除及相关修复过程并不复杂，结合上面的图片，你们应该很容易就能理解，这里就很少说了。
3.3 访问顺序的维护过程
前面说了插入顺序的实现，本节来说讲访问顺序。默认状况下，LinkedHashMap 是按插入顺序维护链表。不过咱们能够在初始化 LinkedHashMap，指定 accessOrder 参数为 true，便可让它按访问顺序维护链表。访问顺序的原理上并不复杂，当咱们调用get/getOrDefault/replace等方法时，只须要将这些方法访问的节点移动到链表的尾部便可。相应的源码以下：
// LinkedHashMap 中覆写
public V get(Object key) {
Node<K,V> e;
if ((e = getNode(hash(key), key)) == null)
return null;
// 若是 accessOrder 为 true，则调用 afterNodeAccess 将被访问节点移动到链表最后
if (accessOrder)
afterNodeAccess(e);
return e.value;
}
// LinkedHashMap 中覆写
void afterNodeAccess(Node<K,V> e) { // move node to last
LinkedHashMap.Entry<K,V> last;
if (accessOrder && (last = tail) != e) {
LinkedHashMap.Entry<K,V> p =
(LinkedHashMap.Entry<K,V>)e, b = p.before, a = p.after;
p.after = null;
// 若是 b 为 null，代表 p 为头节点
if (b == null)
head = a;
else
b.after = a;
if (a != null)
a.before = b;
/*
* 这里存疑，父条件分支已经确保节点 e 不会是尾节点，
* 那么 e.after 必然不会为 null，不知道 else 分支有什么做用
*/
else
last = b;
if (last == null)
head = p;
else {
// 将 p 接在链表的最后
p.before = last;
last.after = p;
}
tail = p;
++modCount;
}
}
上面就是访问顺序的实现代码，并不复杂。下面举例演示一下，帮助你们理解。假设咱们访问下图键值为3的节点，访问前结构为：
访问后，键值为3的节点将会被移动到双向链表的最后位置，其前驱和后继也会跟着更新。访问后的结构以下：
3.4 基于 LinkedHashMap 实现缓存
前面介绍了 LinkedHashMap 是如何维护插入和访问顺序的，你们对 LinkedHashMap 的原理应该有了必定的认识。本节咱们来写一些代码实践一下，这里经过继承 LinkedHashMap 实现了一个简单的 LRU 策略的缓存。在写代码以前，先介绍一下前置知识。
在3.1节分析链表创建过程时，我故意忽略了部分源码分析。本节就把忽略的部分补上，先看源码吧：
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 实现缓存时，经过覆写removeEldestEntry方法能够实现自定义策略的 LRU 缓存。好比咱们能够根据节点数量判断是否移除最近最少被访问的节点，或者根据节点的存活时间判断是否移除该节点等。本节所实现的缓存是基于判断节点数量是否超限的策略。在构造缓存对象时，传入最大节点数。当插入的节点数超过最大节点数时，移除最近最少被访问的节点。实现代码以下：
public class SimpleCache<K, V> extends LinkedHashMap<K, V> {
private static final int MAX_NODE_NUM = 100;
private int limit;
public SimpleCache() {
this(MAX_NODE_NUM);
}
public SimpleCache(int limit) {
super(limit, 0.75f, true);
this.limit = limit;
}
public V save(K key, V val) {
return put(key, val);
}
public V getOne(K key) {
return get(key);
}
public boolean exists(K key) {
return containsKey(key);
}
/**
* 判断节点数是否超限
* @param eldest
* @return 超限返回 true，不然返回 false
*/
@Override
protected boolean removeEldestEntry(Map.Entry<K, V> eldest) {
return size() > limit;
}
}
测试代码以下：
public class SimpleCacheTest {
@Test
public void test() throws Exception {
SimpleCache<Integer, Integer> cache = new SimpleCache<>(3);
for (int i = 0; i < 10; i++) {
cache.save(i, i * i);
}
System.out.println("插入10个键值对后，缓存内容：");
System.out.println(cache + "\n");
System.out.println("访问键值为7的节点后，缓存内容：");
cache.getOne(7);
System.out.println(cache + "\n");
System.out.println("插入键值为1的键值对后，缓存内容：");
cache.save(1, 1);
System.out.println(cache);
}
}
测试结果以下：
在测试代码中，设定缓存大小为3。在向缓存中插入10个键值对后，只有最后3个被保存下来了，其余的都被移除了。而后经过访问键值为7的节点，使得该节点被移到双向链表的最后位置。当咱们再次插入一个键值对时，键值为7的节点就不会被移除。
本节做为对前面内的补充，简单介绍了 LinkedHashMap 在其余方面的应用。本节内容及相关代码并不难理解，这里就不在赘述了。
4. 总结
本文从 LinkedHashMap 维护双向链表的角度对 LinkedHashMap 的源码进行了分析，并在文章的结尾基于 LinkedHashMap 实现了一个简单的 Cache。在平常开发中，LinkedHashMap 的使用频率虽不及 HashMap，但它也个重要的实现。在 Java 集合框架中，HashMap、LinkedHashMap 和 TreeMap 三个映射类基于不一样的数据结构，并实现了不一样的功能。HashMap 底层基于拉链式的散列结构，并在 JDK 1.8 中引入红黑树优化过长链表的问题。基于这样结构，HashMap 可提供高效的增删改查操做。LinkedHashMap 在其之上，经过维护一条双向链表，实现了散列数据结构的有序遍历。TreeMap 底层基于红黑树实现，利用红黑树的性质，实现了键值对排序功能。我在前面几篇文章中，对 HashMap 和 TreeMap 以及他们均使用到的红黑树进行了详细的分析，有兴趣的朋友能够去看看。
到此，本篇文章就写完了，感谢你们的阅读！
附录：映射类文章列表
本文在知识共享许可协议 4.0 下发布，转载请注明出处
做者：coolblog
本文同步发布在个人我的博客： http://www.coolblog.xyz
本做品采用知识共享署名-非商业性使用-禁止演绎 4.0 国际许可协议进行许可。
- 1. LinkedHashMap 源码详细分析（JDK1.8）
- 2. HashMap 源码详细分析(JDK1.8)
- 3. HashMap源码解析JDK1.8(史上最详细的源码分析)
- 4. LinkedHashMap 源码分析
- 5. [源码分析]LinkedHashMap
- 6. LinkedHashMap源码分析
- 7. 源码分析——LinkedHashMap
- 8. [JDK1.8] JAVA集合 LinkedHashMap源码浅析
- 9. Java JDK1.8（五） - LinkedHashMap源码解析
- 10. LinkedHashMap源码解读(JDK1.8)
- 更多相关文章...
- • Spring整合Redis详细步骤 - Redis教程
- • Docker 资源汇总 - Docker教程
- • 互联网组织的未来：剖析GitHub员工的任性之源
- • Java Agent入门实战（二）-Instrumentation源码概述
-
每一个你不满意的现在，都有一个你没有努力的曾经。