1.概述
WeakHashMap 是一种弱引用 Map,内部的 key 会存储为弱引用,当 JVM gc 的时候,如果这些 key 没有强引用存在的话,会被gc回收掉,下一次当我们操作 Map (增删改)的时候会把对应的 Entry 整个删除掉,基于这种特性,WeakHashMap 特别适用于缓存处理
2.存储结构
WeakHashMap 因为gc的时候会把没有强引用的key回收掉,所以注定了它里面的元素不会太多,因此也就不需要像HashMap那样元素多的时候转化为红黑树来处理了。因此,WeakHashMap 的存储结构只有(数组 + 链表)
3.源码解析
3.1.属性
//很多和HashMap相同的属性不细说
//引用队列,当弱键失效的时候会把Entry添加到这个队列中
//当下次访问map的时候会把失效的Entry清除掉
private final ReferenceQueue<Object> queue = new ReferenceQueue<>();
3.2.内部类
WeakHashMap内部的存储节点, 没有key属性
private static class Entry<K,V> extends WeakReference<Object> implements Map.Entry<K,V> {
// 可以发现没有key, 因为key是作为弱引用存到Reference类中
V value;
final int hash;
Entry<K,V> next;
Entry(Object key, V value,
ReferenceQueue<Object> queue,
int hash, Entry<K,V> next) {
// 调用WeakReference的构造方法初始化key和引用队列
super(key, queue);
this.value = value;
this.hash = hash;
this.next = next;
}
}
//弱引用的Reference类
public abstract class Reference<T> {
// 实际存储key的地方
private T referent; /* Treated specially by GC */
// 引用队列
volatile ReferenceQueue<? super T> queue;
Reference(T referent, ReferenceQueue<? super T> queue) {
this.referent = referent;
this.queue = (queue == null) ? ReferenceQueue.NULL : queue;
}
}
3.3.put添加元素
-
计算key 的hash值
-
这里与HashMap有所不同,HashMap中如果key为空直接返回0,这里是用空对象来计算的
-
另外打散方式也不同,HashMap只用了一次异或,这里用了四次
- HashMap给出的解释是一次够了,而且就算冲突了也会转换成红黑树,对效率没什么影响
-
-
计算在哪个桶中
-
遍历桶对应的链表
-
如果找到元素就用新值替换旧值,并返回旧值
-
如果没找到就在链表头部插入新元素
- HashMap 就插入到链表尾部
-
如果元素数量达到了扩容门槛,就把容量扩大到2倍大小
- HashMap中是大于threshold才扩容,这里等于threshold就开始扩容了
public V put(K key, V value) {
// 如果key为空,用空对象代替
Object k = maskNull(key);
// 计算key的hash值
int h = hash(k);
//获取桶数组、
Entry<K,V>[] tab = getTable();
//计算元素在哪个桶中,h & (length-1)
int i = indexFor(h, tab.length);
// 遍历桶对应的链表
for (Entry<K,V> e = tab[i]; e != null; e = e.next) {
if (h == e.hash && eq(k, e.get())) {
// 如果找到了元素就使用新值替换旧值,并返回旧值
V oldValue = e.value;
if (value != oldValue)
e.value = value;
return oldValue;
}
}
modCount++;
// 如果没找到就把新值插入到链表的头部
Entry<K,V> e = tab[i];
tab[i] = new Entry<>(k, value, queue, h, e);
// 如果插入元素后数量达到了扩容门槛就把桶的数量扩容为2倍大小
if (++size >= threshold)
resize(tab.length * 2);
return null;
}
3.4.resize扩容
- 判断旧容量是否达到最大容量
- 新建新桶并把元素全部转移到新桶中
- 如果转移后元素个数不到扩容门槛的一半,则把元素再转移回旧桶,继续使用旧桶,说明不需要扩容
- 否则使用新桶,并计算新的扩容门槛
- 转移元素的过程中会把key为null的元素清除掉,所以size会变小
void resize(int newCapacity) {
// 获取旧桶,getTable()的时候会剔除失效的Entry
Entry<K,V>[] oldTable = getTable();
// 旧容量,判断是否达到最大容量了
int oldCapacity = oldTable.length;
if (oldCapacity == MAXIMUM_CAPACITY) {
threshold = Integer.MAX_VALUE;
return;
}
//创建新的桶
Entry<K,V>[] newTable = newTable(newCapacity);
// 把元素从旧桶转移到新桶
transfer(oldTable, newTable);
table = newTable;
//如果元素个数大于扩容门槛的一半,则使用新桶和新容量,并计算新的扩容门槛
if (size >= threshold / 2) {
threshold = (int)(newCapacity * loadFactor);
} else {
// 否则把元素再转移回旧桶,还是使用旧桶
// 因为在transfer的时候会清除失效的Entry,所以元素个数可能没有那么大了,就不需要扩容了
expungeStaleEntries();
//将新桶的元素移回去旧桶,这里已经清除了失效的Entry了
transfer(newTable, oldTable);
table = oldTable;
}
}
//将src桶的数据移到dest桶中
private void transfer(Entry<K,V>[] src, Entry<K,V>[] dest) {
//遍历旧桶
for (int j = 0; j < src.length; ++j) {
Entry<K,V> e = src[j];
//清空旧桶
src[j] = null;
while (e != null) {
Entry<K,V> next = e.next;
Object key = e.get();
//如果key等于了null就说明key被gc清理掉了,则把整个Entry清除
if (key == null) {
e.next = null; // Help GC
e.value = null; // " "
size--;
} else {
//否则就计算在新桶中的位置并把这个元素放在新桶对应链表的头部
int i = indexFor(e.hash, dest.length);
e.next = dest[i];
dest[i] = e;
}
e = next;
}
}
}
3.5.expungeStaleEntries清除失效的Entry
- 当key失效的时候gc会自动把对应的Entry添加到这个引用队列中
- 所有对map的操作都会直接或间接地调用到这个方法先移除失效的Entry
- 比如
getTable()
、size()
、resize()
- 比如
- 这个方法的目的就是遍历引用队列,并把其中保存的Entry从map中移除掉
- 移除Entry的同时把value也一并置为null帮助 GC 清理元素,防御性编程
private void expungeStaleEntries() {
// 遍历引用队列
for (Object x; (x = queue.poll()) != null; ) {
synchronized (queue) {
@SuppressWarnings("unchecked")
Entry<K,V> e = (Entry<K,V>) x;
//找到所在的桶
int i = indexFor(e.hash, table.length);
Entry<K,V> prev = table[i];
Entry<K,V> p = prev;
// 遍历链表
while (p != null) {
Entry<K,V> next = p.next;
// 找到该元素
if (p == e) {
// 删除该元素
if (prev == e)
table[i] = next;
else
prev.next = next;
//帮助GC清理元素
e.value = null; // Help GC
size--;
break;
}
prev = p;
p = next;
}
}
}
}
3.6.remove移除元素
- 计算key的hash值
- 找到所在的桶
- 遍历桶对应的链表
- 如果找到了就删除该节点,并返回该节点的value值
- 如果没找到就返回null
public V remove(Object key) {
//key是null的话,使用空对象替代
Object k = maskNull(key);
//计算hash值
int h = hash(k);
//获取桶数组
Entry<K,V>[] tab = getTable();
//找到key所在的桶
int i = indexFor(h, tab.length);
Entry<K,V> prev = tab[i];
Entry<K,V> e = prev;
//遍历链表
while (e != null) {
Entry<K,V> next = e.next;
//找到key所在的位置,将其从链表中移除
if (h == e.hash && eq(k, e.get())) {
modCount++;
size--;
if (prev == e)
//这里是头节点的情况
tab[i] = next;
else
prev.next = next;
return e.value;
}
prev = e;
e = next;
}
return null;
}
3.7.get获取元素
- 计算hash值
- 遍历所在桶对应的链表
- 如果找到了就返回元素的value值
- 如果没找到就返回空
public V get(Object key) {
Object k = maskNull(key);
//计算hash值
int h = hash(k);
//找到key对应的桶位置
Entry<K,V>[] tab = getTable();
int index = indexFor(h, tab.length);
Entry<K,V> e = tab[index];
while (e != null) {
//找到就返回对应的值
if (e.hash == h && eq(k, e.get()))
return e.value;
e = e.next;
}
return null;
}
强软弱虚引用
软(弱、虚)引用必须和一个引用队列(ReferenceQueue)一起使用
当gc回收这个软(弱、虚)引用引用的对象时,会把这个软(弱、虚)引用放到这个引用队列中
1.强引用
使用最普遍的引用
如果一个对象具有强引用,它绝对不会被 gc 回收
如果内存空间不足了,gc 宁愿抛出 OutOfMemoryError,也不是会回收具有强引用的对象
2.软引用
如果一个对象只具有软引用,则内存空间足够时不会回收它,但内存空间不够时就会回收这部分对象
只要这个具有软引用对象没有被回收,程序就可以正常使用
3.弱引用
如果一个对象只具有弱引用,则不管内存空间够不够,当gc扫描到它时就会回收它
4.虚引用
如果一个对象只具有虚引用,那么它就和没有任何引用一样,任何时候都可能被gc回收
ConcurrentCache
Tomcat 中的 ConcurrentCache 使用了 WeakHashMap 来实现缓存功能
ConcurrentCache 采取的是分代缓存:
- 经常使用的对象放入 eden 中,eden 使用 ConcurrentHashMap 实现,不用担心会被回收
- 不常用的对象放入 longterm,longterm 使用 WeakHashMap 实现,这些老对象会被垃圾收集器回收
当调用 get()
方法时,会先从 eden 区获取,如果没有找到的话再到 longterm 获取,当从 longterm 获取到就把对象放入 eden 中,从而保证经常被访问的节点不容易被回收
当调用 put()
方法时,如果 eden 的大小超过了 size,那么就将 eden 中的所有对象都放入 longterm 中,利用虚拟机回收掉一部分不经常使用的对象
public final class ConcurrentCache<K, V> {
private final int size;
private final Map<K, V> eden;
private final Map<K, V> longterm;
public ConcurrentCache(int size) {
this.size = size;
this.eden = new ConcurrentHashMap<>(size);
this.longterm = new WeakHashMap<>(size);
}
public V get(K k) {
V v = this.eden.get(k);
if (v == null) {
v = this.longterm.get(k);
if (v != null)
this.eden.put(k, v);
}
return v;
}
public void put(K k, V v) {
if (this.eden.size() >= size) {
this.longterm.putAll(this.eden);
this.eden.clear();
}
this.eden.put(k, v);
}
}