ThreadLocal的應用及原理_ZenDei技術網路在線

## 1. ThreadLocal 是什麼 JDK 對`ThreadLocal`的描述為： > 此類提供線程局部變數。這些變數與普通變數的不同之處在於，每個訪問一個變數的線程（通過其get或set方法）都有自己的、獨立初始化的變數副本。ThreadLocal 實例通常是類中的私有靜態欄位，這些欄位希 ...

1. ThreadLocal 是什麼

JDK 對ThreadLocal的描述為：

此類提供線程局部變數。這些變數與普通變數的不同之處在於，每個訪問一個變數的線程（通過其get或set方法）都有自己的、獨立初始化的變數副本。ThreadLocal 實例通常是類中的私有靜態欄位，這些欄位希望將狀態與線程（例如，用戶ID或事務ID）相關聯。

說白了，ThreadLocal就是用來存放線程自身相關數據的一個容器，這個容器叫做ThreadLocalMap，它是ThreadLocal的一個靜態內部類，同時作為Thread類的一個成員變數。ThreadLocal在使用時，先拿到當前線程的成員變數ThreadLocalMap，以當前的ThreadLocal對象作為key，變數作為value 存入ThreadLocalMap。然後每個線程取變數都是從線程各自的ThreadLocalMap中取值，自然是線程安全的了。因為變數只在自己線程的生命周期內起作用，所以說ThreadLocal 提供線程局部變數，或者叫線程本地變數。

ThreadLocal 的特點有3個：

線程併發：在多線程併發的場景下使用。
數據傳遞：通過 ThreadLocal ，在同一個線程中，不同組件中傳遞公共變數。
線程隔離：不同線程之間互不幹擾，這種變數線上程的生命周期內起作用。

2. ThreadLocal 怎麼用

ThreadLocal 的常用方法有：

public ThreadLocal()：通過構造器創建對象。一般是靜態的。
<S> ThreadLocal<S> withInitial(Supplier<? extends S> supplier)：初始化一個 ThreadLcoal。
void set(T value)：設置當前線程綁定的局部變數。
T get()：獲取當前線程綁定的局部變數。
void remove()：刪除當前線程綁定的局部變數。

2.1 使用入門

2.1.1 原始版本

現在模擬一個需求，一個線程在業務開始時初始化一個用戶 id（類似在一次web請求中上下文中初始化一下用戶信息），業務結束時獲取這個用戶 id（比如用來列印日誌，或者作為一個公共變數運用到業務編碼中），存在多個這樣的線程。

public class ThreadLocalTest {
    private String userId;

    private String getUserId() {
        return userId;
    }

    private void setUserId(String userId) {
        this.userId = userId;
    }

    public static void main(String[] args) {
        ThreadLocalTest test = new ThreadLocalTest();
        for (int i = 1; i < 6; i++) {
            Thread thread = new Thread(() -> {
                // 當前線程初始化userId
                test.setUserId(Thread.currentThread().getName() + "的userId");
                // 執行其他業務代碼
                System.out.println("===執行業務代碼===");
                // 當前線程獲取userId
                System.out.println(Thread.currentThread().getName() + "-->" + test.getUserId());
            });
            thread.setName("線程" + i);
            thread.start();
        }
    }
}

一種可能的結果：

===執行業務代碼===
線程2-->線程1的userId
===執行業務代碼===
線程1-->線程3的userId
===執行業務代碼===
線程3-->線程3的userId
===執行業務代碼===
線程4-->線程4的userId

由於線程調度的不確定性，可能線程1運行到一半，切換到了線程2，於是線程2獲取到的 userId 是線程1設置的。也就是說，每個線程之間的變數不是隔離的，造成數據錯誤。

2.1.2 ThreadLocal 版本

每個線程中的變數都存放到自己的線程當中，所以這些變數叫做線程局部變數很形象。

public class ThreadLocalTest {
    private static ThreadLocal<String> context = new ThreadLocal<>();

    private String getUserId() {
        return context.get();
    }

    private void setUserId(String userId) {
        context.set(userId);
    }

    public static void main(String[] args) {
        ThreadLocalTest test = new ThreadLocalTest();
        for (int i = 1; i < 5; i++) {
            Thread thread = new Thread(() -> {
                test.setUserId(Thread.currentThread().getName() + "的userId");
                System.out.println("===執行業務代碼===");
                System.out.println(Thread.currentThread().getName() + "-->" + test.getUserId());
                context.remove(); // 使用完清理線程局部變數
            });
            thread.setName("線程" + i);
            thread.start();
        }
    }
}

這樣每個線程就互不幹擾，不會取錯變數值。一種可能的結果如下：

===執行業務代碼===
線程1-->線程1的userId
===執行業務代碼===
線程4-->線程4的userId
===執行業務代碼===
線程2-->線程2的userId
===執行業務代碼===
線程3-->線程3的userId

2.1.3 synchronized 版本

如果只看結果的正確性，用 synchronized 給業務代碼塊加鎖也是可以完成的。如下：

Thread thread = new Thread(() -> {
    synchronized (ThreadLocalTest.class) {
        test.setUserId(Thread.currentThread().getName() + "的userId");
        System.out.println("===執行業務代碼===");
        System.out.println(Thread.currentThread().getName() + "->" + test.getUserId());
    }
});

這樣完全可以實現需求，但是 synchronized 的問題是什麼呢？我們總說誰誰誰是線程安全的類，因為它有 synchronized 修飾。就是因為 synchronized 讓多線程變成了單線程，它一次只允許一個線程執行，它能不安全嗎？但它帶來的代價是性能的下降，它不能併發執行，而 ThreadLocal 可以併發執行。

2.1.4 ThreadLocal 和 synchronized 對比

綜上，synchronized 和 ThreadLocal 兩個處理問題的角度和場景是不同的。

synchronized 的側重點在於保證操作的原子性，保證併發場景下共用變數的數據一致性。
ThreadLocal 強調線程隔離性，不同的線程互不幹擾，保證併發場景下數據傳遞的正確性。在web請求上下文中較為常見。

3. ThreadLocal 原理

3.1 代碼結構

ThreadLocal 的原理要從它的set(T value)、get()方法的源碼入手。在 set 值的時候，首先會獲取當前線程一個的成員變數ThreadLocalMap，ThreadLocalMap的 key 是當前ThreadLocal對象，value 是要存入的值。這個 key 和 value 會存到哪裡呢？ThreadLocalMap還有個內部類Entry，這個Entry繼承了WeakReference，key 賦值給弱引用，也就是當前的ThreadLocal對象，value 則賦值給Entry的成員變數value。ThreadLocalMap也是一個哈希表（所謂哈希表，也叫散列表，它基於數組，通過某種哈希演算法計算出一系列關鍵字對應的散列值，然後以這些散列值作為數組索引將數據存放到對應位置，達到快速查找的目的），它內部維護一個Entry數組，來存儲鍵值對。存數據的時候也是通過哈希函數計算ThreadLocal 對象對應的數組下標，然後放入Entry數組中。

3.2 記憶體泄漏問題

ThreadLocal 會發生記憶體泄漏嗎？我們結合代碼慢慢分析。

在 2.1.1 節中有這樣的代碼：

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

    private void setUserId(String userId) {
        threadLocal.set(userId);
    }
    // ...
}

首先，我們new了一個 ThreadLocal 對象，這裡存在一個強引用：threadLocal引用變數指向 ThreadLocal 對象。其次，當其他線程執行setUserId方法時，ThreadLocal 的set方法最終是把數據存到了ThreadLocalMap中的Entry，看源碼我們會發現，存數據最終是調用Entry的構造器Entry(ThreadLocal<?> k, Object v)完成的，而k這個參數是傳入的this對象，說明什麼？我們使用 ThreadLocal 對象調用set，那this肯定是當前new出來的 ThreadLocal 對象！再次說明，我們new出來的 ThreadLocal 對象有兩個引用指向它：

threadLocal變數的強引用。
在Entry中 key 的弱引用。

此時再看一張圖（這張圖被廣泛引用，感謝原圖作者