前言
ThreadLocal 的作用是提供線程內(nèi)的局部變量,這種變量在線程的生命周期內(nèi)起作用,減少同一個(gè)線程內(nèi)多個(gè)函數(shù)或者組件之間一些公共變量的傳遞的復(fù)雜度。但是如果濫用 ThreadLocal ,就可能會(huì)導(dǎo)致內(nèi)存泄漏。下面,我們將圍繞三個(gè)方面來(lái)分析 ThreadLocal 內(nèi)存泄漏的問(wèn)題
ThreadLocal 實(shí)現(xiàn)原理
ThreadLocal 為什么會(huì)內(nèi)存泄漏
ThreadLocal 最佳實(shí)踐
ThreadLocal 實(shí)現(xiàn)原理

ThreadLocal
ThreadLocal 的實(shí)現(xiàn)是這樣的:每個(gè) Thread 維護(hù)一個(gè) ThreadLocalMap 映射表,這個(gè)映射表的 key 是 ThreadLocal 實(shí)例本身, value 是真正需要存儲(chǔ)的 Object 。
也就是說(shuō) ThreadLocal 本身并不存儲(chǔ)值,它只是作為一個(gè) key 來(lái)讓線程從 ThreadLocalMap 獲取 value 。值得注意的是圖中的虛線,表示 ThreadLocalMap 是使用 ThreadLocal 的弱引用作為 Key 的,弱引用的對(duì)象在 GC 時(shí)會(huì)被回收。
ThreadLocal 為什么會(huì)內(nèi)存泄漏
ThreadLocalMap 使用 ThreadLocal 的弱引用作為 key ,如果一個(gè) ThreadLocal沒(méi)有外部強(qiáng)引用來(lái)引用它,那么系統(tǒng) GC 的時(shí)候,這個(gè) ThreadLocal 勢(shì)必會(huì)被回收,這樣一來(lái), ThreadLocalMap 中就會(huì)出現(xiàn) key 為 null 的 Entry ,就沒(méi)有辦法訪問(wèn)這些 key 為 null 的 Entry 的 value ,如果當(dāng)前線程再遲遲不結(jié)束的話,這些key 為 null 的 Entry 的 value 就會(huì)一直存在一條強(qiáng)引用鏈: Thread Ref -> Thread -> ThreaLocalMap -> Entry -> value 永遠(yuǎn)無(wú)法回收,造成內(nèi)存泄漏。
其實(shí), ThreadLocalMap 的設(shè)計(jì)中已經(jīng)考慮到這種情況,也加上了一些防護(hù)措施:在 ThreadLocal 的 get() , set() , remove() 的時(shí)候都會(huì)清除線程 ThreadLocalMap 里所有 key 為 null 的 value 。
但是這些被動(dòng)的預(yù)防措施并不能保證不會(huì)內(nèi)存泄漏:
使用 static 的 ThreadLocal ,延長(zhǎng)了 ThreadLocal 的生命周期,可能導(dǎo)致的內(nèi)存泄漏(參考 ThreadLocal 內(nèi)存泄露的實(shí)例分析 )。
分配使用了 ThreadLocal 又不再調(diào)用 get() , set() , remove() 方法,那么就會(huì)導(dǎo)致內(nèi)存泄漏。
為什么使用弱引用
從表面上看內(nèi)存泄漏的根源在于使用了弱引用。網(wǎng)上的文章大多著重分析 ThreadLocal 使用了弱引用會(huì)導(dǎo)致內(nèi)存泄漏,但是另一個(gè)問(wèn)題也同樣值得思考:為什么使用弱引用而不是強(qiáng)引用?
我們先來(lái)看看官方文檔的說(shuō)法:
To help deal with very large and long-lived usages, the hash table entries use WeakReferences for keys.
為了應(yīng)對(duì)非常大和長(zhǎng)時(shí)間的用途,哈希表使用弱引用的 key。
下面我們分兩種情況討論:
key 使用強(qiáng)引用 :引用的 ThreadLocal 的對(duì)象被回收了,但是 ThreadLocalMap還持有 ThreadLocal 的強(qiáng)引用,如果沒(méi)有手動(dòng)刪除, ThreadLocal 不會(huì)被回收,導(dǎo)致 Entry 內(nèi)存泄漏。
key 使用弱引用 :引用的 ThreadLocal 的對(duì)象被回收了,由于 ThreadLocalMap持有 ThreadLocal 的弱引用,即使沒(méi)有手動(dòng)刪除, ThreadLocal 也會(huì)被回收。 value 在下一次 ThreadLocalMap 調(diào)用 set , get , remove 的時(shí)候會(huì)被清除。
比較兩種情況,我們可以發(fā)現(xiàn):由于 ThreadLocalMap 的生命周期跟 Thread 一樣長(zhǎng),如果都沒(méi)有手動(dòng)刪除對(duì)應(yīng) key ,都會(huì)導(dǎo)致內(nèi)存泄漏,但是使用弱引用可以多一層保障: 弱引用 ThreadLocal 不會(huì)內(nèi)存泄漏,對(duì)應(yīng)的 value 在下一次 ThreadLocalMap 調(diào)用 set , get , remove 的時(shí)候會(huì)被清除 。
因此, ThreadLocal 內(nèi)存泄漏的根源是:由于 ThreadLocalMap 的生命周期跟 Thread 一樣長(zhǎng),如果沒(méi)有手動(dòng)刪除對(duì)應(yīng) key 就會(huì)導(dǎo)致內(nèi)存泄漏,而不是因?yàn)槿跻谩?/p>
ThreadLocal 最佳實(shí)踐
綜合上面的分析,我們可以理解 ThreadLocal 內(nèi)存泄漏的前因后果,那么怎么避免內(nèi)存泄漏呢?
每次使用完 ThreadLocal ,都調(diào)用它的 remove() 方法,清除數(shù)據(jù)。
在使用線程池的情況下,沒(méi)有及時(shí)清理 ThreadLocal ,不僅是內(nèi)存泄漏的問(wèn)題,更嚴(yán)重的是可能導(dǎo)致業(yè)務(wù)邏輯出現(xiàn)問(wèn)題。所以,使用 ThreadLocal 就跟加鎖完要解鎖一樣,用完就清理。