LinkedHashMap也是我们日常开发中比较常用的容器,它具有如下几个特点:
- LinkedHashMap 继承了
HashMap
, 基于HashMap
和双向链表来实现的(尾插法
) - LinkedHashMap 是有序(而
HashMap
是无序的), 可以分为插入顺序
和访问顺序
两种 - LinkedHashMap 存储数据和
HashMap
一样,双向链表只是为了保证顺序 - LinkedHashMap 存储数据和
HashMap
一样, key和value都可以为null(使用的就是HashMap
的存储逻辑) - LinkedHashMap 和
HashMap
一样都是线程不安全的。
由于 LinkedHashMap 继承了 HashMap
,元素存储还是使用了HashMap
那一套逻辑,只不过LinkedHashMap 内部维护了一个双向链表。那么在看 LinkedHashMap 之前,可以先熟悉下 HashMap。
1.LinkedHashMap 主要属性
public class LinkedHashMap<K,V>
extends HashMap<K,V>
implements Map<K,V>
{
/**
* HashMap.Node subclass for normal LinkedHashMap entries.
* LinkedHashMap内部维护的元素节点,继承了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内部的头节点
*/
transient LinkedHashMap.Entry<K,V> head;
/**
* LinkedHashMap内部的尾节点
*/
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.
*
* 访问顺序,这个很重要, 可以用来构建LRU(最近最少使用)缓存
* 如果是true,表示访问顺序
* 如果是false,标识插入顺序,默认是false
*/
final boolean accessOrder;
//省略其他构造器......
//3个参数的构造器,重点关注 accessOrder
public LinkedHashMap(int initialCapacity,
float loadFactor,
boolean accessOrder) {
super(initialCapacity, loadFactor);
this.accessOrder = accessOrder;
}
}
由于LinkedHashMap是基于HashMap+双向链表
实现的,所以我们就关注下put
方法即可,看他是如何有序的,我们调用LinkedHashMap的put
方法,实际上调用HashMap
的put
方法
Map<String, Integer> map = new LinkedHashMap<>();
map.put("刘备", 50); //hash=2
map.put("孙权", 18); //hash=5
map.put("曹操", 40); //hash=7
map.put("孔明", 30); //hash=2
map.put("张飞", 32); //hash=2
map.put("郭嘉", 37); //hash=7
map.forEach((k,v) -> System.out.printf("%s=%s, ", k, v));
我们看下put
方法:
public V put(K key, V value) {
return putVal(hash(key), key, value, false, true);
}
核心逻辑:
看着是不是非常的熟悉,没错,就是HashMap的put逻辑
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;
}
它是如何构建双向链表的呢?在put元素创建Node
节点的时候
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;
}
逻辑并不复杂,我们通过下面这个图来看下:
从图中不难看出,通过双向链表,它将元素按照插入顺序进行了首尾相连,这样当遍历的时候,它就会按照插入顺序进行遍历。
遍历逻辑:
public final void forEach(Consumer<? super Map.Entry<K,V>> action) {
if (action == null)
throw new NullPointerException();
int mc = modCount;
//按照插入顺序,从头到尾遍历
for (LinkedHashMap.Entry<K,V> e = head; e != null; e = e.after)
action.accept(e);
if (modCount != mc)
throw new ConcurrentModificationException();
}
当然了,get()
, remove()
以及扩容resize()
方法都和HashMap
基本上是一样的,这里就不在展开赘述了。但是LinkedHashMap有一个很重要的属性 accessOrder
如果是
true
,表示访问顺序
如果是false
,标识插入顺序,默认是false
2.插入顺序or访问顺序
我们先通过一个栗子看下:
Map<String, Integer> map = new LinkedHashMap<>();
map.put("刘备", 50); //hash=2
map.put("孙权", 18); //hash=5
map.put("曹操", 40); //hash=7
map.put("孔明", 30); //hash=2
map.put("张飞", 32); //hash=2
map.put("郭嘉", 37); //hash=7
//打印结果:刘备=50, 孙权=18, 曹操=40, 孔明=30, 张飞=32, 郭嘉=37
map.forEach((k,v) -> System.out.printf("%s=%s, ", k, v));
System.out.println();
map.get("曹操");
//打印结果:刘备=50, 孙权=18, 曹操=40, 孔明=30, 张飞=32, 郭嘉=37
map.forEach((k,v) -> System.out.printf("%s=%s, ", k, v));
}
两次打印的结果是一样的,都是按照插入顺序进行打印的。
我们在看下面这个栗子:
/**
* 阿里巴巴规约:capacity = (已知元素个数 / loadFactor) + 1
* accessOrder = true, 表示访问顺序
*/
Map<String, Integer> map = new LinkedHashMap<>(((int)((6/0.75) + 1)), 0.5f, true);
//Map<String, Integer> map = new LinkedHashMap<>();
map.put("刘备", 50); //hash=2
map.put("孙权", 18); //hash=5
map.put("曹操", 40); //hash=7
map.put("孔明", 30); //hash=2
map.put("张飞", 32); //hash=2
map.put("郭嘉", 37); //hash=7
//①打印结果:刘备=50, 孙权=18, 曹操=40, 孔明=30, 张飞=32, 郭嘉=37
map.forEach((k,v) -> System.out.printf("%s=%s, ", k, v));
System.out.println();
map.get("曹操"); //访问一下曹操
//②打印结果:刘备=50, 孙权=18, 孔明=30, 张飞=32, 郭嘉=37, 曹操=40
map.forEach((k,v) -> System.out.printf("%s=%s, ", k, v));
System.out.println();
map.get("刘备"); //访问一下刘备
//③打印结果:孙权=18, 孔明=30, 张飞=32, 郭嘉=37, 曹操=40, 刘备=50
map.forEach((k,v) -> System.out.printf("%s=%s, ", k, v));
打印结果分析:
- 第一次打印(①), 它就是按照插入顺序打印的(因为此时还没有访问,也就是调用
get
方法) - 第二次打印(②), 我访问了一次"曹操", 然后再打印的时候,它将"曹操"放到了
尾部
- 第三次打印(③), 我又访问了一次"刘备",然后打印的时候,"刘备"放到了
尾部
不难发现,一旦 accessOrder=true, 链表的存储顺序将按照"访问顺序
" 进行调整,我们通过源码看下:
访问就是调用 get() 方法
public V get(Object key) {
Node<K,V> e;
//根据key查找节点数据,如果没有,则退出
if ((e = getNode(hash(key), key)) == null)
return null;
//如果 accessOrder = true, 则在get后进行进一步的处理
if (accessOrder)
afterNodeAccess(e);
return e.value;
}
我们来看下,访问后它是如何处理的,我们以 get("曹操")
为例进行分析:
void afterNodeAccess(Node<K,V> e) { // move node to last
LinkedHashMap.Entry<K,V> last;
//如果访问的就是尾节点,那就不用处理了,因为经常访问的就是放到尾部
if (accessOrder && (last = tail) != e) {
/**
* b = p.before : 也就是孙权
* p: 当前访问的节点,也就是"曹操"
* a = p.after : 也就是孔明
*
LinkedHashMap.Entry<K,V> p =
(LinkedHashMap.Entry<K,V>)e, b = p.before, a = p.after;
p.after = null;
//如果b为空,说明,"曹操"之前没有节点了,也就是"曹操"首节点,这里并不是
if (b == null)
head = a;
else
/**
* 如果b不为空,说明"曹操"之前是有节点的,那么我就让原来的 b -> p("曹操") -> a
* 变成 b -> a (跳过p, p稍后在处理)
*
*/
b.after = a;
/**
* 如果a不是null,说明 "曹操"之后还有节点,那么我就让之前的 a -> p("曹操") -> b
* 变成 a -> b(跳过p)
* 注意:他们是双向链表 b <=> p <=> a
*/
if (a != null)
a.before = b;
else
last = b;
if (last == null)
head = p;
else {
//因为尾部节点不是null, 所以让p指向原来的尾结点,同时也让原来的尾部节点指向p(双向)
p.before = last;
last.after = p;
}
//将访问的节点"曹操" 放到尾部
tail = p;
++modCount;
}
}
逻辑并不复杂,仔细梳理下就能看明白,我们再通过下图来看下:
由于这个访问顺序的特性,LinkedHashMap可以被用来构建LRU(最近最少使用)缓存
,这一点在源码的文档注释中也有体现:
那么接下来,我们就通过LinkedHashMap实现一下LRU缓存。
3.基于LinkedHashMap构建LRU缓存
/**
* @author qiuguan
* 基于LinkedHashMap实现LRU缓存
*/
public class LruCache<K, V> extends LinkedHashMap<K, V> {
private final int maxCacheSize;
public LruCache(int cacheSize) {
//accessOrder一定要为true
super(8, 0.75f, true);
this.maxCacheSize = cacheSize;
}
/**
* 判断是否要移除最老的数据,也就是最晚访问的数据
* 这也是基于LinkedHashMap实现LRU缓存的核心
*/
@Override
protected boolean removeEldestEntry(Map.Entry<K, V> eldest) {
//return super.size() > 1024; 当元素个数超过1024个,将移除不经常访问的数据
//当Map的元素个数 > 指定的缓存最大数时,此时就需要移除不经常访问的元素了
return super.size() > maxCacheSize;
}
}
测试数据分析:
public class Test {
public static void main(String[] args) {
LruCache<String, Integer> cache = new LruCache<>(6);
//存放6个元素
cache.put("刘备", 50);
cache.put("孙权", 18);
cache.put("曹操", 40);
cache.put("孔明", 30);
cache.put("张飞", 32);
cache.put("郭嘉", 37);
//打印结果:刘备 = 50; 孙权 = 18; 曹操 = 40; 孔明 = 30; 张飞 = 32; 郭嘉 = 37
cache.forEach((k, v) -> System.out.printf("%s = %s; ", k, v));
System.out.println();
//在放一个元素,超过了缓存最大值6
cache.put("关羽", 40);
//打印结果:孙权 = 18; 曹操 = 40; 孔明 = 30; 张飞 = 32; 郭嘉 = 37; 关羽 = 40
//"刘备"被移除了
cache.forEach((k, v) -> System.out.printf("%s = %s; ", k, v));
System.out.println();
cache.get("孙权");
cache.get("孔明");
//打印结果:曹操 = 40; 张飞 = 32; 郭嘉 = 37; 关羽 = 40; 孙权 = 18; 孔明 = 30;
cache.forEach((k, v) -> System.out.printf("%s = %s; ", k, v));
System.out.println();
cache.put("马超", 25);
//打印结果:张飞 = 32; 郭嘉 = 37; 关羽 = 40; 孙权 = 18; 孔明 = 30; 马超 = 25;
//"曹操"是最近最少使用的,位于头部,直接移除
cache.forEach((k, v) -> System.out.printf("%s = %s; ", k, v));
}
}
不难发现,无论我怎么添加元素,它打印的结果都是6个元素,这就是因为当元素个数超过6的时候,他会移除不经常访问的数据,所以基于
LinkedHashMap
实现LRU缓存是非常方便的。
简单看下源码:
void afterNodeInsertion(boolean evict) { // possibly remove eldest
LinkedHashMap.Entry<K,V> first;
/**
* 将双向链表的头节点赋给fist, 如果 removeEldestEntry(first) 为ture, 则移除头部节点
* removeEldestEntry(first) 就是我们实现的方法
*
*/
if (evict && (first = head) != null && removeEldestEntry(first)) {
K key = first.key;
removeNode(hash(key), key, null, false, true);
}
}
好了,关于LinkedHashMap相关的知识点就记录到这里吧。
限于作者水平,文中难免有错误之处,欢迎指正,勿喷,感谢感谢