ThreadLocal源码阅读
-
线程局部变量是我一直对他的叫法，刚开始接触是用来保存jdbc的连接(这样想想我接触的还挺早的) - 作用是 为每个线程保存线程私有的变量 .以空间换时间,也能保证数据的安全性.
-
ThreadLocal并不是底层的集合类，而是一个工具类，所有的线程私有数据都被保存在各个Thread对象中一个叫做threadLocals的ThreadLocalMap的成员变量里,ThreadLocal也只是操作这些变量的工具类. -
也就是说每个
Thread都会存有一个ThreadLocalMap的对象供多个ThreadLocal的类调用，所以你可以发现多个ThreadLocal操作的Map会是同一个，而当ThreadLocal作为key的发生哈希碰撞时,会从当前位置开始向后环型遍历,找到一个空位置,这方法我们可以称之为 线性探测法 .
ThreadLocalMap
-
ThreadLocalMap出人意料的并没有继承任何一个类或接口，是完全独立的类。
成员变量
// 默认的初始容量 一定要是二的次幂
private static final int INITIAL_CAPACITY = 16;
// 元素数组/条目数组
private Entry[] table;
// 大小,用于记录数组中实际存在的Entry数目
private int size = 0;
// 阈值
private int threshold; // Default to 0 构造方法
复制代码
构造方法
// 默认访问权限的初始化方法
ThreadLocalMap(ThreadLocal<?> firstKey, Object firstValue) {
// 使用默认的`容量`初始化数组
table = new Entry[INITIAL_CAPACITY];
// 以`ThreadLocal`的`HashCode`计算下标
// 这里和HashMap中的计算方式一样,都用与运算
int i = firstKey.threadLocalHashCode & (INITIAL_CAPACITY - 1);
// 赋值 修改大小并计算阈值
table[i] = new Entry(firstKey, firstValue);
size = 1;
// `setThreshold`方法也特别简单，就是2/3的容量。
setThreshold(INITIAL_CAPACITY);
}
复制代码
元素获取相关方法
getEntry
-
以
ThreadLocal为Key获取对应的Entry。 -
因为
ThreadLocalMap底层也是使用数组作为数据结构，所以该方法也 借鉴了HashMap中求元素下标的方式 . -
在获取的元素为空的时候还会调用
getEntryAfterMiss做后续处理.
private Entry getEntry(ThreadLocal<?> key) {
// 和HashMap中一样的下标计算方式
int i = key.threadLocalHashCode & (table.length - 1);
Entry e = table[i];
// 获取到对应的Entry之后就分两步
if (e != null && e.get() == key)
// 1. e不为空且threadLocal相等
return e;
else
// 2. e为空或者threadLocal不相等
return getEntryAfterMiss(key, i, e);
}
复制代码
getEntryAfterMiss
-
该方法是在直接按照
Hash计算下标后，没获取到对应的Entry对象的时候调用。 -
通过遍历整个数组的方式获取相同
key表示的Entry对象。
private Entry getEntryAfterMiss(ThreadLocal<?> key, int i, Entry e) {
Entry[] tab = table;
int len = tab.length;
// 此时注意如果从上面情况`2.`进来时,
// e为空则直接返回null,不会进入while循环
// 只有e不为空且e.get() != key时才会进while循环
while (e != null) {
ThreadLocal<?> k = e.get();
// 找到相同的k,返回得到的Entry,get操作结束
if (k == key)
return e;
// 若此时的k为空,那么e则被标记为`Stale`需要被`expunge`
if (k == null)
expungeStaleEntry(i);
else // 下面两个都是遍历的相关操作
i = nextIndex(i, len);
e = tab[i];
}
return null;
}
复制代码
expungeStaleEntry
-
该方法用来清除
staleSlot位置的Entry对象,并且会 清理当前节点到下一个null节点中间的过期Enyru. -
是消除
内存泄漏威胁的主力方法,在整个ThreadLocalMap中会多次调用.
/**
* 清空旧的Entry对象
* @param staleSlot: 清理的起始位置
* @param return: 返回的是第一个为空的Entry下标
*/
private int expungeStaleEntry(int staleSlot) {
Entry[] tab = table;
int len = tab.length;
// 清空`staleSlot`位置的Entry
// value引用置为空之后,对象被标记为不可达,下次GC就会被回收.
tab[staleSlot].value = null;
tab[staleSlot] = null;
size--;
Entry e;
int i;
// 通过nextIndex从`staleSlot`的下一个开始向后遍历Entry数组,直到e不为空
// e赋值为当前的Entry对象
for (i = nextIndex(staleSlot, len);
(e = tab[i]) != null;
i = nextIndex(i, len)) {
ThreadLocal<?> k = e.get();
// 当k为空的时候清空节点信息
if (k == null) {
e.value = null;
tab[i] = null;
size--;
} else { // 以下为k存在的情况
int h = k.threadLocalHashCode & (len - 1);
// 元素下标和key计算的不一样，表明是出现`Hash碰撞`之后调整的位置
// 将当前的元素移动到下一个null位置
if (h != i) {
tab[i] = null;
while (tab[h] != null)
h = nextIndex(h, len);
tab[h] = e;
}
}
}
return i;
}
复制代码
Set相关方法
set
-
因为
ThreadLocalMap底层结构和HashMap一样也是数组,也是通过hash确定下标,也一样会发生Hash碰撞,我们知道在HashMap中为了解决Hash碰撞的问题选择了拉链法,但对于ThreadLocalMap并没有那么高的复杂度,所以此处选择的是开放地址法. -
从下方源码也可以看出来,
Entry再确定数组位置之后直接就开始了遍历,如果key不匹配就往后遍历找到key匹配的元素覆盖,或者key == null的替换.
private void set(ThreadLocal<?> key, Object value) {
Entry[] tab = table;
int len = tab.length;
int i = key.threadLocalHashCode & (len-1);
// 整个循环的功能就是找到相同的key覆盖value
// 或者找到key为null的节点覆盖节点信息
// 只有在e==null的时候跳出循环执行下面的代码
for (Entry e = tab[i];
e != null;
e = tab[i = nextIndex(i, len)]) {
ThreadLocal<?> k = e.get();
// 找到相等的k,则直接替换value,set操作结束
if (k == key) {
e.value = value;
return;
}
// k为空表示该节点过期,直接替换该节点
if (k == null) { // 1.
replaceStaleEntry(key, value, i);
return;
}
}
// 走到这一步就是找到了e为空的位置，不然在上面两个判断里都return了
tab[i] = new Entry(key, value);
int sz = ++size;
if (!cleanSomeSlots(i, sz) && sz >= threshold)
rehash();
}
复制代码
replaceStaleEntry
-
源码中只有从上面
1.处进入该方法,用于 替换key为空的Entry节点,顺带清除数组中的过期节点.
/**
* 从`set.1.`处进入,key是插入元素ThreadLocal的hash,staleSlot为key为空的数组节点下标
*/
private void replaceStaleEntry(ThreadLocal<?> key, Object value,
int staleSlot) {
Entry[] tab = table;
int len = tab.length;
Entry e;
int slotToExpunge = staleSlot;
// 从传入位置,即插入时发现k为null的位置开始,向前遍历,直到数组元素为空
// 找到最前面一个key为null的值.
// 这里要吐槽一下源代码...大括号都不加 习惯真差
for (int i = prevIndex(staleSlot, len);
(e = tab[i]) != null;
i = prevIndex(i, len)){
if (e.get() == null)
// 因为是环状遍历所以此时slotToExpunge是可能等于staleSlot的
slotToExpunge = i;
}
// 该段循环的功能就是向后遍历找到`key`相等的节点并替换
// 并对之后的元素进行清理
for (int i = nextIndex(staleSlot, len);
(e = tab[i]) != null;
i = nextIndex(i, len)) {
ThreadLocal<?> k = e.get();
if (k == key) {
// e就是tab[i]，所以下三行代码的功能就是替换Entry
// 新的Entry实际还是在staleSlot下标的位置
e.value = value;
tab[i] = tab[staleSlot];
tab[staleSlot] = e;
// 因为接下来要进行清理操作,所以此处需要重新确定清理的起点.
if (slotToExpunge == staleSlot)
slotToExpunge = i;
cleanSomeSlots(expungeStaleEntry(slotToExpunge), len);
return;
}
// 其实我对这个`slotToExpunge == staleSlot`的判断一直挺疑惑的,为什么需要这个判断?
if (k == null && slotToExpunge == staleSlot)
slotToExpunge = i;
}
// e==null时跳到下面代码运行
// 清空并重新赋值
tab[staleSlot].value = null;
tab[staleSlot] = new Entry(key, value);
// set后的清理
if (slotToExpunge != staleSlot)
cleanSomeSlots(expungeStaleEntry(slotToExpunge), len);
}
复制代码
cleanSomeSlots
-
该方法的功能是就是清除数组中的过期
Entry -
首次清除从
i向后开始遍历log2(n)次,如果之间发现过期Entry会直接将n扩充到len可以说全数组范围的遍历.发现过期Entry就调用expungeStaleEntry清除直到未发现Entry为止.
/**
* @param i 清除的起始节点位置
* @param n 遍历控制,每次扫描都是log2(n)次,一般取当前数组的`size`或`len`
*/
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];
if (e != null && e.get() == null) {
// 当发现有过期`Entry`时,n变为len
// 即扩大范围,全数组范围在遍历一次
n = len;
removed = true;
i = expungeStaleEntry(i);
}
// 无符号右移一位相当于n = n /2
// 所以在第一次会遍历`log2(n)`次
} while ( (n >>>= 1) != 0);
// 遍历过程中没出现过期`Entry`的情况下会返回是否有清理的标记.
return removed;
}
复制代码
扩容调整方法
rehash
-
容量调整的先驱方法,先清理过期
Entry,并做是否需要resize的判断 - 调整的条件是 当前size大于阈值的3/4 就进行扩容
private void rehash() {
// 清理过期Entry
expungeStaleEntries();
// 初始阈值threshold为10
if (size >= threshold - threshold / 4)
resize();
}
复制代码
resize
- 扩容的实际方法.
private void resize() {
// 获取旧数组并记录就数组大小
Entry[] oldTab = table;
int oldLen = oldTab.length;
// 新数组大小为旧数组的两倍
int newLen = oldLen * 2;
Entry[] newTab = new Entry[newLen];
int count = 0;
// 遍历整个旧数组,并迁移元素到新数组
for (int j = 0; j < oldLen; ++j) {
Entry e = oldTab[j];
// 判断是否为空,空的话就算了
if (e != null) {
ThreadLocal<?> k = e.get();
// k为空即表示为过期节点,当即清理了.
if (k == null) {
e.value = null;
} else {
// 重新计算数组下标,如果数组对应位置已存在元素
// 则环状遍历整个数组找个空位置赋值
int h = k.threadLocalHashCode & (newLen - 1);
while (newTab[h] != null)
h = nextIndex(h, newLen);
newTab[h] = e;
count++;
}
}
}
// 设置新属性
setThreshold(newLen);
size = count;
table = newTab;
}
复制代码
-
ThreadLocal的内部方法因为逻辑都不复杂,不需要单独出来看,就直接全放一块了.
Get方法
-
整个获取的过程其实并不难,所以我说
ThreadLocal的精华只要还是在TheradLocalMap和这种 空间换时间 的结构.-
首先通过
getMap方法获取当前线程绑定的threadLocals -
不要为空时,以当前
ThreadLocal对象为参数获取对应的Entry对象.为空跳到第四步 -
获取
Entry对象中的value,并返回 -
调用
setInitialValue方法,
-
首先通过
// 直接获取线程私有的数据
public T get() {
// 获取当前线程
Thread t = Thread.currentThread();
// getMap其实很简单就是获取`t`中的`threadLocals`,代码在`工具方法`中
ThreadLocalMap map = getMap(t);
if (map != null) { // 3.
ThreadLocalMap.Entry e = map.getEntry(this);
if (e != null) { // 2.
@SuppressWarnings("unchecked")
T result = (T)e.value;
return result;
}
}
return setInitialValue(); // 1.
}
// 这个方法只有在上面`1.`处调用...不知道为什么map,thread不直接传参
// 该方法的功能就是为`Thread`设置`threadLocals`的初始值
private T setInitialValue() {
T value = initialValue();
Thread t = Thread.currentThread();
ThreadLocalMap map = getMap(t);
// map不为null表明是从上面的`2.`处进入该方法
// 已经初始化`threadLocals`,但并未找到当前对应的`Entry`
// 所以此时直接添加`Entry`就行
if (map != null)
map.set(this, value);
else
createMap(t, value);
return value;
}
// 初始值,`protected`方便子类继承,并定义自己的初始值.
protected T initialValue() {
return null;
}
// 创建并赋值`threadLocals`的方法
void createMap(Thread t, T firstValue) {
t.threadLocals = new ThreadLocalMap(this, firstValue);
}
复制代码
Set方法
ThreadLocalMap map map
public void set(T value) {
// 获取当前线程
Thread t = Thread.currentThread();
ThreadLocalMap map = getMap(t); // .1
if (map != null)
map.set(this, value);
else
createMap(t, value);
}
复制代码
工具方法
getMap(Thraed t)
-
获取
t中保留的ThreadLocalMap类型的对象
ThreadLocalMap getMap(Thread t) {
return t.threadLocals;
}
复制代码
ThreadLocal相关问题
ThreadLocal的内存泄漏问题
内存泄漏的原因
-
首先对于对作为
key的ThreadLocal对象,因为是弱引用我们完全不用担心,强引用断开之后自然会被GC回收. -
再来看
value,按照上面所说的作为成员变量存储在每个Thread实例的threadLocals才是存储数据的对象,那么它的生命周期是和Thread相同的,即使将ThreadLocal被GC回收, 但对应的value对象仍然存在thread -> threadLocals -> value引用 -> value对象的引用关系,所以GC会认为它可达,并不会做回收处理,但在我们现有的代码中并没有能够跳过key去获取value的,也就是说实际上value已经不可达了.这样就造成了 内存泄漏 .
内存泄漏的处理方法
-
究其根本还是断开
value的引用关系,就是讲value引用置null. -
可以看到
ThreadLcoalMap的方法多处调用了expungeStaleEntry,cleanSomeSlots检查数组中的Entry对象是否过期,也就是key是否为空.
正文到此结束
热门推荐
相关文章
近期评论
-
文章和留言都翻到11页了 没有OOM
-
-
朋友，翻页到11页，及以后，会出现OOM，无法访问
-
-
搞个gitee的项目
-
-
版本号是多少，你可以下载哪个代码仓库，jdk选1.8 直接跑就行
-
-
-
Loading...
![[HBLOG]公众号](https://www.liuhaihua.cn/img/qrcode_gzh.jpg)
