ThreadLocal = 本地線程?

一、定義

ThreadLocal是JDK包提供的，從名字來看，ThreadLocal意思就是本地線程的意思。

1.1 是什麼？

要想知道他是個啥，我們看看ThreadLocal的源碼（基於JDK 1.8）中對這個類的介紹：

This class provides thread-local variables.  These variables differ from
their normal counterparts in that each thread that accesses one (via its
{@code get} or {@code set} method) has its own, independently initialized
copy of the variable.  {@code ThreadLocal} instances are typically private
static fields in classes that wish to associate state with a thread (e.g.,
a user ID or Transaction ID).

大致能夠總結出：

1. TreadLocal可以給我們提供一個線程內的局部變數，而且這個變數與一般的變數還不同，它是每個線程獨有的，與其他線程互不幹擾的；
2. ThreadLocal 與普通變數的區別在於：每個使用該變數的線程都會初始化一個完全獨立的實例副本。ThreadLocal 變數通常被private static修飾。當一個線程結束時，它所使用的所有 ThreadLocal 相對的實例副本都會被回收；
3. 簡單說ThreadLocal就是一種以空間換時間的做法，在每個Thread裡面維護了一個ThreadLocal.ThreadLocalMap，把數據進行隔離，每個線程的數據不共用，自然就沒有線程安全方面的問題了.

1.2 示例

一言不合上代碼！

//創建ThreadLocal變數
private static ThreadLocal<String> localParam = new ThreadLocal<>();

@Test
public void threadLocalDemo() {
    //創建2個線程，分別設置不同的值
    new Thread(() -> {
        localParam.set("Hello 風塵博客!");
        //列印當前線程本地記憶體中的localParam變數的值
        log.info("{}:{}", Thread.currentThread().getName(), localParam.get());
    }, "T1").start();
    new Thread(() -> {
        log.info("{}:{}", Thread.currentThread().getName(), localParam.get());
    }, "T2").start();
}

• 結果：

... T1:Hello 風塵博客!
... T2:null

列印結果證明，T1線程中設置的值無法在T2取出，證明變數ThreadLocal在各個線程中數據不共用。

1.3 ThreadLocal的API

ThreadLocal定義了四個方法:

1. get():返回此線程局部變數當前副本中的值；
2. set(T value):將線程局部變數當前副本中的值設置為指定值；
3. initialValue():返回此線程局部變數當前副本中的初始值；
4. remove():移除此線程局部變數當前副本中的值。

• set()和initialValue()區別

二、實現原理

ThreadLocal有一個特別重要的靜態內部類ThreadLocalMap，該類才是實現線程隔離機制的關鍵。

• 每個線程的本地變數不是存放在ThreadLocal實例裡面，而是存放在調用線程的threadLocals變數裡面，也就是說：ThreadLocal類型的本地變數存放在具體的線程記憶體空間中。

ThreadLocal.ThreadLocalMap threadLocals = null;
ThreadLocal.ThreadLocalMap inheritableThreadLocals = null;

• Thread類中有兩個ThreadLocalMap類型的變數，分別是threadLocals和inheritableThreadLocals，而ThreadLocalMap是一個定製化的Hashmap，專門用來存儲線程本地變數。在預設情況下，每個線程中的這兩個變數都為null，只有當前線程第一次調用ThreadLocal的set()或者get()方法時才會創建它們。

• ThreadLocal就是一個工具殼，它通過set()方法把value值放入調用線程的threadLocals裡面並存放起來，當調用線程調用它的get()方法時，再從當前線程的threadLocals變數裡面將其拿出來使用。

• 如果調用線程一直不終止，那麼這個本地變數會一直存放在調用線程的threadLocals變數裡面，所以當不需要使用本地變數時可以通過調用ThreadLocal變數的remove()方法，從當前線程的threadLocals裡面刪除該本地變數。

另外Thread裡面的threadLocals被設計為Map結構是因為每個線程可以關聯多個ThreadLocal變數。

原理小結

1. 每個Thread維護著一個ThreadLocalMap的引用；
2. ThreadLocalMap是ThreadLocal的內部類，用Entry來進行存儲；
3. 調用ThreadLocal的set()方法時，實際上就是往ThreadLocalMap設置值，key是ThreadLocal對象，值是傳遞進來的對象；
4. 調用ThreadLocal的get()方法時，實際上就是往ThreadLocalMap獲取值，key是ThreadLocal對象；
5. ThreadLocal本身並不存儲值，它只是作為一個key來讓線程從ThreadLocalMap獲取value。

三、使用場景

3.1 ThreadLocal的作用

• 保存線程上下文信息，在任意需要的地方可以獲取.

由於ThreadLocal的特性，同一線程在某地方進行設置，在隨後的任意地方都可以獲取到。從而可以用來保存線程上下文信息。

• 線程安全的，避免某些情況需要考慮線程安全必須同步帶來的性能損失.

3.2 場景一：獨享對象

每個線程需要一個獨享對象（通常是工具類，典型需要使用的類有SimpleDateFormat和Random）

這類場景阿裡規範裡面也提到了：

3.3 場景二：當前信息需要被線程內的所有方法共用

每個線程內需要保存全局變數（例如在攔截器中獲取用戶信息），可以讓不同方法直接使用，避免參數傳遞的麻煩。

演示（完整演示見文末Github）

• User.java

@Data
public class User {
    private String userName;

    public User() {

    }

    public User(String userName) {
        this.userName = userName;
    }
}

• UserContextHolder.java

public class UserContextHolder {

    public static ThreadLocal<User> holder = new ThreadLocal<>();

}

• Service1.java

public class Service1 {

    public void process() {
        User user = new User("Van");
        //將User對象存儲到 holder 中
        UserContextHolder.holder.set(user);
        new Service2().process();
    }
}

• Service2.java

public class Service2 {

    public void process() {
        User user = UserContextHolder.holder.get();
        System.out.println("Service2拿到用戶名: " + user.getUserName());
        new Service3().process();
    }
}

• Service3.java

public class Service3 {

    public void process() {
        User user = UserContextHolder.holder.get();
        System.out.println("Service3拿到用戶名: " + user.getUserName());
    }
}

• 測試方法

@Test
public void threadForParams() {
    new Service1().process();
}

• 結果列印

Service2拿到用戶名: Van
Service3拿到用戶名: Van

3.4 使用ThreadLocal的好處

1. 達到線程安全的目的；
2. 不需要加鎖，執行效率高；
3. 更加節省記憶體，節省開銷；
4. 免去傳參的繁瑣，降低代碼耦合度。

四、問題

4.1 記憶體泄漏問題

記憶體泄露：某個對象不會再被使用，但是該對象的記憶體卻無法被收回

• 正常情況

當Thread運行結束後，ThreadLocal中的value會被回收，因為沒有任何強引用了。

• 非正常情況

當Thread一直在運行始終不結束，強引用就不會被回收，存在以下調用鏈

Thread-->ThreadLocalMap-->Entry(key為null)-->value

因為調用鏈中的 value 和 Thread 存在強引用，所以value無法被回收，就有可能出現OOM。

如何避免記憶體泄漏(阿裡規範)

調用remove()方法，就會刪除對應的Entry對象，可以避免記憶體泄漏，所以使用完ThreadLocal後，要調用remove()方法。

4.2 ThreadLocal的空指針問題

• ThreadLocalNPE.java

public class ThreadLocalNPE {

    ThreadLocal<Long> longThreadLocal = new ThreadLocal<>();

    public void set() {
        longThreadLocal.set(Thread.currentThread().getId());
    }

    /**
     * 當前返回值為基本類型，會報空指針異常，如果改成包裝類型Long就不會出錯
     * @return
     */
    public long get() {
        return longThreadLocal.get();
    }
}

• 空指針測試

@Test
public void threadLocalNPE() {
    ThreadLocalNPE threadLocalNPE = new ThreadLocalNPE();
    //如果get方法返回值為基本類型，則會報空指針異常，如果是包裝類型就不會出錯
    System.out.println(threadLocalNPE.get());
}

如果get()方法返回值為基本類型，則會報空指針異常；如果是包裝類型就不會出錯。這是因為基本類型和包裝類型存在裝箱和拆箱的關係，所以，我們必須將get()方法返回值使用包裝類型。

4.3 參考文章

1. 再也不學Threadlocal了，看這一篇就忘不掉了（萬字總結）
2. 使用 ThreadLocal 一次解決老大難問題

四、技術交流

Github 示例代碼

1. 風塵博客：https://www.dustyblog.cn
2. 風塵博客-掘金
3. 風塵博客-博客園
4. Github