ThreadLocal的用法举例
- 首先ThreadLocal跟多线程安全并没有什么关系；
- 再看一个用法举例，如在Spring中，用ThreadLocal存储用户信息，这样在其他的地方也能使用该用户信息；可以看到，我们想存储的值是被set在ThreadLocal对象中的：
public class UserContext {
private static final ThreadLocal userInfoLocal = new ThreadLocal();
public static UserInfo getUserInfo() {
return userInfoLocal.get();
}
public static void setUserInfo(UserInfo userInfo) {
userInfoLocal.set(userInfo);
}
public static void clear() {
userInfoLocal.remove();
}
}
ThreadLocal实现原理
ThreadLocal UML
- 看不到图的可以看JDK，ThreadLocal的相关class并不复杂
image
实现原理
-
Thread中有一个属性Thread.ThreadLocalMap threadLocals,ThreadLocalMap是在ThreadLocal中定义的静态内部类,ThreadLocalMap中有属性Entry[] table, 该属性即为存放线程所有本地变量的位置； - 获取ThreadLocal时，通过
ThreadLocal.get()方法获取currentThread中的threadLocals
ThreadLocalMap map = getMap(Thread.currentThread())
- 再获取map中的
Entry
# this指ThreadLocal，以上面的举例，this即为 userInfoLocal
map.getEntry(this)
- 其中
Entry是定义在ThreadLocalMap中的静态内部类：
# 继承WeakReference的作用在于能更快释放内存，此处了解即可
static class Entry extends WeakReference> {
Object value;
...
}
-
Entry中的属性Object value即为当前线程的一个本地变量：map.getEntry(this)取出的即为this(举例中的userInfoLocal)对应的Entry[] table中的元素e，e.value即Entry中的值，就是线程本地变量的对象（例子中的UserInfo实例）； - 可以看到，
ThreadLocal只存在于Thread的threadLocals内，各线程相互独立；
以ThreadLocal的实现原理，关键在于map.getEntry(this)如何找到对应的Entry(线程中可以定义多个ThreadLocal对象，如果只有一个ThreadLocal对象的话，就不用Entry[]只需一个Entry就够了，set/get也简单的多)；
那么对于这个问题，自然地可以想到：
如果每一个ThreadLocal对象都有一个index属性来表示在Entry[] table中的位置，岂不是很完美； 那么如何实现这种index呢？ 我们创建对象时，每次都经历过初始化对象阶段，如果在类内部定义一个static的值，每次初始化时对该static值+1，那么每个对象的该static值都是不同的，这样一来就实现了我们需要的效果。
好了，来看ThreadLocal的实现。ThreadLocal中的index的实现原理类似但不同，下面逐步解释：
- ThreadLocal中定义了一个static的变量
nextHashCode来表示index：
private static AtomicInteger nextHashCode = new AtomicInteger();
- ThreadLocal中定义了一个static的方法来进行
nextHashCode的递增操作：
# TODO 这里为什么是这个值？
private static final int HASH_INCREMENT = 0x61c88647;
private static int nextHashCode() {
# 此处也可以看出nextHashCode是一个原子类型的好处，即避免了多线程的安全问题
return nextHashCode.getAndAdd(HASH_INCREMENT);
}
- ThreadLocal中定义了一个final的
threadLocalHashCode属性，每次创建对象时，则会进行该属性的生成：
# 此处nextHashCode()即上面的static nextHashCode方法
private final int threadLocalHashCode = nextHashCode();
这样一来，每次创建的ThreadLocal对象都有一个该对象特有的index值；
接下里需要根据该index值插入ThreadLocalMap的Entry[] table中。
这里说明一下，ThreadLocalMap.set()中实现的是一个散列方法，其中又因为需要提高GC的效率（例如http服务器场景，会产生大量的ThreadLocal变量，而这些变量需要GC及时回收），做了许多其他的操作，这些操作在此不表；
- 那么最后来看一下
ThreadLocalMap.set()方法，以下摘自JDK源码：
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);
for (Entry e = tab[i];
e != null;
e = tab[i = nextIndex(i, len)]) {
ThreadLocal k = e.get();
# 如果散列位置已有元素，且元素就是我们操作的ThreadLocal对象，则进行替换
if (k == key) {
e.value = value;
return;
}
# 下面的操作最终结果仍是e.value = value，不过其中涉及到GC的优化
if (k == null) {
replaceStaleEntry(key, value, i);
return;
}
# 如果散列位置已有元素，且元素不是我们操作的ThreadLocal对象，则寻找相邻的下一个元素（nextIndex = (i + 1) < len ? i + 1 : 0）,
}
# 执行到此处，说明整张table表已都填满，需要进行扩容
tab[i] = new Entry(key, value);
int sz = ++size;
# 清理散列表（GC相关）
if (!cleanSomeSlots(i, sz) && sz >= threshold)
# table扩容，扩容操作中重新计算每个ThreadLocal对象的散列位置，重新插入
rehash();
}
- 对应的
ThreadLocalMap.get()方法也需要根据targetkey计算散列值，再从散列位置开始，逐个比较该位置上的sourcekey是不是我们的targetkey，直到找到我们的targetkey，或未找到返回null。
综上，我们可以看到，ThreadLocal中实现了一个散列表来存放单个线程中创建的ThreadLocal对象，计算对象散列值的key则是每次创建对象时生成。