记一次CompletableFuture+ThreadLoaal使用

ThreadLocal简介

ThreadLocal 是 Java 中的一个类，它提供了线程本地变量，每个线程都可以独立地操作自己的变量副本，互不影响。在多线程编程中，使用 ThreadLocal 可以方便地实现线程封闭（Thread confinement）和线程局部变量（Thread-local variables）的需求。

以下是关于 ThreadLocal 的详细解释：

线程封闭（Thread Confinement）： 线程封闭是一种将对象限制在特定线程中使用的技术。使用 ThreadLocal 可以轻松实现线程封闭，即每个线程都可以拥有自己独立的对象实例，互不干扰。
线程局部变量（Thread-local variables）： ThreadLocal 主要用于创建线程局部变量。线程局部变量是指，每个线程都有自己独立的变量，线程之间不会相互干扰。通过 ThreadLocal，我们可以在多线程环境中安全地访问和修改变量，而不需要进行额外的同步操作。

使用方式： 使用 ThreadLocal 很简单。你可以通过创建 ThreadLocal 对象，并通过 set 和 get 方法来存取变量。每个线程调用 get 或 set 方法时，都会操作自己的变量副本。

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

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

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

初始值： 可以通过重写 ThreadLocal 的 initialValue 方法来设置线程变量的初始值。

java
private static final ThreadLocal<String> threadLocal = new ThreadLocal<String>() {
    @Override
    protected String initialValue() {
        return "Default Value";
    }
};

注意事项：

使用 ThreadLocal 时，需要注意内存泄漏的问题。如果线程一直存在，但 ThreadLocal 中的对象引用却一直存在，就可能导致内存泄漏。
在线程池等使用线程复用的情况下，要确保在使用完毕后清理 ThreadLocal 中的变量，可以使用 remove 方法。

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

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

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

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

注

总的来说，ThreadLocal 是一种在多线程环境下管理变量的有效方式，可以确保每个线程都有自己的独立副本，避免了线程之间的干扰。

CompletableFuture中获取主线程ThreadLocal的方式

在 CompletableFuture 中获取主线程的 ThreadLocal 值可能涉及到线程上下文切换的问题。由于 CompletableFuture 使用线程池执行任务，异步任务可能在不同的线程中执行，因此在异步任务中直接获取主线程的 ThreadLocal 值可能会遇到无法获取的情况。 CompletableFuture 在异步执行任务时可能会使用不同的线程池，这可能导致在异步任务中无法获取到主线程的 ThreadLocal 的值。ThreadLocal 存储的是线程本地变量，因此在不同的线程中，ThreadLocal 的值是独立的，以下是两种获取方式

方式一：

java
import java.util.concurrent.CompletableFuture;

public class ThreadLocalExample {

    private static ThreadLocal<String> myThreadLocal = new ThreadLocal<>();

    public static void main(String[] args) throws Exception {
        // 设置主线程的 ThreadLocal 值
        myThreadLocal.set("Main Thread Value");

        CompletableFuture<Void> future = CompletableFuture.runAsync(() -> {
            // 在异步任务中获取主线程的 ThreadLocal 值
            String mainThreadValue = myThreadLocal.get();
            System.out.println("Value in async task: " + mainThreadValue);
        });

        // 等待异步任务完成
        future.get();

        // 清除主线程的 ThreadLocal
        myThreadLocal.remove();
    }
}

在这个例子中，通过 myThreadLocal.get() 方法在异步任务中获取了主线程的 ThreadLocal 值。注意，需要在异步任务执行之前设置好主线程的 ThreadLocal 值。

如果异步任务的执行依赖于主线程的 ThreadLocal 值，确保在异步任务开始执行之前传递所需的值。如果异步任务需要访问主线程的多个 ThreadLocal 变量，你可能需要创建一个包含这些值的数据结构，并将这个数据结构传递给异步任务。

方式二：

java
import java.util.concurrent.CompletableFuture;

public class Main {

    public static void main(String[] args) throws Exception {
        // 在主线程中设置 ThreadLocal 值
        ThreadLocal<String> myThreadLocal = new ThreadLocal<>();
        myThreadLocal.set("Main Thread Value");

        // 创建 CompletableFuture，并传递主线程的 ThreadLocal 值
        CompletableFuture<Void> future = CompletableFuture.runAsync(() -> {
            // 在异步任务中获取传递的 ThreadLocal 值
            String value = myThreadLocal.get();
            System.out.println("Async Task Value: " + value);
            // 异步任务的逻辑
        }, RunnableWithThreadLocal.of(myThreadLocal));

        // 等待 CompletableFuture 完成
        future.get();

        // 清理 ThreadLocal，防止内存泄漏
        myThreadLocal.remove();
    }

    // 用于包装 Runnable，并传递主线程的 ThreadLocal 值
    static class RunnableWithThreadLocal implements Runnable {
        private final ThreadLocal<String> threadLocal;
        
        private RunnableWithThreadLocal(ThreadLocal<String> threadLocal) {
            this.threadLocal = threadLocal;
        }

        public static RunnableWithThreadLocal of(ThreadLocal<String> threadLocal) {
            return new RunnableWithThreadLocal(threadLocal);
        }

        @Override
        public void run() {
            // 在异步任务中获取主线程的 ThreadLocal 值
            String value = threadLocal.get();
            System.out.println("Async Task Value: " + value);
            // 异步任务的逻辑
        }
    }
}

上述代码中，通过创建一个自定义的 Runnable 包装类 RunnableWithThreadLocal，并在构造函数中传递主线程的 ThreadLocal 值。然后，通过 CompletableFuture.runAsync 方法执行这个包装类的实例，从而在异步任务中获取主线程的 ThreadLocal 值。这种方式通过传递值的方式实现了在异步任务中获取主线程的 ThreadLocal 值的需求。

独立的执行上下文

"独立的执行上下文"指的是不同的线程拥有不同的执行环境，它们之间的状态和资源是相互隔离的。在多线程编程中，每个线程都有自己的栈、程序计数器和寄存器等执行状态，它们互不干扰。

具体来说，当我们说主线程和线程池中的线程拥有独立的执行上下文时，主要涉及以下几个方面：

栈：每个线程都有自己的执行栈，用于存储方法调用、局部变量和线程私有的数据。线程之间的栈是相互独立的，一个线程无法直接访问另一个线程的栈信息。
程序计数器： 程序计数器用于记录当前线程执行的位置。不同线程的程序计数器是独立的，一个线程的计数器值不会影响其他线程。
寄存器： 寄存器是 CPU 内部用于存储临时数据的地方。不同线程的寄存器也是独立的，一个线程无法直接读取或修改其他线程的寄存器内容。
线程私有数据： 每个线程都可以有自己的线程私有数据，包括 ThreadLocal 变量等。这些数据对于一个线程是私有的，其他线程无法直接访问。

总体而言，每个线程都有自己的执行环境，而线程之间的状态和资源是相互隔离的。这种隔离确保了并发执行的线程之间不会相互干扰，但也需要通过一些机制来进行线程间的协同和数据共享。

目录

ThreadLocal简介

CompletableFuture中获取主线程ThreadLocal的方式

独立的执行上下文