在 Java 中，ThreadLocal 是一个非常有用的工具类，它允许我们在每个线程中存储线程本地（即线程级别）的变量。ThreadLocal 的使用可以避免线程安全问题，提高程序的并发性能。然而，ThreadLocal 的实现和使用需要注意一些细节和最佳实践，同时也存在一些常见的错误和注意事项。本文将从 ThreadLocal 的介绍、实现、使用场景、最佳实践和常见问题等方面，深入探究 Java 中的ThreadLocal。
ThreadLocal 简介
在多线程编程中，线程之间的共享变量很容易引发线程安全问题。因此，为了避免这些问题，我们可以使用 ThreadLocal 来实现线程间的数据隔离。
ThreadLocal 是一个本地线程变量，它提供了一种线程本地存储的机制，为每个使用该变量的线程都提供一个独立的副本，使得每个线程都可以独立地修改自己所拥有的副本，而不会影响其他线程的副本。这样，就可以避免线程安全问题，提高程序的并发性能。
实现原理
ThreadLocal是基于Thread中的ThreadLocalMap实现的。每个Thread维护一个ThreadLocalMap对象，ThreadLocalMap是一个ThreadLocal对象到其值的映射。当我们使用ThreadLocal的set方法时，会将当前ThreadLocal对象作为key，值作为value存储在当前线程的ThreadLocalMap中。在使用ThreadLocal的get方法时，会根据当前ThreadLocal对象在ThreadLocalMap中查找对应的值。由于每个线程维护自己独立的ThreadLocalMap，因此ThreadLocal的值对其他线程是不可见的。
使用场景
ThreadLocal适用于多线程中需要保留一些线程本地状态的场景。例如，在Web应用程序中，可以使用ThreadLocal来存储当前请求的上下文信息，如用户信息、租户信息等。在使用线程池执行任务时，也可以使用ThreadLocal来避免任务之间的状态污染。
public class TenantHolder {
private static final ThreadLocal<String> TENANT_ID = new ThreadLocal<>();
public static String getTenantId() {
return TENANT_ID.get();
}
public static void setTenantId(String tenantId) {
TENANT_ID.set(tenantId);
}
public static void clear() {
TENANT_ID.remove();
}
}
容易犯的错误
使用 ThreadLocal 时需要注意一些细节，否则容易导致意外的问题，以下是一些常见的错误：
- 内存泄漏：如果在使用 ThreadLocal 后没有手动清除对应线程中的值，则可能会导致内存泄漏。ThreadLocal 中的 Entry 对象中的 key 使用了 WeakReference 封装，也就是说 Entry 中的 key 是一个弱引用类型，而弱引用类型只能存活在下次 GC 之前。如果一个线程调用 ThreadLocal 的 set 设置变量，当前 ThreadLocalMap 则会新增一条记录，但由于发生了一次垃圾回收，此时的 key 值就会被回收，而 value 值依然存在内存中，由于当前线程一直存在，所以 value 值将一直被引用。这些被垃圾回收掉的 key 就会一直存在一条引用链的关系：Thread --> ThreadLocalMap–>Entry–>Value。这条引用链会导致 Entry 不会被回收，Value 也不会被回收，但 Entry 中的 key 却已经被回收的情况发生，从而造成内存泄漏。
- 多线程共享数据：由于 ThreadLocal 仅仅是将数据存储在当前线程的 ThreadLocalMap 中，因此不同线程之间的数据是独立的。在使用 ThreadLocal 时，应该时刻牢记它只是一种线程内部的存储机制，而不是全局共享的变量。
- InheritableThreadLocal 不支持线程池：在使用 InheritableThreadLocal 时，需要注意它不支持线程池，因为线程池中的线程可能会被多个线程复用。如果在一个线程中设置了 InheritableThreadLocal 的值，而这个线程在执行完任务后又被回收并放回线程池中，那么后续使用这个线程的任务将会继承之前设置的值，可能会导致不正确的结果。
- 线程池造成的问题。使用线程池时，需要注意 ThreadLocal 的值存储在当前线程中，当线程被放回线程池时，线程池并不会清理 ThreadLocal 中的值，这会导致线程池中的下一个线程会继承当前线程的 ThreadLocal 值，从而导致数据混乱的问题。 尤其是在Web应用中用来存储当前租户/用户信息。在 Tomcat 中使用 HttpServletRequest 对象来设置 ThreadLocal 变量时，可能会出现线程安全问题。这是因为，Tomcat 默认使用线程池来处理请求，当线程池中的某个线程处理完请求后，该线程并不会被销毁，而是被放回线程池中等待下一次请求。如果在处理请求时，将 HttpServletRequest 对象中的租户信息存储到 ThreadLocal 变量中，但在处理下一个请求时，由于使用的是同一个线程，该线程的 ThreadLocal 变量仍然包含上一个请求的租户信息，导致出现错误。所以用完了一定要remove。
