精通Java并发编程N+4：InheritableThreadLocal（可继承的ThreadLocal）详解

精通Java并发编程N+4：InheritableThreadLocal（可继承的ThreadLocal）详解

一、前言

前一段时间做了个服务调用链路追踪的需求，最后需要把trace信息通过Mybatis Plugin持久化到每个业务表中；以供后面的日志审计服务使用。 其中我采用ThreadLocal把trace信息传递到Mybatis Plugin中，不过由于存在 在dubbo接口 / Rest接口中采用new Threa()、CompleteFuture的方式启动一个异步线程去做DB数据（走MyBatis）的持久化，这时ThreadLocal就无法将trace信息传递到Mybatis Plugin，因此有了今天​​​InheritableThreadLocal​​的故事。

二、InheritableThreadLocal概述

​​InheritableThreadLocal​​用于实现 父线程生成的变量可以自动传递到子线程中进行使用 的需求。

从类的构造来看，​​InheritableThreadLocal​​继承自​​ThreadLocal​​；

在编码使用上，​​InheritableThreadLocal​​​和ThreadLocal没有任何区别，只是在实例化的对象的时候使用​​ new InheritableThreadLocal<>()​​。

1、ThreadLocal的使用

public class ParentChildThreadLocal { public final static ThreadLocal threadLocal = new ThreadLocal<>(); public static void main(String[] args) { threadLocal.set("haha, parent-child variables!"); System.out.println("父线程的值（threadLocal）：" + threadLocal.get()); // 开启子线程 new Thread(() -> { System.out.println("子线程继承到的值（threadLocal）: " + threadLocal.get()); }).start(); try { TimeUnit.SECONDS.sleep(2); } catch (InterruptedException e) { e.printStackTrace(); } }}

上述代码中，实例化一个ThreadLocal变量，在main线程中对ThreadLocal变量进行赋值、取值，并在main线程中开启一个子线程获取main线程中ThreadLocal变量的值。执行结果如下：

从运行结果可以看出，使用​​ThreadLocal​​时，子线程无法获取到父线程中的本地变量值。

2、InheritableThreadLocal的使用

public class ParentChildThreadLocal { public final static InheritableThreadLocal inheritableThreadLocal = new InheritableThreadLocal<>(); public static void main(String[] args) { inheritableThreadLocal.set("haha, parent-child variables!"); System.out.println("父线程的值（InheritableThreadLocal）：" + inheritableThreadLocal.get()); // 开启子线程 new Thread(() -> { System.out.println("子线程继承到的值（InheritableThreadLocal）: " + inheritableThreadLocal.get()); }).start(); try { TimeUnit.SECONDS.sleep(2); } catch (InterruptedException e) { e.printStackTrace(); } }}

上述代码中，实例化一个InheritableThreadLocal变量，在main线程中对InheritableThreadLocal变量进行赋值、取值，并在main线程中开启一个子线程获取main线程中InheritableThreadLocal变量的值。执行结果如下：

从运行结果可以看出，使用​​InheritableThreadLocal​​之后，子线程可以获取到父线程中的本地变量值。

那么为什么呢？下面来跟一下InheritableThreadLocal的源码。

三、InheritableThreadLocal源码分析

经过上面的测试代码，我们可以推测出InheritableThreadLocal是ThreadLocal派生出专门用于解决线程本地变量父传子问题的，这里我们通过源码分析一下InheritableThreadLocal是如何完成这一操作的！

1、Thread类构成

Thread类中包含 threadLocals 和 inheritableThreadLocals 两个变量，其中 inheritableThreadLocals 用于存储可自动从父线程向子线程中传递的ThreadLocal.ThreadLocalMap。

1> Thread#inheritableThreadLocals变量

接着，来看一下创建线程时如何实现ThreadLocal在父子线程之间的传递；

而此处所谓的父线程，指想调用new Thread()实例化一个线程的当前线程。

2> ThreadLocal#createInheritedMap()

再看ThreadLocal#createInheritedMap()方法是如何将父线程中的​​inheritableThreadLocals​​传递到子线程的。

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

本质上就是实例化一个ThreadLocalMap：

private ThreadLocalMap(ThreadLocalMap parentMap) { Entry[] parentTable = parentMap.table; int len = parentTable.length; setThreshold(len); // ThreadLocalMap 使用 Entry[] table 存储ThreadLocal table = new Entry[len]; // 逐一复制 parentMap中的所有ThreadLocal记录 for (int j = 0; j < len; j++) { Entry e = parentTable[j]; if (e != null) { @SuppressWarnings("unchecked") ThreadLocal