1 前言
此類提供線程本地變量。這些變量與普通變量不同，因為每個通路一個變量（通過其get或set方法）的線程都有其自己的，獨立初始化的變量副本。 ThreadLocal 執行個體通常是期望将狀态與線程(例如，使用者ID或事務ID)關聯的類中的 private static 字段。
例如，下面的類生成每個線程本地的唯一辨別符。線程的ID是在第一次調用ThreadId.get() 時指派的，并且在以後的調用中保持不變。
隻要線程是活躍的并且 ThreadLocal 執行個體是可通路的，則每個線程都對其線程本地變量的副本持有隐式的引用。線程消失後，線程本地執行個體的所有副本都會被 GC（除非存在對這些副本的其他引用）。
2 繼續體系
- 繼承?不存在的,這其實也是 java.lang 包下的工具類
ThreadLocal 核心源碼解析1 前言2 繼續體系3 屬性4 ThreadLocalMap5 set6 get6 擴容7 總結 - 但是 ThreadLocal 定義帶有泛型，說明可以儲存任意格式的資料.
ThreadLocal 核心源碼解析1 前言2 繼續體系3 屬性4 ThreadLocalMap5 set6 get6 擴容7 總結
3 屬性
-
ThreadLocal 依賴于附加到每個線程（Thread.threadLocals和InheritableThreadLocals）的線程線性探測哈希表.
ThreadLocal 對象充當鍵，通過 threadLocalHashCode 進行搜尋。這是一個自定義哈希碼(僅在ThreadLocalMaps 中有用)，它消除了在相同線程使用連續構造的threadlocal的常見情況下的沖突，而在不太常見的情況下仍然表現良好。
一句話總結: ThreadLocal 通過這樣的 hashCode，計算目前 ThreadLocal 在 ThreadLocalMap 中的索引
- 連續生成的哈希碼之間的內插補點,關于該值的設定,可參考文章 ThreadLocal的hash算法（關于 0x61c88647）
ThreadLocal 核心源碼解析1 前言2 繼續體系3 屬性4 ThreadLocalMap5 set6 get6 擴容7 總結 - 注意 static 修飾,ThreadLocalMap 會被 set 多個 ThreadLocal ，而多個 ThreadLocal 就根據 threadLocalHashCode 區分
ThreadLocal 核心源碼解析1 前言2 繼續體系3 屬性4 ThreadLocalMap5 set6 get6 擴容7 總結
4 ThreadLocalMap
ThreadLocalMap 是自定義的哈希表，僅适用于維護線程本地的值。沒有操作導出到ThreadLocal類之外。
該類是包私有的，允許在 Thread 類中的字段聲明。為了幫助處理非常長的使用壽命，哈希表節點使用 WeakReferences 作為鍵。但是，由于不使用引用隊列，是以僅在表空間不足時，才保證删除過時的節點。
static class ThreadLocalMap {
/**
* 此哈希表中的節點使用其主引用字段作為鍵（始終是一個 ThreadLocal 對象）
* 繼承了 WeakReference。
* 請注意，空鍵（即entry.get（）== null）意味着不再引用該鍵，是以可以從表中删除該節點。
* 在下面的代碼中，此類節點稱為 "stale entries"
*/
static class Entry extends WeakReference<ThreadLocal<?>> {
/** 與此 ThreadLocal 關聯的值 */
Object value;
Entry(ThreadLocal<?> k, Object v) {
super(k);
value = v;
}
}
/**
* 初始容量 -- 必須是 2 的幂
*/
private static final int INITIAL_CAPACITY = 16;
/**
* table 數組,必要時擴容
* table.length 必須是 2 的幂
*/
private Entry[] table;
/**
* table 中的節點個數
*/
private int size = 0;
/**
* 下一次擴容的門檻值
*/
private int threshold; // 預設為 0 特點
- key 是 ThreadLocal 的引用
- value 是 ThreadLocal 儲存的值
- 數組的資料結構
5 set
5.1 ThreadLocal#set
将此線程本地變量的目前線程副本設定為指定值。大多數子類将不需要重寫此方法，而僅依靠initialValue方法來設定線程本地變量的值。
執行流程
- 擷取目前線程
- 擷取線程所對應的ThreadLocalMap，從這可以看出每個線程都是獨立的,是以此方法天然線程安全
- 判斷 map 是否為 null
- 否，則 K.V 對指派，k 為this,即目前的 ThreaLocal 對象
- 是，則初始化一個 ThreadLocalMap 來維護 K.V 對
來具體看看ThreadLocalMap中的 set
5.2 ThreadLocalMap#set
private void set(ThreadLocal<?> key, Object value) {
// 新引用指向 table
Entry[] tab = table;
int len = tab.length;
// 擷取對應 ThreadLocal 在table 中的索引,注意這裡是 hashCode 與 2 幂次長度-1(想起來為什麼這樣計算更好了嗎?)
int i = key.threadLocalHashCode & (len-1);
/**
* 從該下标開始循環周遊
* 1、如遇相同key，則直接替換value
* 2、如果該key已經被回收失效，則替換該失效的key
*/
for (Entry e = tab[i];
e != null;
e = tab[i = nextIndex(i, len)]) {
ThreadLocal<?> k = e.get();
// 找到記憶體位址一樣的 ThreadLocal，直接替換
if (k == key) {
e.value = value;
return;
}
// 若 k 為 null,說明 ThreadLocal 被清理了,則替換目前失效的 k
if (k == null) {
replaceStaleEntry(key, value, i);
return;
}
}
// 找到空位，建立節點并插入
tab[i] = new Entry(key, value);
// table内元素size自增
int sz = ++size;
// 達到門檻值(數組大小的三分之二)時，執行擴容
if (!cleanSomeSlots(i, sz) && sz >= threshold)
rehash();
} 注意通過 hashCode 計算的索引位置 i 處如果已經有值了，會從 i 開始，通過 +1 不斷的往後尋找，直到找到索引位置為空的地方，把目前 ThreadLocal 作為 key 放進去。
6 get
public T get() {
// 擷取目前線程
Thread t = Thread.currentThread();
// 擷取目前線程對應的ThreadLocalMap
ThreadLocalMap map = getMap(t);
// 如果map不為空
if (map != null) {
// 取得目前ThreadLocal對象對應的Entry
ThreadLocalMap.Entry e = map.getEntry(this);
// 如果不為空，讀取目前 ThreadLocal 中儲存的值
if (e != null) {
@SuppressWarnings("unchecked")
T result = (T)e.value;
return result;
}
}
// 否則都執行 setInitialValue
return setInitialValue();
} private T setInitialValue() {
// 擷取初始值，一般是子類重寫
T value = initialValue();
// 擷取目前線程
Thread t = Thread.currentThread();
// 擷取目前線程對應的ThreadLocalMap
ThreadLocalMap map = getMap(t);
// 如果map不為null
if (map != null)
// 調用ThreadLocalMap的set方法進行指派
map.set(this, value);
// 否則建立個ThreadLocalMap進行指派
else
createMap(t, value);
return value;
} 接着我們來看下
ThreadLocalMap#getEntry
// 得到目前 thradLocal 對應的值，值的類型是由 thradLocal 的泛型決定的
// 由于 thradLocalMap set 時解決數組索引位置沖突的邏輯，導緻 thradLocalMap get 時的邏輯也是對應的
// 首先嘗試根據 hashcode 取模數組大小-1 = 索引位置 i 尋找，找不到的話，自旋把 i+1，直到找到索引位置不為空為止
private Entry getEntry(ThreadLocal<?> key) {
// 計算索引位置：ThreadLocal 的 hashCode 取模數組大小-1
int i = key.threadLocalHashCode & (table.length - 1);
Entry e = table[i];
// e 不為空，并且 e 的 ThreadLocal 的記憶體位址和 key 相同，直接傳回，否則就是沒有找到，繼續通過 getEntryAfterMiss 方法找
if (e != null && e.get() == key)
return e;
else
// 這個取資料的邏輯，是因為 set 時數組索引位置沖突造成的
return getEntryAfterMiss(key, i, e);
}
// 自旋 i+1，直到找到為止
private Entry getEntryAfterMiss(ThreadLocal<?> key, int i, Entry e) {
Entry[] tab = table;
int len = tab.length;
// 在大量使用不同 key 的 ThreadLocal 時，其實還蠻耗性能的
while (e != null) {
ThreadLocal<?> k = e.get();
// 記憶體位址一樣，表示找到了
if (k == key)
return e;
// 删除沒用的 key
if (k == null)
expungeStaleEntry(i);
// 繼續使索引位置 + 1
else
i = nextIndex(i, len);
e = tab[i];
}
return null;
} 6 擴容
ThreadLocalMap 中的 ThreadLocal 的個數超過門檻值時，ThreadLocalMap 就要開始擴容了，我們一起來看下擴容的邏輯：
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 {
// 計算 ThreadLocal 在新數組中的位置
int h = k.threadLocalHashCode & (newLen - 1);
// 如果索引 h 的位置值不為空，往後+1，直到找到值為空的索引位置
while (newTab[h] != null)
h = nextIndex(h, newLen);
// 給新數組指派
newTab[h] = e;
count++;
}
}
}
// 給新數組初始化下次擴容門檻值，為數組長度的三分之二
setThreshold(newLen);
size = count;
table = newTab;
} 源碼注解也比較清晰，我們注意兩點：
擴容後數組大小是原來數組的兩倍；
擴容時是絕對沒有線程安全問題的，因為 ThreadLocalMap 是線程的一個屬性，一個線程同一時刻隻能對 ThreadLocalMap 進行操作，因為同一個線程執行業務邏輯必然是串行的，那麼操作 ThreadLocalMap 必然也是串行的。
7 總結
ThreadLocal 是非常重要的 API，我們在寫一個中間件的時候經常會用到，比如說流程引擎中上下文的傳遞，調用鍊ID的傳遞等等，非常好用，但坑也很多。