怪奴底事倍伤神?半为怜春半恼春。
内部类ThreadLocalMap
ThreadLocalMap是一个定制的hashmap,只适合于维护线程本地值。为了帮助处理非常大和长期的使用的场景,entry的键使用弱引用(WeakReferences)。但是,由于不使用引用队列了,所以只有当表开始耗尽空间时,key为空的entry才会被保证丢失。
1.内部类
//这个哈希映射中的entry扩展了WeakReference,使用ThreadLocal对象作为键。
///注意,空键(即entry.get()=null)意味着不再引用该键,因此可以从表中删除该entry。
static class Entry extends WeakReference> {
//与此ThreadLocal关联的值
Object value;
//用ThreadLocal引用作为键值
Entry(ThreadLocal> k, Object v) {
super(k);
value = v;
}
}
- 思考:为什么要弱引用?
如果使用普通的key-value的Entry来存储,那么就将每个Entry与线程的生命周期绑定在一起,如果线程没有销毁,那么这个entry一直处于GC可达的状态,就不会被回收。把key值定义成ThreadLocal的虚引用,那么当某个ThreadLocal已经没有强引用可达,则随着它被垃圾回收,在ThreadLocalMap里对应的Entry的键值会失效,这为ThreadLocalMap本身的垃圾清理提供了便利。
2.属性
//初始容量,一定是2的指数。
private static final int INITIAL_CAPACITY = 16;
//必要时可以重新调整table大小。
//table的长度必须是2的指数。
private Entry[] table;
//table中的实际存储的entries数量。
private int size = 0;
//重新调整表的阈值,默认是0
private int threshold;
3.构造函数
//构造一个最初包含(firstKey,firstValue)的新映射。
//ThreadLocalMap是惰性构造的,所以只有当至少要往里面放一个元素的时候才会构建它.
ThreadLocalMap(ThreadLocal> firstKey, Object firstValue) {
//初始化数组
table = new Entry[INITIAL_CAPACITY];
//计算索引位置。
int i = firstKey.threadLocalHashCode & (INITIAL_CAPACITY - 1);
//构造entry。
table[i] = new Entry(firstKey, firstValue);
//设置entry的数量。
size = 1;
//设置扩容的阈值
setThreshold(INITIAL_CAPACITY);
}
//构造一个新的映射,包括来自给定父映射的所有可继承threadlocal。
//仅由createInheritedMap调用。
private ThreadLocalMap(ThreadLocalMap parentMap) {
//parentMap是与父线程关联的映射。
Entry[] parentTable = parentMap.table;
int len = parentTable.length;
//以父线程的Entry数组的容量来设置阈值。
setThreshold(len);
//以父线程的Entry数组的容量来初始化数组
table = new Entry[len];
//遍历父线程的entry数组,将entry非空,并且key非空的entry存入子线程的entry中。
for (int j = 0; j < len; j++) {
Entry e = parentTable[j];
if (e != null) {
@SuppressWarnings("unchecked")
ThreadLocal
思考:
(1)第7行代码,其实是firstKey.threadLocalHashCode对初始容量取模,但是为什么用& (INITIAL_CAPACITY - 1)替代呢?
因为位运算比取模效率高很多,%2^n可以替换为 &(2^n-1) 。因为对 2^n 取模,非低n位对结果的贡献显然都是0,会影响结果的只能是低n位。
(2)第36行代码childValue(e.value)将调用ThreadLocal的子类InheritableThreadLoca中的重写的childValue方法,下一篇文章会讲解。
4.方法
1)索引方法
//下一个索引下标
private static int nextIndex(int i, int len) {
return ((i + 1 < len) ? i + 1 : 0);
}
//前一个索引下标
private static int prevIndex(int i, int len) {
return ((i - 1 >= 0) ? i - 1 : len - 1);
}
思考:
查找下一个索引,当 i + 1 >= len的时候,索引为0,查找前一个索引;当i - 1 < 0,索引为len-1,这是为什么呢?
因为查找索引用的是线性探测法,所以entry数组其实是一个环形的。
2)清理方法
//删除staleSlot所在的entry,以及staleSlot和下一个空的entry的索引之间的所有key为空的entry,
//并重新计算entry非空且key非空的entry的索引,如果索引改变了,那么将entry挪到空的entry上。
//@param staleSlot key为空的entry的索引。
//@return staleSlot之后的下一个空entry的索引。
private int expungeStaleEntry(int staleSlot) {
Entry[] tab = table;
int len = tab.length;
//将强引用value置为空,便于GC回收对应的对象。
tab[staleSlot].value = null;
//将强引用tab[staleSlot]置为空,便于GC回收对应的对象。
tab[staleSlot] = null;
size--;
//重新哈希,直到遇到entry为空。
Entry e;
int i;
for (i = nextIndex(staleSlot, len);
(e = tab[i]) != null;
i = nextIndex(i, len)) {
ThreadLocal> k = e.get();
if (k == null) {
//将强引用value置为空,便于GC回收对应的对象。
e.value = null;
//将强引用 tab[i] 置为空,便于GC回收对应的对象。
tab[i] = null;
size--;
} else {
//重新进行hash计算索引
int h = k.threadLocalHashCode & (len - 1);
//索引位置改变了
if (h != i) {
tab[i] = null;
//用线性探测法,查找到entry为空的索引。
while (tab[h] != null)
h = nextIndex(h, len);
tab[h] = e;
}
}
}
return i;
}
//启发式清理entry。
//当添加新entry或删除其他key为空的entry时,将调用此函数。
//@param i key不为空的entry所在的索引。扫描从i之后的元素开始。
//@param n 扫描控制的参数,一般情况扫描 log2(n)个entry,但是如果找到找到key为
//entry为空的时候,就将开始扫描log2(table.length)-1个其他entry。
//@return 如果key的空的entry被删除了,返回true。
private boolean cleanSomeSlots(int i, int n) {
boolean removed = false;
Entry[] tab = table;
int len = tab.length;
do {
i = nextIndex(i, len);
Entry e = tab[i];
//遍历过程中遇到entry不为空,但是key为空。
if (e != null && e.get() == null) {
//将n赋值给n。
n = len;
removed = true;
//删除i的entry和下一个空entry之间的key为空的entry。
//下一次循环从空entry的下一个entry开始。
i = expungeStaleEntry(i);
}
} while ( (n >>>= 1) != 0);
return removed;
}
//删除table中所有的key为空的entry。
private void expungeStaleEntries() {
Entry[] tab = table;
int len = tab.length;
for (int j = 0; j < len; j++) {
Entry e = tab[j];
if (e != null && e.get() == null)
expungeStaleEntry(j);
}
}
expungeStaleEntry是ThreadLocalMap中的最基础的清理方法,cleanSomeSlots和expungeStaleEntries是都是基于expungeStaleEntry来完成清理的。
3)容量方法
//将阈值设置为最坏情况下保持2/3的负载因子
private void setThreshold(int len) {
threshold = len * 2 / 3;
}
//把table的容量扩展到原来的两倍。
private void resize() {
Entry[] oldTab = table;
int oldLen = oldTab.length;
int newLen = oldLen * 2;
Entry[] newTab = new Entry[newLen];
int count = 0;
//过滤掉key为空和entry为空的entry,并将其他entry进行rehash。
for (int j = 0; j < oldLen; ++j) {
Entry e = oldTab[j];
if (e != null) {
ThreadLocal> k = e.get();
if (k == null) {
e.value = null; // Help the GC
} else {
//重新hash计算索引。
int h = k.threadLocalHashCode & (newLen - 1);
//线性探测法,寻找空的entry。
while (newTab[h] != null)
h = nextIndex(h, newLen);
newTab[h] = e;
count++;
}
}
}
//设置新的阈值。
setThreshold(newLen);
//设置entry的数量。
size = count;
//将新的table赋值给原来的table。
table = newTab;
}
//首先扫描整个表,删除key为空的entry。
//如果删除的entry数量还不足够,那么会将表的大小加倍。
private void rehash() {
//删除table中所有的过时entry
expungeStaleEntries();
//当entry数量大于等于table容量的1/2,将会扩容。
if (size >= threshold - threshold / 4)
resize();
}
4)set方法
//用指定key的entry替换set操作期间遇到的key为null的entry。
//@param key 键
//@param value 键关联的值
//@param staleSlot 查找key的时候,遇到的第一个key为null的entry所在的索引
private void replaceStaleEntry(ThreadLocal> key, Object value,
int staleSlot) {
Entry[] tab = table;
int len = tab.length;
Entry e;
int slotToExpunge = staleSlot;
//从staleSlot向前遍历,找到最前面entry非空,但是key为空的索引。
for (int i = prevIndex(staleSlot, len);
(e = tab[i]) != null;
i = prevIndex(i, len))
if (e.get() == null)
slotToExpunge = i;
for (int i = nextIndex(staleSlot, len);
(e = tab[i]) != null;
i = nextIndex(i, len)) {
ThreadLocal> k = e.get();
if (k == key) {
//覆盖value值。
e.value = value;
//staleSlot的entry备份到tab[i]中。
tab[i] = tab[staleSlot];
//用新的entry覆盖staleSlot所在的entry。
tab[staleSlot] = e;
//如果staleSlot前面没有key为null的entry,那么以当前备份staleSlot的entry的
//索引为起点清理
if (slotToExpunge == staleSlot)
slotToExpunge = i;
cleanSomeSlots(expungeStaleEntry(slotToExpunge), len);
return;
}
//如果没有找到key,并且当前k为null,且staleSlot前面没有键为空的entry,
//那么以当前的索引作为清理的起点,在这个场景下这个最终将为从staleSlot
//向后的entry为空的索引。
if (k == null && slotToExpunge == staleSlot)
slotToExpunge = i;
}
//如果没有找到key,则将新的entry覆盖staleSlot的entry中。
tab[staleSlot].value = null;
tab[staleSlot] = new Entry(key, value);
//如果运行中还有其他key为null的entry,删除它们。
if (slotToExpunge != staleSlot)
cleanSomeSlots(expungeStaleEntry(slotToExpunge), len);
}
//设置key关联的value。
//@param key ThreadLocal对象。
//@param value 设置的value.
private void set(ThreadLocal> key, Object value) {
Entry[] tab = table;
int len = tab.length;
//计算key的索引
int i = key.threadLocalHashCode & (len-1);
//如果key的索引位置已经有entry了,则线性探测法,向后寻找。
for (Entry e = tab[i];
e != null;
e = tab[i = nextIndex(i, len)]) {
ThreadLocal> k = e.get();
//如果找到key,覆盖value返回。
if (k == key) {
e.value = value;
return;
}
//如果key为空,那么用新的entry覆盖当前的entry返回。
if (k == null) {
replaceStaleEntry(key, value, i);
return;
}
}
//如果没有冲突,那么在当前位置新建一个entry。
tab[i] = new Entry(key, value);
int sz = ++size;
//如果在cleanSomeSlots没有删除过key为null的entry
//并且entry的数量超过了阈值,则进行reshash
if (!cleanSomeSlots(i, sz) && sz >= threshold)
rehash();
}
5)get方法
//getEntry未直接命中的时候调用此方法。
//@param key 线程本地对象
//@param i key的索引
//@param e entry[i]
//@return 与键关联的项, 如果没有返回空
private Entry getEntryAfterMiss(ThreadLocal> key, int i, Entry e) {
Entry[] tab = table;
int len = tab.length;
//采用线性探测法不断向后查找直到遇到空entry
while (e != null) {
ThreadLocal> k = e.get();
if (k == key)
return e;
if (k == null)
expungeStaleEntry(i);
else
i = nextIndex(i, len);
e = tab[i];
}
return null;
}
//获取与key关联的entry。
//@param key ThreadLocal对象。
//@return 与key关联的entry,如果没有,则为空。
private Entry getEntry(ThreadLocal> key) {
int i = key.threadLocalHashCode & (table.length - 1);
Entry e = table[i];
//e.get()返回的是键值
if (e != null && e.get() == key)
return e;
else
//因为用的是线性探测,所以继续往后找有可能会找到的。
return getEntryAfterMiss(key, i, e);
}
6)remove方法
//删除指定key的entry.
private void remove(ThreadLocal> key) {
Entry[] tab = table;
int len = tab.length;
int i = key.threadLocalHashCode & (len-1);
for (Entry e = tab[i];
e != null;
e = tab[i = nextIndex(i, len)]) {
if (e.get() == key) {
//将key值对象置为null。
e.clear();
//做一次清理。
expungeStaleEntry(i);
return;
}
}
}
注意:
在有线程复用如线程池的场景中,一个线程的寿命很长,大对象长期不被回收影响系统运行效率与安全,所以应该在我们不使用的时候,主动调用remove方法进行清理。
一个ThreadLocal对象被回收了,往里面放的value对于调用链(Thread对象 --> Thread.threadLocals对象 --> entry数组 --> entry.value的对象)是一条强引用链是可达的,因此value不会被GC。
内部类SuppliedThreadLocal
ThreadLocal的一个扩展,它从指定的Supplier获取初始值。
static final class SuppliedThreadLocal extends ThreadLocal {
private final Supplier extends T> supplier;
SuppliedThreadLocal(Supplier extends T> supplier) {
//requireNonNull方法检查对象是否为空,如果为空抛出NullPointerException,
//否则返回对象。
this.supplier = Objects.requireNonNull(supplier);
}
@Override
protected T initialValue() {
return supplier.get();
}
}