ThreadLocal是什么
ThreadLocal 的作用是提供線程內的局部變量,這種變量在線程的生命周期內起作用,減少同一個線程內多個函數或者組件之間一些公共變量的傳遞的復雜度。但是如果濫用ThreadLocal
,就可能會導致內存泄漏。
ThreadLocal
的實現是這樣的:每個Thread
維護一個 ThreadLocalMap
映射表,這個映射表的 key
是 ThreadLocal
實例本身,value
是真正需要存儲的 Object
。
也就是說 ThreadLocal
本身並不存儲值,它只是作為一個 key
來讓線程從 ThreadLocalMap
獲取 value
。值得注意的是圖中的虛線,表示 ThreadLocalMap
是使用 ThreadLocal
的弱引用作為 Key
的,弱引用的對象在 GC 時會被回收。
從數據結構入手
下圖為ThreadLocal的內部結構圖


從上面的結構圖,我們已經窺見ThreadLocal的核心機制:
- 每個Thread線程內部都有一個ThreadLocalMap。
- Map里面存儲線程本地對象(key)和線程的變量副本(value)
- 但是,Thread內部的Map是由ThreadLocal維護的,由ThreadLocal負責向map獲取和設置線程的變量值。
所以對於不同的線程,每次獲取副本值時,別的線程並不能獲取到當前線程的副本值,形成了副本的隔離,互不干擾。
Thread線程內部的Map在類中描述如下:
public class Thread implements Runnable { /* ThreadLocal values pertaining to this thread. This map is maintained * by the ThreadLocal class. */ ThreadLocal.ThreadLocalMap threadLocals = null; }
深入解析ThreadLocal
ThreadLocal類提供如下幾個核心方法:
public T get() public void set(T value) public void remove()
- get()方法用於獲取當前線程的副本變量值。
- set()方法用於保存當前線程的副本變量值。
- initialValue()為當前線程初始副本變量值。
- remove()方法移除當前前程的副本變量值。
get()方法
/** * Returns the value in the current thread's copy of this * thread-local variable. If the variable has no value for the * current 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); if (map != null) { ThreadLocalMap.Entry e = map.getEntry(this); if (e != null) return (T)e.value; } return setInitialValue(); } ThreadLocalMap getMap(Thread t) { return t.threadLocals; } 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; } protected T initialValue() { return null; }
步驟:
1.獲取當前線程的ThreadLocalMap對象threadLocals
2.從map中獲取線程存儲的K-V Entry節點。
3.從Entry節點獲取存儲的Value副本值返回。
4.map為空的話返回初始值null,即線程變量副本為null,在使用時需要注意判斷NullPointerException。
set()方法
/** * Sets the current thread's copy of this thread-local variable * to the specified value. Most subclasses will have no need to * override this method, relying solely on the {@link #initialValue} * method to set the values of thread-locals. * * @param value the value to be stored in the current thread's copy of * this thread-local. */ public void set(T value) { Thread t = Thread.currentThread(); ThreadLocalMap map = getMap(t); if (map != null) map.set(this, value); else createMap(t, value); } ThreadLocalMap getMap(Thread t) { return t.threadLocals; } void createMap(Thread t, T firstValue) { t.threadLocals = new ThreadLocalMap(this, firstValue); }
步驟:
1.獲取當前線程的成員變量map
2.map非空,則重新將ThreadLocal和新的value副本放入到map中。
3.map空,則對線程的成員變量ThreadLocalMap進行初始化創建,並將ThreadLocal和value副本放入map中。
remove()方法
/** * Removes the current thread's value for this thread-local * variable. If this thread-local variable is subsequently * {@linkplain #get read} by the current thread, its value will be * reinitialized by invoking its {@link #initialValue} method, * unless its value is {@linkplain #set set} by the current thread * in the interim. This may result in multiple invocations of the * <tt>initialValue</tt> method in the current thread. * * @since 1.5 */ public void remove() { ThreadLocalMap m = getMap(Thread.currentThread()); if (m != null) m.remove(this); } ThreadLocalMap getMap(Thread t) { return t.threadLocals; }
remove方法比較簡單,不做贅述。
ThreadLocalMap
ThreadLocalMap是ThreadLocal的內部類,沒有實現Map接口,用獨立的方式實現了Map的功能,其內部的Entry也獨立實現。


在ThreadLocalMap中,也是用Entry來保存K-V結構數據的。但是Entry中key只能是ThreadLocal對象,這點被Entry的構造方法已經限定死了。
static class Entry extends WeakReference<ThreadLocal> { /** The value associated with this ThreadLocal. */ Object value; Entry(ThreadLocal k, Object v) { super(k); value = v; } }
Entry繼承自WeakReference(弱引用,生命周期只能存活到下次GC前),但只有Key是弱引用類型的,Value並非弱引用。
ThreadLocalMap的成員變量:
static class ThreadLocalMap { /** * The initial capacity -- MUST be a power of two. */ 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 }
Hash沖突怎么解決
和HashMap的最大的不同在於,ThreadLocalMap結構非常簡單,沒有next引用,也就是說ThreadLocalMap中解決Hash沖突的方式並非鏈表的方式,而是采用線性探測的方式,所謂線性探測,就是根據初始key的hashcode值確定元素在table數組中的位置,如果發現這個位置上已經有其他key值的元素被占用,則利用固定的算法尋找一定步長的下個位置,依次判斷,直至找到能夠存放的位置。
ThreadLocalMap解決Hash沖突的方式就是簡單的步長加1或減1,尋找下一個相鄰的位置。
/** * Increment i modulo len. */ private static int nextIndex(int i, int len) { return ((i + 1 < len) ? i + 1 : 0); } /** * Decrement i modulo len. */ private static int prevIndex(int i, int len) { return ((i - 1 >= 0) ? i - 1 : len - 1); }
顯然ThreadLocalMap采用線性探測的方式解決Hash沖突的效率很低,如果有大量不同的ThreadLocal對象放入map中時發送沖突,或者發生二次沖突,則效率很低。
ThreadLocal內存泄漏
首先,讓我們看看在threadlocal的生命周期中,都存在哪些引用吧. 看下圖: 實線代表強引用,虛線代表弱引用.
從中可以看出,弱引用只存在於key上,所以key會被回收. 而value還存在着強引用.只有thead退出以后,value的強引用鏈條才會斷掉.
由於ThreadLocalMap的key是弱引用,而Value是強引用。這就導致了一個問題,ThreadLocal在沒有外部對象強引用時,發生GC時弱引用Key會被回收,而Value不會回收,如果創建ThreadLocal的線程一直持續運行,那么這個Entry對象中的value就有可能一直得不到回收,發生內存泄露。
WeakReference是Java語言規范中為了區別直接的對象引用(程序中通過構造函數聲明出來的對象引用)而定義的另外一種引用關系。WeakReference標志性的特點是:reference實例不會影響到被應用對象的GC回收行為(即只要對象被除WeakReference對象之外所有的對象解除引用后,該對象便可以被GC回收),只不過在被對象回收之后,reference實例想獲得被應用的對象時程序會返回null。
理解了WeakReference之后,ThreadLocalMap使用它的目的也相對清晰了:當threadLocal實例可以被GC回收時,系統可以檢測到該threadLocal對應的Entry是否已經過期(根據reference.get() == null來判斷,如果為true則表示過期,程序內部稱為stale slots)來自動做一些清除工作,否則如果不清除的話容易產生內存無法釋放的問題:value對應的對象即使不再使用,但由於被threadLocalMap所引用導致無法被GC回收。實際代碼中,ThreadLocalMap會在set,get以及resize等方法中對stale slots做自動刪除(set以及get不保證所有過期slots會在操作中會被刪除,而resize則會刪除threadLocalMap中所有的過期slots)。當然將threadLocal對象設置為null並不能完全避免內存泄露對象,最安全的辦法仍然是調用ThreadLocal的remove方法,來徹底避免可能的內存泄露。
關於ThreadLocal是否會引起內存泄漏也是一個比較有爭議性的問題,其實就是要看對內存泄漏的准確定義是什么。
認為ThreadLocal會引起內存泄漏的說法是因為如果一個ThreadLocal對象被回收了,我們往里面放的value對於【當前線程->當前線程的threadLocals(ThreadLocal.ThreadLocalMap對象)->Entry數組->某個entry.value】這樣一條強引用鏈是可達的,因此value不會被回收。
認為ThreadLocal不會引起內存泄漏的說法是因為ThreadLocal.ThreadLocalMap源碼實現中自帶一套自我清理的機制。
之所以有關於內存泄露的討論是因為在有線程復用如線程池的場景中,一個線程的壽命很長,大對象長期不被回收影響系統運行效率與安全。如果線程不會復用,用完即銷毀了也不會有ThreadLocal引發內存泄露的問題。《Effective Java》一書中的第6條對這種內存泄露稱為unintentional object retention
(無意識的對象保留)。
當我們仔細讀過ThreadLocalMap的源碼,我們可以推斷,如果在使用的ThreadLocal的過程中,顯式地進行remove是個很好的編碼習慣,這樣是不會引起內存泄漏。
那么如果沒有顯式地進行remove呢?只能說如果對應線程之后調用ThreadLocal的get和set方法都有很高的概率會順便清理掉無效對象,斷開value強引用,從而大對象被收集器回收。
但無論如何,我們應該考慮到何時調用ThreadLocal的remove方法。一個比較熟悉的場景就是對於一個請求一個線程的server如tomcat,在代碼中對web api作一個切面,存放一些如用戶名等用戶信息,在連接點方法結束后,再顯式調用remove。
為什么使用弱引用?
從文章開頭通過threadLocal,threadLocalMap,entry的引用關系看起來threadLocal存在內存泄漏的問題似乎是因為threadLocal是被弱引用修飾的。那為什么要使用弱引用呢?
如果使用強引用
如果threadLocalMap的Entry強引用threadLocal,就算外部對象不再強引用threadLocal,threadLocal永遠不會被垃圾回收
見:https://www.cnblogs.com/twoheads/p/9681987.html
如果使用弱引用
假設Entry弱引用threadLocal,盡管可能會出現內存泄漏的問題,但是在threadLocal的生命周期里(set,getEntry,remove)里,都會針對key為null的臟entry進行處理。
為什么value不用弱引用呢?
value不像key那樣,key還有一個外部的強引用,如果在業務執行過程中發生了gc,value被清理了,業務后邊取值會出錯的。
如何避免泄漏
既然Key是弱引用,那么我們要做的事,就是在調用ThreadLocal的get()、set()方法時完成業務邏輯后再調用remove方法,將Entry節點和Map的引用關系移除,這樣整個Entry對象在GC Roots分析后就變成不可達了,下次GC的時候就可以被回收。
如果使用ThreadLocal的set方法之后,沒有顯示的調用remove方法,就有可能發生內存泄露,所以養成良好的編程習慣十分重要,使用完ThreadLocal之后,記得調用remove方法。
ThreadLocal<Session> threadLocal = new ThreadLocal<Session>(); try { threadLocal.set(new Session(1, "Misout的博客")); // 其它業務邏輯 } finally { threadLocal.remove(); }
對於沒有使用線程池的方法來說,因為每次線程運行完就退出了,Map里面引用的所有對象都會被垃圾回收,所以沒有關系。
可是,在實際使用中我們都是會用線程池去維護我們的線程,比如在Executors.newFixedThreadPool()時創建線程的時候,為了復用線程是不會結束的,所以threadLocal內存泄漏就值得我們關注。
應用場景
舉例:Hibernate 的 ThreadLocal模式管理 Session
private static final ThreadLocal<Session> threadLocal = new ThreadLocal<Session>(); //獲取Session public static Session getCurrentSession(){ Session session = threadLocal.get(); //判斷Session是否為空,如果為空,將創建一個session,並設置到本地線程變量中 try { if(session ==null&&!session.isOpen()){ if(sessionFactory==null){ rbuildSessionFactory();// 創建Hibernate的SessionFactory }else{ session = sessionFactory.openSession(); } } threadLocal.set(session); } catch (Exception e) { // TODO: handle exception } return session; }
為什么?每個線程訪問數據庫都應當是一個獨立的Session會話,如果多個線程共享同一個Session會話,有可能其他線程關閉連接了,當前線程再執行提交時就會出現會話已關閉的異常,導致系統異常。使用threadlocal每個線程一個session能避免線程爭搶Session,提高並發下的安全性。
使用ThreadLocal的典型場景正如上面的數據庫連接管理,線程會話管理等場景,只適用於獨立變量副本的情況,如果變量為全局共享的,則不適用在高並發下使用。
總結
- 每個ThreadLocal只能保存一個變量副本,如果想要上線一個線程能夠保存多個副本以上,就需要創建多個ThreadLocal。
- ThreadLocal內部的ThreadLocalMap鍵為弱引用,會有內存泄漏的風險。
- 適用於無狀態,副本變量獨立后不影響業務邏輯的高並發場景。如果如果業務邏輯強依賴於副本變量,則不適合用ThreadLocal解決,需要另尋解決方案。
至此,可能大部分朋友已經明白了ThreadLocal是如何為每個線程創建變量的副本的:
首先,在每個線程Thread內部有一個ThreadLocal.ThreadLocalMap類型的成員變量threadLocals,這個threadLocals就是用來存儲實際的變量副本的,鍵值為當前ThreadLocal變量,value為變量副本(即T類型的變量)。
初始時,在Thread里面,threadLocals為空,當通過ThreadLocal變量調用get()方法或者set()方法,就會對Thread類中的threadLocals進行初始化,並且以當前ThreadLocal變量為鍵值,以ThreadLocal要保存的副本變量為value,存到threadLocals。
然后在當前線程里面,如果要使用副本變量,就可以通過get方法在threadLocals里面查找。
下面通過一個例子來證明通過ThreadLocal能達到在每個線程中創建變量副本的效果:

public class Test { ThreadLocal<Long> longLocal = new ThreadLocal<Long>(); ThreadLocal<String> stringLocal = new ThreadLocal<String>(); public void set() { longLocal.set(Thread.currentThread().getId()); stringLocal.set(Thread.currentThread().getName()); } public long getLong() { return longLocal.get(); } public String getString() { return stringLocal.get(); } public static void main(String[] args) throws InterruptedException { final Test test = new Test(); test.set(); System.out.println(test.getLong()); System.out.println(test.getString()); Thread thread1 = new Thread(){ public void run() { test.set(); System.out.println(test.getLong()); System.out.println(test.getString()); }; }; thread1.start(); thread1.join(); System.out.println(test.getLong()); System.out.println(test.getString()); } }
這段代碼的輸出結果為:
從這段代碼的輸出結果可以看出,在main線程中和thread1線程中,longLocal保存的副本值和stringLocal保存的副本值都不一樣。最后一次在main線程再次打印副本值是為了證明在main線程中和thread1線程中的副本值確實是不同的。
https://www.jianshu.com/p/98b68c97df9b