理解 ThreadLocal 类的特性

注意：调试 JDK 源代码，不能准确地查看变量，必须重新编译 rt.jar，具体方法点这里

---

先贴出 Java Doc 里关于 ThreadLocal 类的说明：

This class provides thread-local variables. These variables differ from their normal counterparts in that each thread that accesses one (via its get or set method) has its own, independently initialized copy of the variable. 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).
此类提供线程局部变量。这些变量与那些普通变量不同，因为访问一个（通过其 get 或 set 方法）的每个线程都有自己独立初始化的变量副本。ThreadLocal 实例通常是私有静态字段，并希望将状态与线程（例如，用户ID或事务ID）相关联。

大家先分析下面这段代码：

public class ThreadTest {
    public static void main(String[] args) {
        MyThread thread = new MyThread();
        thread.start();
        // thread.join();  // 3，省略异常处理语句
        System.out.println(thread.get());  // 1
    }
}

class MyThread extends Thread {
    private ThreadLocal value = new ThreadLocal<>();
    public String get() {
        return value.get();
    }
    @Override
    public void run() {
        value.set("hello");  // 2
    }
}

这段代码的输出结果可能跟大家预想的不一样，结果不是 hello 而是 null。至于为什么，下面我们通过分析 Java 源代码和 Debug 查看变量来理解这一过程。

ThreadLocal.get() 方法如下：

public T get() {
    Thread t = Thread.currentThread();  // 注意这里
    ThreadLocalMap map = getMap(t);  // ThreadLocal.ThreadLocalMap
    if (map != null) {
        ThreadLocalMap.Entry e = map.getEntry(this);  // key为当前ThreadLocal实例
        if (e != null) {
            @SuppressWarnings("unchecked")
            T result = (T) e.value;
            return result;
        }
    }
    return setInitialValue();
}

由上可知，该方法先是获取当前执行的线程。每个线程都有一个 ThreadLocal.ThreadLocalMap 类型的名为 threadLocals 的变量，通过 ThreadLocal 保存的数据实际都存放在这个变量里，get 数据的 Key 值是 this 指向的 ThreadLocal 实例。
下面是 ThreadLocal.set() 方法如下：

public void set(T value) {
    Thread t = Thread.currentThread();  // 同get()方法
    ThreadLocalMap map = getMap(t);
    if (map != null)
        map.set(this, value);
    else
        createMap(t, value);
}

set() 方法也是首先获取当前正在执行的线程，再获得线程的 ThreaLocalMap 变量，再进行赋值。

我们提到，第一段代码的执行结果是 null 而不是 hello。首先，程序启动时会产生两个线程，一个是 main 线程，执行 main() 方法，另一个才是我们的 MyThread 实例，它的名字默认是 Thread-0。所以由于线程并行的缘故，代码 1 会先于代码 2 执行，所以 get() 先于 set() 就是结果为 null 原因？不，只是一部分原因。

我们将代码 3 取消注释，结果仍然是 null。下面我通过 Debug 来展示这一过程。
因为 thread.join() 方法，代码先执行到代码 2，对 ThreadLocal 变量进行赋值。

进入 ThreaLocal.set() 方法，我们可以看到当前线程 t 的是 Thread-0。也就是说
"hello" 这个值是保存在 MyThread 实例的 threadLocals 里的。

继续执行到代码 1。

进入ThreadLocal.get()方法，会发现当前线程 t 指向的线程却是 main 线程。

现在，我们可以理解第一段代码的执行结果为什么是 null 而不是 hello 了。因为我们在调用 set()方法赋值时，值是保存在 Thread-0 里的，而在get()取值又取的是 main 线程里的（因为是在 main() 方法里被调用），main 线程的 ThreadLocal 变量没有初始值也没有赋值，所以输出的结果就是 null。

所以这就是 Java Doc 提到的 ThreadLocal 的特性：

每个线程都有自己独立初始化的变量副本。

main()方法所在的 main 线程也不例外。