ThreadLocal (下) 继承性问题解决，以及具体实现原理---YanL

ThreadLocal不支持继承性

首先看一个例子

public class TestThreadLocal { // (1) 创建线程变量 public static ThreadLocal<String> threadLocal = new ThreadLocal<String>(); public static void main(String[] args) { // (2) 设置线程变量 threadLocal.set("hello world"); // (3) 启动子线程 Thread thread = new Thread(new Runnable() { @Override public void run() { // (4) 子线程输出线程变量的值 System.out.println("thread: " + threadLocal.get()); } }); thread.start(); // (5) 主线程获取并输出threadLocal的值 System.out.println("main: " + threadLocal.get()); } }

输出结果如下:

image-20200408173326730.png

通过以上例子可以看到，同一个ThreadLocal变量在父线程中设置值后，在子线程是取不到的。根据上节的介绍，这应该是正常现象。因为子线程thread里面调用get方法时当前线程为thread线程，而这里调用set方法设置的变量时main线程，两者是不同线程，自然子线程访问时放回null。那么有没有办法让子线程能访问到父线程中的值，当然是有的哈哈哈！

InheritableThreadLocal

为了解决上节提出的问题，InheritableThreadLocal应运而生。InheritableThreadLocal继承自ThreadLocal，其提供了一个特性，就是让子线程可以访问在父线程中设置的本地变量。下面看一下InheritableThreadLocal的代码。

public class InheritableThreadLocal<T> extends ThreadLocal<T> { // (1) protected T childValue(T parentValue) { return parentValue; } // (2) ThreadLocalMap getMap(Thread t) { return t.inheritableThreadLocals; } // (3) void createMap(Thread t, T firstValue) { t.inheritableThreadLocals = new ThreadLocalMap(this, firstValue); } }

由上代码可知，InheritableThreadLocal继承自ThreadLocal，并重写了三个方法。由代码 (3) 可知，InheritableThreadLocal重写了createMap方法，那么现在当第一次调用set方法时，创建的是当前线程inheritableThreadLocals变量而不再是threadLocals。由代码 (2) 可知，当调用get方法获取内部的map变量时，获取的是inheritableThreadLocals而不是threadLocals。

综上可知，在InheritableThreadLocal的世界里，变量inheritableThreadLocals替代了threadLocals。

下面我们看一下重写的代码 (1) 何时执行，以及如何让子线程可以访问到父线程的本地变量。这要从创建Thread的代码说去，打开Thread类的默认构造函数，代码如下。

public Thread(Runnable target) { init(null, target, "Thread-" + nextThreadNum(), 0); } private void init(ThreadGroup g, Runnable target, String name, long stackSize, AccessControlContext acc) { ····· // (4) 获取当前线程 Thread parent = currentThread(); ····· // (5) 如果父线程的inheritableThreadLocals变量不为null if (parent.inheritableThreadLocals != null) // (6) 设置子线程中的inheritableThreadLocals变量 this.inheritableThreadLocals = ThreadLocal.createInheritedMap(parent.inheritableThreadLocals); this.stackSize = stackSize; tid = nextThreadID(); }

如上代码在创建线程时，在构造函数里面会调用init方法。代码 (4) 获取了当前线程(这里指main函数所在的线程，也就是父线程)，然后代码 (5) 判断main函数所在的线程里面的inheritableThreadLocal属性是否为null，前面我们讲了InheritableThreadLocal类的get和set方法操作的都是inheritableThreadLocals，所以这里inheritableThreadLocals变量不为null，因此会执行代码 (6)。下面看一下createInheritedMap的代码。

static ThreadLocalMap createInheritedMap(ThreadLocalMap parentMap) { return new ThreadLocalMap(parentMap); }

可以看到，在createInheritedMap内部使用父线程的inheritableThreadLocals变量作为构造函数创建了一个新的ThreadLocalMap变量，然后赋值给了子线程的inheritableThreadLocals变量。限免我们看看在ThreadLocalMap的构造函数内部都做了什么事情。

private ThreadLocalMap(ThreadLocalMap parentMap) { Entry[] parentTable = parentMap.table; int len = parentTable.length; setThreshold(len); table = new Entry[len]; for (int j = 0; j < len; j++) { Entry e = parentTable[j]; if (e != null) { @SuppressWarnings("unchecked") ThreadLocal<Object> key = (ThreadLocal<Object>) e.get(); if (key != null) { // (7) 调用重写方法 Object value = key.childValue(e.value); Entry c = new Entry(key, value); int h = key.threadLocalHashCode & (len - 1); while (table[h] != null) h = nextIndex(h, len); table[h] = c; size++; } } } }

在构造函数内部把父线程的inheritableThreadLocals成员变量的值复制到新的ThreadLocalMap对象中，其中代码 (7) 调用了InheritableThreadLocal类重写的代码 (1)。

总结:

InheritableThreadLocal 类通过重写代码 (2) 和 (3) 让本地变量保存到了具体线程的inheritableThreadLocals变量里面，那么线程再通过InheritableThreadLocal类实例的set或get方法设置变量时，就会创建当前线程的inheritableThreadLocals变量。当父线程创建子线程时，构造函数会把父线程中inheritableThreadLocals变量里面的本地变量复制一份保存到子线程的inheritableThreadLocals变量里面。

把第一个例子代码的 (1) 修改为

public static ThreadLocal<String> threadLocal = new InheritableThreadLocal<String>();

运行结果如下:

image-20200408184018568.png

可以看到现在可以从子线程正常获取到线程变量的值了。

那么在什么情况下需要子线程可以获取父线程的threadLocal变量呢？还挺多比如，子线程需要拿到存放在threadLocal变量中的用户登录信息，有的中间件需要把统一的id追踪到的整个调用链路记录下来。其实子线程使用父线程中的threadLocal方法由多种方式，比如创建线程时传入父线程中的变量，并将其复制到子线程中，或者在父线程中构造一个map作为参数传递给子线程，但是这些都改变了我们的使用习惯，所以在这些情况下InheritableThreadLocal就显得比较有用了

---来自腾讯云社区的---YanL