理解ThreadLocal之原理简介
用途
我们一般用ThreadLocal来提供线程局部变量。线程局部变量会在每个Thread内拥有一个副本,Thread只能访问自己的那个副本。文字解释总是晦涩的,我们来看个例子。
public class Test {
private static ThreadLocal<String> threadLocal = new ThreadLocal<>();
public static void main(String[] args) {
Thread thread1 = new MyThread("lucy");
Thread thread2 = new MyThread("lily");
thread1.start();
thread2.start();
}
private static class MyThread extends Thread {
MyThread(String name) {
super(name);
}
@Override
public void run() {
Thread thread = Thread.currentThread();
threadLocal.set("i am " + thread.getName());
try {
//睡眠两秒,确保线程lucy和线程lily都调用了threadLocal的set方法。
Thread.sleep(2000);
} catch (InterruptedException e) {
e.printStackTrace();
}
System.out.println(thread.getName() + " say: " + threadLocal.get());
}
}
}
这个例子非常简单,就是创建了lucy和lily两个线程。在线程内部,调用threadLocal的set方法存入一字符串,睡眠2秒后输出线程名称和threadLocal中的字符串。我们运行这单代码,看一下输出内容。
lucy say: i am lucy
lily say: i am lily
原理
上面例子很好的解释了ThreadLocal的作用,接下来我们分析一下这是如何实现的。
我们定位到ThreadLocal的set方法。源码中set方法被拆分为几个方法,为了表述方便笔者将这几个方法进行了整合。
public void set(T value) {
//获取当前线程
Thread t = Thread.currentThread();
//获取当前线程的ThreadLocalMap
ThreadLocalMap map = t.threadLocals;
if (map != null)
//将数据放入ThreadLocalMap中,key是当前ThreadLocal对象,值是我们传入的value。
map.set(this, value);
else
//初始化ThreadLocalMap,并以当前ThreadLocal对象为Key,value为值存入map中。
t.threadLocals = new ThreadLocalMap(this, value);
}
通过上面这段代码可以看到,ThreadLocal的set方法主要是通过当前线程的ThreadLocalMap实现的。ThreadLocalMap是一个Map,它的key是ThreadLoacl,value是Object。
TreadLocal的get方法的源码我就不贴出来了,大体上与set方法类似,就是先获取到当前线程的ThreadLocalMap,然后以this为key可以取得value。
到这里我们基本上明白了ThreadLocal的工作原理,我们总结一下
- 每个Thread实例内部都有一个ThreadLocalMap,ThreadLocalMap是一种Map,它的key是ThreadLocal,value是Object。
- ThreadLocal的set方法其实是往当前线程的ThreadLocalMap中存入数据,其key是当前ThreadLocal对象,value是set方法中传入的值。
- 使用数据时,以当前ThreadLocal为key,从当前线程的ThreadLocalMap中取出数据。
ThreadLocalMap
上面我们介绍了ThreadLocal主要是通过线程的ThreadLocalMap实现的。
static class ThreadLocalMap {
private ThreadLocal.ThreadLocalMap.Entry[] table;
static class Entry extends WeakReference<ThreadLocal<?>> {
Object value;
Entry(ThreadLocal<?> var1, Object var2) {
super(var1);
this.value = var2;
}
}
}
ThreadLocalMap是一种Map,其内部维护着一个Entry[]。
ThreadLocalMap其实是就是将Key和Value包装成Entry,然后放入Entry数组中。我们看一下它的set方法。
private void set(ThreadLocal<?> key, Object value) {
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)]) {
ThreadLocal<?> k = e.get();
if (k == key) {
//如果已经存在,直接替换value
e.value = value;
return;
}
if (k == null) {//如果当前位置的key ThreadLocal为空,替换key和value。
replaceStaleEntry(key, value, i);
return;
}
}
tab[i] = new Entry(key, value);//该位置没有数据,直接存入。
int sz = ++size;
if (!cleanSomeSlots(i, sz) && sz >= threshold) //检查是否扩容
rehash();
}
private static int nextIndex(int i, int len) {
return ((i + 1 < len) ? i + 1 : 0);
}
到这里,如果你了解HashMap,应该可以看出ThreadLocalMap就是一种HashMap。不过它并没有采用java.util.HashMap中数组+链表的方式解决Hash冲突,而是采用index后移的方式。
我们简单分析一下这段代码:
-
通过ThreadLocal的threadLocalHashCode与当前Map的长度计算出数组下标 i。
-
从i开始遍历Entry数组,这会有三种情况:
-
Entry的key就是我们要set的ThreadLocal,直接替换Entry中的value。
-
Entry的key为空,直接替换key和value。
-
发生了Hash冲突,当前位置已经有了数据,查找下一个可用空间。
-
-
找到没有数据的位置,将key和value放入。
-
检查是否扩容。
我们知道,HashMap是一种get、set都非常高效的集合,它的时间复杂度只有O(1)。但是如果存在严重的Hash冲突,那HashMap的效率就会降低很多。我们通过上段代码知道,ThreadLocalMap是通过 key.threadLocalHashCode & (len-1)计算Entry存放index的。len是当前Entry[]的长度,这没什么好说的。那看来秘密就在threadLocalHashCode中了。我们来看一下threadLocalHashCode是如何产生的。
public class ThreadLocal<T> {
private final int threadLocalHashCode = nextHashCode();
private static AtomicInteger nextHashCode = new AtomicInteger();
private static final int HASH_INCREMENT = 0x61c88647;
private static int nextHashCode() {
return nextHashCode.getAndAdd(HASH_INCREMENT);
}
}
这段代码非常简单。有个全局的计数器nextHashCode,每有一个ThreadLocal产生这个计数器就会加0x61c88647,然后把当前值赋给threadLocalHashCode。关于0x61c88647这个神奇的常量,可以点这里。