Spring异步线程池—传递线程上下文(TaskDecorator实现)

问题

在spring中使用@async异步调用的情况下,被调用的异步子线程获取不到父线程的request信息,以便处理相关逻辑,即子线程无法获取父线程的上下文数据

思路

在自定义的异步线程池ThreadPoolTaskExecutor中,初始化线程池时有taskDecorator这样一个任务装饰器,类似aop,可对线程执行方法的始末进行增强。其初始化源码如下

 protected ExecutorService initializeExecutor(ThreadFactory threadFactory, RejectedExecutionHandler rejectedExecutionHandler) {
        BlockingQueue<Runnable> queue = this.createQueue(this.queueCapacity);
        ThreadPoolExecutor executor;
        if (this.taskDecorator != null) {
            executor = new ThreadPoolExecutor(this.corePoolSize, this.maxPoolSize, (long)this.keepAliveSeconds, TimeUnit.SECONDS, queue, threadFactory, rejectedExecutionHandler) {
                public void execute(Runnable command) {
                    Runnable decorated = ThreadPoolTaskExecutor.this.taskDecorator.decorate(command);
                    if (decorated != command) {
                        ThreadPoolTaskExecutor.this.decoratedTaskMap.put(decorated, command);
                    }

                    super.execute(decorated);
                }
            };
        } else {
            executor = new ThreadPoolExecutor(this.corePoolSize, this.maxPoolSize, (long)this.keepAliveSeconds, TimeUnit.SECONDS, queue, threadFactory, rejectedExecutionHandler);
        }

        if (this.allowCoreThreadTimeOut) {
            executor.allowCoreThreadTimeOut(true);
        }

        this.threadPoolExecutor = executor;
        return executor;
    }

基本使用,自定义装饰器实现TaskDecorator ,重写decorate方法,自定义线程池,并设置自定义装饰器

自定义异步线程池
@Bean("taskExecutor") // bean 的名称,默认为首字母小写的方法名
  public Executor taskExecutor() {
    ThreadPoolTaskExecutor executor = new ThreadPoolTaskExecutor();
    //其他参数省略
    //设置装饰器
       threadPoolTaskExecutor.setTaskDecorator(new ContextCopyingDecorator());
    return executor;
  }

自定义装饰器,ContextCopyingDecorator,通过try,finally,在子线程执行完后将该线程设置的上下文变量清除

public class ContextCopyingDecorator implements TaskDecorator {
    @Override
    public Runnable decorate(Runnable runnable) {
        try {
            //获取父线程的context
            RequestAttributes context = RequestContextHolder.currentRequestAttributes();
            return () -> {
                try {
                    //将父线程的context设置进子线程里
                    RequestContextHolder.setRequestAttributes(context);
                    //子线程方法执行
                    runnable.run();
                } finally {
                    //清除子线程context
                    RequestContextHolder.resetRequestAttributes();
                }
            };
        } catch (IllegalStateException e) {
            return runnable;
        }
    }
}

存在问题

从父线程取出的RequestContextHolder对象,此为持有线程上下文的request容器,将其设置到子线程中,按道理只要对象还存在强引用,就不会被销毁,但由于RequestContextHolder的特殊性,在父线程销毁的时候,会触发里面的resetRequestAttributes方法(即清除threadLocal里面的信息,即reques中的信息会被清除),此时即使RequestContextHolder这个对象还是存在,子线程也无法继续使用它获取request中的数据了。这也是网上很多文章讲TaskDecorator时没提到的点,真正用起来会发现有时可以有时不行,这个就取决于父子线程哪个先结束了。

完善思路

既然是RequestContextHolder的特殊性,那我们就让绕过他的销毁清除,思路不变,还是继续使用threadLocal来传递我们需要使用到的变量,在父线程装饰前将所需变量取出来,然后在子线程中设置到threadLocal,业务使用的时候从threadLocal中取即可。

改造,自定义threadLocal类(此例子以ua为例子),修改自定义装饰器逻辑

public class ContextCopyingDecorator implements TaskDecorator {
    @Override
    public Runnable decorate(Runnable runnable) {
        try {
            //获取父线程的request的user-agent(示例)
           HttpServletRequest request = ((ServletRequestAttributes) RequestContextHolder.getRequestAttributes()).getRequest();
            String ua = request.getHeader("user-agent");
            return () -> {
                try {
                    //将父线程的ua设置进子线程里
                    ThreadLocalData.setUa(ua);
                    //子线程方法执行
                    runnable.run();
                } finally {
                    //清除线程threadLocal的值
                    ThreadLocalData.remove();
                }
            };
        } catch (IllegalStateException e) {
            return runnable;
        }
    }
}

ThreadLocalData

public class ThreadLocalData {
    public static final ThreadLocal<String> threadLocal = new ThreadLocal<>();

    public static String getUa(){
        return threadLocal.get();
    }

    public static void setUa(String ua){
        threadLocal.set(ua);
    }

    public static void remove(){
        threadLocal.remove();
    }
}

至此经测试,一切符合预期

涉及知识点

ThreadLocal,InheritableThreadLocal,TaskDecorator,RequestContextHolder,TransmittableThreadLocal(通过继承InheritableThreadLocal实现,阿里的,推荐)

测试 ThreadLocal,InheritableThreadLocal,TransmittableThreadLocal的区别和使用

1.父线程使用ThreadLocal,子线程创建时不会拥有父类的threadLocal信息
2.父线程使用InheritableThreadLocal,子线程创建时,默认init方法会拿到父类的InheritableThreadLocal信息,这种在线程池/线程复用的情况下,由于init方法只会在初始化时获取父线程的数据,复用的时候也没法再从父线程那里新的InheritableThreadLocal的数据,此种情况下继续使用,很容易出bug(InheritableThreadLocal适用于非线程池和复用线程,单独创建销毁子线程执行的情况)
3.父线程使用TransmittableThreadLocal,子线程创建时拥有父类的TransmittableThreadLocal信息,在线程池/线程复用的情况下不会出现读取到脏数据的情况

总结

  • 在异步线程池的情况下,通过ThreadLocal+TaskDecorator一般即可解决遇到的透传问题(方式1)
  • 使用阿里的TransmittableThreadLocal,其原理也是对Runnable,Callable,进行装饰(方式2)

参考

Spring线程池—TaskDecorator线程的装饰(跨线程传递ThreadLocal的方案)
(28条消息) TaskDecorator——异步多线程中传递上下文等变量_WannaRunning的博客-CSDN博客

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 204,189评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,577评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,857评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,703评论 1 276
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,705评论 5 366
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,620评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,995评论 3 396
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,656评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,898评论 1 298
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,639评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,720评论 1 330
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,395评论 4 319
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,982评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,953评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,195评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 44,907评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,472评论 2 342

推荐阅读更多精彩内容