1. 是什么?
首先ThreadLocal类是一个线程数据绑定类, 有点类似于HashMap<Thread, 你的数据> (但实际上并非如此), 它所有线程共享, 但读取其中数据时又只能是获取线程自己的数据, 写入也只能给线程自己的数据
2. 怎么用?
public class ThreadLocalDemo {
private static final ThreadLocal<String> threadLocal = new ThreadLocal<>();
public static void main(String[] args) {
for (int i = 0; i < 10; i++) {
new Thread(() -> {
threadLocal.set("zhazha" + Thread.currentThread().getName());
String s = threadLocal.get();
System.out.println("threadName = " + Thread.currentThread().getName() + " [ threadLocal = " + threadLocal + "\t data = " + s + " ]");
}, "threadName" + i).start();
}
}
}
从他的输入来看, ThreadLocal是同一个, 数据存的是线程自己的名字, 所以和threadName是一样的名称
threadName = threadName9 [ threadLocal = java.lang.ThreadLocal@43745e1f data = zhazhathreadName9 ]
threadName = threadName3 [ threadLocal = java.lang.ThreadLocal@43745e1f data = zhazhathreadName3 ]
threadName = threadName7 [ threadLocal = java.lang.ThreadLocal@43745e1f data = zhazhathreadName7 ]
threadName = threadName0 [ threadLocal = java.lang.ThreadLocal@43745e1f data = zhazhathreadName0 ]
threadName = threadName6 [ threadLocal = java.lang.ThreadLocal@43745e1f data = zhazhathreadName6 ]
threadName = threadName1 [ threadLocal = java.lang.ThreadLocal@43745e1f data = zhazhathreadName1 ]
threadName = threadName2 [ threadLocal = java.lang.ThreadLocal@43745e1f data = zhazhathreadName2 ]
threadName = threadName4 [ threadLocal = java.lang.ThreadLocal@43745e1f data = zhazhathreadName4 ]
threadName = threadName5 [ threadLocal = java.lang.ThreadLocal@43745e1f data = zhazhathreadName5 ]
threadName = threadName8 [ threadLocal = java.lang.ThreadLocal@43745e1f data = zhazhathreadName8 ]
3. 有什么使用场景
我们使用获取到一个保存数据库请求, tomcat会有一个线程去操作数据库保存数据和响应数据给客户, 而操作数据库需要存在一个数据库链接Connection对象, 只要是同一个数据库链接, 就可以得到同一个事务
但一个线程是如何获取同一个Connection从而获取同一个事务 ?
方法其实很简单, 使用 ThreadLocal绑定在线程中, 类似于Map<Thread, Connection>去存储
4. 底层源码分析
get方法分析
public T get() {
// 获取当前线程
Thread t = Thread.currentThread();
// 获取ThreadLocalMap
ThreadLocal.ThreadLocalMap map = getMap(t);
// map不为null
if (map != null) {
// 根据this获取我们的entry
ThreadLocal.ThreadLocalMap.Entry e = map.getEntry(this);
if (e != null) {
@SuppressWarnings("unchecked")
T result = (T)e.value;
return result;
}
}
// 如果map获取为空, 则初始化
return setInitialValue();
}
根据上面源码分析发现ThreadLocal底层使用的不是类似Map<Thread, Data> 这种结构而是
每个线程都有一个属于自己的ThreadLocalMap结构
而他的结构是这样的
其中的table数组在上面的 setInitialValue() 方法创建详细源码在这
private T setInitialValue() {
// 这个方法在我们的用例中没写, 所以默认放回 null
T value = initialValue();
Thread t = Thread.currentThread();
// 获取线程单独的 ThreadLocalMap
ThreadLocalMap map = getMap(t);
if (map != null) {
// 如果我们初始化了initialValue() 方法, 那么它默认初始化的值会被设置到这里
map.set(this, value);
} else {
// 线程ThreadLocalMap 没被创建, 需要创建出来,
// 其中的 table 数组在这里被创建
createMap(t, value);
}
// 这里我没分析, 忽略了
if (this instanceof TerminatingThreadLocal) {
TerminatingThreadLocal.register((TerminatingThreadLocal<?>) this);
}
return value;
}
他会在ThreadLocalMap中调用构造方法初始化
// 其中 firstValue是我们的值
void createMap(Thread t, T firstValue) {
// 关注下 this , 它是ThreadLocal
t.threadLocals = new ThreadLocalMap(this, firstValue);
}
ThreadLocalMap(ThreadLocal<?> firstKey, Object firstValue) {
// 我们的table在这里被创建, INITIAL_CAPACITY == 16
table = new Entry[INITIAL_CAPACITY];
// 获取不超过16的hashCode
int i = firstKey.threadLocalHashCode & (INITIAL_CAPACITY - 1);
// 根据计算出来的HashCode设置到对应的table数组中, 这里key是ThreadLocal, value是我们的值
table[i] = new Entry(firstKey, firstValue);
// 初始时, 已经有一个值了, 所以size = 1
size = 1;
// 设置扩容阈值加载因子 threshold = len * 2 / 3; 默认为长度的三分之二
setThreshold(INITIAL_CAPACITY);
}
从这段代码可以发现, firstKey其实是我们ThreadLocalMap中的key, 而firstKey就是我们的ThreadLocal, 而value就是我们 initialValue() 方法返回的值, 这里默认为null, 所以我们可以得出这样一幅图
总结下
每个线程都有一个属于自己的ThreadLocalMap类, 他用于关联多个以ThreadLocal对象为key, 以你的数据为value的Entry对象, 且该对象的key是一个弱引用对象
接下来我们分析下这个类Entry, 它继承了弱引用类WeakReference
static class Entry extends WeakReference<ThreadLocal<?>> {
Object value;
Entry(ThreadLocal<?> k, Object v) {
// ThreadLocal被设置为弱引用
super(k);
// 保存value
value = v;
}
}
发现 ThreadLocal 被设置为弱引用
5. 存在什么问题?
为什么前面的Entry需要继承弱引用类WeakReference呢?
首先了解下什么是引用
简单了解下强、软、弱和虚引用
- 强引用: 如果引用变量没被指向null则, 引用对象将被停留在堆中, 无法被虚拟机回收
Object obj = new Object() - 软引用: 如果虚拟机堆内存不够用了(在发生内存溢出之前), 虚拟机可以选择回收软引用对象, 虚拟机提供
SoftReference类实现软引用, 一般用于相对比较重要但又可以不用的对象, 比如: 缓存 - 弱引用: 生于系统回收之前, 死于系统回收完毕之后, 弱引用需要依附于强引用或者软引用才能够防止被虚拟机回收, 比如放到一个引用队列(
ReferenceQueue)中或者对象中, 比如:ThreadLocalMap的Entry对象, 需要依附于ThreadLocalMap才能够不被删除掉 - 虚引用: 可以理解为跟强引用对象没了引用变量一样, 随时可以被回收, 只要依附于引用队列中才不会被回收, 通常用于网络通讯的
NIO上, 用于引用直接内存, java提供类PhantomReference来实现虚引用
为何Entry对象的key ThreadLocal需要为弱引用?
答案很明显, 防止内存泄漏[1], 我们来详细分析分析
首先, 我们知道ThreadLocalMap中存放的是一个一个Entry对象, 而 Entry对象中的key(ThreadLocal)被设计成弱引用如果key被设置成null
(比如: 外部的测试用例中的private static final ThreadLocal<String> threadLocal = new ThreadLocal<>();这个对象被设置为 threadLocal = null) 则, 你会发现此时Entry的对象key = null value = xxxx(此时这个Entry实质上是没有用的, 连key都给设置成null, 它的value还有什么用?) 而ThreadLocalMap中存储的还是Entry对象的地址, 此Entry不会被回收, 但Entry对象的key被设置成弱引用, 就不一样了, 直接会被回收掉它
[1]内存泄漏: 程序中己动态分配的堆内存由于某种原因程序未释放或无法释放，造成系统内存的浪费，导致程序运行速度减慢甚至系统崩溃等严重后果
那么这样就没有问题了么???(打脸篇)
再次强调, 下面这段话别信, 仔细看到最后, 你会发现这被打脸了
其实应该是没什么问题了(被自己打脸了, 别信这句话), 只不过很多网友觉得Entry中的key虽然是弱引用, 但Entry可能不会被回收, 因为entry的value是强引用, 可能导致线程下的entry无法被回收掉, 最好推荐使用threadLocal.remove方法删除掉, 前面说的threadLocal = null方法不推荐使用, 那么为了以防万一吧, 还是手动调用下remove方法比较好一点
下面是我对threadLocal = null方式的代码测试:
public class ThreadLocalDemo {
private static ThreadLocal<String> threadLocal1 = new ThreadLocal<>() {
@Override
protected String initialValue() {
return "1";
}
@Override
protected void finalize() throws Throwable {
super.finalize();
System.out.println("threadLocal1被回收");
}
};
private static ThreadLocal<String> threadLocal2 = new ThreadLocal<>() {
@Override
protected String initialValue() {
return "2";
}
@Override
protected void finalize() throws Throwable {
super.finalize();
System.out.println("threadLocal1被回收");
}
};
public static void main(String[] args) throws InterruptedException, NoSuchFieldException, IllegalAccessException {
// 获取ThreadLocalMap
Thread thread = Thread.currentThread();
Class<? extends Thread> clazz = thread.getClass();
Field threadLocals = clazz.getDeclaredField("threadLocals");
threadLocals.setAccessible(true);
Object threadLocalsObj = threadLocals.get(thread);
// 获取ThreadLocalMap下的table数组
Class<?> threadLocalsMapClass = threadLocalsObj.getClass();
Field tableField = threadLocalsMapClass.getDeclaredField("table");
tableField.setAccessible(true);
Object[] tableObj = (Object[]) tableField.get(threadLocalsObj);
threadLocal1.set("zhazha");
threadLocal2.set("xixi");
System.out.println(threadLocal1.get());
System.out.println(threadLocal2.get());
// 在这里下一个断点看看ThreadLocal被回收, Entry是否被回收
threadLocal1 = null;
threadLocal2 = null;
System.gc();
Thread.sleep(5000);
System.out.println(tableObj);
System.out.println("主线程结束");
}
}
输出是这样的:
WARNING: An illegal reflective access operation has occurred
WARNING: Illegal reflective access by com.zhazha.threadlocal.ThreadLocalDemo (file:/D:/program/codes/java/Concurrentcy/reviewjuc/target/classes/) to field java.lang.Thread.threadLocals
WARNING: Please consider reporting this to the maintainers of com.zhazha.threadlocal.ThreadLocalDemo
WARNING: Use --illegal-access=warn to enable warnings of further illegal reflective access operations
WARNING: All illegal access operations will be denied in a future release
zhazha
xixi
[Ljava.lang.ThreadLocal$ThreadLocalMap$Entry;@aecb35a
主线程结束
如果上面的代码不调用gc方法, 很长一段时间内不会被回收, 应该是jvm gc还没开始被动回收
但!!!但!!!但!!! 看调试代码
数组中的referent字段还是存在的, 下图是gc回收之前查看数组中的元素发现, 字段referent(也就是ThreadLocal) 它还在
在gc方法执行完毕后, referent被回收掉了, referent = null了
但是那个对象怎么回事??? 没被回收掉?? 打脸了??? 求助广大网友给我看看
那让我们试试 remove方法试试?
好了, 直接没了, 找不到那两个属性了
这An illegal reflective access operation has occurred这个问题怎么帮? 这回真不知道了, 应该不影响我们的代码么?
算了为了把这个红色的字改没掉, 改了改源码
public class ThreadLocalDemo {
private static ThreadLocal<String> threadLocal1 = new ThreadLocal<>() {
@Override
protected String initialValue() {
return "1";
}
@Override
protected void finalize() throws Throwable {
super.finalize();
System.out.println("threadLocal1被回收");
}
};
private static ThreadLocal<String> threadLocal2 = new ThreadLocal<>() {
@Override
protected String initialValue() {
return "2";
}
@Override
protected void finalize() throws Throwable {
super.finalize();
System.out.println("threadLocal1被回收");
}
};
private static Unsafe unsafe;
static {
Class<Unsafe> unsafeClass = Unsafe.class;
Unsafe unsafe = null;
try {
Field unsafeField = unsafeClass.getDeclaredField("theUnsafe");
unsafeField.setAccessible(true);
ThreadLocalDemo.unsafe = (Unsafe) unsafeField.get(null);
} catch (NoSuchFieldException | IllegalAccessException e) {
e.printStackTrace();
}
}
public static void main(String[] args) throws InterruptedException, NoSuchFieldException {
Thread thread = Thread.currentThread();
long threadLocalsFieldOffset = unsafe.objectFieldOffset(Thread.class.getDeclaredField("threadLocals"));
Object threadLocalMapObj = unsafe.getObject(thread, threadLocalsFieldOffset);
long tableOffset = unsafe.objectFieldOffset(threadLocalMapObj.getClass().getDeclaredField("table"));
Object tableObj = unsafe.getObject(threadLocalMapObj, tableOffset);
threadLocal1.set("zhazha");
threadLocal2.set("xixi");
System.out.println(threadLocal1.get());
System.out.println(threadLocal2.get());
threadLocal1 = null;
threadLocal2 = null;
// threadLocal1.remove();
// threadLocal2.remove();
System.gc();
System.out.println(tableObj);
System.out.println("主线程结束");
}
}
好了没这个问题了
zhazha
xixi
threadLocal1被回收
threadLocal1被回收
[Ljava.lang.ThreadLocal$ThreadLocalMap$Entry;@7dc222ae
主线程结束
与目标VM断开连接, 地址为: ''127.0.0.1:58958'，传输: '套接字'', 传输: '{1}'
进程已结束,退出代码0
再分析源码
字段分析
为了分析下自动清除条目机制, 我们分析下字段
ThreadLocal (Entry 的 key):
private static final int HASH_INCREMENT = 0x61c88647; // 据说这个字段的值生成的hash code比较均衡
private static AtomicInteger nextHashCode =
new AtomicInteger(); // 下一个hashcode的基值, 用于和HASH_INCREMENT 一起计算出threadLocalHashCode 字段的
private final int threadLocalHashCode = nextHashCode(); // 计算table索引的值, 用于计算你想要的元素在tab的第几个位置
为什么要这样设计?
我估计Entry使用的key是ThreadLocal, 我们在拿取Entry数组时需要使用到一个索引才能够找到具体的Entry(比如Entry[1]这样), 但如果是单纯的1~N做索引我们是找不到对应的Entry的, 所以设计了上面一系列计算Hash的方式, 存放在Entry的key对象中, 也就是ThreadLocal中, 在每次遍历key的时候可以拿出key所对应的HashCode进行比较, 变成代码就是下面这段ThreadLocal内的查找对应Entry的源码就是
是不是就更加明显了呢?
然后我们再分析ThreadLocalMap的字段
看字段明显就是用于真正存储数据的类
private static final int INITIAL_CAPACITY = 16; // 数组的大小, 必须是2的次方
private Entry[] table; // 存放Entry的真正位置
private int size = 0; // 数组元素数量
private int threshold; // 什么时候重置数组大小
还有一个是Entry
static class Entry extends WeakReference<ThreadLocal<?>> {
/** The value associated with this ThreadLocal. */
Object value;
Entry(ThreadLocal<?> k, Object v) {
super(k);
value = v;
}
}
继承于 WeakReference对象, 生成弱引用k
那么这个弱引用会被gc立即回收么?? 前面说过不会
因为这个弱引用对象在new出来的时候已经给private Entry[] table;强引用对象了, 所以他不会, 除非强引用消失或者强引用的那个位置不再存放该弱引用对象了
在线再分析下set/get方法
public T get() {
// 获取下当前线程
Thread t = Thread.currentThread();
// 获取当前线程的ThreadLocalMap
ThreadLocalMap map = getMap(t);
// 如果不为空
if (map != null) {
// 获取map中对应的Entry, 借助前面分析的HashCode
ThreadLocalMap.Entry e = map.getEntry(this);
if (e != null) {
@SuppressWarnings("unchecked")
T result = (T)e.value;
// 如果不为空, 这直接返回了
return result;
}
}
// 这里是找不到对应的map或者找到了对应的map却找不到Entry
return setInitialValue();
}
分析setInitialValue初始化方法:
private T setInitialValue() {
// 初始化初始的值
T value = initialValue();
Thread t = Thread.currentThread();
ThreadLocalMap map = getMap(t);
if (map != null) {
// 找到了map, 设置初始的值到map中, 这里我们后面分析
map.set(this, value);
} else {
// 创建一个map(内部也创建了tab数组), 并设置值到tab数组中
createMap(t, value);
}
if (this instanceof TerminatingThreadLocal) {
TerminatingThreadLocal.register((TerminatingThreadLocal<?>) this);
}
return value;
}
分析下面的方法
ThreadLocalMap.Entry e = map.getEntry(this);
private Entry getEntry(ThreadLocal<?> key) {
int i = key.threadLocalHashCode & (table.length - 1);
Entry e = table[i];
if (e != null && e.get() == key)
return e;
else
// 不能找到Entry或者Entry中的key不符合, 则走这个函数
return getEntryAfterMiss(key, i, e);
}
重点分析这个方法 , 它存在自动删除无用节点的功能, 可以防止内存泄漏
getEntryAfterMiss
// 为空或者key不相等, 则直接走这个方法
// 当前的key; 当前ThreadLocal对应的i索引; 获取Entry
private Entry getEntryAfterMiss(ThreadLocal<?> key, int i, Entry e) {
Entry[] tab = table;
int len = tab.length;
// 能进入到这里, 说明e!=null, 但是key不相等
while (e != null) {
ThreadLocal<?> k = e.get();
// 如果k 和 key 相同, 则直接返回
if (k == key)
return e;
// 如果k为null, 则直接删除掉可能存在的内存泄漏
if (k == null)
// 这里就是清除 null 空节点 防止内存泄漏的地方
expungeStaleEntry(i);
else
// 获取下一个数组填空的位置
i = nextIndex(i, len);
e = tab[i];
}
return null;
}
private int expungeStaleEntry(int staleSlot) {
Entry[] tab = table;
int len = tab.length;
// expunge entry at staleSlot
// 置 null 让 gc 回收
tab[staleSlot].value = null;
tab[staleSlot] = null;
size--;
// Rehash until we encounter null
Entry e;
int i;
// 往后找不符合的, 继续删除
for (i = nextIndex(staleSlot, len);
(e = tab[i]) != null;
i = nextIndex(i, len)) {
ThreadLocal<?> k = e.get();
// 没有key,但却有Entry, 说明value也有值
if (k == null) {
// 让 gc 回收
e.value = null;
tab[i] = null;
size--;
} else {
// 有 key , 说明是正常的值
// 再计算下 k 的hashcode的值, 计算下索引, 看下是否和我们前面nextIndex得出的值相同, 如果不相同, 则将 i 的位置空出来(说明这个位置放置的不正确, 找到正确的位置存放)
int h = k.threadLocalHashCode & (len - 1);
if (h != i) {
// 空出 i 的位置
tab[i] = null;
// 找出后面的空的位置
while (tab[h] != null)
h = nextIndex(h, len);
// 将 k 位置计算出来的值, 给新的位置
tab[h] = e;
}
}
}
return i;
}
版权声明：本文为qq_30690165原创文章，遵循CC 4.0 BY-SA版权协议，转载请附上原文出处链接和本声明。