📌 TransmittableThreadLocal(TTL) 📌

📖 English Documentation | 📖 中文文档

• 🔧 功能
• 🎨 需求场景
• 👥 User Guide
  • 1. 简�?�使用
  • 2. �?�?线程池中传递值
    • 2.1 修饰Runnable和Callable
      • 整个过程的完整时�?图
    • 2.2 修饰线程池
    • 2.3 使用Java Agent�?�修饰JDK线程池实现类
      • 关于boot class path设置
      • Java的�?�动�?�数�?置
• 🔌 Java API Docs
• �?� Maven�?赖
• 🔨 关于编译构建与IDE开�?�
• �?� FAQ
• 🗿 更多文档
• 📚 相关资料
  • Jdk Core Classes
• 👷 Contributors

🔧 功能

👉 在使用线程池等会池化�?用线程的执行组件情况下，�??供ThreadLocal值的传递功能，解决异步执行时上下文传递的问题。 一个Java标准库本应为框架/中间件设施开�?��??供的标�?能力，本库功能�?�焦 & 0�?赖，支�?Java 16/15/14/13/12/11/10/9/8/7/6。

JDK的InheritableThreadLocal类�?�以完�?父线程到�?线程的值传递。但对于使用线程池等会池化�?用线程的执行组件的情况，线程由线程池创建好，并且线程是池化起�?��??�?使用的；这时父�?线程关系的ThreadLocal值传递已�?没有�?义，应用需�?的实际上是把 任务�??交给线程池时的ThreadLocal值传递到 任务执行时。

本库�??供的TransmittableThreadLocal类继承并加强InheritableThreadLocal类，解决上述的问题，使用详�?User Guide。

整个TransmittableThreadLocal库的核心功能（用户API与框架/中间件的集�?API�?线程池ExecutorService/ForkJoinPool/TimerTask�?�其线程工厂的Wrapper），�?�有 ~1000 SLOC代�?行，�?�常精�?。

欢迎 �?

• 建议和�??问，�??交Issue
• 贡献和改进，Fork�?��??通过Pull Request贡献代�?

🎨 需求场景

在ThreadLocal的需求场景�?�是TransmittableThreadLocal的潜在需求场景，如果你的业务需�?『在使用线程池等会池化�?用线程的执行组件情况下传递ThreadLocal�?则是TransmittableThreadLocal目标场景。

下�?�是几个典型场景例�?。

1. 分布�?跟踪系统 或 全链路压测（�?�链路打标）
2. 日志收集记录系统上下文
3. Session级Cache
4. 应用容器或上层框架跨应用代�?给下层SDK传递信�?�

�?�个场景的展开说明�?��?�?文档 需求场景。

👥 User Guide

使用类TransmittableThreadLocal�?��?存值，并跨线程池传递。

TransmittableThreadLocal继承InheritableThreadLocal，使用方�?也类似。

相比InheritableThreadLocal，添加了

1. copy方法
   用于定制 任务�??交给线程池时 的ThreadLocal值传递到 任务执行时 的拷�?行为，缺�?传递的是引用。
   注�?：如果跨线程传递了对象引用因为�?�?有线程�?闭，与InheritableThreadLocal.childValue一样，使用者/业务逻辑�?注�?传递对象的线程安全。
2. protected的beforeExecute/afterExecute方法
   执行任务(Runnable/Callable)的�?/�?�的生命周期回调，缺�?是空�?作。

具体使用方�?�?下�?�的说明。

1. 简�?�使用

父线程给�?线程传递值。

示例代�?：

TransmittableThreadLocal<String> context = new TransmittableThreadLocal<>();

// =====================================================

// 在父线程中设置
context.set("value-set-in-parent");

// =====================================================

// 在�?线程中�?�以读�?�，值是"value-set-in-parent"
String value = context.get();

# 完整�?��?行的Demo代�?�?��?SimpleDemo.kt。

这是其实是InheritableThreadLocal的功能，应该使用InheritableThreadLocal�?�完�?。

但对于使用线程池等会池化�?用线程的执行组件的情况，线程由线程池创建好，并且线程是池化起�?��??�?使用的；这时父�?线程关系的ThreadLocal值传递已�?没有�?义，应用需�?的实际上是把 任务�??交给线程池时的ThreadLocal值传递到 任务执行时。

解决方法�?��?下�?�的这几�?用法。

2. �?�?线程池中传递值

2.1 修饰Runnable和Callable

使用TtlRunnable和TtlCallable�?�修饰传入线程池的Runnable和Callable。

示例代�?：

TransmittableThreadLocal<String> parent = new TransmittableThreadLocal<>();

// =====================================================

// 在父线程中设置
context.set("value-set-in-parent");

Runnable task = new RunnableTask();
// �?外的处�?�，生�?修饰了的对象ttlRunnable
Runnable ttlRunnable = TtlRunnable.get(task);
executorService.submit(ttlRunnable);

// =====================================================

// Task中�?�以读�?�，值是"value-set-in-parent"
String value = context.get();

上�?�演示了Runnable，Callable的处�?�类似

TransmittableThreadLocal<String> parent = new TransmittableThreadLocal<>();

// =====================================================

// 在父线程中设置
context.set("value-set-in-parent");

Callable call = new CallableTask();
// �?外的处�?�，生�?修饰了的对象ttlCallable
Callable ttlCallable = TtlCallable.get(call);
executorService.submit(ttlCallable);

// =====================================================

// Call中�?�以读�?�，值是"value-set-in-parent"
String value = context.get();

# 完整�?��?行的Demo代�?�?��?TtlWrapperDemo.kt。

整个过程的完整时�?图

2.2 修饰线程池

�?去�?次Runnable和Callable传入线程池时的修饰，这个逻辑�?�以在线程池中完�?。

通过工具类com.alibaba.ttl.threadpool.TtlExecutors完�?，有下�?�的方法：

• getTtlExecutor：修饰接�?�Executor
• getTtlExecutorService：修饰接�?�ExecutorService
• getTtlScheduledExecutorService：修饰接�?�ScheduledExecutorService

示例代�?：

ExecutorService executorService = ...
// �?外的处�?�，生�?修饰了的对象executorService
executorService = TtlExecutors.getTtlExecutorService(executorService);

TransmittableThreadLocal<String> context = new TransmittableThreadLocal<>();

// =====================================================

// 在父线程中设置
context.set("value-set-in-parent");

Runnable task = new RunnableTask();
Callable call = new CallableTask();
executorService.submit(task);
executorService.submit(call);

// =====================================================

// Task或是Call中�?�以读�?�，值是"value-set-in-parent"
String value = context.get();

# 完整�?��?行的Demo代�?�?��?TtlExecutorWrapperDemo.kt。

2.3 使用Java Agent�?�修饰JDK线程池实现类

这�?方�?，实现线程池的传递是�?明的，业务代�?中没有修饰Runnable或是线程池的代�?。�?��?�以�?�到应用代�? 无侵入。
# 关于 无侵入 的更多说明�?��?文档Java Agent方�?对应用代�?无侵入。

示例代�?：

// ## 1. 框架上层逻辑，�?�续�?程框架调用业务 ##
TransmittableThreadLocal<String> context = new TransmittableThreadLocal<>();
context.set("value-set-in-parent");

// ## 2. 应用逻辑，�?�续�?程业务调用框架下层逻辑 ##
ExecutorService executorService = Executors.newFixedThreadPool(3);

Runnable task = new RunnableTask();
Callable call = new CallableTask();
executorService.submit(task);
executorService.submit(call);

// ## 3. 框架下层逻辑 ##
// Task或是Call中�?�以读�?�，值是"value-set-in-parent"
String value = context.get();

Demo�?��?AgentDemo.kt。执行工程下的脚本scripts/run-agent-demo.sh�?��?��?行Demo。

目�?TTL Agent中，修饰了的JDK执行器组件（�?�如线程池）如下：

1. java.util.concurrent.ThreadPoolExecutor 和 java.util.concurrent.ScheduledThreadPoolExecutor
   • 修饰实现代�?在TtlExecutorTransformlet.java。
2. java.util.concurrent.ForkJoinTask（对应的执行器组件是java.util.concurrent.ForkJoinPool）
   • 修饰实现代�?在TtlForkJoinTransformlet.java。从版本 2.5.1 开始支�?。
   • 注�?：Java 8引入的CompletableFuture与（并行执行的）Stream底层是通过ForkJoinPool�?�执行，所以支�?ForkJoinPool�?�，TTL也就�?明支�?了CompletableFuture与Stream。🎉
3. java.util.TimerTask的�?类（对应的执行器组件是java.util.Timer）
   • 修饰实现代�?在TtlTimerTaskTransformlet.java。从版本 2.7.0 开始支�?。
   • 注�?：从2.11.2版本开始缺�?开�?�TimerTask的修饰（因为�?�?正确性是第一�?，而�?是最佳实践『�?推�??使用TimerTask�?:）；2.11.1版本�?�其之�?的版本没有缺�?开�?�TimerTask的修饰。
   • 使用Agent�?�数ttl.agent.enable.timer.task开�?�/关闭TimerTask的修饰：
     • -javaagent:path/to/transmittable-thread-local-2.x.x.jar=ttl.agent.enable.timer.task:true
     • -javaagent:path/to/transmittable-thread-local-2.x.x.jar=ttl.agent.enable.timer.task:false
   • 更多关于TTL Agent�?�数的�?置说明详�?TtlAgent.java的JavaDoc。

关于java.util.TimerTask/java.util.Timer

Timer是JDK 1.3的�?类，�?推�??使用Timer类。

推�??用ScheduledExecutorService。
ScheduledThreadPoolExecutor实现更强壮，并且功能更丰富。 如支�?�?置线程池的大�?（Timer�?�有一个线程）；Timer在Runnable中抛出异常会中止定时执行。更多说明�?��?10. Mandatory Run multiple TimeTask by using ScheduledExecutorService rather than Timer because Timer will kill all running threads in case of failing to catch exceptions. - Alibaba Java Coding Guidelines。

关于boot class path设置

因为修饰了JDK标准库的类，标准库由bootstrap class loader加载；修饰�?�的JDK类引用了TTL的代�?，所以Java Agent使用方�?下TTL Jar文件需�?�?置到boot class path上。

TTL从v2.6.0开始，加载TTL Agent时会自动设置TTL Jar到boot class path上。
注�?：�?能修改从Maven库下载的TTL Jar文件�??（形如transmittable-thread-local-2.x.x.jar）。 如果修改了，则需�?自己手动通过-Xbootclasspath JVM�?�数�?�显�?�?置（就�?TTL之�?的版本的�?�法一样）。

自动设置TTL Jar到boot class path的实现是通过指定TTL Java Agent Jar文件里manifest文件（META-INF/MANIFEST.MF）的Boot-Class-Path属性：

Boot-Class-Path

A list of paths to be searched by the bootstrap class loader. Paths represent directories or libraries (commonly referred to as JAR or zip libraries on many platforms). These paths are searched by the bootstrap class loader after the platform specific mechanisms of locating a class have failed. Paths are searched in the order listed.

更多详�?

• Java Agent规范 - JavaDoc
• JAR File Specification - JAR Manifest
• Working with Manifest Files - The Java™ TutorialsHide

Java的�?�动�?�数�?置

在Java的�?�动�?�数加上：-javaagent:path/to/transmittable-thread-local-2.x.x.jar。

如果修改了下载的TTL的Jar的文件�??（transmittable-thread-local-2.x.x.jar），则需�?自己手动通过-Xbootclasspath JVM�?�数�?�显�?�?置：
比如修改文件�??�?ttl-foo-name-changed.jar，则还加上Java的�?�动�?�数：-Xbootclasspath/a:path/to/ttl-foo-name-changed.jar

Java命令行示例如下：

java -javaagent:path/to/transmittable-thread-local-2.x.x.jar \
    -cp classes \
    com.alibaba.demo.ttl.agent.AgentDemo

或是

# 如果修改了TTL jar文件�?? 或 TTL版本是 2.6.0 之�?，
# 则还需�?显�?设置 -Xbootclasspath �?�数
java -javaagent:path/to/ttl-foo-name-changed.jar \
    -Xbootclasspath/a:path/to/ttl-foo-name-changed.jar \
    -cp classes \
    com.alibaba.demo.ttl.agent.AgentDemo

🔌 Java API Docs

当�?版本的Java API文档地�?�： https://alibaba.github.io/transmittable-thread-local/apidocs/

�?� Maven�?赖

示例：

<dependency>
    <groupId>com.alibaba</groupId>
    <artifactId>transmittable-thread-local</artifactId>
    <version>2.11.5</version>
</dependency>

�?�以在 search.maven.org 查看�?�用的版本。

🔨 关于编译构建与IDE开�?�

编译构建的环境�?求： JDK 8~11；用Maven常规的方�?执行编译构建�?��?�：
# 在工程中已�?包�?�了符�?�版本�?求的Maven，直接�?行 工程根目录下的mvnw；并�?需�?先手动自己安装好Maven。

# �?行测试Case
./mvnw test
# 编译打包
./mvnw package
# �?行测试Case�?编译打包�?安装TTL库到Maven本地
./mvnw install

#####################################################
# 如果使用你自己安装的`Maven`，版本�?求：maven 3.3.9+
mvn install

如何用IDE�?�开�?�时注�?点，更多说明�?��? 文档 如何用IDE开�?� - Developer Guide。

�?� FAQ

• Mac OS X下，使用javaagent，�?�能会报JavaLaunchHelper的出错信�?�。
  JDK Bug: http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=8021205
  �?�以�?�一个版本的JDK。我的开�?�机上1.7.0_40有这个问题，1.6.0_51�?1.7.0_45�?�以�?行。
  # 1.7.0_45还是有JavaLaunchHelper的出错信�?�，但�?影�?�?行。

🗿 更多文档

• 🎨 需求场景说明
• 🎓 Developer Guide
• ☔ 性能测试

📚 相关资料

Jdk Core Classes

• WeakHashMap
• InheritableThreadLocal

👷 Contributors

• Jerry Lee <oldratlee at gmail dot com> @oldratlee
• Yang Fang <snoop.fy at gmail dot com> @driventokill
• Zava Xu <zava.kid at gmail dot com> @zavakid
• wuwen <wuwen.55 at aliyun dot com> @wuwen5
• Xiaowei Shi <179969622 at qq dot com> @xwshiustc
• David Dai <351450944 at qq dot com> @LNAmp
• Your name here :-)