1. LinkedHashMap
LinkedHashMap 是 HashMap 的子类，但内部还有一个双向链表维护键值对的顺序，每个键值对既位于哈希表中，也位于这个双向链表中。LinkedHashMap 支持两种顺序：一种是插入顺序，另一种是访问顺序。
插入顺序：先插入的在前面，后插入的在后面，修改操作不影响顺序。
访问顺序：所谓访问是指 get/put 操作，对一个键执行 put/get 操作后，其对应的键值对会移动到链表表尾，所以，最末尾的是最近访问的，最开始的是最久没被访问的，这种顺序就是访问顺序。
LRU缓存就是访问有序的一种经典的应用。LRU 是一种流行的替换算法，它的全称是 Least Recently Used，即最近最少使用。它的思路是：最近刚被使用的很快再次被用的可能性最高，而最久没被访问的很快再次被用的可能性最低，所以被优先清理。使用 LinkedHashMap，可以非常容易的实现 LRU 缓存。默认情况下，LinkedHashMap 没有对容量做限制，但是它可以很容易的做到，它有一个 protected 方法，如下所示：
protected boolean removeEldestEntry(Map.Entry<K,V> eldest) {
return false;
}
在添加元素到 LinkedHashMap 后，LinkedHashMap 会调用这个方法，传递的参数是最久没被访问的键值对，如果这个方法返回 true，则这个最久的键值对就会被删除。LinkedHashMap 的实现总是返回false，所有容量没有限制，但是子类可以重写该方法，在满足一定条件的情况下，返回 true。以下代码为一个简单的 LRU 缓存的实现，它有一个容量限制，这个限制在构造方法中传递。
class LRUCache<K, V> extends LinkedHashMap<K, V> {
public LRUCache(int maxEntries) {
super(16, 0.75f, true);
this.maxEntries = maxEntries;
}
@Override
protected boolean removeEldestEntry(Map.Entry eldest) {
return size() > maxEntries;
}
}
这个缓存可以这样用：
LRUCache<Integer, String> cache = new LRUCache<>(3);
cache.put(1, "a");
cache.put(2, "b");
cache.put(3, "c");
cache.get(1);
cache.put(4, "d");
System.out.println(cache.keySet());
输出结果为：
[3, 1, 4]
2. 实现原理
2.1 内部组成
LinkedHashMap 是 HashMap 的子类，内部增加了如下实例变量：
//指向双向链表的头部
transient LinkedHashMap.Entry<K,V> head;
//指向双向链表的尾部
transient LinkedHashMap.Entry<K,V> tail;
//遍历元素的顺序，如果是true按照访问顺序，如果是false则按照插入顺序
final boolean accessOrder;
head 和 tail 的类型 Entry 是一个内部类，这个类是 HashMap.Node 的子类，增加了两个变量 before 和 after，指向链表中的前驱和后继，Entry 的完整定义如下：
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);
}
}
Entry 是 HashMap.Node 的子类，LinkedHashMap 中添加了 before, after 这两个属性，维持双向链表。另外必须明确的是，LinkedHashMap中的双向链表关系，HashMap单个哈希桶内的单向链表或者红黑树关系，这三者都是彼此独立的，只是通过类属性的引用关系将不同实例串联起来而已。
2.2 构造方法
//默认情况下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;
}
2.3 添加元素
LinkedHashMap的 put() 方法是调用的HashMap的 put() 方法，因为添加元素的基本逻辑是一样的，但也有不同，不同在于LinkedHashMap实现了 afterNodeAccess，afterNodeInsertion 方法
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;//初始化数组容量
if ((p = tab[i = (n - 1) & hash]) == null)//定位到位置的值为空，新建一个节点
tab[i] = newNode(hash, key, value, null);
else {//如果不为空
Node<K,V> e; K k;
//判断table[i]的首个元素是否和key一样，如果相同直接覆盖value
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 {//p不属于红黑树，遍历节点，统计个数，如果插入元素后节点的个数达到8，则将链表转换成红黑树
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) { // 该键已存在，此时需要更新该键的值，将更新的节点移动到链尾
V oldValue = e.value;
if (!onlyIfAbsent || oldValue == null)
e.value = value;
afterNodeAccess(e);//通过afterNodeAccess方法维护访问顺序
return oldValue;
}
}
++modCount;
if (++size > threshold)
resize();
afterNodeInsertion(evict);//回调函数，新节点插入之后回调，按需删除最早插入的一个元素
return null;
}
其创建节点的方法是 newNode() 方法，而 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);
//将节点插入到链尾
linkNodeLast(p);
return p;
}
// link at the end of list
private void linkNodeLast(LinkedHashMap.Entry<K,V> p) {
LinkedHashMap.Entry<K,V> last = tail;
tail = p;
//如果链表为空，则双向链表为空，则 p 即为头节点也为尾节点
if (last == null)
head = p;
else {//否则修改指针，让之前链尾的after指向p，p的before指向链尾
p.before = last;
last.after = p;
}
}
afterNodeAccess 方法实现了将访问的元素移动到链尾的功能，在 HashMap 中也有该方法，但是没有实现，在 LinkedHashMap 中实现了此方法，其代码为：
//通过afterNodeAccess方法维护访问顺序，每次访问该元素就将该元素移动到双向链表的末尾
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;
//该元素为头元素，直接让a成为头结点
if (b == null)
head = a;
//否则，令b的尾指针指向a
else
b.after = a;
//该元素不是尾元素
if (a != null)
a.before = b;
else
last = b;
//如果双向链表中只有p一个节点，则令p即为头结点，也为尾节点
if (last == null)
head = p;
//否则 将p插入链尾
else {
p.before = last;
last.after = p;
}
tail = p;
++modCount;
}
}
值得注意的是，afterNodeAccess() 函数中，会修改 modCount，因此当在accessOrder=true的模式下,迭代 LinkedHashMap 时，如果同时查询访问数据，也会导致 fail-fast，因为迭代的顺序已经改变。
此外 HashMap 的putVal()方法，还调用了 afterNodeInsertion() 方法，其代码为：
//回调函数，新节点插入之后回调，按需删除最早插入的一个元素
void afterNodeInsertion(boolean evict) { // possibly remove eldest
LinkedHashMap.Entry<K,V> first;
//removeEldestEntry默认返回false，可以被子类改写，如果实现LRU Cache，可以返回true
//把最老的没有被访问的元素移除掉
if (evict && (first = head) != null && removeEldestEntry(first)) {
K key = first.key;
removeNode(hash(key), key, null, false, true);
}
}
//LinkedHashMap 默认返回false 则不删除节点。 返回true 代表要删除最早的节点。通常构建一个LRU Cache会在达到Cache的上限是返回true
protected boolean removeEldestEntry(Map.Entry<K,V> eldest) {
return false;
}
即当插入时，将双向链表的头结点移除。不过 removeEldestEntry() 默认是返回 false 的，需要子类继承重写 removeEldestEntry() 方法。
2.4 获取元素
LinkedHashMap 重写了 HashMap 中的 get() 方法，实现了 LRU，其代码为：
public V get(Object key) {
Node<K,V> e;
if ((e = getNode(hash(key), key)) == null)
return null;
//accessOrder为true时，被访问的节点被置于双向链表尾部
if (accessOrder)
afterNodeAccess(e);
return e.value;
}
2.5 删除键值对
LinkedHashMap的 remove() 方法也是调用的 HashMap 的 remove() 方法
public V remove(Object key) {
Node<K,V> e;
return (e = removeNode(hash(key), key, null, false, true)) == null ?
null : e.value;
}
但它重写了 afterNodeRemoval() 这个回调方法,该方法会在Node<K,V> removeNode(int hash, Object key, Object value, boolean matchValue, boolean movable)方法中回调
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;
//回调从双向链表中移除node
afterNodeRemoval(node);
return node;
}
}
return null;
}
//回调方法，用于将节点从双向链表移除 (从链式关系中删除节点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;
}
2.6 遍历
重写了 entrySet 方法：
public Set<Map.Entry<K,V>> entrySet() {
Set<Map.Entry<K,V>> es;
//返回LinkedEntrySet
return (es = entrySet) == null ? (entrySet = new LinkedEntrySet()) : es;
}
final class LinkedEntrySet extends AbstractSet<Map.Entry<K,V>> {
public final Iterator<Map.Entry<K,V>> iterator() {
return new LinkedEntryIterator();
}
}
final class LinkedEntryIterator extends LinkedHashIterator
implements Iterator<Map.Entry<K,V>> {
public final Map.Entry<K,V> next() { return nextNode(); }
}
abstract class LinkedHashIterator {
LinkedHashMap.Entry<K,V> next;
LinkedHashMap.Entry<K,V> current;
int expectedModCount;
LinkedHashIterator() {
//从双向链表的头元素开始遍历
next = head;
//记录当前 modCount，以满足 fail-fast
expectedModCount = modCount;
//当前节点为空
current = null;
}
public final boolean hasNext() {
return next != null;
}
//nextNode() 就是迭代器里的next()方法
//该方法的实现可以看出，迭代LinkedHashMap，就是从内部维护的双链表的表头开始循环输出
final LinkedHashMap.Entry<K,V> nextNode() {
LinkedHashMap.Entry<K,V> e = next;
if (modCount != expectedModCount)
throw new ConcurrentModificationException();
if (e == null)
throw new NoSuchElementException();
//按照双向链表而不是哈希数组的顺序遍历
current = e;
next = e.after;
return e;
}
public final void remove() {
Node<K,V> p = current;
if (p == null)
throw new IllegalStateException();
if (modCount != expectedModCount)
throw new ConcurrentModificationException();
current = null;
K key = p.key;
removeNode(hash(key), key, null, false, false);
expectedModCount = modCount;
}
}
我们可以看到，LinkedHashMap的 iterator 也是遍历的双向链表。双链表节点的顺序在LinkedHashMap的增、删、改、查时都会更新。以满足按照插入顺序输出，还是访问顺序输出。
3. 总结
①、LinkedHashMap 是一个关联数组、哈希表，它是线程不安全的，允许key为 null，value为 null。
②、它继承自HashMap，实现了Map<K,V>接口。其内部还维护了一个双向链表，在每次插入数据，或者访问、修改数据时，会增加节点、或调整链表的节点顺序，以决定迭代时输出的顺序。
③、默认情况，遍历时的顺序是按照插入节点的顺序。这也是其与HashMap最大的区别。也可以在构造时传入accessOrder参数，使得其遍历顺序按照访问的顺序输出。
④、LinkedHashMap有序，在实现时，重写了HashMap中的几个方法，以满足其输出序列有序的需求。
⑤、LinkedHashMap并没有重写任何 put 方法。但是其重写了构建新节点的 newNode() 方法.在每次构建新节点时，将新节点链接在内部双向链表的尾部
⑥、accessOrder=true 的模式下，在 afterNodeAccess() 函数中，会将当前被访问到的节点e，移动至内部的双向链表的尾部。值得注意的是，afterNodeAccess() 函数中，会修改modCount，因此在 accessOrder=true 的模式下迭代 LinkedHashMap 时，如果同时查询访问数据，也会导致 fail-fast，因为迭代的顺序已经改变。
扫一扫
587
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
