Spring Boot 自定义线程池实现异步开发相信看过陈某的文章都了解，但是在实际开发中需要在父子线程之间传递一些数据，比如用户信息，链路信息等等
比如用户登录信息使用ThreadLocal存放保证线程隔离，代码如下：
/**
* @author 公众号：码猿技术专栏
* @description 用户上下文信息
*/
public class OauthContext {
private static final ThreadLocal loginValThreadLocal=new ThreadLocal<>();
public static LoginVal get(){
return loginValThreadLocal.get();
}
public static void set(LoginVal loginVal){
loginValThreadLocal.set(loginVal);
}
public static void clear(){
loginValThreadLocal.remove();
}
}
那么子线程想要获取这个LoginVal如何做呢？
今天就来介绍几种优雅的方式实现Spring Boot 内部的父子线程的数据传递。
1. 手动设置
每执行一次异步线程都要分为两步：
-
-
代码如下：
public void handlerAsync() {
//1. 获取父线程的loginVal
LoginVal loginVal = OauthContext.get();
log.info("父线程的值：{}",OauthContext.get());
CompletableFuture.runAsync(()->{
//2. 设置子线程的值，复用
OauthContext.set(loginVal);
log.info("子线程的值：{}",OauthContext.get());
});
}
虽然能够实现目的，但是每次开异步线程都需要手动设置，重复代码太多，看了头疼，你认为优雅吗？
2. 线程池设置TaskDecorator
TaskDecorator是什么？官方api的大致意思：这是一个执行回调方法的装饰器，主要应用于传递上下文，或者提供任务的监控/统计信息。
知道有这么一个东西，如何去使用？
TaskDecorator是一个接口，首先需要去实现它，代码如下：
/**
* @author 公众号：码猿技术专栏
* @description 上下文装饰器
*/
public class ContextTaskDecorator implements TaskDecorator {
@Override
public Runnable decorate(Runnable runnable) {
//获取父线程的loginVal
LoginVal loginVal = OauthContext.get();
return () -> {
try {
// 将主线程的请求信息，设置到子线程中
OauthContext.set(loginVal);
// 执行子线程，这一步不要忘了
runnable.run();
} finally {
// 线程结束，清空这些信息，否则可能造成内存泄漏
OauthContext.clear();
}
};
}
}
这里我只是设置了LoginVal，实际开发中其他的共享数据，比如
SecurityContext
，
RequestAttributes
....
TaskDecorator
需要结合线程池使用，实际开发中异步线程建议使用线程池，只需要在对应的线程池配置一下，代码如下：
@Bean("taskExecutor")
public ThreadPoolTaskExecutor taskExecutor() {
ThreadPoolTaskExecutor poolTaskExecutor = new ThreadPoolTaskExecutor();
poolTaskExecutor.setCorePoolSize(xx);
poolTaskExecutor.setMaxPoolSize(xx);
// 设置线程活跃时间（秒）
poolTaskExecutor.setKeepAliveSeconds(xx);
// 设置队列容量
poolTaskExecutor.setQueueCapacity(xx);
//设置TaskDecorator，用于解决父子线程间的数据复用
poolTaskExecutor.setTaskDecorator(new ContextTaskDecorator());
poolTaskExecutor.setRejectedExecutionHandler(new ThreadPoolExecutor.CallerRunsPolicy());
// 等待所有任务结束后再关闭线程池
poolTaskExecutor.setWaitForTasksToCompleteOnShutdown(true);
return poolTaskExecutor;
}
此时业务代码就不需要去设置子线程的值，直接使用即可，代码如下：
public void handlerAsync() {
log.info("父线程的用户信息：{}", OauthContext.get());
//执行异步任务，需要指定的线程池
CompletableFuture.runAsync(()-> log.info("子线程的用户信息：{}", OauthContext.get()),taskExecutor);
}
来看一下结果，如下图：
这里使用的是
CompletableFuture
执行异步任务，使用
@Async
这个注解同样是可行的。
注意
：无论使用何种方式，都需要指定线程池
3. InheritableThreadLocal
这种方案不建议使用，InheritableThreadLocal虽然能够实现父子线程间的复用，但是在线程池中使用会存在复用的问题。
这种方案使用也是非常简单，直接用InheritableThreadLocal替换ThreadLocal即可，代码如下：
/**
* @author 公众号：码猿技术专栏
* @description 用户上下文信息
*/
public class OauthContext {
private static final InheritableThreadLocal loginValThreadLocal=new InheritableThreadLocal<>();
public static LoginVal get(){
return loginValThreadLocal.get();
}
public static void set(LoginVal loginVal){
loginValThreadLocal.set(loginVal);
}
public static void clear(){
loginValThreadLocal.remove();
}
}
4. TransmittableThreadLocal
TransmittableThreadLocal是阿里开源的工具，弥补了InheritableThreadLocal的缺陷，在使用线程池等会池化复用线程的执行组件情况下，提供
ThreadLocal
值的传递功能，解决异步执行时上下文传递的问题。
使用起来也是非常简单，添加依赖如下：
<dependency>
<groupId>com.alibabagroupId>
<artifactId>transmittable-thread-localartifactId>
<version>2.14.2version>
dependency>
OauthContext改造代码如下：
/**
* @author 公众号：码猿技术专栏
* @description 用户上下文信息
*/
public class OauthContext {
private static final TransmittableThreadLocal loginValThreadLocal=new TransmittableThreadLocal<>();
public static LoginVal get(){
return loginValThreadLocal.get();
}
public static void set(LoginVal loginVal){
loginValThreadLocal.set(loginVal);
}
public static void clear(){
loginValThreadLocal.remove();
}}
TransmittableThreadLocal原理
从定义来看，
TransimittableThreadLocal
继承于
InheritableThreadLocal
，并实现
TtlCopier
接口，它里面只有一个
copy
方法。所以主要是对
InheritableThreadLocal
的扩展。
public class TransmittableThreadLocal<T> extends InheritableThreadLocal<T> implements TtlCopier<T>
在
TransimittableThreadLocal
中添加
holder
属性。这个属性的作用就是被标记为具备线程传递资格的对象都会被添加到这个对象中。
要标记一个类，比较容易想到的方式，就是给这个类新增一个
Type
字段，还有一个方法就是将具备这种类型的的对象都添加到一个静态全局集合中。之后使用时，这个集合里的所有值都具备这个标记。
// 1. holder本身是一个InheritableThreadLocal对象
// 2. 这个holder对象的value是WeakHashMap, ?>
// 2.1 WeekHashMap的value总是null,且不可能被使用。
// 2.2 WeekHasshMap支持value=null
private static InheritableThreadLocal, ?>> holder = new InheritableThreadLocal, ?>>() {
@Override
protected WeakHashMap, ?> initialValue() {
return new WeakHashMap, Object>();
}
/**
* 重写了childValue方法，实现上直接将父线程的属性作为子线程的本地变量对象。
*/
@Override
protected WeakHashMap, ?> childValue(WeakHashMap, ?> parentValue) {
return new WeakHashMap, Object>(parentValue);
}
};
应用代码是通过
TtlExecutors
工具类对线程池对象进行包装。工具类只是简单的判断，输入的线程池是否已经被包装过、非空校验等，然后返回包装类
ExecutorServiceTtlWrapper
。根据不同的线程池类型，有不同和的包装类。
@Nullable
public static
