Java 超详细讲解ThreadLocal类的使用

什么是ThreadLocal？

ThreadLocal是Java的一个线程封闭工具类，它允许当前线程存储和获取某个值，并且这个值对其他线程是不可见的。

通常情况下，我们需要共享数据之间遵循建议：

1. 不可变的元素在任何情况下都是线程安全的。
2. 可变的元素在并发情况下，应该遵循不同的访问方式，例如同步访问。
3. 不可变还是可变取决于某些情况。在多个线程访问同一个数据时，仅当数据确实是不变的情况下，才能确保数据是线程安全的。

但是，有时我们需要将可变数据作为线程的本地变量，这时使用ThreadLocal就非常方便。

ThreadLocal 的使用

创建ThreadLocal对象

创建ThreadLocal对象的语法很简单：

ThreadLocal<String> threadLocal = new ThreadLocal<>();

上面的代码会创建一个ThreadLocal实例，它是一个泛型，指定存储在ThreadLocal中的值的类型。我们使用无参构造函数创建ThreadLocal对象，这意味着initialValue()方法将返回null。

设置ThreadLocal变量值

使用set()方法设置ThreadLocal的值，当前线程可以通过get()方法检索该值。示例如下：

public class MyThread {
    private static final ThreadLocal<String> threadLocal = new ThreadLocal<>();

    public static void setData(String data){
        threadLocal.set(data);
    }

    public static String getData(){
        return threadLocal.get();
    }
}

在上面的代码示例中，我们将ThreadLocal对象声明为static和final，这是因为ThreadLocal类的实例是可重用的。这意味着如果多个线程使用一个ThreadLocal实例，则它们将共享其中的值。因此，为了保持变量共享的安全性，我们必须将ThreadLocal对象声明为static和final以保持其实例唯一性。

清除ThreadLocal变量值

在使用ThreadLocal时，要注意内存泄漏问题，由于ThreadLocal强引用了存储在其中的变量，这可能导致永久的内存泄漏。为了避免内存泄漏，我们需要显式的调用remove()方法来删除ThreadLocal变量值。

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

示例1：使用ThreadLocal实现线程安全的SimpleDateFormat

SimpleDateFormat是Java中非常常用的日期格式化类，但它不是线程安全的。使用ThreadLocal，我们可以实现线程安全的SimpleDateFormat

public class DateUtils {
    private static final ThreadLocal<SimpleDateFormat> dateFormat = ThreadLocal.withInitial(() -> new SimpleDateFormat("yyyy-MM-dd HH:mm:ss"));

    public static String format(Date date){
        return dateFormat.get().format(date);
    }
}

在上面的代码示例中，我们创建了一个ThreadLocal实例，初始值为SimpleDateFormat，这意味着每个线程都有自己的日期格式化实例，这避免了在多线程环境下访问SimpleDateFormat对象的线程安全问题。

示例2：在Web应用程序中使用ThreadLocal

在Web应用程序中，线程安全特别重要，因为多个请求经常处理在同一个线程上。为了实现线程安全，需要使用ThreadLocal存储一些特定于线程的值，例如当前用户的信息。示例如下：

public abstract class BaseController {
    private static final ThreadLocal<User> currentUser = new ThreadLocal<>();

    public User getCurrentUser(){
        return currentUser.get();
    }

    public void setCurrentUser(User user){
        currentUser.set(user);
    }

    public void clearCurrentUser(){
        currentUser.remove();
    }
}

public class UserController extends BaseController {
    public void login(String username, String password){
        User user = userService.login(username,password);
        setCurrentUser(user);
    }

    public void logout(){
        clearCurrentUser();
        //执行其他逻辑
    }
}

在上面的代码示例中，我们创建了一个ThreadLocal实例，每个线程都维护自己的用户信息，从而保证线程安全。

总结

ThreadLocal是一种非常有用的Java工具类，它允许我们创建线程本地变量，避免了多线程环境下并发访问同一变量的安全问题，值得我们在实际开发中认真对待。