來源：碼農本農

ThreadLocal是一個執行緒安全的，以執行緒為單位的資料傳遞工具。廣泛應用於多層級資料傳遞。

1應用場景

ThreadLocal主要功能是跨層傳遞引數,比如，Controller層的資料需要在業務邏輯層使用時，除了利用方法的引數傳遞之外還可以使用ThreadLocal傳遞。

有時候我們需要從上層傳遞一個引數到下層的方法，但是下層的方法新增一個引數的話，會違背開閉原則，如果依賴此方法的上層比較多，那修改此方法必然會牽扯很多其他的程式碼也要改動（程式碼中難免會遇到這種不合理的程式碼）因此我們可以透過ThreadLocal來傳遞這個引數

另外，ThreadLocal在原始碼中經常被應用，例如，Spring MVC的RequestContextHolder的實現就是使用了ThreadLocal，cglib動態代理中也應用了ThreadLocal等等。

2基礎應用

public final class OperationInfoRecorder {

private static final ThreadLocal<OperationInfoDTO> THREAD_LOCAL = new ThreadLocal<>();

    private OperationInfoRecorder() {
    }
    
    public static OperationInfoDTO get() {
        return THREAD_LOCAL.get();
    }
    
    public static void set(OperationInfoDTO operationInfoDTO) {
        THREAD_LOCAL.set(operationInfoDTO);
    }
    
    public static void remove() {
        THREAD_LOCAL.remove();
    }
    
}

//使用
OperationInfoRecorder.set(operationInfoDTO)
OperationInfoRecorder.get()

日常的程式碼書寫中需要注意兩點：

static確保全域性只有一個儲存OperationInfoDTO物件的ThreadLocal例項，並且可避免記憶體洩露；
final確保ThreadLocal的例項不可更改。防止被意外改變，導致放入的值和取出來的不一致。

3架構設計

先來看看ThreadLocal設計的巧妙之處，透過一段原始碼深入瞭解

public static void set(OperationInfoDTO operationInfoDTO) {
        THREAD_LOCAL.set(operationInfoDTO);
    }

public void set(T value) {
        Thread t = Thread.currentThread();
        ThreadLocalMap map = getMap(t);
        if (map != null)
            map.set(this, value);
        else
            createMap(t, value);
    }

跟到這裡發現獲取當前執行緒，當前執行緒參與進來了，進入createMap方法

void createMap(Thread t, T firstValue) {
      t.threadLocals = new ThreadLocalMap(this, firstValue);
}

此處實際上就是建立了一個ThreadLocalMap物件，賦值給當前執行緒的threadLocals屬性。

我們去到Thread類中看看這個屬性到底是什麼

public class Thread implements Runnable {

ThreadLocal.ThreadLocalMap threadLocals = null;

ThreadLocal.ThreadLocalMap inheritableThreadLocals = null;

}

可見每個執行緒物件中都有兩個屬性，這兩個屬性都是ThreadLocalMap型別。

看到這裡不難想象，ThreadLocal對外聲稱的資料執行緒隔離不過是把資料儲存到了當前執行緒物件裡面，自然是執行緒隔離以及執行緒安全了。

4資料結構

那麼ThreadLocalMap和ThreadLocal是什麼關係呢？

如圖：

ThreadLocalMap內部有一個Entry陣列，這個陣列中的每個元素都是一個key-value鍵值對，value是要儲存的值，key是透過WeakReference包裝的ThreadLocal物件的弱引用，弱引用會在每次垃圾回收的時候被回收。

在程式碼結構上ThreadLocalMap是ThreadLocal的靜態內部類，真正負責儲存資料的是ThreadLocalMap。

在應用上，ThreadLocal為ThreadLocalMap提供了對外訪問的api，包括set，get，remove。同時ThreadLocal物件的引用又作為ThreadLocalMap中Entry元素的key。

既然是陣列，插入資料的時候是怎麼解決hash衝突呢？

ThreadLocalMap採用開放定址法插入資料。就是如果發現hash衝突，就依次向後面的尋找一個空桶，直到找到為止，然後插入進去。

那麼為什麼使用開地址法？而不是像hash表一樣使用連結串列法呢？

在開放定址法中，所有的資料都儲存在一個陣列中，比起連結串列法來說，衝突的代價更高。所以，使用開放定址法解決衝突的散列表，裝載因子的上限不能太大。這也導致這種方法比連結串列法更浪費記憶體空間。但是反過看，連結串列法指標需要額外的空間，故當結點規模較小時，開放定址法較為節省空間，而若將節省的指標空間用來擴大雜湊表的規模，可使裝填因子變小，這又減少了開放定址法中的衝突，從而提高平均查詢速度。並且使用中很少有大量ThreadLocal物件的場景。

5原始碼解析

set方法解析

1.第一次set資料

public void set(T value) {
        Thread t = Thread.currentThread();
        ThreadLocalMap map = getMap(t);
        if (map != null)
            map.set(this, value);
        else
            createMap(t, value);
    }
    
    void createMap(Thread t, T firstValue) {
        t.threadLocals = new ThreadLocalMap(this, firstValue);
    }
    
    ThreadLocalMap(ThreadLocal<?> firstKey, Object firstValue) {
            table = new Entry[INITIAL_CAPACITY];
            int i = firstKey.threadLocalHashCode & (INITIAL_CAPACITY - 1);
            table[i] = new Entry(firstKey, firstValue);
            size = 1;
            setThreshold(INITIAL_CAPACITY);
        }

第一次set資料比較簡單，執行緒中尚未初始化ThreadLocalMap，需要先初始化，初始化步驟如下：

宣告陣列
計算下標
給對應陣列下標賦值
設定當前陣列長度size
陣列長度計算擴容因子Threshold

1.非第一次set資料

private void set(ThreadLocal<?> key, Object value) {

            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)]) {
                ThreadLocal<?> k = e.get();

                if (k == key) {
                    e.value = value;
                    return;
                }

                if (k == null) {
                    replaceStaleEntry(key, value, i);
                    return;
                }
            }

            tab[i] = new Entry(key, value);
            int sz = ++size;
            if (!cleanSomeSlots(i, sz) && sz >= threshold)
                rehash();
        }

上面的程式碼步驟如下：

計算下標
如果當前下標無資料，直接進入4。
如果當前下標有資料，則從當前下標開始向後遍歷，每遍歷一次，i++
3.1 如果當前下標桶中的Entry物件的k和需要儲存的key相同，直接更新，結束
3.2 如果當前下標桶中的Entry物件的k和需要儲存的key不相同，且k不為空，不處理
3.3 如果當前下標桶中的Entry物件的k為空，說明當前Entry物件已經失效無用，需要進行進一步處理
3.4 進入replaceStaleEntry方法，結束
如果到現在沒有結束方法，則建立Entry賦值給下標i對應的桶，注意這裡的i不一定是最開始值了。

 private void replaceStaleEntry(ThreadLocal<?> key, Object value,
                                       int staleSlot) {
            Entry[] tab = table;
            int len = tab.length;
            Entry e;

            int slotToExpunge = staleSlot;
            for (int i = prevIndex(staleSlot, len);
                 (e = tab[i]) != null;
                 i = prevIndex(i, len)){
                if (e.get() == null)
                    slotToExpunge = i;
            }
            
            for (int i = nextIndex(staleSlot, len);
                 (e = tab[i]) != null;
                 i = nextIndex(i, len)) {
                ThreadLocal<?> k = e.get();
                if (k == key) {
                    e.value = value;
                    tab[i] = tab[staleSlot];
                    tab[staleSlot] = e;
                    if (slotToExpunge == staleSlot)
                        slotToExpunge = i;
                    cleanSomeSlots(expungeStaleEntry(slotToExpunge), len);
                    return;
                }
                if (k == null && slotToExpunge == staleSlot)
                    slotToExpunge = i;
            }
            
            tab[staleSlot].value = null;
            tab[staleSlot] = new Entry(key, value);

            if (slotToExpunge != staleSlot)
                cleanSomeSlots(expungeStaleEntry(slotToExpunge), len);
        }

replaceStaleEntry方法是對set過程中遇到的失效Entry做進一步處理，replaceStaleEntry程式碼中執行步驟如下：

1. 從當前下標為staleSlot的地方向左遍歷，直到找到第一個空桶停止遍歷，此時slotToExpunge=staleSlot，或者直到找到第一個非空桶且Entry物件的key為空為止，此時slotToExpunge為當前桶下標。此處可能說的有點繞，但是相信自己看程式碼就能明白。

2. 從當前下標為staleSlot的地方向右遍歷，此遍歷的目的是為了檢視右側是否存在key相同的Entry，如果有，就更新value，並且和staleSlot下標對應的桶中的失效Entry交換位置，如果沒有就直接更新staleSlot下標的桶。

這裡為什麼不直接更新staleSlot下標對應的桶呢？

因為Entry陣列插入的時候如果遇到hash衝突(即兩個key計算出的下標相同)，直接是依次插到後面一個空桶，如果再後來的資料插入的時候發現對應下標的桶已經被佔用，這種情況也是向後一個空桶插入。因此可以知道，不直接更新而是向後遍歷檢視key是否相等，就類似於hash表插入的時候發生hash衝突後對連結串列的遍歷查詢。只不過多了一個為止交換。

3. 每一次插入完成，就要執行expungeStaleEntry方法和cleanSomeSlots方法，這個兩個方法都是失效清理方法。

expungeStaleEntry方法為探測式清理，從給定開始的下標開始向右遍歷，直到第一個空桶為止

private int expungeStaleEntry(int staleSlot) {
            Entry[] tab = table;
            int len = tab.length;
            tab[staleSlot].value = null;
            tab[staleSlot] = null;
            size--;
            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;
        }

還記得這個變數嗎slotToExpunge，這個變數的值是向左遍歷得到的第一個Entry失效的桶的下標。

此方法做的事情就是從這個下標開始向右把失效的Entry全部清除，而把沒有失效的Entry重新計算下標，重新按照開放地址法放到陣列中。直到第一個空桶停止遍歷。並且把當前遍歷到的桶的下標返回。

我們先來總結下這個過程的幾個關鍵點

向左遍歷到第一個空桶的位置。
向右遍歷的過程中清除失效Entry，重hash有效Entry，直到遍歷到第一個空桶為止。

那麼為什麼這麼做呢？

首先，之所以只操作兩個空桶之間的元素，是因為兩個空桶之間的元素都和當前key計算的下標有關係（有可能是hash衝突造成的臨近元素），操作這一部分資料可以保證與當前key相關的元素都能得到失效處理。

然後就是小範圍的失效操作，避免大量資料參與，可以提高效能。

最後是可以使得rehash後的資料距離正確的位置更近一些，能提高整個雜湊表的查詢效能。

同時這個方法會在set，get，remove，resize方法中反覆使用，因此不能大規模掃描。

private boolean cleanSomeSlots(int i, int n) {
            boolean removed = false;
            Entry[] tab = table;
            int len = tab.length;
            do {
                i = nextIndex(i, len);
                Entry e = tab[i];
                if (e != null && e.get() == null) {
                    n = len;
                    removed = true;
                    i = expungeStaleEntry(i);
                }
            } while ( (n >>>= 1) != 0);
            return removed;
        }

cleanSomeSlots方法為啟發式清理，從給定開始的下標開始向右遍歷log2n個位置，對遍歷過程中失效元素呼叫expungeStaleEntry方法，目的也是在不影響效能的基礎上儘可能的多的把失效的元素清除。

get方法解析

 public T get() {
        Thread t = Thread.currentThread();
        ThreadLocalMap map = getMap(t);
        if (map != null) {
            ThreadLocalMap.Entry e = map.getEntry(this);
            if (e != null) {
                @SuppressWarnings("unchecked")
                T result = (T)e.value;
                return result;
            }
        }
        return setInitialValue();
    }
    
 private Entry getEntry(ThreadLocal<?> key) {
            int i = key.threadLocalHashCode & (table.length - 1);
            Entry e = table[i];
            if (e != null && e.get() == key)
                return e;
            else
                return getEntryAfterMiss(key, i, e);
        }   
    
    
 private Entry getEntryAfterMiss(ThreadLocal<?> key, int i, Entry e) {
            Entry[] tab = table;
            int len = tab.length;

            while (e != null) {
                ThreadLocal<?> k = e.get();
                if (k == key)
                    return e;
                if (k == null)
                    expungeStaleEntry(i);
                else
                    i = nextIndex(i, len);
                e = tab[i];
            }
            return null;
        }

get方法要比set方法簡單，邏輯步驟如下

計算下標，透過下標獲取元素
對比下標對應桶中元素的key和要查詢k是否相等，如果相等直接返回
如果key不相等，就會走這個getEntryAfterMiss方法

getEntryAfterMiss方法就是從當前座標開始向後檢查key是否相等，相等的直接返回，如果失效，就呼叫expungeStaleEntry做失效處理，如果沒有找到就返回null。

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方法就更加簡單了，遍歷找到key相等的元素，進行刪除，順便在當前座標位置開始呼叫expungeStaleEntry進行失效處理

擴容解析

private void resize() {
            Entry[] oldTab = table;
            int oldLen = oldTab.length;
            int newLen = oldLen * 2;
            Entry[] newTab = new Entry[newLen];
            int count = 0;

            for (int j = 0; j < oldLen; ++j) {
                Entry e = oldTab[j];
                if (e != null) {
                    ThreadLocal<?> k = e.get();
                    if (k == null) {
                        e.value = null; // Help the GC
                    } else {
                        int h = k.threadLocalHashCode & (newLen - 1);
                        while (newTab[h] != null)
                            h = nextIndex(h, newLen);
                        newTab[h] = e;
                        count++;
                    }
                }
            }

            setThreshold(newLen);
            size = count;
            table = newTab;
        }

擴容機制也比較簡單，在擴容前會先呼叫expungeStaleEntry進行一次失效處理，這此失效處理是在座標0開始，失效處理結束後如果size >= threshold - threshold / 4，那就進行擴容

擴容步驟

宣告新的陣列，是原來資料的2倍
遍歷原來的陣列，對元素進行重hash計算下標，然後放入新的陣列中。
遍歷過程中如果遇到失效的元素，value置為空。
重置size,重置table，重新計算擴容因子threshold,(len * 2 / 3)

6ThreadLocal的問題

記憶體洩露

在ThreadLocalMap中使用WeakReference包裝後的ThreadLocal物件作為key，也就是說這裡對ThreadLocal物件為弱引用。當ThreadLocal物件在ThreadLocalMap引用之外，再無其他引用的時候能夠被垃圾回收

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

垃圾回收後，Entry物件的key變為null，value還被引用著，既然key為null，那麼value就不可能再被應用，但是因為value被Entry引用著，Entry被ThreadLocalMap引用著，ThreadLocalMap被Thread引用著，因此執行緒不結束，那麼該回收的記憶體就會一直回收不了。

很容易出問題的情況就是我們在使用執行緒池的時候，執行緒池中的執行緒都是重複利用的，這時候使用threadLocal存放一些資料的話，如果線上程結束的時候沒有顯示的做清除處理，就有可能會出現記憶體洩露問題，甚至導致業務邏輯出現問題。所以在使用執行緒池的時候需要特別注意在程式碼執行完後顯式的去清空設定的資料，如果用自定義的執行緒池同樣也會遇到這樣的問題。此時需要在finally程式碼塊顯式清除threadLocal中的資料。

當然對於記憶體洩露問題，ThreadLocalMap也是做了相關處理的，透過上面的原始碼知道ThreadLocalMap在get和set以及remove的時候,都會相應的做一次探測式清理操作，但是我們也說了這種清除是小範圍的，是不能100%保證能夠清理乾淨的。

我們可以透過以下兩種方式來避免這個問題：

把ThreadLocal物件宣告為static，這樣ThreadLocal成為了類變數，生命週期不是和物件繫結，而是和類繫結，延長了宣告週期，避免了被回收；

在使用完ThreadLocal變數後，手動remove掉，防止ThreadLocalMap中Entry一直保持對value的強引用。導致value不能被回收。

threadlocal的繼承性

threadlocal不支援繼承性：也就是說，同一個ThreadLocal變數在父執行緒中被設定值後，在子執行緒中是獲取不到的。

但是父執行緒設定上下文就無法被子執行緒獲取嗎？當然不是，thread類除了提供了threadLocals，還提供了inheritableThreadLocals，InheritableThreadLocal繼承了ThreadLocal，這個類中的父執行緒的值就可以在子執行緒中獲取到。此類重寫了ThreadLocal的三個方法。

public class InheritableThreadLocal<T> extends ThreadLocal<T> {
    public InheritableThreadLocal() {
    }
    protected T childValue(T var1) {
        return var1;
    }
    ThreadLocalMap getMap(Thread var1) {
        return var1.inheritableThreadLocals;
    }
    void createMap(Thread var1, T var2) {
        var1.inheritableThreadLocals = new ThreadLocalMap(this, var2);
    }
}

此類是如何實現子執行緒獲取父執行緒儲存的值的呢？下面程式碼是thread類的原始碼，在建立一個執行緒時，thread初始化的innt方法中會去判斷父執行緒的inheritThreadLocals中是否有值，如果有，直接賦值給子執行緒

if (inheritThreadLocals && parent.inheritableThreadLocals != null)
    this.inheritableThreadLocals =
        ThreadLocal.createInheritedMap(parent.inheritableThreadLocals);

InheritableThreadLocals的使用方式

private static final ThreadLocal<OperationInfoDTO> THREAD_LOCAL = new InheritableThreadLocals <OperationInfoDTO>();

面試官問：ThreadLocal中的鍵為什麼是弱引用？