深入剖析ThreadLocal實現原理以及內存泄漏問題

本文轉載自查看原文 2020-11-26 15:02 363

原創：https://blog.csdn.net/LHQJ1992/article/details/52451136?utm_medium=distribute.pc_relevant_t0.none-task-blog-BlogCommendFromMachineLearnPai2-1.control&depth_1-utm_source=distribute.pc_relevant_t0.none-task-blog-BlogCommendFromMachineLearnPai2-1.control

一、概述

在2017京東校園招聘筆試題中遇到了描述ThreadLocal的實現原理和內存泄漏的問題，之前看過ThreadLocal的實現原理，但是網上有很多文章將的很亂，其中有很多文章將ThreadLocal與線程同步機制混為一談，特別注意的是ThreadLocal與線程同步無關，並不是為了解決多線程共享變量問題！
ThreadLocal官網解釋：

This class provides thread-local variables. These variables differ from their normal counterparts in that each thread that accesses one (via its {@code get} or {@code set} method) has its own, independently initialized copy ofthevariable. {@code ThreadLocal} instances are typically private static fields in classes that wish to associate state witha thread (e.g.,a user ID or Transaction ID)

->翻譯過來的大概意思就是：ThreadLocal類用來提供線程內部的局部變量。這些變量在多線程環境下訪問(通過get或set方法訪問)時能保證各個線程里的變量相對獨立於其他線程內的變量，ThreadLocal實例通常來說都是private static類型。
總結：ThreadLocal不是為了解決多線程訪問共享變量，而是為每個線程創建一個單獨的變量副本，提供了保持對象的方法和避免參數傳遞的復雜性。

ThreadLocal的主要應用場景為按線程多實例（每個線程對應一個實例）的對象的訪問，並且這個對象很多地方都要用到。例如：同一個網站登錄用戶，每個用戶服務器會為其開一個線程，每個線程中創建一個ThreadLocal，里面存用戶基本信息等，在很多頁面跳轉時，會顯示用戶信息或者得到用戶的一些信息等頻繁操作，這樣多線程之間並沒有聯系而且當前線程也可以及時獲取想要的數據。

二、實現原理

ThreadLocal可以看做是一個容器，容器里面存放着屬於當前線程的變量。ThreadLocal類提供了四個對外開放的接口方法，這也是用戶操作ThreadLocal類的基本方法：
(1) void set(Object value)設置當前線程的線程局部變量的值。
(2) public Object get()該方法返回當前線程所對應的線程局部變量。
(3) public void remove()將當前線程局部變量的值刪除，目的是為了減少內存的占用，該方法是JDK 5.0新增的方法。需要指出的是，當線程結束后，對應該線程的局部變量將自動被垃圾回收，所以顯式調用該方法清除線程的局部變量並不是必須的操作，但它可以加快內存回收的速度。
(4) protected Object initialValue()返回該線程局部變量的初始值，該方法是一個protected的方法，顯然是為了讓子類覆蓋而設計的。這個方法是一個延遲調用方法，在線程第1次調用get()或set(Object)時才執行，並且僅執行1次，ThreadLocal中的缺省實現直接返回一個null。

可以通過上述的幾個方法實現ThreadLocal中變量的訪問，數據設置，初始化以及刪除局部變量，那ThreadLocal內部是如何為每一個線程維護變量副本的呢？

其實在ThreadLocal類中有一個靜態內部類ThreadLocalMap(其類似於Map)，用鍵值對的形式存儲每一個線程的變量副本，ThreadLocalMap中元素的key為當前ThreadLocal對象，而value對應線程的變量副本，每個線程可能存在多個ThreadLocal。

源代碼：

/** Returns the value in the current thread's copy of this thread-local variable. If the variable has no value for thecurrent thread, it is first initialized to the value returned by an invocation of the {@link #initialValue} method. @return the current thread's value of this thread-local */public T get() { Thread t = Thread.currentThread();//當前線程 ThreadLocalMap map = getMap(t);//獲取當前線程對應的ThreadLocalMapif (map != null) { ThreadLocalMap.Entry e = map.getEntry(this);//獲取對應ThreadLocal的變量值if (e != null) { @SuppressWarnings("unchecked") T result = (T)e.value; return result; } } return setInitialValue();//若當前線程還未創建ThreadLocalMap，則返回調用此方法並在其中調用createMap方法進行創建並返回初始值。 } //設置變量的值publicvoidset(T value) { Thread t = Thread.currentThread(); ThreadLocalMap map = getMap(t); if (map != null) map.set(this, value); else createMap(t, value); } private T setInitialValue() { T value = initialValue(); Thread t = Thread.currentThread(); ThreadLocalMap map = getMap(t); if (map != null) map.set(this, value); else createMap(t, value); return value; } /** 為當前線程創建一個ThreadLocalMap的threadlocals,並將第一個值存入到當前map中 @param t the current thread @param firstValue value for the initial entry of the map */void createMap(Thread t, T firstValue) { t.threadLocals = new ThreadLocalMap(this, firstValue); } //刪除當前線程中ThreadLocalMap對應的ThreadLocalpublicvoidremove() { ThreadLocalMap m = getMap(Thread.currentThread()); if (m != null) m.remove(this); }

上述是在ThreadLocal類中的幾個主要的方法，他們的核心都是對其內部類ThreadLocalMap進行操作，下面看一下該類的源代碼：

static class ThreadLocalMap {//map中的每個節點Entry,其鍵key是ThreadLocal並且還是弱引用，這也導致了后續會產生內存泄漏問題的原因。 static class Entry extends WeakReference<ThreadLocal<?>> { Object value; Entry(ThreadLocal<?> k, Object v) { super(k); value = v; } /** * 初始化容量為16，以為對其擴充也必須是2的指數 */private static final int INITIAL_CAPACITY = 16; /** * 真正用於存儲線程的每個ThreadLocal的數組，將ThreadLocal和其對應的值包裝為一個Entry。 */private Entry[] table; ///....其他的方法和操作都和map的類似 }

總之，為不同線程創建不同的ThreadLocalMap，用線程本身為區分點，每個線程之間其實沒有任何的聯系，說是說存放了變量的副本，其實可以理解為為每個線程單獨new了一個對象。

三、內存泄漏問題（參考其他博文）

　　在上面提到過，每個thread中都存在一個map, map的類型是ThreadLocal.ThreadLocalMap. Map中的key為一個threadlocal實例. 這個Map的確使用了弱引用,不過弱引用只是針對key. 每個key都弱引用指向threadlocal. 當把threadlocal實例置為null以后,沒有任何強引用指向threadlocal實例,所以threadlocal將會被gc回收. 但是,我們的value卻不能回收,因為存在一條從current thread連接過來的強引用. 只有當前thread結束以后, current thread就不會存在棧中,強引用斷開, Current Thread, Map, value將全部被GC回收.
　　所以得出一個結論就是只要這個線程對象被gc回收，就不會出現內存泄露，但在threadLocal設為null和線程結束這段時間不會被回收的，就發生了我們認為的內存泄露。其實這是一個對概念理解的不一致，也沒什么好爭論的。最要命的是線程對象不被回收的情況，這就發生了真正意義上的內存泄露。比如使用線程池的時候，線程結束是不會銷毀的，會再次使用的。就可能出現內存泄露。

ThreadLocal是一個線程內共享變量工具類。將線程與該線程存放的對象做一個映射，各個線程之間的變量互不干擾。適用於各個線程依賴不同的變量值完成操作的場景，如：Spring聲明式數據庫事務、shiro的session

ThreadLocal內部結構

在這里插入圖片描述

核心機制：
1.每個線程實例中有個threadlocals屬性，實際上是個map
2.這個Map中存放的是ThreadLocal實例和Threadlocal實例在該線程中共享的值(value)
3.線程中的Map有ThreadLocal實例維護，由ThreadLocal實例向map中設置和獲取值。
3.1 設置值
ThreadLocal實例通過Thread.currentThread獲得當前線程實例，自身為key，待設置的值為value組成Entry，放入當前線程實例的map中。
3.2 獲取值
ThreadLocal實例通過Thread.currentThread獲得當前線程實例，在map中以自身為key，獲得對應的value。

從上面的機制中確保threadlocal設置的值，僅在設置時的線程中共享，其它線程無法訪問到該線程中設置的值。確保了，1、線程間變量隔離，2、線程內能訪問。

內存溢出

當線程實例的生命周期短於ThreadLocal實例的生命周期，threadLocal內存的回收，取決於threadLocal實例的生命周期。而，當線程實例的生命周期長於ThreadLocal實例的生命周期(一般線程池場景)時，thread中ThreadLocalMap的每個Entry的key(對threadLocal的弱引用)，在gc時會被回收；然而,Entry中value(強引用)是不會回收。當我們使用ThreadLocal的set方法，要配套進行remove，確保value能及時回收。

This class provides thread-local variables. These variables differ from their normal counterparts in that each thread that accesses one (via its {@code get} or {@code set} method) has its own, independently initialized copy of the variable.  {@code ThreadLocal} instances are typically private static fields in classes that wish to associate state with a thread (e.g.,a user ID or Transaction ID)

二、實現原理

可以通過上述的幾個方法實現ThreadLocal中變量的訪問，數據設置，初始化以及刪除局部變量，那ThreadLocal內部是如何為每一個線程維護變量副本的呢？

源代碼：

/** Returns the value in the current thread's copy of this thread-local variable. If the variable has no value for thecurrent thread, it is first initialized to the value returned by an invocation of the {@link #initialValue} method.  @return the current 
thread's value of this thread-local */
public T get() {
    Thread t = Thread.currentThread();//當前線程
    ThreadLocalMap map = getMap(t);//獲取當前線程對應的ThreadLocalMap
    if (map != null) {
        ThreadLocalMap.Entry e = map.getEntry(this);//獲取對應ThreadLocal的變量值
        if (e != null) {
            @SuppressWarnings("unchecked")
            T result = (T)e.value;
            return result;
        }
    }
    return setInitialValue();//若當前線程還未創建ThreadLocalMap，則返回調用此方法並在其中調用createMap方法進行創建並返回初始值。
}
//設置變量的值
public void set(T value) {
   Thread t = Thread.currentThread();
   ThreadLocalMap map = getMap(t);
   if (map != null)
       map.set(this, value);
   else
       createMap(t, value);
}
private T setInitialValue() {
   T value = initialValue();
   Thread t = Thread.currentThread();
   ThreadLocalMap map = getMap(t);
   if (map != null)
       map.set(this, value);
   else
       createMap(t, value);
   return value;
}
/** 為當前線程創建一個ThreadLocalMap的threadlocals,並將第一個值存入到當前map中 @param t the current thread @param firstValue value for the initial entry of the map */
void createMap(Thread t, T firstValue) {
    t.threadLocals = new ThreadLocalMap(this, firstValue);
}
//刪除當前線程中ThreadLocalMap對應的ThreadLocal
public void remove() {
       ThreadLocalMap m = getMap(Thread.currentThread());
       if (m != null)
           m.remove(this);
}

上述是在ThreadLocal類中的幾個主要的方法，他們的核心都是對其內部類ThreadLocalMap進行操作，下面看一下該類的源代碼：

static class ThreadLocalMap {
  //map中的每個節點Entry,其鍵key是ThreadLocal並且還是弱引用，這也導致了后續會產生內存泄漏問題的原因。
 static class Entry extends WeakReference<ThreadLocal<?>> {
           Object value;
           Entry(ThreadLocal<?> k, Object v) {
               super(k);
               value = v;
   }
    /** * 初始化容量為16，以為對其擴充也必須是2的指數 */
    private static final int INITIAL_CAPACITY = 16;
    /** * 真正用於存儲線程的每個ThreadLocal的數組，將ThreadLocal和其對應的值包裝為一個Entry。 */
    private Entry[] table;


    ///....其他的方法和操作都和map的類似
}