TransmittableThreadLocal 问题杂记

0、前言

TransmittableThreadLocal,简称 TTL,是阿里巴巴开源的一个Java库,它能够实现ThreadLocal在多线程间的值传递,适用于使用线程池、异步调用等需要线程切换的场景,解决了ThreadLocal在使用父子线程、线程池时不能正确传递值的问题。

核心实现:捕获(capture)- 重放(replay)- 恢复(restore)

  • 捕获:将父线程的 TTL/ThreadLocal 拷贝一份到子线程中存为快照;
java 复制代码
    private static class Snapshot {
        final HashMap<TransmittableThreadLocal<Object>, Object> ttl2Value;
        final HashMap<ThreadLocal<Object>, Object> threadLocal2Value;
    }
  • 重放:将快照中的内容存入子线程的 TTL/ThreadLocal 中,并移除不存在快照中的子线程已经存在的 TTL/ThreadLocal;
  • 恢复:清除子线程的 TTL/ThreadLocal。

1、上下文乱象

背景:为了实现在异步线程中也能正确进行通用字段的填充,引入了 TTL,将原先存储用户上下文信息的 ThreadLocal 换成了 TTL。(注:异步线程通过线程池进行管理)

乱象: 子线程在执行任务的过程中,用户上下文出现了两种状态:run() 执行前后 -- 正确信息、run() 执行中 -- null,如下图所示。

代码部分:如下所示。

功能逻辑

线程池装饰器

字段填充

2、没有使用 TtlRunnable

capture,replay,restore 本质是线程任务执行前后的增强方法,这些方法的调用发生于 TtlRunnable 的 run 方法中。

java 复制代码
    /**
     * wrap method {@link Runnable#run()}.
     */
    @Override
    public void run() {
        final Object captured = capturedRef.get();
        if (captured == null || releaseTtlValueReferenceAfterRun && !capturedRef.compareAndSet(captured, null)) {
            throw new IllegalStateException("TTL value reference is released after run!");
        }

        final Object backup = replay(captured);
        try {
            runnable.run();
        } finally {
            restore(backup);
        }
    }

使用方式:

  • 直接调用 TtlRunnable.get(...) 对 Runnable 进行包装增强;
  • 通过 TtlExecutors 工具类获取相应的包装类。

错误例子:

正确例子:

3、父子线程引用共享问题

TTL 默认的上下文复制方式是浅拷贝,这就会造成父子线程中的上下文信息出现共享问题。解决这一问题的方法为:重写 TTL 的 copy 方法,将浅拷贝换成深拷贝。

java 复制代码
    /**
     * Computes the value for this transmittable thread-local variable
     * as a function of the source thread's value at the time the task
     * Object is created.
     * <p>
     * This method is called from {@link TtlRunnable} or
     * {@link TtlCallable} when it create, before the task is started.
     * <p>
     * This method merely returns reference of its source thread value(the shadow copy),
     * and should be overridden if a different behavior is desired.
     *
     * @since 1.0.0
     */
    public T copy(T parentValue) {
        return parentValue;
    }

错误例子:

java 复制代码
    private final static ThreadLocal<Map<String, Integer>> transmittableThreadLocal = new TransmittableThreadLocal<Map<String, Integer>>() {
        @Override
        protected Map<String, Integer> initialValue() {
            return new HashMap<>();
        }
    };

    private static int i = 0;

    public static void main(String[] args) {
        transmittableThreadLocal.get().put(String.format("key-%d", ++i), i);

        Executor ttlExecutor = TtlExecutors.getTtlExecutor(Executors.newFixedThreadPool(1));
        CompletableFuture.runAsync(()-> {
            try {
                Thread.sleep(3 * 1000);
            } catch (InterruptedException e) {
            }
            System.out.println(StrUtil.format("[{}]子线程:{}", LocalTime.now(), transmittableThreadLocal.get()));
        }, ttlExecutor);

        transmittableThreadLocal.get().put(String.format("key-%d", ++i), i);
        System.out.println(StrUtil.format("[{}]父线程:{}", LocalTime.now(), transmittableThreadLocal.get()));

        transmittableThreadLocal.remove();
    }

正确例子:

java 复制代码
   private final static ThreadLocal<Map<String, Integer>> transmittableThreadLocal = new TransmittableThreadLocal<Map<String, Integer>>() {
        @Override
        protected Map<String, Integer> initialValue() {
            return new HashMap<>();
        }

        @Override
        public Map<String, Integer> copy(Map<String, Integer> parentValue) {
            return parentValue != null ? new HashMap<>(parentValue) : null;
        }
    };

    private static int i = 0;

    public static void main(String[] args) {
        transmittableThreadLocal.get().put(StrUtil.format("key-{}", ++i), i);

        Executor ttlExecutor = TtlExecutors.getTtlExecutor(Executors.newFixedThreadPool(1));
        CompletableFuture.runAsync(()-> {
            try {
                Thread.sleep(3 * 1000);
            } catch (InterruptedException e) {
            }
            System.out.println(StrUtil.format("[{}]子线程:{}", LocalTime.now(), transmittableThreadLocal.get()));
        }, ttlExecutor);

        transmittableThreadLocal.get().put(String.format("key-%d", ++i), i);
        System.out.println(StrUtil.format("[{}]父线程:{}", LocalTime.now(), transmittableThreadLocal.get()));

        transmittableThreadLocal.remove();
    }

拓展:捕获、重放期间的线程切换和 ThreadLocal 变化。

捕获:

重放:

  • 备份


  • 重新设置



相关推荐
甄超锋5 分钟前
Java Maven更换国内源
java·开发语言·spring boot·spring·spring cloud·tomcat·maven
m0_7190841121 分钟前
sharding-jdbc读写分离配置
java
还是鼠鼠1 小时前
tlias智能学习辅助系统--Maven 高级-私服介绍与资源上传下载
java·spring boot·后端·spring·maven
Xiaokai丶2 小时前
Java 8 新特性深度剖析:核心要点与代码实战
java
灵魂猎手2 小时前
3. MyBatis Executor:SQL 执行的核心引擎
java·后端·源码
Galaxy在掘金2 小时前
从业8年,谈谈我认知的后端架构之路-1
java·架构
努力努力再努力wz2 小时前
【c++深入系列】:万字详解模版(下)
java·c++·redis
瓦特what?3 小时前
关于C++的#include的超超超详细讲解
java·开发语言·数据结构·c++·算法·信息可视化·数据挖掘
是乐谷4 小时前
阿里云杭州 AI 产品法务岗位信息分享(2025 年 8 月)
java·人工智能·阿里云·面试·职场和发展·机器人·云计算
Java水解4 小时前
Java中的四种引用类型详解:强引用、软引用、弱引用和虚引用
java·后端