本文主要從源碼的角度解析了 ThreadLocal，並分析了發生記憶體泄漏的原因及正確用法，最後對它的應用場景進行了簡單介紹。 ...
引言：
當多線程訪問共用且可變的數據時，涉及到線程間同步的問題，並不是所有時候，都要用到共用數據，所以就需要ThreadLocal出場了。
ThreadLocal又稱線程本地變數，使用其能夠將數據封閉在各自的線程中，每一個ThreadLocal能夠存放一個線程級別的變數且它本身能夠被多個線程共用使用，並且又能達到線程安全的目的，且絕對線程安全。一般用法如下：
public final static ThreadLocal<String> PARAMS = new ThreadLocal<String>();
PARAMS代表一個能夠存放String類型的ThreadLocal對象。此時不論什麼一個線程能夠併發訪問這個變數，對它進行寫入、讀取操作，都是線程安全的。
實際上可以把企微會話存檔的相關配置參數存入到ThreadLocal中，各個方法內需要使用直接從ThreadLocal中獲取就可以了.
原理：我們先看一下ThreadLocal的結構：
首先是set方法：
這塊代碼其實很有意思，我們發現在向ThreadLocal中存放值時需要先從當前線程中獲取ThreadLocalMap，最後實際是要把當前ThreadLocal對象作為key、要存入的值作為value存放到ThreadLocalMap中，那我們就不得不先看一下ThreadLocalMap的結構。
部分核心代碼：
static class ThreadLocalMap {
// 鍵值對實體的存儲結構
static class Entry extends WeakReference<ThreadLocal<?>> {
/** The value associated with this ThreadLocal. */
// 當前線程關聯的 value，這個 value 並沒有用弱引用追蹤
Object value;
// k 作 key,作為 key 的 ThreadLocal 會被包裝為一個弱引用，v 作 value
Entry(ThreadLocal<?> k, Object v) {
super(k);
value = v;
}
}
/**
* 初始容量，必須為 2 的冪.
*/
private static final int INITIAL_CAPACITY = 16;
/**
* The table, resized as necessary.
* table.length MUST always be a power of two.
*/
private Entry[] table;
/**
* The number of entries in the table.
*/
private int size = 0;
/**
* The next size value at which to resize.
*/
private int threshold; // Default to 0
}
ThreadLocalMap 是 ThreadLocal 的靜態內部類，當一個線程有多個 ThreadLocal 時，需要一個容器來管理多個 ThreadLocal，ThreadLocalMap 的作用就是管理線程中多個 ThreadLocal，從源碼中看到 ThreadLocalMap 其實就是一個簡單的 Map 結構，底層是數組，有初始化大小，也有擴容閾值大小，數組的元素是 Entry，Entry 的 key 就是 ThreadLocal 的引用，value 是 ThreadLocal記憶體入 的值。
ThreadLocalMap 解決 hash 衝突的方式採用的是「線性探測法」，如果發生衝突會繼續尋找下一個空的位置。
每個Thread內部都持有一個ThreadLoalMap對象
/* ThreadLocal values pertaining to this thread. This map is maintained * by the ThreadLocal class. */
ThreadLocal.ThreadLocalMap threadLocals = null;
我們都能夠明白ThreadLocal存值的過程了，雖然我們是按照前言中的用法聲明瞭一個全局常量，但是這個常量在每次設置時實際都是向當前線程的ThreadLocalMap記憶體值，從而確保了數據在不同線程之間的隔離。
接下來就是get:
有了上面的鋪墊，這段代碼就不難理解了，獲取ThreadLocal內的值時，實際上是從當前線程的ThreadLocalMap中以當前ThreadLocal對象作為key取出對應的值，由於值在保存時時線程隔離的，所以現在取值時只會取得當前線程中的值，所以是絕對線程安全的。
remove:
remove將ThreadLocal對象關聯的鍵值對從Entry中移除，正確執行remove方法能夠避免使用ThreadLocal出現記憶體泄漏的潛在風險，int i = key.threadLocalHashCode & (len-1)這行代碼很有意思，從一個集合中找到一個元素存放位置的最簡單方法就是利用該元素的hashcode對這個集合的長度取餘，如果我們能夠將集合的長度限製成2的整數次冪就能夠將取餘運算轉換成hashcode與[集合長度-1]的與運算，這樣就能夠提高查找效率，HashMap中也是這樣處理的。
ThreadLocal的原理圖：
在提及ThreadLocal使用的註意事項時，所有的文章都會指出記憶體泄漏這一風險，但是我發現很少有文章能夠真正的把這一部分講清楚，這裡我就斗膽嘗試一下，由於ThreadLocalMap中的Entry的key持有的是ThreadLocal對象的弱引用，當這個ThreadLocal對象當且僅當被ThreadLocalMap中的Entry引用時發生了GC，會導致當前ThreadLocal對象被回收；那麼 ThreadLocalMap 中保存的 key 值就變成了 null，而Entry 又被 ThreadLocalMap 對象引用，ThreadLocalMap 對象又被 Thread 對象所引用，那麼當 Thread 一直不銷毀的話，value 對象就會一直存在於記憶體中，也就導致了記憶體泄漏，直至 Thread 被銷毀後，才會被回收。
解決辦法：
我們知道出現記憶體泄漏的原因是失去了對ThreadLocal對象的強引用，避免記憶體泄漏最簡單的方法就是始終保持對ThreadLocal對象的強引用，為每個線程聲明一個對ThreadLocal對象的強引用顯然是不合適的（太麻煩且缺乏聲明的時機），所以，我們可以將ThreadLocal對象聲明為一個全局常量，所有的線程均使用這一常量即可，例如：
按照上面的方式聲明ThreadLocal對象後，所有的線程共用此對象，在使用此對象存值時會把此對象作為key然後把對應的值作為value存入到當前線程的ThreadLocalMap中，由於此對象始終存在著一個全局的強引用，所以其不會被垃圾回收，調用remove方法後就能夠將此對象關聯的Entry清除。
結果如下：
可以看出兩個線程內對應的Entry的key為同一個對象且即使發生了垃圾回收該對象也不會被回收。
那麼是不是說將ThreadLocal對象聲明為一個全局常量後使用就沒有問題了呢，當然不是，我們需要確保在每次使用完ThreadLocal對象後確保要執行一下該對象的remove方法（重要），清除當前線程保存的信息，這樣當此線程再被利用時不會取到錯誤的信息（使用線程池極易出現）；
常見的使用場景：
ThreadLocal 的特性也導致了應用場景比較廣泛，主要的應用場景如下：
- 線程間數據隔離，各線程的 ThreadLocal 互不影響
- 方便同一個線程使用某一對象，避免不必要的參數傳遞
- 全鏈路追蹤中的 traceId 或者流程引擎中上下文的傳遞一般採用 ThreadLocal
- Spring 事務管理器採用了 ThreadLocal
- Spring MVC 的 RequestContextHolder 的實現使用了 ThreadLocal
- 一個APP多個數據源，來回切換多個數據源進行查詢數據。
- 日期格式化實例多線程安全問題。
總結：
本文主要從源碼的角度解析了 ThreadLocal，並分析了發生記憶體泄漏的原因及正確用法，最後對它的應用場景進行了簡單介紹。
ThreadLocal還有其他變種例如FastThreadLocal和TransmittableThreadLocal，FastThreadLocal主要解決了偽共用的問題比ThreadLocal擁有更好的性能，TransmittableThreadLocal主要解決了線程池中線程復用導致後續提交的任務並不會繼承到父線程的線程變數的問題等。
作者：京東零售 郭春元
來源：京東雲開發者社區
