Java中ThreadLocal的简单介绍和原理分析

使用场景

可以用于在线程范围内共享数据，同时不会有并发问题。
有许多常用的库的都用到了 ThreadLocal，例如 Mybatis 的分页插件 PageHelper 的 PageMethod ，Spring中的 ThreadLocalSecurityContextHolderStrategy 等

使用样例

public class ThreadLocalTest {
    private final ThreadLocal<Long> value = new ThreadLocal<>();
    
    public void doSth() {
        try {
            // 设置值
            value.set(1L);
            doBusiness();
        } finally {
            // 最终要从线程中移除这个变量的线程本地副本，否则可能会导致内存泄露
            value.remove();
        }
    }
    
    private void doBusiness() {
        // 获取之前设置的值
        Long contextValue = value.get();
        // 业务逻辑
        System.out.println("ContextValue: " + contextValue);
    }
    
    public static void main(String[] args){
        ThreadLocalTest test = new ThreadLocalTest();
        test.doSth();
    }
}

ThreadLocal中的 API

1. set 为这个变量的在当前线程的本地副本设置值
2. get 从这个变量的在当前线程的本地副本获取设置的值
3. clear 清除这个变量在当前线程的本地副本

ThreadLocal的实现原理

我们进入ThreadLocal类，打开源码（JDK8版本）可以看到，这个类的源文件总共700+行，而其中一个内部类ThreadLocalMap却占据了400+行。
ThreadLocalMap 是一个用于维护线程本地变量的定制化的哈希表实现，这个类没有继承类。为了便于我们理解，可以把他暂时可以理解为哈希表。而这个哈希表的key类型为ThreadLocal<?>，值类型为Object。 我们先记住这一点，后面会用到。

现在我们开始看ThreadLocal类的 set() 方法的实现：

public void set(T value) {
    // 1、获取当前线程
    Thread t = Thread.currentThread();
    // 2、获取对应当前线程的map
    ThreadLocalMap map = getMap(t);
    if (map != null)
        // 3、如果map有，就设置值
        map.set(this, value);
    else
        // 4、如果map还没有，就创建一个含有要设置的值的map
        createMap(t, value);
}

仅从上面的代码片段，我们就可以看出，调用set()方法时，是将值保存到一个对应于线程的类型为ThreadLocalMap的map中。
那么这个map是哪来的呢？

我们进入getMap()方法可以发现这个方法是直接返回了当前线程的一个属性。

ThreadLocalMap getMap(Thread t) {
    // 直接返回线程对象的一个属性
    return t.threadLocals;
}

于是我们继续进入Thread类，查看这个属性：

public class Thread implements Runnable {
	// 省略之前无关代码
    /* ThreadLocal values pertaining to this thread. This map is maintained
     * by the ThreadLocal class.
     */
    ThreadLocal.ThreadLocalMap threadLocals = null;
    // 省略之后无关代码
}

翻译一下，就是说，这个包访问级别的变量是保存属于这个线程的本地变量的。同时，这个变量的值由ThreadLocal类维护。

那么我们回到set()方法，再进去第4步 createMap(t, value) 看看：

void createMap(Thread t, T firstValue) {
    t.threadLocals = new ThreadLocalMap(this, firstValue);
}

这个方法直接创建了一个新的ThreadLocalMap对象并赋值给了Thread对象，也就是当前线程。
总结下，通过ThreadLocal对象的set()方法设置的变量的值其实是放置在了当前线程的一个类型为ThreadLocalMap的属性中，而这个属性的map以当前的ThreadLocal变量作为map的key，以要设置的值作为map中的value，组成一个放置于map的键值对。

理解了这个，那就可以推测出, get() 方法是去当前线程的这个属性所代表的的map去通过ThreadLocal对象作为key取得之前存放的值了。我们查看代码验证下:

public T get() {
        // 1、获取当前线程
        Thread t = Thread.currentThread();
        // 2、获取当前线程的map
        ThreadLocalMap map = getMap(t);
        if (map != null) {
            // 3、如果map不为null，尝试通过this代表的变量从map获取键值对
            ThreadLocalMap.Entry e = map.getEntry(this);
            if (e != null) {
                @SuppressWarnings("unchecked")
                // 4. 如果找到了对应的键值对，返回值
                T result = (T)e.value;
                return result;
            }
        }
        // 5. 没有map或者没有找到键值对时，返回初始值，ThreadLocal这个类的初始值实现是给的null
        // 但是子类可以通过重写protected T initialValue()这个方法改变初始值的实现
        return setInitialValue();
    }

剩下的ThreadLocal#remove()也是同理，从当前线程的类型为ThreadLocal的map中移除key为当前ThreadLocal对象的 键值对。

总结

1. 线程范围的共享变量是通过在当前线程本身的一个类型为ThreadLocalMap的属性实现；
2. set()方法是将ThreadLocal的一个实例作为key，将set的参数作为value存到map中。get和remove方法也是类似；
3. 最后，注意一点：使用完变量之后要记得remove，否则会导致内存泄露。虽然ThreadLocalMap中的键值对因为使用了弱引用便于GC回收key，但是value的回收是依赖ThreadLocalMap本身的机制的，这个回收不一定及时（这一块留待之后再仔细分析吧）。