JAVA并发场景下ThreadLocal随机丢失值问题的真实原因分析

大家好，今天我们来深入探讨一个在Java并发编程中经常遇到的问题：ThreadLocal随机丢失值。这个问题听起来有点玄乎，好像ThreadLocal这个线程隔离的“神器”突然失效了。但实际上，问题的根源往往不在ThreadLocal本身，而是我们对它的理解和使用方式。

ThreadLocal：线程局部变量的“真相”

首先，我们来明确一下ThreadLocal的作用。ThreadLocal，顾名思义，是线程本地变量。它提供了一种线程隔离的机制，使得每个线程都可以拥有自己独立的变量副本，而不会与其他线程共享。这在并发场景下非常有用，例如管理事务上下文、用户会话等。

ThreadLocal的底层实现依赖于 Thread 类中的一个 ThreadLocalMap 类型的成员变量。ThreadLocalMap 类似于一个 HashMap，但是它的 key 是 ThreadLocal 对象本身，value 则是与该线程相关的变量副本。

// Thread类中的成员变量
/* ThreadLocal values pertaining to this thread. This map is maintained
 * by the ThreadLocal class. */
ThreadLocal.ThreadLocalMap threadLocals = null;

当我们调用 ThreadLocal.set(value) 方法时，实际上是将 value 存储到当前线程的 ThreadLocalMap 中，以 ThreadLocal 对象作为 key。而当我们调用 ThreadLocal.get() 方法时，实际上是从当前线程的 ThreadLocalMap 中，以 ThreadLocal 对象作为 key，获取对应的 value。

丢失值：表象与原因

那么，为什么会出现ThreadLocal随机丢失值的情况呢？ “随机”二字往往暗示着与线程生命周期，线程池等因素相关。让我们从以下几个方面来分析：

线程池与线程复用

这是最常见的原因。在Java Web应用中，我们通常会使用线程池来管理线程，以提高性能。线程池会复用线程，而不是每次请求都创建新的线程。这意味着，当一个线程处理完一个请求后，它可能会被重新分配去处理另一个请求。

如果我们在处理完请求后，没有及时清理ThreadLocal中存储的值，那么这个值就会被保留下来，并在下一个请求中被错误地使用。这就是所谓的“值污染”，也是导致“随机丢失值”的罪魁祸首。

例如，假设我们使用ThreadLocal来存储用户ID：
```
public class UserContext {
    private static final ThreadLocal<Long> userId = new ThreadLocal<>();

    public static void setUserId(Long id) {
        userId.set(id);
    }

    public static Long getUserId() {
        return userId.get();
    }

    public static void clear() {
        userId.remove();
    }
}

// 在Servlet中
public class MyServlet extends HttpServlet {
    protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
        // 模拟从请求中获取用户ID
        Long userId = parseUserIdFromRequest(request);
        UserContext.setUserId(userId);

        // 处理业务逻辑
        processBusinessLogic();

        // 清理ThreadLocal
        UserContext.clear(); // 必须清理！
    }
    //...
}
```
在这个例子中，如果在MyServlet.doGet()方法中没有调用 UserContext.clear()，那么当线程被复用时，它仍然会持有上一个请求的用户ID，导致下一个请求错误地使用了上一个用户的身份。

解决方案： 在每次使用完ThreadLocal后，一定要调用 ThreadLocal.remove() 方法来清理存储的值。通常，我们会在请求处理的最后阶段，或者使用AOP等机制来统一清理ThreadLocal。
内存泄漏

ThreadLocalMap的Key是弱引用。当ThreadLocal对象没有被强引用指向时，发生GC时，这个ThreadLocal对象会被回收，但是对应的Value并没有被回收，ThreadLocalMap中就会出现key为null的Entry，这就是所谓的内存泄漏。

如果线程池中的线程长时间运行，积累的这些key为null的Entry就会越来越多，占用越来越多的内存。

解决方案：
- 及时remove()。这是最有效的解决方案。
- 使用JDK提供的ThreadLocalMap.expungeStaleEntries()方法。这个方法会清理key为null的Entry。但是，这个方法只有在ThreadLocal的get()、set()、remove()方法调用时才会被顺带调用。所以，即使使用了JDK提供的机制，仍然需要手动remove()。
```
public class UserContext {
    private static final ThreadLocal<Long> userId = new ThreadLocal<Long>() {
        @Override
        protected void finalize() throws Throwable {
            // 确保在ThreadLocal对象被回收时清理资源
            try {
                remove();
            } finally {
                super.finalize();
            }
        }
    };

    public static void setUserId(Long id) {
        userId.set(id);
    }

    public static Long getUserId() {
        return userId.get();
    }

    public static void clear() {
        userId.remove();
    }
}
```
虽然这个 finalize() 方法看起来不错，但它并不能保证一定会被执行，而且在垃圾回收时执行 finalize() 方法会带来性能损耗。 最佳实践仍然是显式地调用 remove() 方法。
初始化问题

如果在多线程环境下，多个线程同时访问一个尚未初始化的ThreadLocal变量，可能会导致一些意想不到的结果。
```
private static final ThreadLocal<List<String>> dataList = new ThreadLocal<>();

public List<String> getDataList() {
    if (dataList.get() == null) {
        dataList.set(new ArrayList<>());
    }
    return dataList.get();
}
```
这段代码看起来好像没有问题，但是如果在高并发环境下，多个线程同时进入 if (dataList.get() == null) 判断，都发现 dataList.get() 为 null，那么每个线程都会创建一个新的 ArrayList，导致每个线程都持有不同的 List 实例，而不是共享同一个实例。这可能不是我们想要的结果。

解决方案：
- 使用initialValue()方法: ThreadLocal提供了一个initialValue()方法，可以用于在线程第一次访问ThreadLocal变量时进行初始化。
```
private static final ThreadLocal<List<String>> dataList = ThreadLocal.withInitial(() -> new ArrayList<>());

public List<String> getDataList() {
    return dataList.get();
}
```
  使用 ThreadLocal.withInitial(() -> new ArrayList<>()) 可以确保每个线程在第一次访问 dataList 时，都会获得一个新的 ArrayList 实例，并且这个实例是线程私有的。
- 静态初始化: 如果我们希望所有线程共享同一个实例，可以使用静态初始化。
```
private static final List<String> sharedDataList = new ArrayList<>();
private static final ThreadLocal<List<String>> dataList = ThreadLocal.withInitial(() -> sharedDataList);

public List<String> getDataList() {
    return dataList.get();
}
```
  在这个例子中，所有线程都会共享同一个 sharedDataList 实例。
父子线程问题

在某些情况下，我们可能会创建子线程来执行一些任务。默认情况下，子线程无法访问父线程的ThreadLocal变量。
```
public class ParentThread {
    private static final ThreadLocal<String> parentData = ThreadLocal.withInitial(() -> "Parent Data");

    public static void main(String[] args) {
        System.out.println("Parent Thread: " + parentData.get());

        new Thread(() -> {
            System.out.println("Child Thread: " + parentData.get()); // 输出 null
        }).start();
    }
}
```
在这个例子中，子线程无法访问父线程的 parentData 变量，输出为 null。

解决方案：
- InheritableThreadLocal: 可以使用 InheritableThreadLocal 类来实现父子线程之间的数据传递。InheritableThreadLocal 会在创建子线程时，将父线程的ThreadLocal变量复制到子线程中。
```
public class ParentThread {
    private static final InheritableThreadLocal<String> parentData = new InheritableThreadLocal<String>() {
        @Override
        protected String initialValue() {
            return "Parent Data";
        }
    };

    public static void main(String[] args) {
        System.out.println("Parent Thread: " + parentData.get());

        new Thread(() -> {
            System.out.println("Child Thread: " + parentData.get()); // 输出 Parent Data
        }).start();
    }
}
```
  使用 InheritableThreadLocal 后，子线程可以访问父线程的 parentData 变量，输出为 "Parent Data"。
- TransmittableThreadLocal: 对于使用线程池的场景，InheritableThreadLocal 可能会失效，因为线程池会复用线程，导致子线程获取到的可能是上一个父线程的ThreadLocal变量。可以使用阿里巴巴开源的 TransmittableThreadLocal (TTL) 来解决这个问题。 TTL在线程池提交任务时，会将父线程的ThreadLocal变量传递到子线程中，保证子线程可以正确地访问父线程的ThreadLocal变量。
错误的使用姿势
将ThreadLocal当作全局变量使用，并且存储一些重量级的对象。正确的姿势是将ThreadLocal看作轻量级的上下文传递工具，尽可能存储一些简单的数据类型，例如用户ID，请求ID等。避免存储大量的对象，避免复杂的对象结构。

ThreadLocal使用场景举例

| 使用场景 | 描述 | 示例代码 |
| ———————— | ————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————- | ———————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————— ——————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————– 1．解决线程安全问题。例如，数据库连接、Session管理等。

public class ThreadLocalConnection {
    private static final ThreadLocal<Connection> connectionHolder
            = new ThreadLocal<Connection>();

    public static Connection getConnection() {
        Connection connection = connectionHolder.get();
        if (connection == null) {
            connection = createConnection();
            connectionHolder.set(connection);
        }
        return connection;
    }

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

    private static Connection createConnection() {
        // ...
    }
}

| 2. 传递上下文信息。 | 例如，在分布式系统中，需要在不同的服务之间传递调用链信息。 | java public class LogInterceptor implements HandlerInterceptor { private static final ThreadLocal<String> traceId = new ThreadLocal<>(); @Override public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) { String traceIdValue = UUID.randomUUID().toString(); traceId.set(traceIdValue); MDC.put("traceId", traceIdValue); return true; } @Override public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) { traceId.remove(); MDC.remove("traceId"); } } |
| 3. 实现单例模式。 | 保证每个线程只有一个实例。 | java public class Singleton { private static final ThreadLocal<Singleton> instanceHolder = new ThreadLocal<Singleton>() { @Override protected Singleton initialValue() { return new Singleton(); } }; private Singleton() {} public static Singleton getInstance() { return instanceHolder.get(); } }

JAVA并发场景下ThreadLocal随机丢失值问题的真实原因分析

发表回复 取消回复

发表回复取消回复