ThreadLocal是线程本地存储,在每个线程中都创建了一个ThreadLocalMap对象,每个线程可以访问自己内部ThreadLocalMap对象内的value。
经典的使用场景是为每个线程分配一个JDBC连接Connection。这样就可以保证每个线程的都在各自的Connection上进行数据库的操作,不会出现A线程关了B线程正在使用的Connection;还有session管理等问题。
ThreadLocal使用例子:
public class ThreadLocalTest {
//线程本地存储变量
private static final ThreadLocal<Integer> THREAD_LOCAL_NUM = new ThreadLocal<Integer>(){
@Override
protected Integer initialValue() {
return 0;
}
};
public static void main(String[] args) {
for(int i = 0; i < 3; i++) {//启动三个线程
Thread t = new Thread(() -> {
add10ByThreadLocal();
});
t.start();
}
}
//线程本地存储变量加5
private static void add10ByThreadLocal() {
for(int i = 0; i < 5; i++) {
Integer n = THREAD_LOCAL_NUM.get();
n += 1;
THREAD_LOCAL_NUM.set(n);
System.out.println(Thread.currentThread().getName() + "\tThreadLocalNum = " + n);
}
}
}
打印结果:启动了3个线程,每个线程最后都打印到"ThreadLocalNum=5",而不是num一直在累加直到值等于15
实现原理
按照我们的第一直觉,感觉ThreadLocal内部肯定是有个Map结构,key存了Thread,value存了本地变量V的值。每次通过ThreadLocal对象的get()和set(T value)方法获取当前线程里存的本地变量、设置当前线程里的本地变量。
而JDK的实现里面这个Map是属于Thread,而非属于ThreadLocal。ThreadLocal仅是一个代理工具类,内部并不持有任何与线程相关的数据,所有和线程相关的数据都存储在Thread里面。ThreadLocalMap属于Thread也更加合理。
ThreadLocal持有的Map会持有Thread对象的引用,只要ThreadLocal对象存在,那么Map中的Thread对象就永远不会被回收。ThreadLocal的生命周期往往比线程要长,所以这种设计方案很容易导致内存泄漏。
JDK的实现中Thread持有ThreadLocalMap,而且ThreadLocalMap里对ThreadLocal的引用还是弱引用(WeakReference),所以只要Thread对象可以被回收,那么ThreadLocalMap就能被回收。JDK的这种实现方案复杂但更安全。
在线程池中使用ThreadLocal为什么可能导致内存泄露呢?
在线程池中线程的存活时间太长,往往都是和程序同生共死的,这样Thread持有的ThreadLocalMap一直都不会被回收,再加上ThreadLocalMap中的Entry对ThreadLocal是弱引用(WeakReference),所以只要ThreadLocal结束了自己的生命周期是可以被回收掉的。
Entry中的value是被Entry强引用的,即便value的生命周期结束了,value也是无法被回收的,导致内存泄漏。
线程池中,如何正确使用ThreadLocal?
在finally代码块中手动清理ThreadLocal中的value,调用ThreadLocal的remove()方法。
ThreadLocal核心方法
- 设置Thread对应的value值,首次会创建一个ThreadLocalMap,添加ThreadLocal-Value到ThreadLocalMap中,并且绑定ThreadLocalMap到当前线程。
public void set(T value) {
Thread t = Thread.currentThread();
ThreadLocalMap map = getMap(t);
if (map != null)
map.set(this, value);
else
createMap(t, value);
}
- 创建ThreadLocalMap,绑定到当前线程。
void createMap(Thread t, T firstValue) {
t.threadLocals = new ThreadLocalMap(this, firstValue);
}
- 通过ThreadLocalMap获取当前线程存储的value值
public T get() {
Thread t = Thread.currentThread();
ThreadLocalMap map = getMap(t);
if (map != null) {
ThreadLocalMap.Entry e = map.getEntry(this);
if (e != null) {
@SuppressWarnings("unchecked")
T result = (T)e.value;
return result;
}
}
return setInitialValue();
}
- 设置ThreadLocal的初始化值,未set(T value)初次获取Thread对应的value值时会调用,即被setInitialValue方法调用。需要重写该方法
protected T initialValue() {
return null;
}
- 移除当前线程存储的value值。当ThreadLocal不再使用,最好在finally语句块中,调用remove()方法,释放value的引用,避免内存泄漏。
public void remove() {
ThreadLocalMap m = getMap(Thread.currentThread());
if (m != null)
m.remove(this);
}