ThreadLocal 遇上線程池的問題及解決辦法

      ThreadLocal 稱為線程本地存儲，一般作為靜態域使用，它為每一個使用它的線程提供一個其值（value）的副本。通常對數據庫連接（Connection）和事務（Transaction）使用線程本地存儲。

      可以簡單地將 ThreadLocal<T> 理解成一個容器，它將 value 對象存儲在 Map<Thread, T> 域中，即使用當前線程為 key 的一個 Map，ThreadLocal 的 get() 方法從 Map 里取與當前線程相關聯的 value 對象。ThreadLocal 的真正實現並不是這樣的，但是可以簡單地這樣理解。

      線程池中的線程在任務執行完成后會被復用，所以在線程執行完成時，要對 ThreadLocal 進行清理（清除掉與本線程相關聯的 value 對象）。不然，被復用的線程去執行新的任務時會使用被上一個線程操作過的 value 對象，從而產生不符合預期的結果。

      下面舉一個簡單的例子來說明：

import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;

public class ThreadLocalVariableHolder {
    private static ThreadLocal<Integer> variableHolder = new ThreadLocal<Integer>() {
        @Override
        protected Integer initialValue() {
            return 0;
        }
    };

    public static int getValue() {
        return variableHolder.get();
    }

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

    public static void increment() {
        variableHolder.set(variableHolder.get() + 1);
    }

    public static void main(String[] args) {
        ExecutorService executor = Executors.newCachedThreadPool();
        for (int i = 0; i < 5; i++) {
            executor.execute(() -> {
                int before = getValue();
                increment();
                int after = getValue();
                System.out.println("before: " + before + ", after: " + after);
            });
        }

        executor.shutdown();
    }
}

      執行結果如下（如果你的執行結果 before 都是 0，after 都是 1 的話，就增加線程池執行的線程個數）：

before: 0, after: 1
before: 0, after: 1
before: 0, after: 1
before: 1, after: 2
before: 1, after: 2

      既然是為每個線程都提供一個副本，為什么會出現 before 不為 0 的情況呢？

      下面追蹤每一個執行的線程，將 main 方法修改為如下：

public static void main(String[] args) {
    ExecutorService executor = Executors.newCachedThreadPool();
    for (int i = 0; i < 5; i++) {
        executor.execute(() -> {
            long threadId = Thread.currentThread().getId();
            int before = getValue();
            increment();
            int after = getValue();
            System.out.println("threadId: " + threadId + ", before: " + before + ", after: " + after);
        });
    }

    executor.shutdown();
}

      執行結果如下：

threadId: 10, before: 0, after: 1
threadId: 11, before: 0, after: 1
threadId: 12, before: 0, after: 1
threadId: 12, before: 1, after: 2
threadId: 11, before: 1, after: 2

      由上面的執行結果可以看出，id 為 11 和 12 的線程被復用。線程池在復用線程執行任務時使用被之前的線程操作過的 value 對象。因此，在每個線程執行完成時，應該清理 ThreadLocal。具體做法如下：

public static void main(String[] args) {
    ExecutorService executor = Executors.newCachedThreadPool();
    for (int i = 0; i < 100; i++) {
        executor.execute(() -> {
            try {
                long threadId = Thread.currentThread().getId();
                int before = getValue();
                increment();
                int after = getValue();
                System.out.println("threadId: " + threadId + ", before: " + before + ", after: " + after);
            } finally {
                // 清理線程本地存儲
                remove();
            }
        });
    }

    executor.shutdown();
}