深入学习Java集合之LinkedHashMap的实现原理
【1】LinkedHashMap定义
LinkedHashMap是HashMap的子类，其实现与HashMap 的不同之处在于，LinkedHashMap维护着一个运行于所有条目的双重链接列表。此链接列表定义了迭代顺序，该迭代顺序可以是插入顺序或者是访问顺序。
注意，此实现不是同步的。如果多个线程同时访问链接的哈希映射，而其中至少一个线程从结构上修改了该映射，则它必须保持外部同步。
对于LinkedHashMap 而言，它继承与HashMap、底层使用哈希表与双向链表来保存所有元素。其基本操作与父类HashMap 相似，它通过重写父类相关的方法，来实现自己的链接列表特性。下面我们来分析LinkedHashMap 的源代码。
【2】LinkedHashMap 源码分析
如下代码如未显示说明，则是基于JDK1.8。
① Entry 元素
LinkedHashMap 采用的hash 算法和HashMap 相同，但是它重新定义了数组中保存的元素Entry，该Entry 除了保存当前对象的引用外，还保存了其上一个元素before 和下一个元素after 的引用，从而在哈希表的基础上又构成了双向链接列表。
看源代码：
//双向链表的表头(eldest)元素。
transient LinkedHashMap.Entry<K,V> head;
//双向链表的表尾(youngest)元素。
transient LinkedHashMap.Entry<K,V> tail;
/**
* The iteration ordering method for this linked hash map: <tt>true</tt>
* for access-order, <tt>false</tt> for insertion-order.
*/
final boolean accessOrder;
//LinkedHashMap 的Entry 元素。
//继承HashMap 的Node元素，又保存了其上一个元素before 和下一个元素after 的引用。
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);
}
}
② 初始化
通过源代码可以看出，在LinkedHashMap 的构造方法中，实际调用了父类HashMap的相关构造方法来构造一个底层存放的table 数组。
如下所示：
//空参构造方法，调用父类的空参构造方法
public LinkedHashMap() {
super();
accessOrder = false;
}
//指定初始容量的构造方法，同样调用父类对应构造方法
public LinkedHashMap(int initialCapacity) {
super(initialCapacity);
accessOrder = false;
}
//指定初始容量和负载因子
public LinkedHashMap(int initialCapacity, float loadFactor) {
super(initialCapacity, loadFactor);
accessOrder = false;
}
//使用指定map创建一个LinkedHashMap，调用父类的无参构造方法和putMapEntries方法
public LinkedHashMap(Map<? extends K, ? extends V> m) {
super();
accessOrder = false;
putMapEntries(m, false);
//第二个参数为false，表示创建模式
}
//指定容量和负载因子及accessOrder
public LinkedHashMap(int initialCapacity,
float loadFactor,
boolean accessOrder) {
super(initialCapacity, loadFactor);
this.accessOrder = accessOrder;
}
③ jdk1.8下get(Object key)
public V get(Object key) {
Node<K,V> e;
//调用父类的该方法获取节点e，如果为null则返回null
if ((e = getNode(hash(key), key)) == null)
return null;
if (accessOrder)
afterNodeAccess(e);
return e.value;
}
getNode(hash(key),key)是调用父类HashMap的方法：
final Node<K,V> getNode(int hash, Object key) {
Node<K,V>[] tab; Node<K,V> first, e; int n; K k;
if ((tab = table) != null && (n = tab.length) > 0 &&
(first = tab[(n - 1) & hash]) != null) {
if (first.hash == hash && // always check first node
((k = first.key) == key || (key != null && key.equals(k))))
return first;
if ((e = first.next) != null) {
if (first instanceof TreeNode)
return ((TreeNode<K,V>)first).getTreeNode(hash, key);
do {
if (e.hash == hash &&
((k = e.key) == key || (key != null && key.equals(k))))
return e;
} while ((e = e.next) != null);
}
}
return null;
}
在父类中如下三个回调函数是提供给LinkedHashMap 使用的，HashMap未提供具体实现：
// Callbacks to allow LinkedHashMap post-actions
void afterNodeAccess(Node<K,V> p) { }
void afterNodeInsertion(boolean evict) { }
void afterNodeRemoval(Node<K,V> p) { }
在LinkedHashMap中，实现了父类的这三个方法。
④ jdk1.7下get方法分析
jdk1.7下LinkedHashMap 重写了父类HashMap 的get 方法，实际在调用父类getEntry()方法取得查找的元素后，再判断当排序模式accessOrder 为true 时，记录访问顺序，将最新访问的元素添加到双向链表的表头，并从原来的位置删除。由于链表的增加、删除操作是常量级的，故并不会带来性能的损失。
public V get(Object key) {
// 调用父类HashMap 的getEntry()方法，取得要查找的元素。
Entry<K,V> e = (Entry<K,V>)getEntry(key);
if (e == null)
return null;
// 记录访问顺序。
e.recordAccess(this);
return e.value;
}
void recordAccess(HashMap<K,V> m) {
LinkedHashMap<K,V> lm = (LinkedHashMap<K,V>)m;
// 如果定义了LinkedHashMap 的迭代顺序为访问顺序，
// 则删除以前位置上的元素，并将最新访问的元素添加到链表表头。
if (lm.accessOrder) {
lm.modCount++;
remove();
addBefore(lm.header);
}
}
⑤ 排序模式accessOrder和LRU
LinkedHashMap 定义了排序模式accessOrder，该属性为boolean 型变量，对于访问顺序，为true；对于插入顺序，则为false。
一般情况下，不必指定排序模式，其迭代顺序即默认为插入顺序。看LinkedHashMap的构造方法，这些构造方法都会默认指定排序模式为插入顺序。除了其中一个有accessOrder参数外，其他均默认为false。
如果你想构造一个LinkedHashMap，并打算按从近期访问最少到近期访问最多的顺序（即访问顺序）来保存元素，那么请使用下面的构造方法构造LinkedHashMap：
public LinkedHashMap(int initialCapacity,
float loadFactor,
boolean accessOrder) {
super(initialCapacity, loadFactor);
this.accessOrder = accessOrder;
}
该哈希映射的迭代顺序就是最后访问其条目的顺序，这种映射很适合构建LRU 缓存。
LinkedHashMap 提供了removeEldestEntry(Map.Entry<K,V> eldest)方法，在将新条目插入到映射后，put 和 putAll 将调用此方法。该方法可以提供在每次添加新条目时移除最旧条目的实现程序，默认返回false，这样，此映射的行为将类似于正常映射，即永远不能移除最旧的元素。
protected boolean removeEldestEntry(Map.Entry<K,V> eldest) {
return false;
}
此方法通常不以任何方式修改映射，相反允许映射在其返回值的指引下进行自我修改。如果用此映射构建LRU 缓存，则非常方便，它允许映射通过删除旧条目来减少内存损耗。
例如：重写此方法，维持此映射只保存100 个条目的稳定状态，在每次添加新条目时删除最旧的条目。
private static final int MAX_ENTRIES = 100;
protected boolean removeEldestEntry(Map.Entry eldest) {
return size() > MAX_ENTRIES;
}
【3】LinkedHashMap实现的三个回调函数
在LinkedHashMap调用父类的put和removeNode相关方法中，实现了三个回调函数来进行链表的维护。
父类HashMap的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;
}
removeNode相关方法如下：
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)
node = ((TreeNode<K,V>)p).getTreeNode(hash, key);
else {
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)
((TreeNode<K,V>)node).removeTreeNode(this, tab, movable);
else if (node == p)
tab[index] = node.next;
else
p.next = node.next;
++modCount;
--size;
//第三处
afterNodeRemoval(node);
return node;
}
}
return null;
}
① afterNodeAccess
如果定义了accessOrder 为true，则每次访问之后都会将该元素放到链表中youngest位置处。
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;
if (b == null)
head = a;
else
b.after = a;
if (a != null)
a.before = b;
else
last = b;
if (last == null)
head = p;
else {
p.before = last;
last.after = p;
}
tail = p;
++modCount;
}
}
② afterNodeInsertion(boolean evict)
如果需要移除eldest结点，如LRU实现中，就根据evict和removeEldestEntry将head移除：
void afterNodeInsertion(boolean evict) { // possibly remove eldest
LinkedHashMap.Entry<K,V> first;
if (evict && (first = head) != null && removeEldestEntry(first)) {
K key = first.key;
//调用父类HashMap的移除方法
removeNode(hash(key), key, null, false, true);
}
}
③ afterNodeRemoval(Node<K,V> e)
如果该结点被移除，就从链表中断开。
//e为已经被移除的结点
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;
}