深入分析ThreadLocal內(nèi)存泄漏問(wèn)題

魏可源

ThreadLocal的作用是提供線(xiàn)程內(nèi)的局部變量，這種變量在線(xiàn)程的生命周期內(nèi)起作用，減少同一個(gè)線(xiàn)程內(nèi)多個(gè)函數(shù)或者組件之間一些公共變量傳遞的復(fù)雜度。但是如果濫用ThreadLocal，就可能會(huì)導(dǎo)致內(nèi)存泄漏。

下面，我們將圍繞三個(gè)方面來(lái)分析ThreadLocal內(nèi)存泄漏的問(wèn)題：

1. ThreadLocal實(shí)現(xiàn)原理

2. ThreadLocal為什么會(huì)內(nèi)存泄漏

3. ThreadLocal最佳實(shí)踐

ThreadLocal實(shí)現(xiàn)原理

ThreadLocal的實(shí)現(xiàn)是這樣的：每個(gè)Thread維護(hù)一個(gè)ThreadLocalMap映射表，這個(gè)映射表的key是ThreadLocal實(shí)例本身，value是真正需要存儲(chǔ)的Object。

也就是說(shuō)ThreadLocal本身并不存儲(chǔ)值，它只是作為一個(gè)key來(lái)讓線(xiàn)程從ThreadLocalMap獲取value。值得注意的是上圖中的虛線(xiàn)，表示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)有辦法訪(fǎng)問(wèn)這些key為null的Entry的value，如果當(dāng)前線(xiàn)程再遲遲不結(jié)束的話(huà)，這些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ì)清除線(xiàn)程ThreadLocalMap里所有key為null的value。

但是這些被動(dòng)的預(yù)防措施并不能保證不會(huì)內(nèi)存泄漏：

1.使用static的ThreadLocal，延長(zhǎng)了ThreadLocal的生命周期，可能導(dǎo)致的內(nèi)存泄漏。

2.分配使用了ThreadLocal又不再調(diào)用get（），set（），remove（）方法，那么就會(huì)導(dǎo)致內(nèi)存泄漏。

為什么使用弱引用

從表面上看內(nèi)存泄漏的根源在于使用了弱引用，但是另一個(gè)問(wèn)題也同樣值得思考：為什么使用弱引用而不是強(qiáng)引用？

我們先來(lái)看看官方文檔的說(shuō)法：

為了應(yīng)對(duì)非常大和長(zhǎng)時(shí)間的用途，哈希表使用弱引用的

key。（To help deal with verylarge and long-lived usages， the hash table entries use WeakReferences for keys.）

下面分兩種情況討論：

1. key使用強(qiáng)引用：引用的ThreadLocal的對(duì)象被回收了，但是ThreadLocalMap還持有ThreadLocal的強(qiáng)引用，如果沒(méi)有手動(dòng)刪除，ThreadLocal不會(huì)被回收，導(dǎo)致Entry內(nèi)存泄漏。

2. 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ù)。

在使用線(xiàn)程池的情況下，沒(méi)有及時(shí)清理ThreadLocal，不僅是內(nèi)存泄漏的問(wèn)題，更嚴(yán)重的是可能導(dǎo)致業(yè)務(wù)邏輯出現(xiàn)問(wèn)題。所以，使用ThreadLocal就跟加鎖完要解鎖一樣，所以用完就一定要清理。