ThreadLocal 在上下文传值场景实践源码

ThreadLocal 是 Java 中常用的多线程编程技术之一，它可以在多个线程环境中保存并传递数据，将数据与线程绑定在一起，实现线程的局部变量。在一些上下文传值的场景中，ThreadLocal 可以较为方便的实现参数的传递。接下来，本文将详细讲解 ThreadLocal 在上下文传值场景实践源码的完整攻略。

什么是 ThreadLocal

ThreadLocal 是一个与线程绑定的变量，它可以在不同线程中保存和取出相应的值，即每个 ThreadLocal 对象都可以在某个线程中存储一个值。在多个线程环境下，每个线程可能都需要访问变量并进行修改，但是线程之间互相干扰会导致数据不一致，ThreadLocal 就是为了解决这一问题而存在的。

在 Java 中，ThreadLocal 可以实现变量的线程局部化，保证每个线程中有自己的变量副本，避免线程干扰，实现了线程间数据的隔离。ThreadLocal 常用于应用中跨越多个组件、层或方法的上下文传值场景中，就可以避免传参的烦扰。单例线程池异步处理的时候，经常需要在线程调用之前或结束时传递一些值。

ThreadLocal 用法示例

下面让我们通过两个示例来说明 ThreadLocal 的用法，先定义一个简单的 Request 类，模拟一个请求。

public class Request {

    private final String name;

    public Request(String name) {
        this.name = name;
    }

    public String getName() {
        return name;
    }
}

示例一：通过 ThreadLocal 将 Request 对象在多个方法中传递

假设现在有一个三层的方法嵌套：firstMethod -> secondMethod -> thirdMethod，需要将一个 Request 对象在这三个方法中传递。此时可以使用 ThreadLocal，将 Request 对象绑定到当前线程中。

public class ThreadLocalExample1 {

    private static final ThreadLocal<Request> REQUEST_THREAD_LOCAL = new ThreadLocal<>();

    public static void main(String[] args) {
        Request request = new Request("test");
        REQUEST_THREAD_LOCAL.set(request);
        firstMethod();
    }

    public static void firstMethod() {
        Request request = REQUEST_THREAD_LOCAL.get();
        System.out.println("firstMethod get request: " + request.getName());
        secondMethod();
    }

    public static void secondMethod() {
        Request request = REQUEST_THREAD_LOCAL.get();
        System.out.println("secondMethod get request: " + request.getName());
        thirdMethod();
    }

    public static void thirdMethod() {
        Request request = REQUEST_THREAD_LOCAL.get();
        System.out.println("thirdMethod get request: " + request.getName());
    }
}

运行结果如下：

firstMethod get request: test
secondMethod get request: test
thirdMethod get request: test

从结果可以看出，通过 ThreadLocal 可以实现变量在多个方法中的传递，非常方便。

示例二：在多线程环境中使用 ThreadLocal

假如现在有 2 个线程，需要对一个计数器进行操作，每个线程自己维护计数。此时可以使用 ThreadLocal，将计数器的值绑定到当前线程中。

public class ThreadLocalExample2 {

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

    public static void main(String[] args) throws InterruptedException {
        Thread t1 = new Thread(() -> {
            int counter = COUNTER.get();
            for (int i = 0; i < 5; i++) {
                counter++;
                COUNTER.set(counter);
                System.out.println(Thread.currentThread().getName() + " - " + counter);
            }
        });

        Thread t2 = new Thread(() -> {
            int counter = COUNTER.get();
            for (int i = 0; i < 5; i++) {
                counter++;
                COUNTER.set(counter);
                System.out.println(Thread.currentThread().getName() + " - " + counter);
            }
        });

        t1.start();
        t2.start();
        t1.join();
        t2.join();
    }
}

运行结果如下：

Thread-0 - 1
Thread-0 - 2
Thread-0 - 3
Thread-0 - 4
Thread-0 - 5
Thread-1 - 1
Thread-1 - 2
Thread-1 - 3
Thread-1 - 4
Thread-1 - 5

从结果可以看出，每个线程自己维护自己的计数器，ThreadLocal 实现了在多线程环境下的计数器对象的隔离。

结语

本文详细讲解了 ThreadLocal 在上下文传值场景实践源码的完整攻略，并提供了两个示例，希望可以帮助到大家。ThreadLocal 是一个非常实用的多线程编程技术，可以帮助避免线程干扰的问题，实现线程间数据隔离。