大家好，我是了不起。

ThreadLocal相信大家都用過，但你知道他的原理嗎，今天了不起帶大家學(xué)習(xí)ThreadLocal。

ThreadLocal是什么

在多線程編程中，經(jīng)常會(huì)遇到需要在不同線程中共享數(shù)據(jù)的情況。通常情況下，為了保證線程安全，我們需要使用鎖或其他同步機(jī)制。然而，有些情況下，我們希望在每個(gè)線程中都有一份獨(dú)立的數(shù)據(jù)副本，這就是ThreadLocal派上用場(chǎng)的地方。

ThreadLocal翻譯過來就是線程本地，也就是本地線程變量，意思是ThreadLocal中填充的變量屬于當(dāng)前線程，該變量對(duì)其他線程而言是隔離的。ThreadLocal提供了一種機(jī)制，允許我們?yōu)槊總€(gè)線程創(chuàng)建獨(dú)立的變量，每個(gè)線程都可以獨(dú)立訪問自己的變量，而不會(huì)干擾其他線程的數(shù)據(jù)。ThreadLocal為變量在每個(gè)線程中都創(chuàng)建了一個(gè)副本，那么每個(gè)線程可以訪問自己內(nèi)部的副本變量，各個(gè)線程間互不影響，從而實(shí)現(xiàn)線程安全。

ThreadLocal的原理

ThreadLocal的原理涉及到兩個(gè)重要概念：ThreadLocal實(shí)例和ThreadLocalMap。

1. ThreadLocal實(shí)例

每個(gè)ThreadLocal對(duì)象實(shí)際上是一個(gè)容器，用于存儲(chǔ)線程本地的變量副本。每個(gè)線程都可以擁有自己的ThreadLocal實(shí)例，這些實(shí)例可以存儲(chǔ)不同的數(shù)據(jù)，互相之間互不影響。

2. ThreadLocalMap

ThreadLocalMap是ThreadLocal的底層數(shù)據(jù)結(jié)構(gòu)，它是一個(gè)哈希表。每個(gè)線程都有一個(gè)與之相關(guān)聯(lián)的ThreadLocalMap，用于存儲(chǔ)該線程所擁有的ThreadLocal實(shí)例以及對(duì)應(yīng)的值。ThreadLocalMap中的鍵是ThreadLocal實(shí)例，值是該線程對(duì)應(yīng)ThreadLocal實(shí)例的變量副本。

當(dāng)我們調(diào)用ThreadLocal的set()方法設(shè)置值時(shí)，實(shí)際上是在當(dāng)前線程的ThreadLocalMap中以ThreadLocal實(shí)例為鍵，將值存儲(chǔ)在對(duì)應(yīng)的位置。而調(diào)用get()方法時(shí)，則是從當(dāng)前線程的ThreadLocalMap中根據(jù)ThreadLocal實(shí)例獲取對(duì)應(yīng)的值。

ThreadLocal怎么用，應(yīng)用場(chǎng)景

public static void main(String[] args) {
   IntStream.range(1, 5).forEach(i -> new Thread(() -> {
       // 設(shè)置線程中本地變量的值
       threadLocal.set("thread-" + i);
       // 打印當(dāng)前線程中本地內(nèi)存中本地變量的值
       System.out.println(threadLocal.get());
       // 清除本地內(nèi)存中的本地變量
       threadLocal.remove();
       // 打印本地變量
       System.out.println("thread-" + i + " after remove: " + threadLocal.get());
   }).start());
}
/*
thread-1
thread-4
thread-4 after remove: null
thread-2
thread-3
thread-2 after remove: null
thread-1 after remove: null
thread-3 after remove: null
*/

從結(jié)果可以看到，每一個(gè)線程都有各自的值，并且互不影響。

應(yīng)用場(chǎng)景

1. 用戶訪問之后，在本地線程保存用戶的身份信息，在本次訪問過程中，可以隨時(shí)獲取用戶的身份信息以驗(yàn)證身份。
2. 在進(jìn)行對(duì)象跨層傳遞的時(shí)候，使用ThreadLocal可以避免多次傳遞，打破層次間的約束。
3. 數(shù)據(jù)庫連接管理：每個(gè)線程可以擁有自己的數(shù)據(jù)庫連接，避免了線程之間的數(shù)據(jù)庫連接混淆。
4. 用戶身份管理：在Web應(yīng)用中，可以將用戶身份信息存儲(chǔ)在ThreadLocal中，以便在整個(gè)請(qǐng)求處理過程中方便地訪問。
5. 事務(wù)管理：將事務(wù)狀態(tài)存儲(chǔ)在ThreadLocal中，確保每個(gè)線程都能獨(dú)立管理自己的事務(wù)狀態(tài)。

ThreadLocal源碼分析

先看一下 ThreadLocal 和 Thread 的關(guān)系

圖片

Thread類中有一個(gè)threadLocals屬性，是ThreadLocal內(nèi)部類ThreadLocalMap類型的變量，ThreadLocalMap可以看作是一個(gè)HashMap，其內(nèi)部有一個(gè)內(nèi)部類為 Entry，繼承了WeakReference<ThreadLocal<?>>，是一個(gè)弱引用。Entry的key是ThreadLocal<?>，value是Object類型的值。

大致了解了Thread和ThreadLocal的關(guān)系之后，看一下Thread Local的源碼：我們只要看其主要的幾個(gè)方法，就可以完全了解ThreadLocal的原理了。

set方法

public void set(T value) {
    // 獲取當(dāng)前線程
    Thread t = Thread.currentThread();
    // 通過當(dāng)前線程獲取線程中的ThreadLocal.ThreadLocalMap對(duì)象
    ThreadLocalMap map = getMap(t);
    if (map != null)
        // map不為空，則直接賦值
        map.set(this, value);
    else
        // map為空，則創(chuàng)建一個(gè)ThreadLocalMap對(duì)象
        createMap(t, value);
}
// 根據(jù)提供的線程對(duì)象，和指定的值，創(chuàng)建一個(gè)ThreadLocalMap對(duì)象
void createMap(Thread t, T firstValue) {
    t.threadLocals = new ThreadLocalMap(this, firstValue);
}
// threadLocals是Thread類的一個(gè)屬性
ThreadLocalMap getMap(Thread t) {
    return t.threadLocals;
}

/*
Thread 類 182行
 // ThreadLocal values pertaining to this thread. This map is maintained by the ThreadLocal class.
 與該線程有關(guān)的ThreadLocal值。這個(gè)映射由ThreadLocal類維護(hù)
    ThreadLocal.ThreadLocalMap threadLocals = null;
*/

get方法

// ThreadLocalMap中的內(nèi)部類，存放key，value
static class Entry extends WeakReference<ThreadLocal<?>> {
    // 與此ThreadLocal關(guān)聯(lián)的值
    Object value;
 // k：ThreadLocal的引用，被傳遞給WeakReference的構(gòu)造方法
    Entry(ThreadLocal<?> k, Object v) {
        super(k);
        value = v;
    }
}

public T get() {
    // 獲取當(dāng)前線程
    Thread t = Thread.currentThread();
    // 通過當(dāng)前線程獲取線程中的ThreadLocal.ThreadLocalMap對(duì)象
    ThreadLocalMap map = getMap(t);
    if (map != null) {
        // map不為空，通過this(當(dāng)前對(duì)象，即ThreadLocal對(duì)象)獲取Entry對(duì)象
        ThreadLocalMap.Entry e = map.getEntry(this);
        if (e != null) {
            @SuppressWarnings("unchecked")
            T result = (T)e.value;
            // Entry不為空，則直接返回Entry中的value值
            return result;
        }
    }
    // 如果map或Entry為空，則返回初始值-null
    return setInitialValue();
}
// 設(shè)置初始值，初始化ThreadLocalMap對(duì)象，并設(shè)置value為 null
private T setInitialValue() {
    // 初始化值，此方法返回 null
    T value = initialValue();
    Thread t = Thread.currentThread();
    ThreadLocalMap map = getMap(t);
    if (map != null)
        map.set(this, value);
    else
        createMap(t, value);
    return value;
}

remove方法

public void remove() {
    // 通過當(dāng)前線程獲取線程中的ThreadLocal.ThreadLocalMap對(duì)象
    ThreadLocalMap m = getMap(Thread.currentThread());
    if (m != null)
        // 移除對(duì)象
        m.remove(this);
}
// 根據(jù)key，刪除對(duì)應(yīng)的所有值
private void remove(ThreadLocal<?> key) {
    Entry[] tab = table;
    int len = tab.length;
    // 獲取key對(duì)應(yīng)的 Entry[] 下標(biāo)
    int i = key.threadLocalHashCode & (len-1);
    for (Entry e = tab[i];
         e != null;
         // 獲取下一個(gè)Entry對(duì)象
         e = tab[i = nextIndex(i, len)]) {
        if (e.get() == key) {
            e.clear();
            // 通過重新哈希位于staleSlot和下一個(gè)null插槽之間的任何可能沖突的條目，來清除陳舊的條目。這還會(huì)清除尾隨null之前遇到的所有其他過時(shí)的條目，防止出現(xiàn)內(nèi)存泄漏問題
            expungeStaleEntry(i);
            return;
        }
    }
}

總結(jié)：

1. 每個(gè)Thread維護(hù)著一個(gè)ThreadLocalMap的引用
2. ThreadLocalMap是ThreadLocal的內(nèi)部類，用Entry來進(jìn)行存儲(chǔ)
3. ThreadLocal創(chuàng)建的副本是存儲(chǔ)在自己的threadLocals中的，也就是自己的ThreadLocalMap。
4. ThreadLocalMap的鍵為ThreadLocal對(duì)象，而且可以有多個(gè)threadLocal變量，因此保存在map中
5. 在進(jìn)行g(shù)et之前，必須先set，否則會(huì)報(bào)空指針異常，當(dāng)然也可以初始化一個(gè)，但是必須重寫initialValue()方法。
6. ThreadLocal本身并不存儲(chǔ)值，它只是作為一個(gè)key來讓線程從ThreadLocalMap獲取value。

注意事項(xiàng)

雖然ThreadLocal在某些情況下非常有用，但過度使用它也可能導(dǎo)致內(nèi)存泄漏問題。因?yàn)門hreadLocalMap中的數(shù)據(jù)只有在線程結(jié)束時(shí)才會(huì)被釋放，如果沒有正確地清理ThreadLocal實(shí)例，就可能會(huì)導(dǎo)致無限制的數(shù)據(jù)積累。

另外，ThreadLocal不適合在并發(fā)量非常大的情況下使用，因?yàn)槊總€(gè)線程都會(huì)創(chuàng)建自己的變量副本，可能會(huì)導(dǎo)致內(nèi)存消耗過大。

ThreadLocal內(nèi)存泄漏問題

在上面的代碼中，我們可以看出，當(dāng)前ThreadLocal的引用k被傳遞給WeakReference的構(gòu)造函數(shù)，所以ThreadLocalMap中的key為ThreadLocal的弱引用。

如果當(dāng)前線程一直存在且沒有調(diào)用該ThreadLocal的remove方法，如果這個(gè)時(shí)候別的地方還有對(duì)ThreadLocal的引用，那么當(dāng)前線程中的ThreadLocalMap中會(huì)存在對(duì)ThreadLocal變量的引用和value對(duì)象的引用，是不會(huì)釋放的，會(huì)造成內(nèi)存泄漏。

ThreadLocalMap中的Entry的key使用的是ThreadLocal對(duì)象的弱引用，在沒有其他地方對(duì)ThreadLoca依賴，ThreadLocalMap中的ThreadLocal對(duì)象就會(huì)被回收掉，但是對(duì)應(yīng)的value值不會(huì)被回收，這個(gè)時(shí)候Map中就可能存在key為null但是value不為null的項(xiàng)，也會(huì)造成內(nèi)存泄漏。

小結(jié)

ThreadLocal是一種多線程編程的工具，可以幫助我們?cè)诙嗑€程環(huán)境中管理線程本地的變量。它通過ThreadLocal實(shí)例和ThreadLocalMap的組合實(shí)現(xiàn)了這一功能。

使用ThreadLocal時(shí)需要注意內(nèi)存泄漏和性能問題，確保合理使用。

使用完ThreadLocal后，一定執(zhí)行remove操作，避免出現(xiàn)內(nèi)存泄漏情況。