SpringBoot ThreadLocal 簡單介紹及使用詳解

更新時間：2024年01月19日 14:32:47 作者：致最長的電影

ThreadLocal 叫做線程變量,意思是 ThreadLocal 中填充的變量屬于當前線程,該變量對其他線程而言是隔離的,也就是說該變量是當前線程獨有的變量,這篇文章主要介紹了SpringBoot ThreadLocal 的詳解,需要的朋友可以參考下

一、ThreadLocal 簡介

ThreadLocal 叫做線程變量，意思是 ThreadLocal 中填充的變量屬于當前線程，該變量對其他線程而言是隔離的，也就是說該變量是當前線程獨有的變量。ThreadLocal 為變量在每個線程中都創(chuàng)建了一個副本，那么每個線程可以訪問自己內(nèi)部的副本變量。

ThreadLocal 變量，線程局部變量，同一個 ThreadLocal 所包含的對象，在不同的 Thread 中有不同的副本。這里有幾點需要注意：

因為每個 Thread 內(nèi)有自己的實例副本，且該副本只能由當前 Thread 使用。這也是 ThreadLocal 命名的由來。
既然每個 Thread 有自己的實例副本，且其它 Thread 不可訪問，那就不存在多線程間共享的問題。

ThreadLocal 提供了線程本地的實例。它與普通變量的區(qū)別在于，每個使用該變量的線程都會初始化一個完全獨立的實例副本。

ThreadLocal 變量通常被 private static 修飾。當一個線程結(jié)束時，它所使用的所有 ThreadLocal 相對的實例副本都可被回收。

下圖可以增強理解：

二、ThreadLocal 與 Synchronized 的區(qū)別

ThreadLocal<T> 其實是與線程綁定的一個變量。ThreadLocal 和 Synchorized 都用于解決多線程并發(fā)訪問。

但是 ThreadLocal 和 Synchorized 有本質(zhì)的區(qū)別：

Synchorized 用于線程間的數(shù)據(jù)共享，而 ThreadLocal 則用于線程間的數(shù)據(jù)隔離。
Synchorized 是利用鎖的機制，使變量或代碼塊在某一時刻只能被一個線程訪問。而 ThreadLocal 為每一個線程都提供了變量的副本，使得每個線程在某一時間訪問到的并不是同一個對象，這樣就隔離了多個線程對數(shù)據(jù)的數(shù)據(jù)共享。

而 Synchorized 卻正好相反，它用于在多個線程間通信時能夠獲得數(shù)據(jù)共享。

總結(jié)：

一句話理解 ThreadLocal ，threadLocal 是作為當前線程中屬性 ThreadLocalMap 集合中的某一個 Entry 的 key 值，Entry（threadlocal，value），雖然不同的線程之間 threadLocal 這個 key 值是一樣，但是不同的線程所擁有的 ThreadLocalMap 是獨一無二的，也就是不同的線程間同一個 ThreadLocal（key）對應存儲的值（value）不一樣，從而到達了線程間變量隔離的目的，但是在同一個線程中這個 value 變量地址是一樣的。

三、ThreadLocal 的簡單使用

public class ThreadLocalTest {
    private static ThreadLocal<String> localVar = new ThreadLocal<String>();
    static void print(String str) {
        // 打印當前線程中本地內(nèi)存中變量的值
        System.out.println(str + ":" + localVar.get());
        // 清除內(nèi)存中的本地變量
        localVar.remove();
    }
    public static void main(String[] args) throws InterruptedException {
        new Thread(new Runnable() {
            @Override
            public void run() {
                ThreadLocalTest.localVar.set("xdclass_A");
                print("A");
                // 打印本地變量
                System.out.println("清楚后：" + localVar.get());
            }
        }, "A").start();
        Thread.sleep(1000);
        new Thread(new Runnable() {
            @Override
            public void run() {
                ThreadLocalTest.localVar.set("xdclass_B");
                print("B");
                // 打印本地變量
                System.out.println("清楚后：" + localVar.get());
            }
        }, "B").start();
    }
}
A:xdclass_A
清楚后：null
B:xdclass_B
清楚后：null

從這個示例中我們可以看到，兩個線程分別獲取了自己線程存放的變量，他們之間變量的獲取并不會錯亂。這個的理解也可以結(jié)合圖，相信會有一個更深刻地理解。

四、ThreadLocal 常見使用場景

ThreadLocal 適用于如下兩種場景

每個線程需要有自己單獨的實例
實例需要在多個方法中共享，但不希望被多線程共享

對于第一點，每個線程擁有自己實例，實現(xiàn)它的方式很多。例如可以在線程內(nèi)部構(gòu)建一個單獨的實例。ThreadLoca 可以以非常方便的形式滿足該需求。

對于第二點，可以在滿足第一點（每個線程有自己的實例）的條件下，通過方法間引用傳遞的形式實現(xiàn)。ThreadLocal 使得代碼耦合度更低，且實現(xiàn)更優(yōu)雅。

存儲用戶 userInfo 場景：

@Slf4j
public class OnlineUserUtil {
    private final static ThreadLocal<UserInfo> threadLocal = new ThreadLocal<>();
    public static void set(UserInfo userInfo) {
        threadLocal.set(userInfo);
    }
    public static UserInfo get() {
        return threadLocal.get();
    }
    public static void remove() {
        threadLocal.remove();
    }
}

@Slf4j
@Aspect
@Component
@Order(2)
public class TokenAuthenticationAspect {
    @Before(value = "@annotation(tokenAuthentication)")
    public void doBefore(JoinPoint pjp, TokenAuthentication tokenAuthentication) {
        // 校驗代碼
        log.info("驗證成功，保存到threadLocal userInfo={}", userInfo);
        OnlineUserUtil.set(userInfo);
    }
    @AfterReturning(value = "@annotation(tokenAuthentication)")
    public void doAfter(TokenAuthentication tokenAuthentication) {
        OnlineUserUtil.remove();
    }
}

這樣在方法中，都能用到 userInfo 這個對象。

五、如何正確的使用 ThreadLocal

將ThreadLocal變量定義成private static的，這樣的話ThreadLocal的生命周期就更長，由于一直存在ThreadLocal的強引用，所以ThreadLocal也就不會被回收，也就能保證任何時候都能根據(jù)ThreadLocal的弱引用訪問到Entry的value值，然后remove它，防止內(nèi)存泄露。
每次使用完ThreadLocal，都調(diào)用它的remove()方法，清除數(shù)據(jù)。