ThreadLocal 使用实践

ThreadLocal 类在 Java 中用来创建线程局部变量，即这些变量只属于当前线程，其他线程无法访问到这些变量。ThreadLocal 实例通常是类中的私有静态字段，用于保存与线程相关的数据，比如用户身份信息、事务状态等。

使用 ThreadLocal

以下是一个简洁的 ThreadLocal 使用示例：

public class ThreadLocalExample {

    // 创建一个 Integer 类型的线程局部变量
    private static final ThreadLocal<Integer> userCounter = new ThreadLocal<>();

    public static void main(String[] args) {
        // 创建三个线程，每个线程都有自己的 userCounter 副本
        for (int i = 0; i < 3; i++) {
            Thread thread = new Thread(() -> {
                // 设置当前线程的 userCounter 值
                userCounter.set((int) (Math.random() * 100D));

                try {
                    // 假装线程正在做一些工作
                    Thread.sleep(2000);
                } catch (InterruptedException e) {
                    e.printStackTrace();
                }

                // 获取当前线程的 userCounter 值
                System.out.println("Thread [" + Thread.currentThread().getName() + "] userCounter: " + userCounter.get());
            });

            thread.start();
        }
    }
}

在上面的代码中，我们为每个线程设置了一个随机数作为其 userCounter 值。每个线程都会在两秒后打印出其 userCounter 的值。由于 userCounter 是 ThreadLocal 变量，每个线程打印的值都是唯一的，不会出现变量值共享的情况。

清理 ThreadLocal

使用 ThreadLocal 时需要注意内存泄漏的问题。ThreadLocal 变量在不需要时应该被清理，特别是在使用线程池的情况下，因为线程通常不会被销毁，而是会被线程池重用。

userCounter.remove(); // 清理操作

在实际应用中，通常会在 finally 块中调用 remove() 方法，以确保 ThreadLocal 变量在方法调用结束后被清理掉：

try {
    userCounter.set((int) (Math.random() * 100D));
    // 做一些工作
} finally {
    userCounter.remove();
}

ThreadLocal with Initial Value

ThreadLocal 还可以通过覆写 initialValue() 方法或使用 withInitial(Supplier<? extends S> supplier) 方法来指定初始值。

private static final ThreadLocal<Integer> userCounter = ThreadLocal.withInitial(() -> 0);

或者：

private static final ThreadLocal<Integer> userCounter = new ThreadLocal<Integer>() {
    @Override
    protected Integer initialValue() {
        return 0;
    }
};

使用 initialValue() 或 withInitial() 可以在 ThreadLocal 变量被 get() 方法首次调用时提供一个初始值，避免返回 null。

ThreadLocal in Web Applications

在 Web 应用中，ThreadLocal 常用于存取与当前请求相关的数据，例如用户身份验证信息。例如，Spring 框架使用 ThreadLocal 来持有当前请求的 Authentication 对象。

public class WebSession {

    private static final ThreadLocal<User> currentUser = new ThreadLocal<>();

    public void loginUser(User user) {
        currentUser.set(user); // 在用户登录时设置用户信息
    }

    public void logoutUser() {
        currentUser.remove(); // 在用户登出时清理用户信息
    }

    // 其他方法可以依赖 currentUser.get() 来获得当前登录的用户信息
}

在上面的例子中，currentUser 变量用于存储当前登录的用户信息。每次用户登录或登出时，都应当相应地设置或清理 ThreadLocal 变量。

总结

ThreadLocal 是一个强大的工具，它能够简化线程的上下文管理，使每个线程都有自己独立的变量副本。不过，如果不正确使用或未及时清理，ThreadLocal 变量可能会导致内存泄漏。因此，使用 ThreadLocal 时需要特别注意其生命周期和资源清理。