TransmittableThreadLocal背景目前我们公司项目记录日志，有三个必须要记录的信息：site、tra

站长

2024年09月01日 21:26 · 阅读数 20

背景

目前我们公司项目记录日志，有三个必须要记录的信息：site、traceId、以及guid，其中site是和具体业务相关的，用来切换数据源的，traceId就是链路跟踪id通常一个请求一个，guid是跟用户走的。在项目里现在获取这三个信息的方式就是通过入参传递，这就导致了我设计任何方法（需要记录日志的方法）都需要这三个入参，导致我很反感，但是由于是老系统，我也不敢动，动了的话牵扯范围太广了。

由于老系统越来越大，代码量越来越多，所以领导准备以后将所有新业务放到一个新项目里，提供接口，然后让老项目进行调用。很显然，新项目的日志也需要上面三个值。新项目我是不想再用上面那种方式了，所以写了一个过滤器将入参三个信息分别给存储到线程的3个threadlocal里了。

ThreadLocal、InheritableThreadLocal

InheritableThreadLocal 的内存泄漏

本来打算就是用InheritableThreadLocal的，但是领导看见之后和我说这个有内存泄漏的风险，让我去研究一下阿里的一个ttl。

InheritableThreadLocal 为什么会内存泄漏？

我们先了解下 InheritableThreadLocal 的作用以及内存泄漏的原因：可以将父线程的threadlocal传递给子线程。但是当移除父线程的threadlocal，子线程的threadlocal并不会消失。并且通常来讲子线程是放线程池管理的，不会随着父线程的消失而消失。所以子线程的threadlocal就一直存在，但是已经用不到了，这就造成了内存泄漏了。

下面看InheritableThreadlocal内存泄漏的例子：

public class InheritableThreadLocalSolution {

    private static final InheritableThreadLocal<String> inheritableUserNameThreadLocal = new InheritableThreadLocal<>();

    public static void main(String[] args) throws InterruptedException {
        inheritableUserNameThreadLocal.set("Parent Thread (Inheritable)");

        ExecutorService executorService = Executors.newSingleThreadExecutor();
        executorService.submit(() -> {
            try {
                TimeUnit.SECONDS.sleep(1);
            } catch (InterruptedException e) {
                throw new RuntimeException(e);
            }
            System.out.println("From child thread (InheritableThreadLocal): " + inheritableUserNameThreadLocal.get());
        });

        TimeUnit.SECONDS.sleep(5);
        inheritableUserNameThreadLocal.remove();
        // 提交第二个任务，看看子线程是否还会获得 inheritableThreadLocal的值
        // 结果：会的
        executorService.submit(() -> {
            try {
                TimeUnit.SECONDS.sleep(1);
            } catch (InterruptedException e) {
                throw new RuntimeException(e);
            }
            // 父线程以及移除了，但是子线程仍然能获取到
            System.out.println("second From child thread (InheritableThreadLocal): " + inheritableUserNameThreadLocal.get());
        });
        TimeUnit.SECONDS.sleep(10);
        executorService.shutdown();
    }
}

其实除此之外，我觉得每次往线程池中提交任务的时候都用try-finally里包围起来，在finally里手动进行remove也是可以解决的 InheritableThreadLocal 内存泄漏问题的。

但是，谁家好人每次往线程池提交任务都这样，太麻烦了不是，多出来的约定。

那有没有一种更加优雅的threadlocal呢？

就是当前线程要开启子线程，不需要我手动传递当前线程的threadlocal，子线程自动就获取了。但是在当前线程的threadlocal移除了，那么相关子线程的threadlocal也要移除。