总结
总结放前面防止太长不看:
- LinkedHashMap继承自HashMap,为Entry额外维护了两个属性:before和after,可以按照节点的插入顺序或者访问顺序为Entry维护一个链表,默认是按插入顺序排序的,遍历LinkedHashMap的时候就是通过链表的顺序访问。
- LinkedHashMap将访问节点、移除节点从而调整链表的操作放在了
afterNodeAccess
,afterNodeRemoval
中,但插入节点调整链表的逻辑并不是在afterNodeInsertion
中,这个方法对LinkedHashMap总是无用的,然而子类可以重写这个方法实现类似LRU的功能。真正的插入节点调整链表的逻辑放在了newNode
和newTreeNode
中。 - 除了维护链表,其他操作和HashMap非常类似。
在SpringMVC的ModelMap中看过它的应用。
概述
HashMap 是无序的,也就是说,迭代 HashMap 所得到的元素顺序并不是它们最初放置到HashMap 的顺序。HashMap 的这一缺点往往会造成诸多不便,因为在有些场景中,我们确需要用到一个可以保持插入顺序的 Map。庆幸的是,JDK 为我们解决了这个问题,它为HashMap 提供了一个子类 —— LinkedHashMap。虽然 LinkedHashMap 增加了时间和空间上的开销,但是它通过维护一个额外的双向链表保证了迭代顺序。特别地,该迭代顺序可以是插入顺序,也可以是访问顺序。因此,根据链表中元素的顺序可以将 LinkedHashMap 分为:保持插入顺序的 LinkedHashMap 和 保持访问顺序(LRU,get 后调整链表序,最新获取的放在最后)的 LinkedHashMap,其中 LinkedHashMap 的默认实现是按插入顺序排序的。
破例先看一下实现链表的结构:
重要内部类和字段
Entry
LinkedHashMap实现链表是重写了Entry内部类,将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设计为了可作为双向链表的结点。
head & tail
链表的头节点:
transient LinkedHashMap.Entry<K,V> head;
链表的尾节点:
transient LinkedHashMap.Entry<K,V> tail;
accessOrder
final boolean accessOrder;
这个决定链表的连接顺序,accessOrder为true代表按访问节点的顺序,false代表按插入节点的顺序。
重要方法
put
首先需要明确的是,LinkedHashMap是继承自HashMap,put方法并没有重写,并且我们在之前HashMap源码分析的时候提到putVal中有一个参数evict没有用到,它就是供LinkedHashMap使用的。
public V put(K key, V value) {
return putVal(hash(key), key, value, false, true);
}
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)
//resize,给一个初始容量,n被赋予容量大小
n = (tab = resize()).length;
//先获取原来的桶p,如果hash不冲突,直接插入节点
if ((p = tab[i = (n - 1) & hash]) == null)
tab[i] = newNode(hash, key, value, null);
//hash冲突
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);
//如果binCount大于TREEIFY_THRESHOLD - 1,则树化,可以猜测转红黑树
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;
//如果onlyIfAbsent不为true或原来的value为null,替换value
if (!onlyIfAbsent || oldValue == null)
e.value = value;
//待分析
afterNodeAccess(e);
return oldValue;
}
}
++modCount;
//大于threshold则扩容
if (++size > threshold)
resize();
//待分析
afterNodeInsertion(evict);
return null;
}
putVal方法之前在分析HashMap的时候分析过了,现在就来看看afterNodeAccess(e)
和afterNodeInsertion(evict)
干了什么:
afterNodeAccess
在上面的putVal方法的逻辑中,如果获取的节点之前就已经存在,就会调用afterNodeAccess方法,根据我们对LinkedHashMap性质的推测,如果链表顺序为accessOrder,就会调整Entry在链表中的顺序。
// 把Entry调整至链表尾部
void afterNodeAccess(Node<K,V> e) { // move node to last
LinkedHashMap.Entry<K,V> last;
// 如果accessOrder为true且链表尾部不是这个节点才会调整位置
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
//evict代表是不是处于创建模式,put方法调用的就是true
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等功能(最近最少使用淘汰)
那么把节点连到链表尾部的方法在哪呢,其实分别在newNode和newTreeNode上:
newNode
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;
}
newTreeNode
TreeNode<K,V> newTreeNode(int hash, K key, V value, Node<K,V> next) {
TreeNode<K,V> p = new TreeNode<K,V>(hash, key, value, next);
linkNodeLast(p);
return p;
}
可见把节点连到链表末端的逻辑就在linkNodeLast方法中:
linkNodeLast
private void linkNodeLast(LinkedHashMap.Entry<K,V> p) {
LinkedHashMap.Entry<K,V> last = tail;
tail = p;
if (last == null)
head = p;
else {
p.before = last;
last.after = p;
}
}
就是把节点连到tail后面
get
LinkedHashMap重写了get方法:
public V get(Object key) {
Node<K,V> e;
if ((e = getNode(hash(key), key)) == null)
return null;
if (accessOrder)
afterNodeAccess(e);
return e.value;
}
getNode还是HashMap中的getNode,逻辑是一样的,只是如果accessOrder为true,在访问完之后会调用一次afterNodeAccess,这个方法我们前面看过了,是把节点调至链表的尾部。
remove
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;
}
removeNode
//后面两个布尔值分别代表是否要求值匹配,movable如果是false不允许移动其他节点
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)
//使用getTreeNode先获取红黑树节点
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);
}
}
//如果matchValue为true,必须要比对用户给的旧值是否正确
if (node != null && (!matchValue || (v = node.value) == value ||
(value != null && value.equals(v)))) {
//如果是红黑树,调用该类的removeTreeNode移除节点
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,LinkedHashMap重写了实现
afterNodeRemoval(node);
return node;
}
}
return null;
}
和HashMap的区别就是在移除完节点之后会调用一次afterNodeRemoval(node)
afterNodeRemoval
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;
}
可以看到就是把node前后的节点接在了一起,实现了从链表中移除节点。
entrySet
public Set<Map.Entry<K,V>> entrySet() {
Set<Map.Entry<K,V>> es;
return (es = entrySet) == null ? (entrySet = new LinkedEntrySet()) : es;
}
涉及到LinkedEntrySet类:
LinkedEntrySet
final class LinkedEntrySet extends AbstractSet<Map.Entry<K,V>> {
public final int size() { return size; }
public final void clear() { LinkedHashMap.this.clear(); }
public final Iterator<Map.Entry<K,V>> iterator() {
return new LinkedEntryIterator();
}
//...
}
可以看到迭代器实现自LinkedEntryIterator,跟踪进去:
LinkedEntryIterator
final class LinkedEntryIterator extends LinkedHashIterator
implements Iterator<Map.Entry<K,V>> {
public final Map.Entry<K,V> next() { return nextNode(); }
}
继承自LinkedHashIterator,看到这里,和HashMap的迭代器实现已经非常像了,不过可以推测LinkedHashIterator的迭代器就是按链表顺序返回节点:
LinkedHashIterator
abstract class LinkedHashIterator {
LinkedHashMap.Entry<K,V> next;
LinkedHashMap.Entry<K,V> current;
int expectedModCount;
LinkedHashIterator() {
//把next定位到head
next = head;
expectedModCount = modCount;
current = null;
}
public final boolean hasNext() {
return next != null;
}
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;
//nextNode就是链表中的下一个元素
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;
}
}
验证了我们的猜想。根据我们对HashMap的了解大概也可以猜想LinkedHashMap的KeySet也是通过LinkedHashIterator得到节点,但只返回它的key。
keySet
public Set<K> keySet() {
Set<K> ks = keySet;
if (ks == null) {
ks = new LinkedKeySet();
keySet = ks;
}
return ks;
}
LinkedKeySet
final class LinkedKeySet extends AbstractSet<K> {
public final int size() { return size; }
public final void clear() { LinkedHashMap.this.clear(); }
public final Iterator<K> iterator() {
return new LinkedKeyIterator();
}
//...
}
LinkedKeyIterator
final class LinkedKeyIterator extends LinkedHashIterator
implements Iterator<K> {
public final K next() { return nextNode().getKey(); }
}
验证了我们的猜想。
构造方法
public LinkedHashMap() {
super();
accessOrder = false;
}
public LinkedHashMap(int initialCapacity) {
super(initialCapacity);
accessOrder = false;
}
public LinkedHashMap(int initialCapacity, float loadFactor) {
super(initialCapacity, loadFactor);
accessOrder = false;
}
public LinkedHashMap(int initialCapacity,
float loadFactor,
boolean accessOrder) {
super(initialCapacity, loadFactor);
this.accessOrder = accessOrder;
}
可见默认是按插入顺序排序的,也可以指定它的初始容量、负载因子(和HashMap一样的扩容),要设置它的排序顺序必须先设置初始容量和负载因子。
原创文章,作者:彭晨涛,如若转载,请注明出处:https://www.codetool.top/article/linkedhashmap%e6%ba%90%e7%a0%81%e5%88%86%e6%9e%90/