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

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

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

TaskDecorator

这个问题需要使用

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

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

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

定义**TaskDecorator实例**

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

public class ContextCopyingDecorator implements TaskDecorator {
    @Override
    public Runnable decorate(Runnable runnable) {
        try {
            RequestAttributes context = RequestContextHolder.currentRequestAttributes();  //1
            Map<String,String> previous = MDC.getCopyOfContextMap();                    //2
            SecurityContext securityContext = SecurityContextHolder.getContext();         //3
            return () -> {
                try {
                    RequestContextHolder.setRequestAttributes(context);  //1
                    MDC.setContextMap(previous);                         //2                
                    SecurityContextHolder.setContext(securityContext);   //3
                    runnable.run();
                } finally {
                    RequestContextHolder.resetRequestAttributes();      // 1
                    MDC.clear();                                        // 2
                    SecurityContextHolder.clearContext();               // 3
                }
            };
        } catch (IllegalStateException e) {
            return runnable;
        }
    }
}

线程池使用TaskDecorator

@Bean
    public TaskExecutor taskExecutor() {
        ThreadPoolTaskExecutor executor = new ThreadPoolTaskExecutor();
        executor.setCorePoolSize(corePoolSize);
        executor.setMaxPoolSize(maxPoolSize);
        executor.setQueueCapacity(queueCapacity);
        executor.setThreadNamePrefix("MyExecutor-");

        // for passing in request scope context
        executor.setTaskDecorator(new ContextCopyingDecorator());

        executor.setRejectedExecutionHandler(new ThreadPoolExecutor.CallerRunsPolicy());
        executor.setWaitForTasksToCompleteOnShutdown(true);
        executor.initialize();
        return executor;
    }