Java ThreadLocal变量 - 什么时候用以及如何使用

今天，并发应用程序最关键的方面之一是共享数据。当您创建实现Runnable接口的线程，然后使用相同的Runnable对象启动各种线程对象时，所有线程共享Runnable对象内定义的相同属性。这实际上意味着，如果您更改线程中的任何属性，所有线程都将受到此更改的影响，并将在第一个线程中看到修改后的值。有时它是期望的行为，例如多个线程增加/减少相同的计数器变量；但有时您希望确保每个线程必须在它自己的线程实例副本上工作，而不影响其他数据。

什么时候使用ThreadLocal？

例如，假设您正在处理一个电子商务应用程序。您需要为每个请求此控制器流程的客户生成唯一的事务id，并且需要将此事务id传递给manager/DAO类中的业务方法，以便进行日志记录。一个解决方案是将这个事务id作为参数传递给所有业务方法。但这不是一个好的解决方案，因为代码会产生不必要的冗余。

想要解决这个问题，可以使用ThreadLocal变量。您可以在控制器或任何预处理器拦截器中生成事务id；并在ThreadLocal中设置此事务id。之后，无论控制器调用什么方法，它们都可以从threadlocal访问这个事务id。还请注意，应用程序控制器将同时处理多个请求，由于每个请求在框架级别上在单独的线程中处理，因此事务id对于每个线程都是惟一的，并且可以从线程的所有执行路径访问它。

更多信息：与JAX-RS ResteasyProviderFactory共享上下文数据(ThreadLocalStack示例)

ThreadLocal类内部？

Java并发API使用ThreadLocal类为线程本地变量提供了一种干净的机制，具有非常好的性能。

public class ThreadLocal<T> extends Object {...}

该类提供线程本地变量。这些变量与普通的对应变量的不同之处在于，每个访问一个变量的线程(通过其get或set方法)都有自己的、独立初始化的变量副本。ThreadLocal实例通常是类中的私有静态字段，类希望将状态与线程关联(例如，用户ID或事务ID)。

这个类有以下方法:

1. get()：返回该线程本地变量的当前线程副本中的值。
2. initialValue()：返回这个线程本地变量的当前线程的“初始值”。
3. remove()：删除这个线程本地变量的当前线程值。
4. set(T value)：将当前线程的这个线程本地变量的副本设置为指定的值。

如何使用ThreadLocal?

下面的例子使用了两个线程本地变量，即threadId和startDate。两者都被定义为推荐的private static字段。threadId将用于标识当前正在运行的线程，startDate将用于获取线程开始执行的时间。以上信息将打印在控制台中，以验证每个线程都维护了自己的变量副本。

public class DemoTask implements Runnable {
    // 包含要分配的下一个线程ID的原子整数
    private static final AtomicInteger nextId = new AtomicInteger(0);

    // 包含每个线程的ID的ThreadLocal变量
    private static final ThreadLocal<Integer> threadId = new ThreadLocal<Integer>() {
        @Override
        protected Integer initialValue() {
            return nextId.getAndIncrement();// 获取值，并递增
        }
    };

    // 返回当前线程的唯一ID，必要时为其赋值
    public int getThreadId() {
        return threadId.get();
    }

    // 返回当前线程的启动时间戳
    private static final ThreadLocal<Date> startDate = new ThreadLocal<Date>() {
        protected Date initialValue() {
            return new Date();
        }
    };


    public void run() {
        System.out.printf("Starting Thread: %s : %s\n", getThreadId(), startDate.get());
        try {
            TimeUnit.SECONDS.sleep((int) Math.rint(Math.random() * 10));
        } catch (InterruptedException e) {
            e.printStackTrace();
        }
        System.out.printf("Thread Finished: %s : %s\n", getThreadId(), startDate.get());
    }
}

现在，为了验证变量基本上能够维护它们的状态，而不需要考虑多个线程的多个初始化，让我们创建这个任务的三个实例；启动线程;然后验证它们在控制台打印的信息。

public class ThreadLocalExample {
    public static void main(String[] args) throws Exception {
        Thread thread[] = new Thread[3];
        for (int i = 0; i < 3; i++) {
            DemoTask demoTask = new DemoTask();
            thread[i] = new Thread(demoTask, "Thread " + i);
        }
        for (int i = 0; i < 3; i++) {
            thread[i].start();
            TimeUnit.SECONDS.sleep((int) Math.rint(Math.random() * 10));
        }
    }
}

输出结果为

Starting Thread: 0 : Mon Mar 04 00:15:28 CST 2019
Thread Finished: 0 : Mon Mar 04 00:15:28 CST 2019

Starting Thread: 1 : Mon Mar 04 00:15:31 CST 2019
Thread Finished: 1 : Mon Mar 04 00:15:31 CST 2019

Starting Thread: 2 : Mon Mar 04 00:15:37 CST 2019
Thread Finished: 2 : Mon Mar 04 00:15:37 CST 2019

在上面的输出中，每次打印语句的顺序都会有所不同。我将它们按顺序排列，这样我们就可以清楚地确定每个线程实例的线程本地值都是安全的；不会混杂在一起。自己尝试一下。

ThreadLocal最常见的用法是，当您有某个对象不是线程安全的，但是您希望避免使用synchronized关键字/块对该对象进行同步访问时。相反，应该为每个线程提供其要使用的对象的实例。
同步或threadlocal的一个很好的替代方法是将变量变成一个本地变量。局部变量总是线程安全的。唯一可能阻止您这样做的是您的应用程序设计约束。

在wabapp服务器中，它可能保留一个线程池，因此在响应客户机之前应该删除ThreadLocal变量，因为当前线程可能被下一个请求重用。此外，如果在完成时不清理，那么它对作为已部署webapp的一部分加载的类的任何引用都将保留在永久堆中，永远不会被垃圾收集。

参考资料
Java ThreadLocal Variables – When and How to Use?