TaskDecorator——异步多线程中传递上下文等变量

发布时间 2023-08-11 10:16:58作者: 甜菜波波

目录

TaskDecorator

定义TaskDecorator实例

线程池使用TaskDecorator


开发中很多数据如oauth2的认证信息,日志TracerId都是在请求线程中的,如果内部使用多线程处理就存在获取不到认证信息或TraceId的问题。这时候就需要处理子线程与主线程间数据传递的问题。

TaskDecorator

这个问题需要使用线程的ThreadLocal和TaskDecorator来处理。官方文档中描述意思是TaskDecorator是一个执行回调方法的装饰器,主要应用于传递上下文,或者提供任务的监控/统计信息。

实现方式就是定义一个TaskDecorator,在线程池中设置使用这个TaskDecorator。

注意线程池中有的线程是一直存在一直被复用的,所以线程执行完成后需要在TaskDecorator的finally方法中移除传递的上下文对象,否则就存在内存泄漏的问题。

定义TaskDecorator实例

继承TaskDecorator接口创建ContextCopyingDecorator 实现类,重写decorate方法,设置需要传递的上下文和变量值。注意finally代码块

  1.  
    public class ContextCopyingDecorator implements TaskDecorator {
  2.  
    @Override
  3.  
    public Runnable decorate(Runnable runnable) {
  4.  
    try {
  5.  
    RequestAttributes context = RequestContextHolder.currentRequestAttributes(); //1
  6.  
    Map<String,String> previous = MDC.getCopyOfContextMap(); //2
  7.  
    SecurityContext securityContext = SecurityContextHolder.getContext(); //3
  8.  
    return () -> {
  9.  
    try {
  10.  
    RequestContextHolder.setRequestAttributes(context); //1
  11.  
    MDC.setContextMap(previous); //2
  12.  
    SecurityContextHolder.setContext(securityContext); //3
  13.  
    runnable.run();
  14.  
    } finally {
  15.  
    RequestContextHolder.resetRequestAttributes(); // 1
  16.  
    MDC.clear(); // 2
  17.  
    SecurityContextHolder.clearContext(); // 3
  18.  
    }
  19.  
    };
  20.  
    } catch (IllegalStateException e) {
  21.  
    return runnable;
  22.  
    }
  23.  
    }
  24.  
    }

线程池使用TaskDecorator

  1.  
    @Bean
  2.  
    public TaskExecutor taskExecutor() {
  3.  
    ThreadPoolTaskExecutor executor = new ThreadPoolTaskExecutor();
  4.  
    executor.setCorePoolSize(corePoolSize);
  5.  
    executor.setMaxPoolSize(maxPoolSize);
  6.  
    executor.setQueueCapacity(queueCapacity);
  7.  
    executor.setThreadNamePrefix("MyExecutor-");
  8.  
     
  9.  
    // for passing in request scope context
  10.  
    executor.setTaskDecorator(new ContextCopyingDecorator());
  11.  
     
  12.  
    executor.setRejectedExecutionHandler(new ThreadPoolExecutor.CallerRunsPolicy());
  13.  
    executor.setWaitForTasksToCompleteOnShutdown(true);
  14.  
    executor.initialize();
  15.  
    return executor;
  16.  
    }