Java中的ThreadLocal詳解
一、ThreadLocal簡介
多線程訪問同一個(gè)共享變量的時(shí)候容易出現(xiàn)并發(fā)問題,特別是多個(gè)線程對一個(gè)變量進(jìn)行寫入的時(shí)候,為了保證線程安全,一般使用者在訪問共享變量的時(shí)候需要進(jìn)行額外的同步措施才能保證線程安全性。ThreadLocal是除了加鎖這種同步方式之外的一種保證一種規(guī)避多線程訪問出現(xiàn)線程不安全的方法,當(dāng)我們在創(chuàng)建一個(gè)變量后,如果每個(gè)線程對其進(jìn)行訪問的時(shí)候訪問的都是線程自己的變量這樣就不會(huì)存在線程不安全問題。
ThreadLocal
是JDK包提供的,它提供線程本地變量,如果創(chuàng)建一樂ThreadLocal
變量,那么訪問這個(gè)變量的每個(gè)線程都會(huì)有這個(gè)變量的一個(gè)副本,在實(shí)際多線程操作的時(shí)候,操作的是自己本地內(nèi)存中的變量,從而規(guī)避了線程安全問題,如下圖所示
二、ThreadLocal簡單使用
下面的例子中,開啟兩個(gè)線程,在每個(gè)線程內(nèi)部設(shè)置了本地變量的值,然后調(diào)用print
方法打印當(dāng)前本地變量的值。如果在打印之后調(diào)用本地變量的remove
方法會(huì)刪除本地內(nèi)存中的變量,代碼如下所示
1 package test; 2 3 public class ThreadLocalTest { 4 5 static ThreadLocal<String> localVar = new ThreadLocal<>(); 6 7 static void print(String str) { 8 //打印當(dāng)前線程中本地內(nèi)存中本地變量的值 9 System.out.println(str + " :" + localVar.get()); 10 //清除本地內(nèi)存中的本地變量 11 localVar.remove(); 12 } 13 14 public static void main(String[] args) { 15 Thread t1 = new Thread(new Runnable() { 16 @Override 17 public void run() { 18 //設(shè)置線程1中本地變量的值 19 localVar.set("localVar1"); 20 //調(diào)用打印方法 21 print("thread1"); 22 //打印本地變量 23 System.out.println("after remove : " + localVar.get()); 24 } 25 }); 26 27 Thread t2 = new Thread(new Runnable() { 28 @Override 29 public void run() { 30 //設(shè)置線程1中本地變量的值 31 localVar.set("localVar2"); 32 //調(diào)用打印方法 33 print("thread2"); 34 //打印本地變量 35 System.out.println("after remove : " + localVar.get()); 36 } 37 }); 38 39 t1.start(); 40 t2.start(); 41 } 42 }
下面是運(yùn)行后的結(jié)果:
三、ThreadLocal的實(shí)現(xiàn)原理
下面是ThreadLocal
的類圖結(jié)構(gòu)
從圖中可知:Thread類中有兩個(gè)變量threadLocals
和inheritableThreadLocals
,二者都是ThreadLocal
內(nèi)部類ThreadLocalMap類型的變量,我們通過查看內(nèi)部內(nèi)ThreadLocalMap
可以發(fā)現(xiàn)實(shí)際上它類似于一個(gè)HashMap。在默認(rèn)情況下,每個(gè)線程中的這兩個(gè)變量都為null,只有當(dāng)線程第一次調(diào)用ThreadLocal的set或者get方法的時(shí)候才會(huì)創(chuàng)建他們(后面我們會(huì)查看這兩個(gè)方法的源碼)。除此之外,和我所想的不同的是,每個(gè)線程的本地變量不是存放在ThreadLocal
實(shí)例中,而是放在調(diào)用線程的ThreadLocals
變量里面(前面也說過,該變量是Thread類的變量)。也就是說,ThreadLocal類型的本地變量是存放在具體的線程空間上,其本身相當(dāng)于一個(gè)裝載本地變量的工具殼,通過set方法將value添加到調(diào)用線程的threadLocals
中,當(dāng)調(diào)用線程調(diào)用get方法時(shí)候能夠從它的threadLocals
中取出變量。如果調(diào)用線程一直不終止,那么這個(gè)本地變量將會(huì)一直存放在他的threadLocals
中,所以不使用本地變量的時(shí)候需要調(diào)用remove方法將threadLocals
中刪除不用的本地變量。下面我們通過查看ThreadLocal
的set、get以及remove方法來查看ThreadLocal
具體實(shí)怎樣工作的
1、set方法源碼
1 public void set(T value) { 2 //(1)獲取當(dāng)前線程(調(diào)用者線程) 3 Thread t = Thread.currentThread(); 4 //(2)以當(dāng)前線程作為key值,去查找對應(yīng)的線程變量,找到對應(yīng)的map 5 ThreadLocalMap map = getMap(t); 6 //(3)如果map不為null,就直接添加本地變量,key為當(dāng)前定義的ThreadLocal變量的this引用,值為添加的本地變量值 7 if (map != null) 8 map.set(this, value); 9 //(4)如果map為null,說明首次添加,需要首先創(chuàng)建出對應(yīng)的map 10 else 11 createMap(t, value); 12 }
在上面的代碼中,(2)處調(diào)用getMap
方法獲得當(dāng)前線程對應(yīng)的threadLocals
(參照上面的圖示和文字說明),該方法代碼如下
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說明是第一次調(diào)用set方法(前面說到過,threadLocals
默認(rèn)值為null
,只有調(diào)用set方法的時(shí)候才會(huì)創(chuàng)建map),這個(gè)時(shí)候就需要調(diào)用createMap
方法創(chuàng)建threadLocals,該方法如下所示
1 void createMap(Thread t, T firstValue) { 2 t.threadLocals = new ThreadLocalMap(this, firstValue); 3 }
createMap
方法不僅創(chuàng)建了threadLocals,同時(shí)也將要添加的本地變量值添加到了threadLocals
中。
2、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。
1 public T get() { 2 //(1)獲取當(dāng)前線程 3 Thread t = Thread.currentThread(); 4 //(2)獲取當(dāng)前線程的threadLocals變量 5 ThreadLocalMap map = getMap(t); 6 //(3)如果threadLocals變量不為null,就可以在map中查找到本地變量的值 7 if (map != null) { 8 ThreadLocalMap.Entry e = map.getEntry(this); 9 if (e != null) { 10 @SuppressWarnings("unchecked") 11 T result = (T)e.value; 12 return result; 13 } 14 } 15 //(4)執(zhí)行到此處,threadLocals為null,調(diào)用該更改初始化當(dāng)前線程的threadLocals變量 16 return setInitialValue(); 17 } 18 19 private T setInitialValue() { 20 //protected T initialValue() {return null;} 21 T value = initialValue(); 22 //獲取當(dāng)前線程 23 Thread t = Thread.currentThread(); 24 //以當(dāng)前線程作為key值,去查找對應(yīng)的線程變量,找到對應(yīng)的map 25 ThreadLocalMap map = getMap(t); 26 //如果map不為null,就直接添加本地變量,key為當(dāng)前線程,值為添加的本地變量值 27 if (map != null) 28 map.set(this, value); 29 //如果map為null,說明首次添加,需要首先創(chuàng)建出對應(yīng)的map 30 else 31 createMap(t, value); 32 return value; 33 }
3、remove方法的實(shí)現(xiàn)
remove
方法判斷該當(dāng)前線程對應(yīng)的threadLocals
變量是否為null,不為null就直接刪除當(dāng)前線程中指定的threadLocals
變量
1 public void remove() { 2 //獲取當(dāng)前線程綁定的threadLocals 3 ThreadLocalMap m = getMap(Thread.currentThread()); 4 //如果map不為null,就移除當(dāng)前線程中指定ThreadLocal實(shí)例的本地變量 5 if (m != null) 6 m.remove(this); 7 }
如下圖所示:每個(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)用線程對應(yīng)的本地變量,所以二者自然是不能共享的)
1 package test; 2 3 public class ThreadLocalTest2 { 4 5 //(1)創(chuàng)建ThreadLocal變量 6 public static ThreadLocal<String> threadLocal = new ThreadLocal<>(); 7 8 public static void main(String[] args) { 9 //在main線程中添加main線程的本地變量 10 threadLocal.set("mainVal"); 11 //新創(chuàng)建一個(gè)子線程 12 Thread thread = new Thread(new Runnable() { 13 @Override 14 public void run() { 15 System.out.println("子線程中的本地變量值:"+threadLocal.get()); 16 } 17 }); 18 thread.start(); 19 //輸出main線程中的本地變量值 20 System.out.println("mainx線程中的本地變量值:"+threadLocal.get()); 21 } 22 }
五、InheritableThreadLocal類
在上面說到的ThreadLocal
類是不能提供子線程訪問父線程的本地變量的,而InheritableThreadLocal
類則可以做到這個(gè)功能,下面是該類的源碼
1 public class InheritableThreadLocal<T> extends ThreadLocal<T> { 2 3 protected T childValue(T parentValue) { 4 return parentValue; 5 } 6 7 ThreadLocalMap getMap(Thread t) { 8 return t.inheritableThreadLocals; 9 } 10 11 void createMap(Thread t, T firstValue) { 12 t.inheritableThreadLocals = new ThreadLocalMap(this, firstValue); 13 } 14 }
從上面代碼可以看出,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í)行,怎樣讓子線程訪問父線程的本地變量值。我們首先從Thread
類開始說起
1 private void init(ThreadGroup g, Runnable target, String name, 2 long stackSize) { 3 init(g, target, name, stackSize, null, true); 4 } 5 private void init(ThreadGroup g, Runnable target, String name, 6 long stackSize, AccessControlContext acc, 7 boolean inheritThreadLocals) { 8 //判斷名字的合法性 9 if (name == null) { 10 throw new NullPointerException("name cannot be null"); 11 } 12 13 this.name = name; 14 //(1)獲取當(dāng)前線程(父線程) 15 Thread parent = currentThread(); 16 //安全校驗(yàn) 17 SecurityManager security = System.getSecurityManager(); 18 if (g == null) { //g:當(dāng)前線程組 19 if (security != null) { 20 g = security.getThreadGroup(); 21 } 22 if (g == null) { 23 g = parent.getThreadGroup(); 24 } 25 } 26 g.checkAccess(); 27 if (security != null) { 28 if (isCCLOverridden(getClass())) { 29 security.checkPermission(SUBCLASS_IMPLEMENTATION_PERMISSION); 30 } 31 } 32 33 g.addUnstarted(); 34 35 this.group = g; //設(shè)置為當(dāng)前線程組 36 this.daemon = parent.isDaemon();//守護(hù)線程與否(同父線程) 37 this.priority = parent.getPriority();//優(yōu)先級(jí)同父線程 38 if (security == null || isCCLOverridden(parent.getClass())) 39 this.contextClassLoader = parent.getContextClassLoader(); 40 else 41 this.contextClassLoader = parent.contextClassLoader; 42 this.inheritedAccessControlContext = 43 acc != null ? acc : AccessController.getContext(); 44 this.target = target; 45 setPriority(priority); 46 //(2)如果父線程的inheritableThreadLocal不為null 47 if (inheritThreadLocals && parent.inheritableThreadLocals != null) 48 //(3)設(shè)置子線程中的inheritableThreadLocals為父線程的inheritableThreadLocals 49 this.inheritableThreadLocals = 50 ThreadLocal.createInheritedMap(parent.inheritableThreadLocals); 51 this.stackSize = stackSize; 52 53 tid = nextThreadID(); 54 }
在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)造方法
1 static ThreadLocalMap createInheritedMap(ThreadLocalMap parentMap) { 2 return new ThreadLocalMap(parentMap); 3 } 4 5 private ThreadLocalMap(ThreadLocalMap parentMap) { 6 Entry[] parentTable = parentMap.table; 7 int len = parentTable.length; 8 setThreshold(len); 9 table = new Entry[len]; 10 11 for (int j = 0; j < len; j++) { 12 Entry e = parentTable[j]; 13 if (e != null) { 14 @SuppressWarnings("unchecked") 15 ThreadLocal<Object> key = (ThreadLocal<Object>) e.get(); 16 if (key != null) { 17 //調(diào)用重寫的方法 18 Object value = key.childValue(e.value); 19 Entry c = new Entry(key, value); 20 int h = key.threadLocalHashCode & (len - 1); 21 while (table[h] != null) 22 h = nextIndex(h, len); 23 table[h] = c; 24 size++; 25 } 26 } 27 } 28 }
在構(gòu)造函數(shù)中將父線程的inheritableThreadLocals
成員變量的值賦值到新的ThreadLocalMap
對象中。返回之后賦值給子線程的inheritableThreadLocals
??傊?code>InheritableThreadLocals類通過重寫getMap和createMap兩個(gè)方法將本地變量保存到了具體線程的inheritableThreadLocals
變量中,當(dāng)線程通過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)存泄漏問題
1、基礎(chǔ)概念
首先我們先看看ThreadLocalMap
的類圖,在前面的介紹中,我們知道ThreadLocal
只是一個(gè)工具類,他為用戶提供get、set、remove接口操作實(shí)際存放本地變量的threadLocals
(調(diào)用線程的成員變量),也知道threadLocals是一個(gè)ThreadLocalMap
類型的變量,下面我們來看看ThreadLocalMap
這個(gè)類。在此之前,我們回憶一下Java中的四種引用類型,相關(guān)GC只是參考前面系列的文章(JVM相關(guān))
①強(qiáng)引用:Java中默認(rèn)的引用類型,一個(gè)對象如果具有強(qiáng)引用那么只要這種引用還存在就不會(huì)被GC。
②軟引用:簡言之,如果一個(gè)對象具有弱引用,在JVM發(fā)生OOM之前(即內(nèi)存充足夠使用),是不會(huì)GC這個(gè)對象的;只有到JVM內(nèi)存不足的時(shí)候才會(huì)GC掉這個(gè)對象。軟引用和一個(gè)引用隊(duì)列聯(lián)合使用,如果軟引用所引用的對象被回收之后,該引用就會(huì)加入到與之關(guān)聯(lián)的引用隊(duì)列中
③弱引用(這里討論ThreadLocalMap中的Entry類的重點(diǎn)):如果一個(gè)對象只具有弱引用,那么這個(gè)對象就會(huì)被垃圾回收器GC掉(被弱引用所引用的對象只能生存到下一次GC之前,當(dāng)發(fā)生GC時(shí)候,無論當(dāng)前內(nèi)存是否足夠,弱引用所引用的對象都會(huì)被回收掉)。弱引用也是和一個(gè)引用隊(duì)列聯(lián)合使用,如果弱引用的對象被垃圾回收期回收掉,JVM會(huì)將這個(gè)引用加入到與之關(guān)聯(lián)的引用隊(duì)列中。若引用的對象可以通過弱引用的get方法得到,當(dāng)引用的對象唄回收掉之后,再調(diào)用get方法就會(huì)返回null
④虛引用:虛引用是所有引用中最弱的一種引用,其存在就是為了將關(guān)聯(lián)虛引用的對象在被GC掉之后收到一個(gè)通知。(不能通過get方法獲得其指向的對象)
2、分析ThreadLocalMap內(nèi)部實(shí)現(xiàn)
上面我們知道ThreadLocalMap
內(nèi)部實(shí)際上是一個(gè)Entry數(shù)組,我們先看看Entry的這個(gè)內(nèi)部類
1 /** 2 * 是繼承自WeakReference的一個(gè)類,該類中實(shí)際存放的key是 3 * 指向ThreadLocal的弱引用和與之對應(yīng)的value值(該value值 4 * 就是通過ThreadLocal的set方法傳遞過來的值) 5 * 由于是弱引用,當(dāng)get方法返回null的時(shí)候意味著坑能引用 6 */ 7 static class Entry extends WeakReference<ThreadLocal<?>> { 8 /** value就是和ThreadLocal綁定的 */ 9 Object value; 10 11 //k:ThreadLocal的引用,被傳遞給WeakReference的構(gòu)造方法 12 Entry(ThreadLocal<?> k, Object v) { 13 super(k); 14 value = v; 15 } 16 } 17 //WeakReference構(gòu)造方法(public class WeakReference<T> extends Reference<T> ) 18 public WeakReference(T referent) { 19 super(referent); //referent:ThreadLocal的引用 20 } 21 22 //Reference構(gòu)造方法 23 Reference(T referent) { 24 this(referent, null);//referent:ThreadLocal的引用 25 } 26 27 Reference(T referent, ReferenceQueue<? super T> queue) { 28 this.referent = referent; 29 this.queue = (queue == null) ? ReferenceQueue.NULL : queue; 30 }
在上面的代碼中,我們可以看出,當(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就是通過set設(shè)置的值。如果當(dāng)前線程一直存在且沒有調(diào)用該ThreadLocal
的remove方法,如果這個(gè)時(shí)候別的地方還有對ThreadLocal
的引用,那么當(dāng)前線程中的ThreadLocalMap中會(huì)存在對ThreadLocal變量的引用和value對象的引用,是不會(huì)釋放的,就會(huì)造成內(nèi)存泄漏。
考慮這個(gè)ThreadLocal
變量沒有其他強(qiáng)依賴,如果當(dāng)前線程還存在,由于線程的ThreadLocalMap
里面的key是弱引用,所以當(dāng)前線程的ThreadLocalMap里面的ThreadLocal
變量的弱引用在gc的時(shí)候就被回收,但是對應(yīng)的value還是存在的這就可能造成內(nèi)存泄漏(因?yàn)檫@個(gè)時(shí)候ThreadLocalMap會(huì)存在key為null但是value不為null的entry項(xiàng))。
THreadLocalMap
中的Entry的key使用的是ThreadLocal對象的弱引用,在沒有其他地方對ThreadLoca依賴,ThreadLocalMap中的ThreadLocal
對象就會(huì)被回收掉,但是對應(yīng)的不會(huì)被回收,這個(gè)時(shí)候Map中就可能存在key為null但是value不為null的項(xiàng),這需要實(shí)際的時(shí)候使用完畢及時(shí)調(diào)用remove方法避免內(nèi)存泄漏。
到此這篇關(guān)于Java中的ThreadLocal詳解的文章就介紹到這了,更多相關(guān)Java中的ThreadLocal內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
相關(guān)文章
使用java反射將結(jié)果集封裝成為對象和對象集合操作
這篇文章主要介紹了使用java反射將結(jié)果集封裝成為對象和對象集合操作,具有很好的參考價(jià)值,希望對大家有所幫助。一起跟隨小編過來看看吧2020-08-08Springboot如何配置yml文件與映射到j(luò)ava類
這篇文章主要介紹了Springboot如何配置yml文件與映射到j(luò)ava類問題,具有很好的參考價(jià)值,希望對大家有所幫助,如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2023-09-09Java多線程Callable接口實(shí)現(xiàn)代碼示例
相信大家對Java編程中如何創(chuàng)建線程已經(jīng)不陌生了,這篇文章就向朋友們介紹實(shí)現(xiàn)callable接口,具體實(shí)例詳見正文。2017-10-10SpringBoot配置多個(gè)數(shù)據(jù)源超簡單步驟(連接多個(gè)數(shù)據(jù)庫)
公司項(xiàng)目有連接多個(gè)不同數(shù)據(jù)庫的需求,特研究了一下,根據(jù)網(wǎng)上的資料,這篇文章主要給大家介紹了關(guān)于SpringBoot配置多個(gè)數(shù)據(jù)源(連接多個(gè)數(shù)據(jù)庫)的相關(guān)資料,需要的朋友可以參考下2024-05-05詳解Java TCC分布式事務(wù)實(shí)現(xiàn)原理
這篇文章主要介紹了詳解Java TCC分布式事務(wù)實(shí)現(xiàn)原理,對分布式事務(wù)感興趣的同學(xué),一定要看一下2021-04-04