Java中關(guān)于ThreadLocal的隱式引用詳解
前言
ThreadLocal 并不是一個(gè)Thread,而是 ThreadLocalVariable(線程局部變量)。也許把它命名為 ThreadLocalVar更加合適。線程局部變量就是為每一個(gè)使用該變量的線程都提供一個(gè)變量值的副本,是 Java中一種較為特殊的線程綁定機(jī)制,是每一個(gè)線程都可以獨(dú)立地改變自己的副本,而不會(huì)和其它線程的副本沖突。ThreadLocal是除了加鎖這種同步方式之外的另一種保證多線程訪問(wèn)出現(xiàn)線程不安全的方式。
從線程的角度看,每個(gè)線程都保持一個(gè)對(duì)其線程局部變量副本的隱式引用,只要線程是活動(dòng)的,ThreadLocal實(shí)例就是可訪問(wèn)的;在線程消失之后,其線程局部實(shí)例的所有副本都會(huì)被垃圾回收(除非存在對(duì)這些副本的其他引用)。
通過(guò)ThreadLocal存取的數(shù)據(jù),總是與當(dāng)前線程相關(guān),也就是說(shuō),JVM 為每個(gè)運(yùn)行的線程,綁定了私有的本地實(shí)例存取空間,從而為多線程環(huán)境常出現(xiàn)的并發(fā)訪問(wèn)問(wèn)題提供了一種隔離機(jī)制。在 ThreadLocal類中有一個(gè) Map,用于存儲(chǔ)每一個(gè)線程變量的副本,Map中元素的鍵為線程對(duì)象,而值為對(duì)應(yīng)線程的變量副本。ThreadLocal采用了 “以空間換時(shí)間” 的方式。為每一個(gè)線程都提供了一份變量,因此可以同時(shí)訪問(wèn)而互不影響。
一、API說(shuō)明
- new ThreadLocal(): 創(chuàng)建一個(gè)線程本地變量。
- T get(): 返回此線程局部變量的當(dāng)前線程副本中的值,如果這是線程第一次調(diào)用該方法,則創(chuàng)建并初始化此副本。
- void set(T value): 將此線程局部變量的當(dāng)前線程副本中的值設(shè)置為指定值。許多應(yīng)用程序不需要這項(xiàng)功能,它們只依賴于 initialValue() 方法來(lái)設(shè)置線程局部變量的值。
- void remove(): 移除此線程局部變量的值。這可能有助于減少線程局部變量的存儲(chǔ)需求。如果再次訪問(wèn)此線程局部變量,那么在默認(rèn)情況下它將擁有其 initialValue。
- protected T initialValue(): 返回此線程局部變量的當(dāng)前線程的初始值。最多在每次訪問(wèn)線程來(lái)獲得每個(gè)線程局部變量時(shí)調(diào)用此方法一次,即線程第一次使用 get() 方法訪問(wèn)變量的時(shí)候。如果線程先調(diào)用 set(T) 方法再調(diào)用 get() 方法,則不會(huì)在線程中再調(diào)用 initialValue() 方法。若該實(shí)現(xiàn)只返回 null;如果程序員希望將線程局部變量初始化為 null 以外的某個(gè)值,則必須為 ThreadLocal 創(chuàng)建子類,并重寫此方法。通常,將使用匿名內(nèi)部類。initialValue 的典型實(shí)現(xiàn)將調(diào)用一個(gè)適當(dāng)?shù)臉?gòu)造方法,并返回新構(gòu)造的對(duì)象。
在程序中一般都重寫 initialValue方法,以給定一個(gè)特定的初始值。
二、ThreadLocal簡(jiǎn)單使用
下面的例子中,開(kāi)啟兩個(gè)線程,在每個(gè)線程內(nèi)部設(shè)置了本地變量的值,然后調(diào)用 print方法打印當(dāng)前本地變量的值。如果在打印之后調(diào)用本地變量的 remove方法會(huì)刪除本地內(nèi)存中的變量,代碼如下所示:
package test; public class ThreadLocalTest { static ThreadLocal<String> localVar = new ThreadLocal<>(); static void print(String str) { //打印當(dāng)前線程中本地內(nèi)存中本地變量的值 System.out.println(str + " :" + localVar.get()); //清除本地內(nèi)存中的本地變量 localVar.remove(); } public static void main(String[] args) { Thread t1 = new Thread(new Runnable() { @Override public void run() { //設(shè)置線程1中本地變量的值 localVar.set("localVar1"); //調(diào)用打印方法 print("thread1"); //打印本地變量 System.out.println("after remove : " + localVar.get()); } }); Thread t2 = new Thread(new Runnable() { @Override public void run() { //設(shè)置線程1中本地變量的值 localVar.set("localVar2"); //調(diào)用打印方法 print("thread2"); //打印本地變量 System.out.println("after remove : " + localVar.get()); } }); t1.start(); t2.start(); } }
下面是運(yùn)行后的結(jié)果:
thread1 :localVar1
after remove : null
thread2 :localVar2
after remove : null
三、ThreadLocal的實(shí)現(xiàn)原理
下面是 ThreadLocal的類圖結(jié)構(gòu),從圖中可知:Thread類中有兩個(gè)變量 threadLocals和 inheritableThreadLocals,二者都是 ThreadLocal內(nèi)部類 ThreadLocalMap類型的變量,我們通過(guò)查看內(nèi)部?jī)?nèi) ThreadLocalMap可以發(fā)現(xiàn)實(shí)際上它類似于一個(gè)HashMap。在默認(rèn)情況下,每個(gè)線程中的這兩個(gè)變量都為null。
ThreadLocal.ThreadLocalMap threadLocals = null; ThreadLocal.ThreadLocalMap inheritableThreadLocals = null;
只有當(dāng)線程第一次調(diào)用 ThreadLocal的 set或者 get方法的時(shí)候才會(huì)創(chuàng)建他們(后面我們會(huì)查看這兩個(gè)方法的源碼)。除此之外,每個(gè)線程的本地變量不是存放在 ThreadLocal實(shí)例中,而是放在調(diào)用線程的 ThreadLocals變量里面(前面也說(shuō)過(guò),該變量是Thread類的變量)。也就是說(shuō),ThreadLocal類型的本地變量是存放在具體的線程空間上,其本相當(dāng)于一個(gè)裝載本地變量的工具殼,通過(guò) set方法將 value添加到調(diào)用線程的 threadLocals中,當(dāng)調(diào)用線程調(diào)用 get方法時(shí)候能夠從它的 threadLocals中取出變量。如果調(diào)用線程一直不終止,那么這個(gè)本地變量將會(huì)一直存放在他的 threadLocals中,所以不使用本地變量的時(shí)候需要調(diào)用 remove方法將 threadLocals中刪除不用的本地變量。下面我們通過(guò)查看 ThreadLocal的set、get以及remove方法來(lái)查看 ThreadLocal具體實(shí)怎樣工作的。
set方法源碼
public void set(T value) { //(1)獲取當(dāng)前線程(調(diào)用者線程) Thread t = Thread.currentThread(); //(2)以當(dāng)前線程作為key值,去查找對(duì)應(yīng)的線程變量,找到對(duì)應(yīng)的map ThreadLocalMap map = getMap(t); //(3)如果map不為null,就直接添加本地變量,key為當(dāng)前線程,值為添加的本地變量值 if (map != null) map.set(this, value); //(4)如果map為null,說(shuō)明首次添加,需要首先創(chuàng)建出對(duì)應(yīng)的map else createMap(t, value); }
在上面的代碼中,(2)處調(diào)用 getMap方法獲得當(dāng)前線程對(duì)應(yīng)的 threadLocals(參照上面的圖示和文字說(shuō)明),該方法代碼如下:
ThreadLocalMap getMap(Thread t) { return t.threadLocals; //獲取線程自己的變量threadLocals,并綁定到當(dāng)前調(diào)用線程的成員變量threadLocals上 }
如果調(diào)用 getMap方法返回值不為 null,就直接將 value值設(shè)置到 threadLocals中(key為當(dāng)前線程引用,值為本地變量);如果getMap方法返回 null說(shuō)明是第一次調(diào)用 set方法(前面說(shuō)到過(guò),threadLocals默認(rèn)值為null,只有調(diào)用 set方法的時(shí)候才會(huì)創(chuàng)建map),這個(gè)時(shí)候就需要調(diào)用 createMap方法創(chuàng)建 threadLocals,該方法如下所示:createMap方法不僅創(chuàng)建了threadLocals,同時(shí)也將要添加的本地變量值添加到了 threadLocals中。
void createMap(Thread t, T firstValue) { t.threadLocals = new ThreadLocalMap(this, firstValue); }
get方法源碼: 在 get方法的實(shí)現(xiàn)中,首先獲取當(dāng)前調(diào)用者線程,如果當(dāng)前線程的 threadLocals不為null,就直接返回當(dāng)前線程綁定的本地變量值,否則執(zhí)行 setInitialValue方法初始化 threadLocals變量。在 setInitialValue方法中,類似于 set方法的實(shí)現(xiàn),都是判斷當(dāng)前線程的 threadLocals變量是否為null,是則添加本地變量(這個(gè)時(shí)候由于是初始化,所以添加的值為null),否則創(chuàng)建 threadLocals變量,同樣添加的值為null。
public T get() { //(1)獲取當(dāng)前線程 Thread t = Thread.currentThread(); //(2)獲取當(dāng)前線程的threadLocals變量 ThreadLocalMap map = getMap(t); //(3)如果threadLocals變量不為null,就可以在map中查找到本地變量的值 if (map != null) { ThreadLocalMap.Entry e = map.getEntry(this); if (e != null) { @SuppressWarnings("unchecked") T result = (T)e.value; return result; } } //(4)執(zhí)行到此處,threadLocals為null,調(diào)用該更改初始化當(dāng)前線程的threadLocals變量 return setInitialValue(); } private T setInitialValue() { //protected T initialValue() {return null;} T value = initialValue(); //獲取當(dāng)前線程 Thread t = Thread.currentThread(); //以當(dāng)前線程作為key值,去查找對(duì)應(yīng)的線程變量,找到對(duì)應(yīng)的map ThreadLocalMap map = getMap(t); //如果map不為null,就直接添加本地變量,key為當(dāng)前線程,值為添加的本地變量值 if (map != null) map.set(this, value); //如果map為null,說(shuō)明首次添加,需要首先創(chuàng)建出對(duì)應(yīng)的map else createMap(t, value); return value; }
remove方法的實(shí)現(xiàn): remove方法判斷當(dāng)前線程對(duì)應(yīng)的 threadLocals變量是否為null,不為 null就直接刪除當(dāng)前線程中指定的 threadLocals變量。
public void remove() { //獲取當(dāng)前線程綁定的threadLocals ThreadLocalMap m = getMap(Thread.currentThread()); //如果map不為null,就移除當(dāng)前線程中指定ThreadLocal實(shí)例的本地變量 if (m != null) m.remove(this); }
如下圖所示: 每個(gè)線程內(nèi)部有一個(gè)名為 threadLocals的成員變量,該變量的類型為 ThreadLocal.ThreadLocalMap類型(類似于一個(gè)HashMap),其中的 key為當(dāng)前定義的 ThreadLocal變量的 this引用,value為我們使用 set方法設(shè)置的值。每個(gè)線程的本地變量存放在自己的本地內(nèi)存變量 threadLocals中,如果當(dāng)前線程一直不消亡,那么這些本地變量就會(huì)一直存在(可能會(huì)導(dǎo)致內(nèi)存溢出),因此使用完畢需要將其 remove掉。
四、ThreadLocal不支持繼承性
同一個(gè) ThreadLocal變量在父線程中被設(shè)置值后,在子線程中是獲取不到的。(threadLocals 中為當(dāng)前調(diào)用線程對(duì)應(yīng)的本地變量,所以二者自然是不能共享的)
package test; public class ThreadLocalTest2 { //(1)創(chuàng)建ThreadLocal變量 public static ThreadLocal<String> threadLocal = new ThreadLocal<>(); public static void main(String[] args) { //在main線程中添加main線程的本地變量 threadLocal.set("mainVal"); //新創(chuàng)建一個(gè)子線程 Thread thread = new Thread(new Runnable() { @Override public void run() { System.out.println("子線程中的本地變量值:"+threadLocal.get()); } }); thread.start(); //輸出main線程中的本地變量值 System.out.println("mainx線程中的本地變量值:"+threadLocal.get()); } }
五、InheritableThreadLocal類
在上面說(shuō)到的 ThreadLocal類是不能提供子線程訪問(wèn)父線程的本地變量的,而 InheritableThreadLocal類則可以做到這個(gè)功能,下面是該類的源碼
public class InheritableThreadLocal<T> extends ThreadLocal<T> { protected T childValue(T parentValue) { return parentValue; } ThreadLocalMap getMap(Thread t) { return t.inheritableThreadLocals; } void createMap(Thread t, T firstValue) { t.inheritableThreadLocals = new ThreadLocalMap(this, firstValue); } }
從上面代碼可以看出,InheritableThreadLocal類繼承了 ThreadLocal類,并重寫了childValue、getMap、createMap三個(gè)方法。其中 createMap方法在被調(diào)用(當(dāng)前線程調(diào)用 set方法時(shí)得到的 map為 null的時(shí)候需要調(diào)用該方法)的時(shí)候,創(chuàng)建的是inheritableThreadLocal而不是 threadLocals。同理,getMap方法在當(dāng)前調(diào)用者線程調(diào)用 get方法的時(shí)候返回的也不是threadLocals 而是 inheritableThreadLocal。下面我們看看重寫的 childValue方法在什么時(shí)候執(zhí)行,怎樣讓子線程訪問(wèn)父線程的本地變量值。我們首先從 Thread類開(kāi)始說(shuō)起
private void init(ThreadGroup g, Runnable target, String name, long stackSize) { init(g, target, name, stackSize, null, true); } private void init(ThreadGroup g, Runnable target, String name, long stackSize, AccessControlContext acc, boolean inheritThreadLocals) { //判斷名字的合法性 if (name == null) { throw new NullPointerException("name cannot be null"); } this.name = name; //(1)獲取當(dāng)前線程(父線程) Thread parent = currentThread(); //安全校驗(yàn) SecurityManager security = System.getSecurityManager(); if (g == null) { //g:當(dāng)前線程組 if (security != null) { g = security.getThreadGroup(); } if (g == null) { g = parent.getThreadGroup(); } } g.checkAccess(); if (security != null) { if (isCCLOverridden(getClass())) { security.checkPermission(SUBCLASS_IMPLEMENTATION_PERMISSION); } } g.addUnstarted(); this.group = g; //設(shè)置為當(dāng)前線程組 this.daemon = parent.isDaemon();//守護(hù)線程與否(同父線程) this.priority = parent.getPriority();//優(yōu)先級(jí)同父線程 if (security == null || isCCLOverridden(parent.getClass())) this.contextClassLoader = parent.getContextClassLoader(); else this.contextClassLoader = parent.contextClassLoader; this.inheritedAccessControlContext = acc != null ? acc : AccessController.getContext(); this.target = target; setPriority(priority); //(2)如果父線程的inheritableThreadLocal不為null if (inheritThreadLocals && parent.inheritableThreadLocals != null) //(3)設(shè)置子線程中的inheritableThreadLocals為父線程的inheritableThreadLocals this.inheritableThreadLocals = ThreadLocal.createInheritedMap(parent.inheritableThreadLocals); this.stackSize = stackSize; tid = nextThreadID(); }
在 init方法中,首先(1)處獲取了當(dāng)前線程(父線程),然后(2)處判斷當(dāng)前父線程的 inheritableThreadLocals是否為null,然后調(diào)用createInheritedMap將父線程的 inheritableThreadLocals作為構(gòu)造函數(shù)參數(shù)創(chuàng)建了一個(gè)新的 ThreadLocalMap變量,然后賦值給子線程。下面是 createInheritedMap方法和 ThreadLocalMap的構(gòu)造方法
static ThreadLocalMap createInheritedMap(ThreadLocalMap parentMap) { return new ThreadLocalMap(parentMap); } private ThreadLocalMap(ThreadLocalMap parentMap) { Entry[] parentTable = parentMap.table; int len = parentTable.length; setThreshold(len); table = new Entry[len]; for (int j = 0; j < len; j++) { Entry e = parentTable[j]; if (e != null) { @SuppressWarnings("unchecked") ThreadLocal<Object> key = (ThreadLocal<Object>) e.get(); if (key != null) { //調(diào)用重寫的方法 Object value = key.childValue(e.value); Entry c = new Entry(key, value); int h = key.threadLocalHashCode & (len - 1); while (table[h] != null) h = nextIndex(h, len); table[h] = c; size++; } } } }
在構(gòu)造函數(shù)中將父線程的 inheritableThreadLocals成員變量的值賦值到新的 ThreadLocalMap對(duì)象中。返回之后賦值給子線程的inheritableThreadLocals。總之,InheritableThreadLocals類通過(guò)重寫getMap和createMap兩個(gè)方法將本地變量保存到了具體線程的inheritableThreadLocals變量中,當(dāng)線程通過(guò)InheritableThreadLocals實(shí)例的set或者get方法設(shè)置變量的時(shí)候,就會(huì)創(chuàng)建當(dāng)前線程的inheritableThreadLocals變量。而父線程創(chuàng)建子線程的時(shí)候,ThreadLocalMap中的構(gòu)造函數(shù)會(huì)將父線程的inheritableThreadLocals中的變量復(fù)制一份到子線程的inheritableThreadLocals變量中。
六、從ThreadLocalMap看ThreadLocal使用不當(dāng)?shù)膬?nèi)存泄漏問(wèn)題
基礎(chǔ)概念 : 首先我們先看看 ThreadLocalMap的類圖,在前面的介紹中,我們知道 ThreadLocal只是一個(gè)工具類,他為用戶提供get、set、remove接口操作實(shí)際存放本地變量的 threadLocals(調(diào)用線程的成員變量),也知道 threadLocals是一個(gè)ThreadLocalMap類型的變量,下面我們來(lái)看看 ThreadLocalMap這個(gè)類。在此之前,我們回憶一下 Java中的四種引用類型鏈接
分析 ThreadLocalMap內(nèi)部實(shí)現(xiàn): 上面我們知道 ThreadLocalMap內(nèi)部實(shí)際上是一個(gè) Entry數(shù)組 private Entry[] table ?,我們先看看 Entry的這個(gè)內(nèi)部類
/** * 是繼承自WeakReference的一個(gè)類,該類中實(shí)際存放的key是指向ThreadLocal的弱引用和與之對(duì)應(yīng)的value值(該value值 * 就是通過(guò)ThreadLocal的set方法傳遞過(guò)來(lái)的值)由于是弱引用,當(dāng)get方法返回null的時(shí)候意味著回收引用 */ static class Entry extends WeakReference<ThreadLocal<?>> { /** value就是和ThreadLocal綁定的 */ Object value; //k:ThreadLocal的引用,被傳遞給WeakReference的構(gòu)造方法 Entry(ThreadLocal<?> k, Object v) { super(k); value = v; } } //WeakReference構(gòu)造方法(public class WeakReference<T> extends Reference<T> ) public WeakReference(T referent) { super(referent); //referent:ThreadLocal的引用 } //Reference構(gòu)造方法 Reference(T referent) { this(referent, null);//referent:ThreadLocal的引用 } Reference(T referent, ReferenceQueue<? super T> queue) { this.referent = referent; this.queue = (queue == null) ? ReferenceQueue.NULL : queue; }
在上面的代碼中,我們可以看出,當(dāng)前 ThreadLocal的引用 k被傳遞給 WeakReference的構(gòu)造函數(shù),所以 ThreadLocalMap中的key為 ThreadLocal的弱引用。當(dāng)一個(gè)線程調(diào)用ThreadLocal的 set方法設(shè)置變量的時(shí)候,當(dāng)前線程的 ThreadLocalMap就會(huì)存放一個(gè)記錄,這個(gè)記錄的 key值為 ThreadLocal的弱引用,value就是通過(guò) set設(shè)置的值。如果當(dāng)前線程一直存在且沒(méi)有調(diào)用該ThreadLocal的 remove方法,如果這個(gè)時(shí)候別的地方還有對(duì) ThreadLocal的引用,那么當(dāng)前線程中的 ThreadLocalMap中會(huì)存在對(duì)ThreadLocal變量的引用和 value對(duì)象的引用,是不會(huì)釋放的,就會(huì)造成內(nèi)存泄漏。
考慮這個(gè) ThreadLocal變量沒(méi)有其他強(qiáng)依賴,如果當(dāng)前線程還存在,由于線程的 ThreadLocalMap里面的 key是弱引用,所以當(dāng)前線程的 ThreadLocalMap里面的 ThreadLocal變量的弱引用在 gc的時(shí)候就被回收,但是對(duì)應(yīng)的 value還是存在的這就可能造成內(nèi)存泄漏(因?yàn)檫@個(gè)時(shí)候 ThreadLocalMap會(huì)存在key為 null但是 value不為 null的 entry項(xiàng) )。
ThreadLocalMap 中的 Entry的 key使用的是 ThreadLocal對(duì)象的弱引用,在沒(méi)有其他地方對(duì) ThreadLoca依賴,ThreadLocalMap中的 ThreadLocal對(duì)象就會(huì)被回收掉,但是對(duì)應(yīng)的 value不會(huì)被回收,這個(gè)時(shí)候 Map中就可能存在 key為null但是 value不為null的項(xiàng),這需要實(shí)際使用的時(shí)候使用完畢及時(shí)調(diào)用 remove方法避免內(nèi)存泄漏。
如果使用線程池,由于線程可能并不是真正的關(guān)閉(比如newFixedThreadPool會(huì)保持線程一只存活)。因此,如果將一些大對(duì)象存放到 ThreadLocalMap中,可能會(huì)造成內(nèi)存泄漏。因?yàn)榫€程沒(méi)有關(guān)閉,無(wú)法回收,但是這些對(duì)象不會(huì)再被使用了。如果希望及時(shí)回收對(duì)象,則可以使用Thread.remove()方法將變量移除。
以上就是Java中關(guān)于ThreadLocal的隱式引用詳解的詳細(xì)內(nèi)容,更多關(guān)于Java ThreadLocal的資料請(qǐng)關(guān)注腳本之家其它相關(guān)文章!
相關(guān)文章
Spring Boot修改內(nèi)置Tomcat默認(rèn)端口號(hào)的示例
本篇文章主要介紹了Spring Boot修改內(nèi)置Tomcat端口號(hào)的示例,具有一定的參考價(jià)值,感興趣的小伙伴們可以參考一下2017-08-08Java 策略模式與模板方法模式相關(guān)總結(jié)
這篇文章主要介紹了Java 策略模式與模板方法模式相關(guān)總結(jié),幫助大家更好的理解和使用Java,感興趣的朋友可以了解下2021-01-01