SpringBoot 异步线程间传递上下文方式

目录

• 异步线程间传递上下文
• 需求
• 实现
• 启用异步功能
• 配置异步
• 配置任务装饰器
• 启用多线程安全上下文无法在线程间共享问题
• 问题
• 解决方案
• 原理
• 结果

异步线程间传递上下文

需求

SpringBoot项目中，经常使用@Async来开启一个子线程来完成异步操作。主线程中的用户信息需要传递给子线程

实现

启用异步功能

在启动类里加上@EnableAsync注解

@EnableAsync
@SpringBootApplication
public class Application {}

配置异步

新建一个配置类，实现AsyncConfigurer接口，并重写getAsyncExecutor方法

@Configuration
public class AsyncConfig implements AsyncConfigurer {
    @Override
    public Executor getAsyncExecutor() {
        ThreadPoolTaskExecutor executor = new ThreadPoolTaskExecutor();
        executor.setCorePoolSize(10);
        executor.setMaxPoolSize(50);
        executor.setThreadNamePrefix("async-pool-");
        // 这一步是关键，异步Task装饰器
        executor.setTaskDecorator(new MyContextDecorator());
        executor.initialize();
        return executor;
    }
}

配置任务装饰器

新建一个异步任务装饰器，实现TaskDecorator接口，并重写decorate方法

public class MyContextDecorator implements TaskDecorator {
    @Override
    @Nonnull
    public Runnable decorate(@Nonnull Runnable runnable) {
  // 获取主线程中的请求信息（我们的用户信息也放在里面）
       RequestAttributes attributes = RequestContextHolder.getRequestAttributes();
        return () -> {
            try {
               // 将主线程的请求信息，设置到子线程中
               RequestContextHolder.setRequestAttributes(attributes);
              // 执行子线程，这一步不要忘了
                runnable.run();
            } finally {
             // 线程结束，清空这些信息，否则可能造成内存泄漏
                RequestContextHolder.resetRequestAttributes();
            }
        };
    }

补充下：RequestContextHolder内部是基于ThreadLocal实现的，因此在使用set get时，都是和当前线程绑定的。当然，使用者的用户信息不一定放在了RequestContextHolder里面，读者可以自行扩展。

到此，通过@Async开启的子线程，就可以正常拿到父线程中的Request信息了。

启用多线程安全上下文无法在线程间共享问题

问题

项目中多线程添加数据，mybatisplus元数据填充功能，填充创建人时，数据是来自 spring security SecurityContextHolder.getContext.getAuthentication,同步操作时，能正常获取，而异步执行时空指针异常。

解决方案

配置安全上下文全局策略SecurityContextHolder.setStrategyName(SecurityContextHolder.MODE_INHERITABLETHREADLOCAL)

原理

Spring Security 安全上下文默认策略为MODE_THREADLOCAL,ThreadLocal机制来保存每个使用者的安全上下文。

这意味着，只要针对某个使用者的逻辑执行都是在同一个线程中进行，即使不在各个方法之间以参数的形式传递其安全上下文，各个方法也能通过SecurityContextHolder工具获取到该安全上下文。

只要在处理完当前使用者的请求之后注意清除ThreadLocal中的安全上下文，这种使用ThreadLocal的方式是很安全的。

• MODE_GLOBAL： JVM中所有的线程使用同一个安全上下文
• MODE_INHERITABLETHREADLOCAL：有些应用会有自己的线程创建，并且希望这些新建线程也能使用创建者的安全上下文。这种效果，可以通过将SecurityContextHolder配置成MODE_INHERITABLETHREADLOCAL策略达到。

结果

在配置文件中添加：

@PostConstruct
public void init(){
    SecurityContextHolder.setStrategyName(SecurityContextHolder.MODE_INHERITABLETHREADLOCAL);
}
 

@PostConstruct注解好多人以为是Spring提供的。其实是Java自己的注解。

Java中该注解的说明：@PostConstruct该注解被用来修饰一个非静态的void（）方法。被@PostConstruct修饰的方法会在服务器加载Servlet的时候运行，并且只会被服务器执行一次。PostConstruct在构造函数之后执行，init（）方法之前执行。

通常我们会是在Spring框架中使用到@PostConstruct注解 该注解的方法在整个Bean初始化中的执行顺序：

Constructor(构造方法) -> @Autowired(依赖注入) -> @PostConstruct(注释的方法)

以上为个人经验，希望能给大家一个参考，也希望大家多多支持我们。