ThreadLocal原始碼和圖文分析

目錄

一、ThreadLocal結構和存取資料

1、ThreadLocal#get

2、ThreadLocal#set

二、梳理存在的問題和解決

ThreadLocal#remove

---

從一道面試題開始吧，ThreadLocal使用需要注意什麼，或者有什麼問題？ 答：如果是線上程池中使用，會存在 1、記憶體洩漏 2、髒資料 的問題 解決：try finally中呼叫 remove方法

            慢慢從ThreadLocal的設計和原始碼開始分析，

一、ThreadLocal結構和存取資料

    當建立了一個ThreadLocal物件時，可以將存放的Object物件、或者回撥函式（延遲載入）放入setInitialValue中；噹噹前執行緒去獲取時，則會在當前執行緒Thread的屬性threadLocals中獲取，而該屬性的型別則為TheadLocal的靜態內部類ThreadLocalMap，但是引用還是指向了Thread；而該threadLocals的ThreadLocalMap內部維護了一個其內部類ThreadLocal.ThreadLocalMap.Entry陣列，而Entry由key和value組成，key即為當前的 new 的ThreadLocal物件本身，value為我們當前儲存的Object物件，並且key為WeakReference(弱引用)型別。

所以，ThreadLocal本身只定義了一些內部類，而並不真實擁有任何資料，可以理解為全是空殼子；當獲取資料時若當前執行緒的ThreadLocal物件（記憶體地址）不存在，則才會在該物件的setInitialValue中copy一份值到Thread的屬性threadLocals中，key為當前物件引用，value為儲存的Object值；當建立了多個ThreadLocal物件時，當每當前執行緒都呼叫過ThreadLocal進行get或set時，則會在當前執行緒的threadLocals中儲存多個值，如下圖：

 

1、ThreadLocal#get

public T get() {
    Thread var1 = Thread.currentThread();
    ThreadLocal.ThreadLocalMap var2 = this.getMap(var1);
    if (var2 != null) {
        ThreadLocal.ThreadLocalMap.Entry var3 = var2.getEntry(this);
        if (var3 != null) {
            Object var4 = var3.value;
            return var4;
        }
    }

    return this.setInitialValue();
}

獲取當前的執行緒，並且使用當前執行緒去獲取ThreadLocal.ThreadLocalMap型別的物件，先看看getMap方法，

ThreadLocal.ThreadLocalMap getMap(Thread var1) {
    return var1.threadLocals;
}

什麼都沒有做，只是將傳入的當前物件的threadLocals屬性返回，只是該引用還是指向了Thread本身。

繼續，1、如果threadLocals物件本身不為null，則通過this，即當前ThreadLocal物件的引用為key，獲取對應Entry的值返回。

2、如果threadLocals物件本身為null，說明當前執行緒中沒有存放過任何ThreadLocal物件的引入的值。則需要調setInitialValue方法，如下：

private T setInitialValue() {
    Object var1 = this.initialValue();
    Thread var2 = Thread.currentThread();
    ThreadLocal.ThreadLocalMap var3 = this.getMap(var2);
    if (var3 != null) {
        var3.set(this, var1);
    } else {
        this.createMap(var2, var1);
    }

    return var1;
}

    呼叫當前ThreadLocal物件的initialValue方法，如果我們沒有重寫，則當前預設返回null，否則呼叫我們重寫的方法，可以理解為懶載入。每個執行緒第一次都會呼叫該方法獲取的返回值，那麼如果沒次呼叫都是返回同一個物件則Thread中儲存的就是同一個物件，需要我們自己注意（如果同一物件執行緒A改變之後執行緒B也改變了），並且也存線上程安全的問題。

還是獲取當前Map是否為null，則呼叫createMap方法。如下：

void createMap(Thread var1, T var2) {
    var1.threadLocals = new ThreadLocal.ThreadLocalMap(this, var2);
}

2、ThreadLocal#set

    理解完get的過程，set的就比較容易了，主要是引用本身比較繞。

public void set(T var1) {
    Thread var2 = Thread.currentThread();
    ThreadLocal.ThreadLocalMap var3 = this.getMap(var2);
    if (var3 != null) {
        var3.set(this, var1);
    } else {
        this.createMap(var2, var1);
    }

}

獲取到Thread的屬性threadLocals，如果是null則new一個，否則就往Map中放一個Entry物件。

 

二、梳理存在的問題和解決

    當線上程池中使用的時候，其實大部分情況下我們都會線上程池中使用，比如Tomcat執行緒池。則key為弱引用，在Root gc不可達的情況下，則會被JVM進行回收。但是正是因為如此value值將永遠的遊離，Root gc永遠指向不到該value值，則不能進行gc。當頻繁的呼叫，則這樣的物件越來越多，發生記憶體洩漏。如果該物件的記憶體還比較大，則會照成後續分配記憶體時新生代不足，則可能照成溢位的情況（溢位的個人理解）。

    並且，當迴圈使用執行緒的話，比如存放的是使用者資訊，如果上一個使用者請求離開時未清除資料，下一個使用者進來直接獲取的話會拿到上一個使用者的資料，如果是儲存的積分等，則完全就是髒資料。

一併解決上面的兩個問題方法比較簡單，每次在呼叫程式碼時增加 try finally中呼叫 ThreadLocal物件的remove方法，如下：

ThreadLocal#remove

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

    首先還是獲取當前的執行緒去獲取 Thread的屬性threadLocals呼叫其（ThreadLocalMap的）remove方法，如下：

private void remove(ThreadLocal<?> var1) {
    ThreadLocal.ThreadLocalMap.Entry[] var2 = this.table;
    int var3 = var2.length;
    int var4 = var1.threadLocalHashCode & var3 - 1;

    for(ThreadLocal.ThreadLocalMap.Entry var5 = var2[var4]; var5 != null; 
            var5 = var2[var4 = nextIndex(var4, var3)]) {
        if (var5.get() == var1) {
            var5.clear();
            this.expungeStaleEntry(var4);
            return;
        }
    }
}

根據當前的ThreadLocal引用，去Map中迴圈匹配，當匹配到之後，呼叫Entry的remove方法，其實是呼叫Refrence的clear方法。最後呼叫expungeStaleEntry方法將其對應的Entry從陣列中消除。

    再看看Reference的clear方法：

public void clear() {
    this.referent = null;
}

    將該值直接置位null，則後續JVM會對該物件進行gc。