InheritableThreadLocal

ThreadLocal

在我之前的文章中介绍过什么是ThreadLocal，但是我现在有另一个需求，我想在子线程中获取到父线程中ThreadLocal的数据，例如下面的代码示例：

public class App11 {
    public static ThreadLocal<Integer> threadLocal = new ThreadLocal<>();
    public static void main(String[] args) throws InterruptedException {
        threadLocal.set(1);
        new Thread(()->{
            Integer data = threadLocal.get();
            System.out.printf("%s 获取到的值：%d\n",Thread.currentThread().getName(),data);
        }).start();
        TimeUnit.SECONDS.sleep(1L);
        System.out.printf("%s 获取到的值：%d\n",Thread.currentThread().getName(),threadLocal.get());
    }
}

如果了解ThreadLocal的话可以知道最后的打印结果如下：

Thread-0 获取到的值：null
main 获取到的值：1

如果我想在子线程中获取到父线程放入的值，我该怎么办呢？最简单的方法就是将该值传入到子线程，但是这种方式比较麻烦，有没有更简便的方式呢？

InheritableThreadLocal

对于上面所说的情况，我们只需要使用InheritableThreadLocal就能解决，修改代码如下：

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

我这里讲ThreadLocal直接改成InheritableThreadLocal，再次运行代码结果如下：

Thread-0 获取到的值：1
main 获取到的值：1

实现原理

通过上面的方式我们很简单的就实现了子线程获取到父线程中的值，那么InheritableThreadLocal是如何做到的呢？我们先看这个类的定义：

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

从代码结构上我们很容易看出它是ThreadLocal的一个子类，同时它重写了ThreadLocal中的三个方法。看到这里的实现你一定在想为什么要重写这三个方法呢？这里我先解释一下为什么要重写getMap方法和createMap方法。
在讲ThreadLocal是的时候我们见过，ThreadLocal是通过在Thread中保存ThreadLocal与数据的映射关系存在Thread的变量threadLocals中来实现的，而重写getMap它返回的是inheritableThreadLocals。简单的说就是InheritableThreadLocal是通过在Thread中保存InheritableThreadLocal与数据的映射关系存在Thread的变量inheritableThreadLocals中来实现的，这样做当我们在操作inheritableThreadLocals时将不会影响到ThreadLocal中的数据。而重写createMap的原因与getMap类似。

而childValue该方法是在父线程创建子线程，向子线程复制InheritableThreadLocal变量时使用。而InheritableThreadLocal中的实现对于向子线程复制值是并没有做任何改变，如果在上面的例子中，我们想在子线程获取到父线程的值时乘以10，我们可以继承InheritableThreadLocal并重写它的childValue方法即可：

public class App11 {
    //修改成我们自己的InheritableThreadLocal
    public static ThreadLocal<Integer> threadLocal = new MyInheritableThreadLocal();
    public static void main(String[] args) throws InterruptedException {
        threadLocal.set(1);
        new Thread(()->{
            Integer data = threadLocal.get();
            System.out.printf("%s 获取到的值：%d\n",Thread.currentThread().getName(),data);
        }).start();
        TimeUnit.SECONDS.sleep(1L);
        System.out.printf("%s 获取到的值：%d\n",Thread.currentThread().getName(),threadLocal.get());
    }
}
//自定义的InheritableThreadLocal
class MyInheritableThreadLocal extends InheritableThreadLocal<Integer>{
    @Override
    protected Integer childValue(Integer parentValue) {
        return parentValue * 10;
    }
}

最后的打印结果如下：

Thread-0 获取到的值：10
main 获取到的值：1

子线程是如何获取到父线程中的数据

在创建线程的构造方法中会调用一个init方法，应为该方法较长我截取了部分关键代码如下：

init方法.png

从上面代码可以知道，子线程中的inheritableThreadLocals是通过下面的代码获取的：

ThreadLocal.createInheritedMap(parent.inheritableThreadLocals)

我们直接继续跟踪ThreadLocal.createInheritedMap的实现直接就是调用ThreadLocalMap私有的有参构造方法，该方法的内部实现如下：

ThreadLocalMap私有有参构造方法.png

该方法的实现就是将父线程中inheritableThreadLocals的数据复制到子线程的inheritableThreadLocals中，从而实现了我们在子线程中可以获取到父线程中的值。

总结

如果明白ThreadLocal是如何实现的，再来理解InheritableThreadLocal的实现原理就很简单的了。简单的说就是ThreadLocal是通过将ThreadLocal与数据的映射关系存在Thread的变量threadLocals中来实现的，而InheritableThreadLocal则是将这种关系存在inheritableThreadLocals中，而在子线程创建时它会将父线程中inheritableThreadLocals的值复制到子线程的inheritableThreadLocals。

但是InheritableThreadLocal也有一个限制，在实际的开发中我们很少直接创建线程，一般都是通过线程池的方式来获取线程。这样也导致了InheritableThreadLocal在线程池中无法实现这种效果，因为线程池中的线程会重复利用。如果有这方面的需求，我们可以选择使用阿里开源的TransmittableThreadLocal来实现。