InheritableThreadLocal在全链路中的作用

由于 ThreadLocal 在父子线程交互中子线程无法访问到存储在父线程中的值，无法满足某些场景的需求，例如链路跟踪，例如如下场景：

为了解决上述问题，JDK 引入了 InheritableThreadLocal，即子线程可以访问父线程中的线程本地变量，更严谨的说法是子线程可以访问在创建子线程时父线程当时的本地线程变量，因为其实现原理就是在创建子线程将父线程当前存在的本地线程变量拷贝到子线程的本地线程变量中。

类图

从类的继承层次来看，InheritableThreadLocal 只是在 ThreadLocal 的 get、set、remove 流程中，重写了 getMap、createMap 方法，整体流程与 ThreadLocal 保持一致，故我们初步来看一下InheritableThreadLocal 是如何重写上述这两个方法的。

从代码得知，ThreadLocal 操作的是 Thread 对象的 threadLocals 属性，而 InheritableThreadLocal 操作的是 Thread 对象的 inheritableThreadLocals 属性。

温馨提示：createMap 被执行的条件是调用 InheritableThreadLocal#get、set 时如果线程的inheritableThreadLocals 属性为空时才会被调用。

那问题来了，InheritableThreadLocal 是如何继承自父对象的线程本地变量的呢？

线程上下文环境如何从父线程传递到子线程

这部分的代码入口为：Thread#init 方法

子线程是通过在父线程中通过调用 new Thread() 方法来创建子线程，Thread#init 方法就是在 Thread的构造方法中被调用。

代码@1：获取当前线程对象，即待创建的线程的父线程。

代码@2：如果父线程的 inheritableThreadLocals 不为空并且 inheritThreadLocals 为 true(该值默认为true)，则使用父线程的 inherit 本地变量的值来创建子线程的 inheritableThreadLocals 结构，即将父线程中的本地变量复制到子线程中。

上述代码就不一一分析，类似于 Map 的复制，只不过其在 Hash 冲突时，不是使用链表结构，而是直接在数组中找下一个为 null 的槽位。

温馨提示：子线程默认拷贝父线程的方式是浅拷贝，如果需要使用深拷贝，需要使用自定义ThreadLocal，继承 InheritableThreadLocal 并重写 childValue 方法

验证 InheritableThreadLocal 的特性

验证代码如下：

public class Service {

private static InheritableThreadLocal<Integer> requestIdThreadLocal = new InheritableThreadLocal<>();

public static void main(String[] args) {

Integer reqId = new Integer(5);

Service a = new Service();

a.setRequestId(reqId);

}

public void setRequestId(Integer requestId) {

requestIdThreadLocal.set(requestId);

doBussiness();

}

public void doBussiness() {

System.out.println("首先打印requestId:" + requestIdThreadLocal.get());

(new Thread(new Runnable() {

@Override

public void run() {

System.out.println("子线程启动");

System.out.println("在子线程中访问requestId:" + requestIdThreadLocal.get());

}

})).start();

}

}
复制代码

执行结果如下：

符合预期，在子线程中如愿访问到了在主线程中设置的本地环境变量。

InheritableThreadLocal 局限性

全链路压测必备基础组件之线程上下文管理之“三剑客”

原创2020-05-06 22:38·中间件兴趣圈

说起本地线程变量，我相信大家首先会想到的是 JDK 默认提供的 ThreadLocal，用来存储在整个调用链中都需要访问的数据，并且是线程安全的。

由于本文的写作背景是笔者需要在公司落地全链路压测平台，一个基本并核心的功能需求是压测标记需要在整个调用链中进行传递，线程上下文环境成为解决这个问题最合适的技术。

温馨提示：本从从 ThreadLocal 原理入手分析，并抛出其缺点，再逐一引出InheritableThreadLocal、TransmittableThreadLocal。文章篇幅稍长，但由于循序渐进，层层递进，故精华部分在后面。

1、ThreadLocal 详解

ThreadLocal对外提供;的API如下：

•  public T get(）
  从线程上下文环境中获取设置的值。

• public void set(T value)
  将值存储到线程上下文环境中，供后续使用。

• public void remove()
  清除线程本地上下文环境。

上述API使用简单，关键是要理解 ThreadLocal 的内部存储结果。

1.1 ThreadLocal存储结构

ThreadLocal 存储结构

上图的几个关键点如下：

•  数据存储位置
  当线程调用 threadLocal 对象的 set(Object value) 方法时，数据并不是存储在 ThreadLocal 对象中，而是存储在 Thread 对象中，这也是 ThreadLocal 的由来，具体存储在线程对象的threadLocals 属性中，其类型为 ThreadLocal.ThreadLocalMap。

•  ThreadLocal.ThreadLocalMap
  Map 结构，即键值对，键为 threadLocal 对象，值为需要存储到线程上下文的值(threadLocal#set)方法的参数。

1.2 源码分析 ThreadLocal

1.2.1 源码分析 get

ThreadLocal get 方法

代码@1：获取当前线程。

代码@2：获取线程的 threadLocals 属性，在上图中已展示其存储结构。

代码@3：如果线程对象的 threadLocals 属性不为空，则从该 Map 结构中，用 threadLocal 对象为键去查找值，如果能找到，则返回其 value 值，否则执行代码@4。

代码@4：如果线程对象的 threadLocals 属性为空，或未从 threadLocals 中找到对应的键值对，则调用该方法执行初始化

ThreadLocal#setInitialValue

代码@1：调用 initialValue() 获取默认初始化值，该方法默认返回 null，子类可以重写，实现线程本地变量的初始化。

代码@2：获取当前线程。

代码@3：获取该线程对象的 threadLocals 属性。

代码@4：如果不为空，则将 threadLocal:value 存入线程对象的 threadLocals 属性中。

代码@5：否则初始化线程对象的 threadLocals,然后将 threadLocal:value 键值对存入线程对象的threadLocals 属性中。

1.2.2 源码分析set

ThreadLocal#set

在掌握了 get 方法实现细节，set 方法、remove 其实现的逻辑基本一样，就是对线程对象的threadLocals 属性进行操作( Map结构)。

1.3 ThreadLocal局限性

经过上面的剖析，对 ThreadLocal 的内部存储与 set、get、remove 等实现细节都已理解，但ThreadLocal 无法在父子线程之间传递，示例代码如下：

父子传递 Demo

运行结果如下：

Demo 示例结果

从结果上来看，在子线程中无法访问在父线程中设置的本地线程变量，那我们该如何来解决该问题呢？

为了解决该问题，JDK引入了另外一个线程本地变量实现类 InheritableThreadLocal，接下来将重点介绍 InheritableThreadLocal 的实现原理。

2、InheritableThreadLocal

由于 ThreadLocal 在父子线程交互中子线程无法访问到存储在父线程中的值，无法满足某些场景的需求，例如链路跟踪，例如如下场景：

为了解决上述问题，JDK 引入了 InheritableThreadLocal，即子线程可以访问父线程中的线程本地变量，更严谨的说法是子线程可以访问在创建子线程时父线程当时的本地线程变量，因为其实现原理就是在创建子线程将父线程当前存在的本地线程变量拷贝到子线程的本地线程变量中。

2.1 类图

InheritableThreadLocal 类图

从类的继承层次来看，InheritableThreadLocal 只是在 ThreadLocal 的 get、set、remove 流程中，重写了 getMap、createMap 方法，整体流程与 ThreadLocal 保持一致，故我们初步来看一下InheritableThreadLocal 是如何重写上述这两个方法的。

InheritableThreadLocal#getMap

从代码得知，ThreadLocal 操作的是 Thread 对象的 threadLocals 属性，而 InheritableThreadLocal 操作的是 Thread 对象的 inheritableThreadLocals 属性。

温馨提示：createMap 被执行的条件是调用 InheritableThreadLocal#get、set 时如果线程的inheritableThreadLocals 属性为空时才会被调用。

那问题来了，InheritableThreadLocal 是如何继承自父对象的线程本地变量的呢？

2.2 线程上下文环境如何从父线程传递到子线程

这部分的代码入口为：Thread#init 方法

Thread#init

子线程是通过在父线程中通过调用 new Thread() 方法来创建子线程，Thread#init 方法就是在 Thread的构造方法中被调用。

代码@1：获取当前线程对象，即待创建的线程的父线程。

代码@2：如果父线程的 inheritableThreadLocals 不为空并且 inheritThreadLocals 为 true(该值默认为true)，则使用父线程的 inherit 本地变量的值来创建子线程的 inheritableThreadLocals 结构，即将父线程中的本地变量复制到子线程中。

createInheritedMap

上述代码就不一一分析，类似于 Map 的复制，只不过其在 Hash 冲突时，不是使用链表结构，而是直接在数组中找下一个为 null 的槽位。

温馨提示：子线程默认拷贝父线程的方式是浅拷贝，如果需要使用深拷贝，需要使用自定义ThreadLocal，继承 InheritableThreadLocal 并重写 childValue 方法。

2.3 验证 InheritableThreadLocal 的特性

验证代码如下：

public class Service {

private static InheritableThreadLocal<Integer> requestIdThreadLocal = new InheritableThreadLocal<>();

public static void main(String[] args) {

Integer reqId = new Integer(5);

Service a = new Service();

a.setRequestId(reqId);

}

public void setRequestId(Integer requestId) {

requestIdThreadLocal.set(requestId);

doBussiness();

}

public void doBussiness() {

System.out.println("首先打印requestId:" + requestIdThreadLocal.get());

(new Thread(new Runnable() {

@Override

public void run() {

System.out.println("子线程启动");

System.out.println("在子线程中访问requestId:" + requestIdThreadLocal.get());

}

})).start();

}

}
复制代码

执行结果如下：

符合预期，在子线程中如愿访问到了在主线程中设置的本地环境变量。

2.4 InheritableThreadLocal 局限性

InheritableThreadLocal 支持子线程访问在父线程的核心思想是在创建线程的时候将父线程中的本地变量值复制到子线程，即复制的时机为创建子线程时。但我们提到并发、多线程就理不开线程池的使用，因为线程池能够复用线程，减少线程的频繁创建与销毁，如果使用 InheritableThreadLocal，那么线程池中的线程拷贝的数据来自于第一个提交任务的外部线程，即后面的外部线程向线程池中提交任务时，子线程访问的本地变量都来源于第一个外部线程，造成线程本地变量混乱，验证代码如下：

import java.util.concurrent.ExecutorService;

import java.util.concurrent.Executors;

public class Service {

/**

* 模拟tomcat线程池

*/

private static ExecutorService tomcatExecutors = Executors.newFixedThreadPool(10);

/**

* 业务线程池，默认Control中异步任务执行线程池

*/

private static ExecutorService businessExecutors = Executors.newFixedThreadPool(5);

/**

* 线程上下文环境，模拟在Control这一层，设置环境变量，然后在这里提交一个异步任务，模拟在子线程中，是否可以访问到刚设置的环境变量值。

*/

private static InheritableThreadLocal<Integer> requestIdThreadLocal = new InheritableThreadLocal<>();

public static void main(String[] args) {

for(int i = 0; i < 10; i ++ ) { // 模式10个请求，每个请求执行ControlThread的逻辑，其具体实现就是，先输出父线程的名称，

// 然后设置本地环境变量，并将父线程名称传入到子线程中，在子线程中尝试获取在父线程中的设置的环境变量

tomcatExecutors.submit(new ControlThread(i));

}

//简单粗暴的关闭线程池

try {

Thread.sleep(10000);

} catch (InterruptedException e) {

e.printStackTrace();

}

businessExecutors.shutdown();

tomcatExecutors.shutdown();

}

/**

* 模拟Control任务

*/

static class ControlThread implements Runnable {

private int i;

public ControlThread(int i) {

this.i = i;

}

@Override

public void run() {

System.out.println(Thread.currentThread().getName() + ":" + i);

requestIdThreadLocal.set(i);

//使用线程池异步处理任务

businessExecutors.submit(new BusinessTask(Thread.currentThread().getName()));

}

}

/**

* 业务任务，主要是模拟在Control控制层，提交任务到线程池执行

*/

static class BusinessTask implements Runnable {

private String parentThreadName;

public BusinessTask(String parentThreadName) {

this.parentThreadName = parentThreadName;

}

@Override

public void run() {

//如果与上面的能对应上来，则说明正确，否则失败

System.out.println("parentThreadName:" + parentThreadName + ":" + requestIdThreadLocal.get());

}

}

}
复制代码

执行效果如下：

pool-1-thread-1:0

pool-1-thread-2:1

pool-1-thread-3:2

pool-1-thread-4:3

pool-1-thread-5:4

pool-1-thread-6:5

pool-1-thread-7:6

pool-1-thread-8:7

pool-1-thread-9:8

pool-1-thread-10:9

parentThreadName:pool-1-thread-7:6

parentThreadName:pool-1-thread-4:6

parentThreadName:pool-1-thread-3:6

parentThreadName:pool-1-thread-2:6

parentThreadName:pool-1-thread-1:6

parentThreadName:pool-1-thread-9:6

parentThreadName:pool-1-thread-10:6

parentThreadName:pool-1-thread-8:7

parentThreadName:pool-1-thread-6:5

parentThreadName:pool-1-thread-5:4
复制代码

从这里可以出 thread-7、thread-4、thread-3、thread-2、thread-1、thread-9、thread-10 获取的都是6，在子线程中出现出现了线程本地变量混乱的现象，在全链路跟踪与压测出现这种情况是致命的。