ThreadLocal能夠在線程本地存儲(chǔ)對(duì)應(yīng)的變量，從而有效的避免線程安全問(wèn)題。但是使用ThreadLocal時(shí)，稍微不注意就有可能造成內(nèi)存泄露的問(wèn)題。那么ThreadLocal在哪些場(chǎng)景下會(huì)出現(xiàn)內(nèi)存泄露？哪些場(chǎng)景下不會(huì)出現(xiàn)內(nèi)存泄露？出現(xiàn)內(nèi)存泄露的根本原因又是什么呢？如何真正避免內(nèi)存泄露？

這可能是你職業(yè)生涯中最具含金量的一次點(diǎn)擊，點(diǎn)擊【項(xiàng)目實(shí)戰(zhàn)】查看詳情，與冰河一起研發(fā)基于大廠真正核心技術(shù)的硬核項(xiàng)目。

接下來(lái)，我們就用大量的圖解來(lái)分析ThreadLocal內(nèi)存泄露的四個(gè)核心問(wèn)題：哪些場(chǎng)景不會(huì)內(nèi)存泄露、哪些場(chǎng)景會(huì)內(nèi)存泄露、內(nèi)存泄露的根本原因是什么、以及如何真正 避免內(nèi)存泄露。

一、ThreadLocal內(nèi)部結(jié)構(gòu)

為了更好的說(shuō)明ThreadLocal內(nèi)存泄露的場(chǎng)景，以及具體的原因，先來(lái)了解下ThreadLocal的內(nèi)部結(jié)構(gòu)，如圖1所示。

圖片

可以看到，ThreadLocal對(duì)象是存儲(chǔ)在每個(gè)Thread線程內(nèi)部的ThreadLocalMap中的，并且在ThreadLocalMap中有一個(gè)Entry數(shù)組，Entry數(shù)組中的每一個(gè)元素都是一個(gè)Entry對(duì)象。

每個(gè)Entry對(duì)象中存儲(chǔ)著一個(gè)ThreadLocal對(duì)象與其對(duì)應(yīng)的value值，每個(gè)Entry對(duì)象在Entry數(shù)組中的位置是通過(guò)ThreadLocal對(duì)象的threadLocalHashCode計(jì)算出來(lái)的，以此來(lái)快速定位Entry對(duì)象在Entry數(shù)組中的位置。所以，在Thread中，可以存儲(chǔ)多個(gè)ThreadLocal對(duì)象。

二、不會(huì)出現(xiàn)內(nèi)存泄露的場(chǎng)景

了解完ThreadLocal的內(nèi)部存儲(chǔ)結(jié)構(gòu)后，我們先來(lái)思考下哪些場(chǎng)景下ThreadLocal不會(huì)發(fā)生內(nèi)存泄露，假設(shè)我們單獨(dú)開啟一個(gè)線程，并且將變量存儲(chǔ)到ThreadLocal中，如圖2所示。

圖片

可以看到，Thread線程在正常執(zhí)行的情況下，會(huì)引用ThreadLocalMap的實(shí)例對(duì)象，只要Thread線程一直在執(zhí)行任務(wù)，這種引用關(guān)系就一直存在。

當(dāng)Thread線程執(zhí)行任務(wù)結(jié)束退出時(shí)，Thread線程與ThreadLocalMap實(shí)例對(duì)象之間的引用關(guān)系就不存在了，如圖3所示。

圖片

Thread線程執(zhí)行完任務(wù)退出后，線程里持有的ThreadLocalMap對(duì)象也就失去了強(qiáng)引用，此時(shí)ThreadLocalMap對(duì)象就會(huì)被GC自動(dòng)回收，而ThreadLocalMap中包含的ThreadLocal對(duì)象也會(huì)被GC回收掉，如圖4所示。

圖片

可以看出，如果只是通過(guò)Thread類或者Thread類的子類來(lái)創(chuàng)建線程執(zhí)行任務(wù)，隨著對(duì)應(yīng)線程的任務(wù)執(zhí)行完畢，線程退出，Thread線程引用的ThreadLocal也會(huì)被GC回收掉，此時(shí)就不會(huì)出現(xiàn)內(nèi)存泄露的問(wèn)題。

三、會(huì)出現(xiàn)內(nèi)存泄露的場(chǎng)景

在實(shí)際項(xiàng)目中，如果為每個(gè)任務(wù)的執(zhí)行都開啟一個(gè)線程的話，是非常耗費(fèi)系統(tǒng)資源的，所以，在實(shí)際項(xiàng)目中，我們很少直接使用Thread類來(lái)創(chuàng)建線程，而是使用線程池來(lái)執(zhí)行對(duì)應(yīng)的任務(wù)。如果是在線程池場(chǎng)景下，線程與ThreadLocalMap之間的引用關(guān)系又是怎樣的呢？

這里，我們先來(lái)看一張圖，如圖5所示。

圖片

可以看到，線程池中會(huì)有多個(gè)線程執(zhí)行任務(wù)，如果是通過(guò)ThreadLocal存儲(chǔ)數(shù)據(jù)的話，每個(gè)線程都會(huì)引用一個(gè)ThreadLocalMap對(duì)象。

另外，線程池中的核心線程在執(zhí)行完任務(wù)后，是不會(huì)退出的，可以循環(huán)使用，說(shuō)明線程池中的每個(gè)核心線程和ThreadLocalMap之間一直是強(qiáng)引用關(guān)系，核心線程對(duì)應(yīng)的ThreadLocal是不會(huì)自動(dòng)被GC回收的，會(huì)存在內(nèi)存泄露的風(fēng)險(xiǎn)。

四、內(nèi)存泄露問(wèn)題分析

這里，我們對(duì)在線程池中使用ThreadLocal存在內(nèi)存泄露問(wèn)題的原因進(jìn)行分析，首先，將ThreadLocalMap中的Entry數(shù)組展開，如圖6所示。

圖片

可以看到，ThreadLocalMap中包含一個(gè)Entry數(shù)組，而Entry數(shù)組中的每一個(gè)元素就是Entry對(duì)象，Entry對(duì)象中存儲(chǔ)的Key就是ThreadLocal對(duì)象，而value就是要存儲(chǔ)的數(shù)據(jù)。其中，Entry對(duì)象中的Key屬于弱引用，這點(diǎn)我們可以從ThreadLocalMap類中的內(nèi)部類Entry的定義可以看出。Entry類的源碼詳見：java.lang.ThreadLocal.ThreadLocalMap.Entry。

static class Entry extends WeakReference<ThreadLocal<?>> {
    /** The value associated with this ThreadLocal. */
    Object value;

    Entry(ThreadLocal<?> k, Object v) {
        super(k);
        value = v;
    }
}

可以看到，Entry類繼承了WeakReference類，WeakReference類的泛型是ThreadLocal，，說(shuō)明ThreadLocalMap中的Entry數(shù)組對(duì)Entry對(duì)象的Key就是弱引用。所以，Entry對(duì)象中的Key可以被GC自動(dòng)回收。當(dāng)Entry對(duì)象中的Key被GC自動(dòng)回收后如圖7所示。

圖片

當(dāng)Entry對(duì)象中的Key被GC自動(dòng)回收后，對(duì)應(yīng)的ThreadLocal被GC回收掉了，變成了null，但是ThreadLocal對(duì)應(yīng)的value值依然被Entry引用，不能被GC自動(dòng)回收，如圖8所示。

圖片

此時(shí)，我們可以看到，Entry對(duì)象中的Key，也就是ThreadLocal對(duì)象可以被GC自動(dòng)回收，但是對(duì)應(yīng)的value還在被引用，所以，value是不能被GC自動(dòng)回收的，這種情況下就會(huì)存在內(nèi)存泄露的風(fēng)險(xiǎn)。

我們?cè)賮?lái)總結(jié)下，在線程池中使用ThreadLocal保存數(shù)據(jù)存在內(nèi)存泄露風(fēng)險(xiǎn)的原因：線程池中的核心線程會(huì)被循環(huán)使用，每個(gè)線程中對(duì)應(yīng)的ThreadLocalMap會(huì)被線程強(qiáng)引用。

所以，每個(gè)線程對(duì)應(yīng)的ThreadLocalMap不能被GC自動(dòng)回收。而ThreadLocalMap中包含一個(gè)Entry數(shù)組，Entry數(shù)組中含有多個(gè)Key為ThreadLocal，value為存儲(chǔ)的數(shù)據(jù)的Entry對(duì)象，雖然Entry對(duì)象中的Key是弱引用，能夠被GC自動(dòng)回收，但是value卻是強(qiáng)引用，不能被GC自動(dòng)回收，所以，在線程池中使用ThreadLocal會(huì)存在內(nèi)存泄露的風(fēng)險(xiǎn)。

五、如何避免內(nèi)存泄露

在線程池中使用ThreadLocal如何避免內(nèi)存泄露呢？ThreadLocal提供相應(yīng)的解決方法了嗎？這里，我們就從ThreadLocal的源碼中看看ThreadLocal是否提供了對(duì)應(yīng)的解決方案。

在ThreadLocal中，提供了一個(gè)remove()方法，源碼詳見：java.lang.ThreadLocal#remove。

public void remove() {
    ThreadLocalMap m = getMap(Thread.currentThread());
    if (m != null)
        m.remove(this);
}

可以看到，在remove()方法中，首先根據(jù)當(dāng)前線程獲取ThreadLocalMap類型的m對(duì)象，不為空，則直接調(diào)用m對(duì)象的有參remove()方法移除value的值。

有參remove()方法的源碼詳見：java.lang.ThreadLocal.ThreadLocalMap#remove。

private void remove(ThreadLocal<?> key) {
    Entry[] tab = table;
    int len = tab.length;
    int i = key.threadLocalHashCode & (len-1);
    for (Entry e = tab[i];
         e != null;
         e = tab[i = nextIndex(i, len)]) {
        if (e.get() == key) {
            e.clear();
            expungeStaleEntry(i);
            return;
        }
    }
}

可以看到，在有參remove()方法中，會(huì)通過(guò)threadLocalHashCode計(jì)算出Entry對(duì)象在Entry數(shù)組中的位置，并獲取出對(duì)應(yīng)的Entry對(duì)象，如果Entry對(duì)象不為空，并且Entry對(duì)象中的Key等于傳入的ThreadLocal對(duì)象，則清除對(duì)應(yīng)的Key，并且調(diào)用expungeStaleEntry()方法。

接下來(lái)，我們?cè)俜治鱿耬xpungeStaleEntry()方法，源碼詳見：java.lang.ThreadLocal.ThreadLocalMap#expungeStaleEntry。

private int expungeStaleEntry(int staleSlot) {
    Entry[] tab = table;
    int len = tab.length;

    // expunge entry at staleSlot
    tab[staleSlot].value = null;
    tab[staleSlot] = null;
    size--;

    // Rehash until we encounter null
    Entry e;
    int i;
    for (i = nextIndex(staleSlot, len);
         (e = tab[i]) != null;
         i = nextIndex(i, len)) {
        ThreadLocal<?> k = e.get();
        if (k == null) {
            e.value = null;
            tab[i] = null;
            size--;
        } else {
            int h = k.threadLocalHashCode & (len - 1);
            if (h != i) {
                tab[i] = null;

                // Unlike Knuth 6.4 Algorithm R, we must scan until
                // null because multiple entries could have been stale.
                while (tab[h] != null)
                    h = nextIndex(h, len);
                tab[h] = e;
            }
        }
    }
    return i;
}

可以看到，在expungeStaleEntry()方法中，會(huì)將ThreadLocal為null對(duì)應(yīng)的value設(shè)置為null，同時(shí)會(huì)把對(duì)應(yīng)的Entry對(duì)象也設(shè)置為null，并且會(huì)將所有ThreadLocal對(duì)應(yīng)的value為null的Entry對(duì)象設(shè)置為null，這樣就去除了強(qiáng)引用，便于后續(xù)的GC進(jìn)行自動(dòng)垃圾回收，也就避免了內(nèi)存泄露的問(wèn)題。調(diào)用ThreadLocal的remove()方法后的示意圖如圖9所示。

圖片

注意：在ThreadLocal中，不僅僅是remove()方法會(huì)調(diào)用expungeStaleEntry()方法，在set()方法和get()方法中也可能會(huì)調(diào)用expungeStaleEntry()方法來(lái)清理數(shù)據(jù)。

還有一點(diǎn)需要注意的是，ThreadLocal雖然提供了避免內(nèi)存泄露的方法，但是ThreadLocal不會(huì)主動(dòng)去執(zhí)行這些方法，需要我們?cè)谑褂猛闠hreadLocal對(duì)象中保存的數(shù)據(jù)后，在finally{}代碼塊中調(diào)用ThreadLocal的remove()方法，加快GC自動(dòng)垃圾回收，避免內(nèi)存泄露。

六、總結(jié)

本文，主要結(jié)合圖例介紹了ThreadLocal有關(guān)內(nèi)存泄露方面的知識(shí)，包括：ThreadLocal的內(nèi)部結(jié)構(gòu)，不會(huì)出現(xiàn)內(nèi)存泄露的場(chǎng)景，會(huì)出現(xiàn)內(nèi)存泄露的場(chǎng)景，內(nèi)存泄露的問(wèn)題分析以及如何避免內(nèi)存泄露。