概述
ThreadLocal如果单纯从名字上来看像是“本地线程"这么个意思,只能说这个名字起的确实不太好,很容易让人产生误解,ThreadLocalVariable(线程本地变量)应该是个更好的名字。我们先看一下官方对ThreadLocal的描述:
该类提供了线程局部 (thread-local) 变量。这些变量不同于它们的普通对应物,因为访问某个变量(通过其
get 或 set 方法)的每个线程都有自己的局部变量,它独立于变量的初始化副本。ThreadLocal 实例通常是
类中的 private static 字段,它们希望将状态与某一个线程(例如,用户 ID 或事务 ID)相关联。
ThreadLocal 对维持线程封闭性提供了一种规范的方法。ThreadLocal提供了get和set方法的接口或方法,这些方法为每个使用该变量的线程都存有一份独立的副本(这里叫副本还不太正确,看下面源码就清楚了),因此get总是返回由当前执行线程在调用set方法的最新值。
每个线程中都有一个ThreadLocalMap键值是ThreadLocal,值是存入的对象,set方法就是往ThreadLocalMap加值,同一个线程中的一个ThreadLocal关联一个对象,可以有多个ThreadLocal
提供了双向隔离,一个是线程与线程之间的隔离,通过每个线程中有一个私有的ThreadLocalMap实现,另外一个就是不同的ThreadLocal实例之间的互相隔离,通过ThreadLocalMap中键值为ThreadLocal实现
适用场景
ThreadLocal 通常用来防止对可变的单实例对象(Singleton)或全局变量进行共享。适用于线程范围内的共享数据(图1所示)。
Code
public class ThreadLocalTest {
//创建一个Integer型的线程本地变量
public static final ThreadLocal<Integer> local = new ThreadLocal<Integer>() {
@Override
protected Integer initialValue() {
return 0;
}
};
public static void main(String[] args) throws InterruptedException {
Thread[] threads = new Thread[5];
for (int j = 0; j < 5; j++) {
threads[j] = new Thread(new Runnable() {
@Override
public void run() {
//获取当前线程的本地变量,然后累加5次
int num = local.get();
for (int i = 0; i < 5; i++) {
num++;
}
//重新设置累加后的本地变量
local.set(num);
System.out.println(Thread.currentThread().getName() + " : "+ local.get());
}
}, "Thread-" + j);
}
for (Thread thread : threads) {
thread.start();
}
}
运行结果
Thread-0 : 5
Thread-4 : 5
Thread-2 : 5
Thread-1 : 5
Thread-3 : 5
ThreadLocal源码解析
initialValue方法
该方法是ThreadLocal的初始值赋值操作,在下面get()方法中将看到。返回的是null,一般是供调用ThreadLocal时进行重写,如上面的Code
protected T initialValue() {
return null;
}
** set(T value)方法**
首先得到执行该方法的线程,然后得到该线程对应的ThreadLocalMap(每个线程都有一个ThreadLocalMap,在createMap方法中将会看到)如果存在ThreadLocalMap进行set操作键值是ThreadLocalMap ,不存在就新建ThreadLocalMap
public void set(T value) {
Thread t = Thread.currentThread();//得到当前线程
ThreadLocalMap map = getMap(t);//得到当前线程对应的ThreadLocalMap
if (map != null)
map.set(this, value);//map不是null就赋值,调用ThreadLocalMap的set
else
createMap(t, value);//是null就创建map
}
ThreadLocalMap getMap(Thread t) {
return t.threadLocals;//Thread里有个属性是threadLocals,threadLocals会在createMap里赋值
}
**ThreadLocalMap的set(ThreadLocal<?> key, Object value) **
table是ThreadLocalMap用来存储键值对的数组数组里存的是Entry对象。首先得到当前线程的所有数据及长度, key.threadLocalHashCode这个
得到内部增长的一个值,要用这个值得到在table中的位置,因为ThreadLocal是键值所以每一个ThreadLocal对象只对应一个本地线程的变量数据,ThreadLocalMap中可以保存多个ThreadLocal对象
private void set(ThreadLocal<?> key, Object value) {
// We don't use a fast path as with get() because it is at
// least as common to use set() to create new entries as
// it is to replace existing ones, in which case, a fast
// path would fail more often than not.
Entry[] tab = table;//得到该线程的所有数据
int len = tab.length;
int i = key.threadLocalHashCode & (len-1);// 得到存储该值在table中的位置
for (Entry e = tab[i];
e != null;
e = tab[i = nextIndex(i, len)]) {
ThreadLocal<?> k = e.get();
if (k == key) {//每个线程传入的都是new ThreadLocal那个对象,这个是因为在同一个线程存入多个ThreadLocal
e.value = value;
return;
}
if (k == null) {
replaceStaleEntry(key, value, i);
return;
}
}
tab[i] = new Entry(key, value);
int sz = ++size;
if (!cleanSomeSlots(i, sz) && sz >= threshold)
rehash();
}
private final int threadLocalHashCode = nextHashCode();
private static final int HASH_INCREMENT = 0x61c88647;
private static int nextHashCode() {
return nextHashCode.getAndAdd(HASH_INCREMENT);
}
private static AtomicInteger nextHashCode =
new AtomicInteger();
createMap(Thread t, T firstValue)方法
该方法为每个线程生成一个ThreadLocalMap,键值是ThreadLocalMap,每个线程都私有的ThreadLocalMap对象,
void createMap(Thread t, T firstValue) {
t.threadLocals = new ThreadLocalMap(this, firstValue);
}
get()方法
首先得到该线程私有的ThreadLocalMap ,如果不等于null就获取等于null就调用setInitialValue,setInitialValue 首先调用initialValue获取初始值,
再获取map,map为null将新建map并将初始值传入
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();
}
private T setInitialValue() {
T value = initialValue();//可能是用户重写的方法比如上面的例子中返回的就是0
Thread t = Thread.currentThread();
ThreadLocalMap map = getMap(t);
if (map != null)
map.set(this, value);
else
createMap(t, value);
return value;
}
ThreadLocalMap内部存储数据结构
key是弱引用
private Entry[] table;//存储数据
static class Entry extends WeakReference<ThreadLocal<?>> {
/** The value associated with this ThreadLocal. */
Object value;
Entry(ThreadLocal<?> k, Object v) {
super(k);
value = v;
}
}