Java 安装 Java:第一个程序 Hello World Java:建议使用 UTF-8 编写 Java 代码 Java:package 包命名规范 使用 Intellij IDEA 创建 Java 项目 Java 布尔类型 Java 处理日期和时间 Java 正则表达式 Java finalize 方法 Java:空值 null Java 如何触发垃圾回收 Java ThreadLocal Java InheritableThreadLocal Java Integer之间的比较 Java 动态代理 Java 匿名类 Java 枚举 Java 如何静态导入 import static println Java 引用级别:强引用、软引用、弱引用、幽灵引用 Java try finally return 解惑 Java WeakHashMap Java ReferenceQueue 怎么写 Java 示例代码? Java 匿名类双大括号初始化 什么是 Java Bean Java 多行字符串 Java 快速生成 List Java 快速生成 Map Java 将异常堆栈转换为 String JDK SPI 的使用和源码分析 Java Map 中的 key 和 value 能否为 null ? Java List 和 数组的互相转换 Java 获取环境变量 Java 获取和设置系统属性 Java:如何获取当前进程的 PID ? Java 字符串左侧 右侧补充空格或者其他字符 Java 线程 Java:如何获取文本文件内容 Java:读取资源文件内容 Java:使用 JavaFx 构建 GUI Java:Class 类 Java:使用 instanceof 判断对象类型 一个自定义的 Java 工具类 Java:获取当前函数所属类的类名 Java:获取当前执行的函数名 Java:使用 String 的 split 函数拆分字符串 Java:获取字符的 Unicode 编号(代码点) Java:获取当前工作目录 Java:使用 Class 对象的 isArray 方法判断对象是否为数组 使用 Java 生成 CSV 文件 Java Mockito 测试框架快速入门 JUnit 入门 JUnit 单测隔离 Java JOOR 反射库 Java alibaba transmittable-thread-local 库:让 ThreadLocal 跨线程传播 Java 日志组件 slf4j 的使用和源码分析 Java Lombok 库:为你减少样板代码 Java:使用 cglib 实现动态代理 Java Hibernate validator 校验框架 Java 使用 Hessian2 序列化和反序列化 H2 数据库快速入门 Java:使用 Gson 库处理 JSON 数据 Java 集成 groovy 构建规则引擎 Java 13:安装 Java 13 新特性:文本块(多行字符串) 卸载 MacOS 上安装的 Java Java:执行 sql 文件 Java JDK 有哪些发行版 ? java拾遗:String和数组 java拾遗:由反转数组想到System.out的实现机制 java拾遗:如何读取properties文件内容 Java并发概念汇总 java拾遗:System.out.println()是什么? java拾遗:通过示例理解位运算 使用“庖丁解牛”进行中文分词 DBUtils简明教程 试用velocity模板引擎 Java:将字符串哈希为数字 kafka SnappyError no native library is found 问题

Java alibaba transmittable-thread-local 库:让 ThreadLocal 跨线程传播


#Java


了解该库之前,建议先看下:

源码地址: https://github.com/alibaba/transmittable-thread-local

可以简称为 TTL 。

maven 仓库地址: https://mvnrepository.com/artifact/com.alibaba/transmittable-thread-local

这个库解决了什么问题 ? ThreadLocal、InheritableThreadLocal 无法直接将值传播到新线程/线程池, 而该库可以解决这个问题。

引入依赖

gradle:

compile group: 'com.alibaba', name: 'transmittable-thread-local', version: '2.10.2'

maven:

<dependency>
    <groupId>com.alibaba</groupId>
    <artifactId>transmittable-thread-local</artifactId>
    <version>2.10.2</version>
</dependency>

示例1:基本使用

import com.alibaba.ttl.TransmittableThreadLocal;

public class TtlTest {

    public static TransmittableThreadLocal<Integer> logId = new TransmittableThreadLocal<>();

    // 输出线程名、logId在当前线程的值
    public static void showLogId() {
        System.out.printf("%s : %s\n", Thread.currentThread().getName(), logId.get());
    }


    public static void main(String[] args) {
        showLogId();    // null

        logId.set(10);
        showLogId();    // 10

        logId.set(20);
        showLogId();    // 20

        logId.remove(); // 清除
        showLogId();    // null
    }
}

运行结果:

main : null
main : 10
main : 20
main : null

示例2:在多线程中使用

import com.alibaba.ttl.TransmittableThreadLocal;

public class TtlTest {

    public static TransmittableThreadLocal<Integer> logId = new TransmittableThreadLocal<>();

    // 输出线程名、logId在当前线程的值
    public static void showLogId() {
        System.out.printf("%s : %s\n", Thread.currentThread().getName(), logId.get());
    }


    public static void main(String[] args) throws InterruptedException {
        showLogId();    // null

        logId.set(10);
        showLogId();    // 10

        Thread t1 = new Thread(()->{
            showLogId();     // 10
            logId.set(20);
            showLogId();     // 20
        });

        Thread t2 = new Thread(()->{
            showLogId();   // 10
            logId.set(30);
            showLogId();   // 30
        });

        t1.start(); // 运行线程 t1
        t2.start(); // 运行线程 t2
        t1.join();  // 等待线程 t1 执行完
        t2.join();  // 等待线程 t2 执行完

        showLogId(); // 10
    }
}

执行结果:

main : null
main : 10
Thread-1 : 10
Thread-1 : 20
Thread-2 : 10
Thread-2 : 30
main : 10

可以看到 Thread-1 和 Thread-2 中的 logId的初始值都是 10,符合预期。

示例3:线程池错误的使用方式

import com.alibaba.ttl.TransmittableThreadLocal;

import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;
import java.util.concurrent.TimeUnit;

public class TtlTest {

    public static TransmittableThreadLocal<Integer> logId = new TransmittableThreadLocal<>();

    // 输出线程名、logId在当前线程的值
    public static void showLogId() {
        System.out.printf("%s : %s\n", Thread.currentThread().getName(), logId.get());
    }


    public static void main(String[] args) throws InterruptedException {
        showLogId();    // null

        logId.set(10);
        showLogId();    // 10

        // 只有一个线程的线程池,该线程会复用
        ExecutorService executorService = Executors.newFixedThreadPool(1);
        // 提交task
        executorService.submit(() -> {
            showLogId();
            logId.set(20);
            showLogId();
        });

        // 再提交一个task
        executorService.submit(() -> {
            showLogId();
            logId.set(30);
            showLogId();
        });

        // 关闭线程池
        executorService.shutdown();
        // 等待至任务都执行完,最多等3秒
        executorService.awaitTermination(3, TimeUnit.SECONDS);

        showLogId();
    }
}

输出:

main : null
main : 10
pool-1-thread-1 : 10
pool-1-thread-1 : 20
pool-1-thread-1 : 20
pool-1-thread-1 : 30
main : 10

可以看到 logId 还是被线程池里的logId复用了。如果要 logId 不被复用,那么就要用 TTL 系统的包装类。

示例4:线程池下的使用方式 - 包装 Runnale

import com.alibaba.ttl.TransmittableThreadLocal;
import com.alibaba.ttl.TtlRunnable;

import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;
import java.util.concurrent.TimeUnit;

public class TtlTest {

    public static TransmittableThreadLocal<Integer> logId = new TransmittableThreadLocal<>();

    // 输出线程名、logId在当前线程的值
    public static void showLogId() {
        System.out.printf("%s : %s\n", Thread.currentThread().getName(), logId.get());
    }


    public static void main(String[] args) throws InterruptedException {
        showLogId();    // null

        logId.set(10);
        showLogId();    // 10

        // 只有一个线程的线程池,该线程会复用
        ExecutorService executorService = Executors.newFixedThreadPool(1);
        // 提交task
        executorService.submit(TtlRunnable.get(() -> {
            showLogId();
            logId.set(20);
            showLogId();
        }));

        // 再提交一个task
        executorService.submit(TtlRunnable.get(() -> {
            showLogId();
            logId.set(30);
            showLogId();
        }));

        // 关闭线程池
        executorService.shutdown();
        // 等待至任务都执行完,最多等3秒
        executorService.awaitTermination(3, TimeUnit.SECONDS);

        showLogId();
    }
}

运行结果:

main : null
main : 10
pool-1-thread-1 : 10
pool-1-thread-1 : 20
pool-1-thread-1 : 10
pool-1-thread-1 : 30
main : 10

可以看到,两个 task 虽然都在同一个线程中依次执行,但是 logId 的初始值都是 10,符合预期。

示例5:线程池下的使用方式 - 包装线程池

import com.alibaba.ttl.TransmittableThreadLocal;
import com.alibaba.ttl.threadpool.TtlExecutors;

import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;
import java.util.concurrent.TimeUnit;

public class TtlTest {

    public static TransmittableThreadLocal<Integer> logId = new TransmittableThreadLocal<>();

    // 输出线程名、logId在当前线程的值
    public static void showLogId() {
        System.out.printf("%s : %s\n", Thread.currentThread().getName(), logId.get());
    }


    public static void main(String[] args) throws InterruptedException {
        showLogId();    // null

        logId.set(10);
        showLogId();    // 10

        // 使用包装的线程池
        ExecutorService executorService = TtlExecutors.getTtlExecutorService(Executors.newFixedThreadPool(1));
        // 提交task
        executorService.submit(() -> {
            showLogId();
            logId.set(20);
            showLogId();
        });

        // 再提交一个task
        executorService.submit(() -> {
            showLogId();
            logId.set(30);
            showLogId();
        });

        // 关闭线程池
        executorService.shutdown();
        // 等待至任务都执行完,最多等3秒
        executorService.awaitTermination(3, TimeUnit.SECONDS);

        showLogId();
    }
}

运行结果:

main : null
main : 10
pool-1-thread-1 : 10
pool-1-thread-1 : 20
pool-1-thread-1 : 10
pool-1-thread-1 : 30
main : 10

可以看到,两个 task 虽然都在同一个线程中依次执行,但是 logId 的初始值都是 10,符合预期。

示例6: 使用 javaagent

使用 javaagent,就不用包装 Runnable 或者线程池了。但执行时需要指定 javaagent。

在 maven 仓库中下载 ttl 的jar包到本地。

代码如下:

import com.alibaba.ttl.TransmittableThreadLocal;

import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;
import java.util.concurrent.TimeUnit;

public class TtlTest {

    public static TransmittableThreadLocal<Integer> logId = new TransmittableThreadLocal<>();

    // 输出线程名、logId在当前线程的值
    public static void showLogId() {
        System.out.printf("%s : %s\n", Thread.currentThread().getName(), logId.get());
    }


    public static void main(String[] args) throws InterruptedException {
        showLogId();    // null

        logId.set(10);
        showLogId();    // 10

        // 只有一个线程的线程池,该线程会复用
        ExecutorService executorService = Executors.newFixedThreadPool(1);
        // 提交task
        executorService.submit(() -> {
            showLogId();
            logId.set(20);
            showLogId();
        });

        // 再提交一个task
        executorService.submit(() -> {
            showLogId();
            logId.set(30);
            showLogId();
        });

        // 关闭线程池
        executorService.shutdown();
        // 等待至任务都执行完,最多等3秒
        executorService.awaitTermination(3, TimeUnit.SECONDS);

        showLogId();
    }
}

编译上面的源代码:

$ javac -cp ./transmittable-thread-local-2.10.2.jar TtlTest.java

-cp 换成 -classpath 也行。

运行时不指定 javaagent :

$ java -cp ./transmittable-thread-local-2.10.2.jar:. TtlTest
main : null
main : 10
pool-1-thread-1 : 10
pool-1-thread-1 : 20
pool-1-thread-1 : 20
pool-1-thread-1 : 30
main : 10

结果不符合预期。

运行时指定 javaagent:

$ java -cp ./transmittable-thread-local-2.10.2.jar:. -javaagent:./transmittable-thread-local-2.10.2.jar TtlTest
main : null
main : 10
pool-1-thread-1 : 10
pool-1-thread-1 : 20
pool-1-thread-1 : 10
pool-1-thread-1 : 30
main : 10

结果符合预期。



( 本文完 )