Java笔记-30、ThreadLocal是什么，怎么用？

在Java多线程编程中，共享变量的访问是一个常见的问题，通常需要通过同步机制（如synchronized关键字或Lock接口）来保证线程安全。然而，过度使用同步可能导致性能下降和死锁。为了解决这个问题，Java提供了ThreadLocal类，它允许你在每个线程中拥有自己的变量副本，从而避免了线程间的竞争。

ThreadLocal的核心概念

ThreadLocal提供了一种线程局部变量的机制。这意味着当你创建一个ThreadLocal变量时，每个访问这个变量的线程都会有这个变量的一个独立副本。每个线程都可以独立地改变自己的副本，而不会影响其他线程的副本。这使得ThreadLocal成为在同一个线程内跨多个方法或类传递数据的一种便捷方式，而无需显式地作为参数传递。

可以形象地理解为，每个线程都有一个“抽屉”，ThreadLocal变量就放在这个抽屉里。每个线程只能看到和操作自己抽屉里的变量，互相之间是隔离的。

ThreadLocal的内部工作原理（简化）

ThreadLocal内部维护了一个ThreadLocalMap，这个Map存储了线程的ThreadLocal变量及其对应的值。每个线程都持有一个自己的ThreadLocalMap实例。当你调用ThreadLocal的set()方法时，它会将当前线程作为key，要设置的值作为value存储到当前线程的ThreadLocalMap中。当你调用get()方法时，它会获取当前线程，然后以当前线程作为key从其ThreadLocalMap中取出对应的值。

ThreadLocal的主要用途

• 管理每个线程特有的状态： 例如，在Web应用中，可以使用ThreadLocal来存储当前用户的会话信息、请求上下文或事务连接，确保每个请求在同一个线程中处理时都能访问到正确的上下文信息。
• 为非线程安全的对象提供线程安全： 有些类本身不是线程安全的（例如SimpleDateFormat）。如果多个线程需要使用同一个SimpleDateFormat实例，通常需要同步。使用ThreadLocal可以将SimpleDateFormat实例包装起来，每个线程都拥有自己的实例，避免了同步的开销。
• 在方法调用链中传递上下文信息： 有时候，你需要在程序的深层嵌套方法中访问某个上下文信息，但又不想在每一层方法签名中都添加这个参数。ThreadLocal可以让你在调用链的顶层设置好信息，然后在任何深度的位置都能轻松获取到。

如何使用ThreadLocal

ThreadLocal类提供了几个主要的方法：

1. ThreadLocal()或ThreadLocal.withInitial(Supplier<? extends T> supplier):创建一个ThreadLocal实例。withInitial()方法在Java 8中引入，可以使用Lambda表达式提供一个初始值创建的函数，更加简洁。
2. set(T value):设置当前线程的ThreadLocal变量的值。
3. get():获取当前线程的ThreadLocal变量的值。如果当前线程没有设置过值，并且ThreadLocal是通过withInitial()创建的，或者重写了initialValue()方法，那么会先调用相应的初始化方法获取初始值并设置，然后返回。否则返回null。
4. remove():移除当前线程的ThreadLocal变量的值。这是非常重要的，特别是在使用线程池时，如果不移除，线程被回收后再次使用时可能会看到之前遗留的值，导致意外的行为和内存泄漏。

使用示例

以下是一个简单的示例，演示了如何使用ThreadLocal来为每个线程存储一个独立的计数器：

import java.util.concurrent.ExecutorService; 
import java.util.concurrent.Executors; 
import java.util.concurrent.TimeUnit; 
public class ThreadLocalExample {

    // 创建一个ThreadLocal，为每个线程提供一个独立的Integer副本，初始值为0
    private static final ThreadLocal<Integer> threadLocalCounter = ThreadLocal.withInitial(() -> 0); 
    
    public static void main(String[] args) throws InterruptedException { 
    
    ExecutorService executor = Executors.newFixedThreadPool(3);

        // 提交几个任务到线程池
        for (int i = 0; i < 5; i++) {
            executor.submit(() -> {
                // 获取当前线程的计数器值
                int counter = threadLocalCounter.get();
                System.out.println(Thread.currentThread().getName() + " - Initial counter: " + counter);

                // 增加计数器并设置回ThreadLocal
                counter++;
                threadLocalCounter.set(counter);

                System.out.println(Thread.currentThread().getName() + " - Final counter: " + threadLocalCounter.get());

                // 模拟一些工作
                try {
                    TimeUnit.MILLISECONDS.sleep(100);
                } catch (InterruptedException e) {
                    e.printStackTrace();
                }

                // !!! 重要：在使用线程池时，一定要移除ThreadLocal的值，避免内存泄漏和数据污染
                threadLocalCounter.remove();
                System.out.println(Thread.currentThread().getName() + " - Counter after removal: " + threadLocalCounter.get()); // 移除后再次获取会重新初始化或为null
            });
        }

        executor.shutdown();
        executor.awaitTermination(1, TimeUnit.MINUTES);
    }
}

在这个例子中，即使多个任务（由不同的线程执行）访问同一个threadLocalCounter变量，它们各自操作的都是自己线程的副本，因此每个线程的计数器都是独立的，从0开始计数。最后调用remove()是为了清理线程本地的值，这在使用线程池时尤为关键。

注意事项

• 内存泄漏： 在使用线程池时，如果不在任务执行完毕后调用remove()方法清理ThreadLocal的值，那么当线程被放回线程池重复使用时，它可能仍然持有之前任务遗留的ThreadLocal值，导致数据污染和潜在的内存泄漏。
• 不适合共享： ThreadLocal的设计目的是隔离数据，而不是共享数据。如果需要在线程之间共享数据，仍然应该使用同步机制。
• 可读性： 过度依赖ThreadLocal可能会降低代码的可读性，因为数据的来源不再是方法的参数或对象的字段，而是隐含在当前线程中。

ThreadLocal是Java中一个非常有用的工具，它提供了一种简洁高效的方式来管理线程局部变量，尤其适用于需要在同一线程内跨多个组件传递上下文信息的场景。但是，在使用时务必注意其生命周期管理，特别是在结合线程池使用时，要确保及时调用remove()方法进行清理。