一、概述
ThreadLocal是java.lang包下提供的一个类,那么他的作用是什么呢?我们直接看源码中的注释:
* This class provides thread-local variables. These variables differ from
* their normal counterparts in that each thread that accesses one (via its
* {@code get} or {@code set} method) has its own, independently initialized
* copy of the variable. {@code ThreadLocal} instances are typically private
* static fields in classes that wish to associate state with a thread (e.g.,
* a user ID or Transaction ID).
此类提供线程局部变量。这些变量不同于它们的正常对应部分是,每个访问一个线程的线程
(通过{@code get}或{@code set}方法)有自己的独立初始化变量的副本。{@code ThreadLocal}
实例通常是私有的希望将状态与线程关联的类中的静态字段(例如用户ID或事务ID)。
通过字面理解就是说每一个线程访问它时,都会有一个属于线程自己的变量的副本。而且对于每个线程来说时私有的。
二、使用
我们来举个简单的例子来验证上面的话。
public static void main(String[] args) {
//创建一个ThreadLocal
ThreadLocal<String> threadLocal = new ThreadLocal<>();
//在线程1中设置threadLocal的值并打印
new Thread(() -> {
threadLocal.set("我是线程1");
System.out.println(Thread.currentThread().getName()+":"+threadLocal.get());
},"线程1").start();
//在线程2中打印threadLocal的值
new Thread(()->{
System.out.println(Thread.currentThread().getName()+":"+threadLocal.get());
},"线程2").start();
}
如果没有了解过ThreadLocal的小伙伴可能会认为,输出都是一样的,因为线程1中已经设置了threadLocal的值,所以线程2中获取到的是一样的,错。我们来看下打印结果:
线程1:我是线程1
线程2:null
可以看到,打印是不同的,在线程1中设置的值打印了,线程2中打印出来却为null,这就印证了前面说的话以及ThreadLocal的作用:每个访问ThreadLocal的线程都有自己的独立初始化变量的副本。
三、分析
在了解了ThreadLocal作用以及使用之后,我们对它的源码进行分析,这里主要分析他的set和get方法。
先来看看set:
public void set(T value) {
Thread t = Thread.currentThread();
ThreadLocalMap map = getMap(t);
if (map != null)
map.set(this, value);
else
createMap(t, value);
}
set方法中,首先通过当前线程获取map,如果map不为空,则设置map的值,否则就创建一个map,并以当前线程为key和value存进去。那么ThreadLocalMap是什么呢?我们来看一下:
static class ThreadLocalMap {
static class Entry extends WeakReference<ThreadLocal<?>> {
/** The value associated with this ThreadLocal. */
Object value;
Entry(ThreadLocal<?> k, Object v) {
super(k);
value = v;
}
}
private static final int INITIAL_CAPACITY = 16;
private Entry[] table;
ThreadLocalMap(ThreadLocal<?> firstKey, Object firstValue) {
//初始化table
table = new Entry[INITIAL_CAPACITY];
//计算下标
int i = firstKey.threadLocalHashCode & (INITIAL_CAPACITY - 1);
//为table[i]赋值
table[i] = new Entry(firstKey, firstValue);
//初始大小1
size = 1;
setThreshold(INITIAL_CAPACITY);
}
略····
}
在ThreadLocalMap中有一个内部类Entry继承自弱引用,其中ThreadLocal就是弱引用对象,value就是ThreadLocal的值,就是说ThreadLocal本身就是key。
ThreadLocalMap中还有一个Entry数组,INITIAL_CAPACITY即默认容量16。
ThreadLocalMap的构造方法的参数就是传入的key和value。
接下来继续看set方法中所调用的getMap方法,该方法传入的就是当前的线程Thread,返回Thread的threadLocals。
ThreadLocalMap getMap(Thread t) {
return t.threadLocals;
}
我们点进去Thread中看的确Thread中包含一个ThreadLocal.ThreadLocalMap对象,默认为空。
ThreadLocal.ThreadLocalMap threadLocals = null;
接下来继续顺着set方法看,首先当map为空时,调用了createMap方法,createMap如下:
void createMap(Thread t, T firstValue) {
t.threadLocals = new ThreadLocalMap(this, firstValue);
}
这个地方new了一个ThreadLocalMap并赋值给Thread中的threadLocals。
此时就是相当于把key和value存到了Thread中。
当map不为空时,调用map.set方法。map.set方法这里就不贴了,他就是遍历table找到与传入的相同的key并改变其value。如果没有相同的key则创建一个新的Entry并赋值给table[i]。
继续来看get方法:
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();
}
get方法的原理就是拿到当前线程中的map,如果不为空时,则拿到map中的Entry,entry不为空值,则返回它的value。如果当前Thread的map为空时,则返回初始值。
三、总结
看完源码,我的个人理解就是ThreadLocal并不是用来存储数据的,真正存储数据的是ThreadLocalMap。而Thread又持有ThreadLocalMap,所以其实数据存在了Thread中,ThreadLocal只是用来实现不同线程间存储对应数据的一个桥梁而已。
关于ThreadLocal今天就分析到这里把,其实里面还有很多其他操作,比如扩容以及remove,感兴趣的话可以自己去阅读一下源码,主要是ThreadLocal和ThreadLocalMap都在一个文件中,Thread中又持有ThreadLocalMap,滑来滑去看着脑壳疼,睡觉。
最后附上一张Thread和ThreadLocal的关系图: