Java ThreadLocal的詳細(xì)解釋
一、ThreadLocal簡(jiǎn)介
多線程訪問同一個(gè)共享變量的時(shí)候容易出現(xiàn)并發(fā)問題,特別是多個(gè)線程對(duì)一個(gè)變量進(jìn)行寫入的時(shí)候,為了保證線程安全,一般使用者在訪問共享變量的時(shí)候需要進(jìn)行額外的同步措施才能保證線程安全性。ThreadLocal是除了加鎖這種同步方式之外的一種保證一種規(guī)避多線程訪問出現(xiàn)線程不安全的方法,當(dāng)我們?cè)趧?chuàng)建一個(gè)變量后,如果每個(gè)線程對(duì)其進(jìn)行訪問的時(shí)候訪問的都是線程自己的變量這樣就不會(huì)存在線程不安全問題。
ThreadLocal是JDK包提供的,它提供線程本地變量,如果創(chuàng)建一樂ThreadLocal變量,那么訪問這個(gè)變量的每個(gè)線程都會(huì)有這個(gè)變量的一個(gè)副本,在實(shí)際多線程操作的時(shí)候,操作的是自己本地內(nèi)存中的變量,從而規(guī)避了線程安全問題,如下圖所示

二、ThreadLocal簡(jiǎn)單使用
下面的例子中,開啟兩個(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é)果:

三、ThreadLocal的實(shí)現(xiàn)原理
下面是ThreadLocal的類圖結(jié)構(gòu),從圖中可知:Thread類中有兩個(gè)變量threadLocals和inheritableThreadLocals,二者都是ThreadLocal內(nèi)部類ThreadLocalMap類型的變量,我們通過查看內(nèi)部?jī)?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方法源碼
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)前定義的ThreadLocal變量的this引用,值為添加的本地變量值
if (map != null)
map.set(this, value);
//(4)如果map為null,說明首次添加,需要首先創(chuàng)建出對(duì)應(yīng)的map
else
createMap(t, value);
}
在上面的代碼中,(2)處調(diào)用getMap方法獲得當(dāng)前線程對(duì)應(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,該方法如下所示
void createMap(Thread t, T firstValue) {
t.threadLocals = new ThreadLocalMap(this, firstValue);
}
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。
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,說明首次添加,需要首先創(chuàng)建出對(duì)應(yīng)的map
else
createMap(t, value);
return value;
}
3、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);
}
4、如下圖所示:
每個(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類
在上面說到的ThreadLocal類是不能提供子線程訪問父線程的本地變量的,而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í)行,怎樣讓子線程訪問父線程的本地變量值。我們首先從Thread類開始說起
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類通過重寫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))
①?gòu)?qiáng)引用:Java中默認(rèn)的引用類型,一個(gè)對(duì)象如果具有強(qiáng)引用那么只要這種引用還存在就不會(huì)被GC。
②軟引用:簡(jiǎn)言之,如果一個(gè)對(duì)象具有弱引用,在JVM發(fā)生OOM之前(即內(nèi)存充足夠使用),是不會(huì)GC這個(gè)對(duì)象的;只有到JVM內(nèi)存不足的時(shí)候才會(huì)GC掉這個(gè)對(duì)象。軟引用和一個(gè)引用隊(duì)列聯(lián)合使用,如果軟引用所引用的對(duì)象被回收之后,該引用就會(huì)加入到與之關(guān)聯(lián)的引用隊(duì)列中
③弱引用(這里討論ThreadLocalMap中的Entry類的重點(diǎn)):如果一個(gè)對(duì)象只具有弱引用,那么這個(gè)對(duì)象就會(huì)被垃圾回收器GC掉(被弱引用所引用的對(duì)象只能生存到下一次GC之前,當(dāng)發(fā)生GC時(shí)候,無論當(dāng)前內(nèi)存是否足夠,弱引用所引用的對(duì)象都會(huì)被回收掉)。弱引用也是和一個(gè)引用隊(duì)列聯(lián)合使用,如果弱引用的對(duì)象被垃圾回收期回收掉,JVM會(huì)將這個(gè)引用加入到與之關(guān)聯(lián)的引用隊(duì)列中。若引用的對(duì)象可以通過弱引用的get方法得到,當(dāng)引用的對(duì)象唄回收掉之后,再調(diào)用get方法就會(huì)返回null
④虛引用:虛引用是所有引用中最弱的一種引用,其存在就是為了將關(guān)聯(lián)虛引用的對(duì)象在被GC掉之后收到一個(gè)通知。(不能通過get方法獲得其指向的對(duì)象)

2、分析ThreadLocalMap內(nèi)部實(shí)現(xiàn)
上面我們知道ThreadLocalMap內(nèi)部實(shí)際上是一個(gè)Entry數(shù)組
,我們先看看Entry的這個(gè)內(nèi)部類
/**
* 是繼承自WeakReference的一個(gè)類,該類中實(shí)際存放的key是
* 指向ThreadLocal的弱引用和與之對(duì)應(yīng)的value值(該value值
* 就是通過ThreadLocal的set方法傳遞過來的值)
* 由于是弱引用,當(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就是通過set設(shè)置的值。如果當(dāng)前線程一直存在且沒有調(diào)用該ThreadLocal的remove方法,如果這個(gè)時(shí)候別的地方還有對(duì)ThreadLocal的引用,那么當(dāng)前線程中的ThreadLocalMap中會(huì)存在對(duì)ThreadLocal變量的引用和value對(duì)象的引用,是不會(huì)釋放的,就會(huì)造成內(nèi)存泄漏。
考慮這個(gè)ThreadLocal變量沒有其他強(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))。
總結(jié):
THreadLocalMap中的Entry的key使用的是ThreadLocal對(duì)象的弱引用,在沒有其他地方對(duì)ThreadLoca依賴,ThreadLocalMap中的ThreadLocal對(duì)象就會(huì)被回收掉,但是對(duì)應(yīng)的不會(huì)被回收,這個(gè)時(shí)候Map中就可能存在key為null但是value不為null的項(xiàng),這需要實(shí)際的時(shí)候使用完畢及時(shí)調(diào)用remove方法避免內(nèi)存泄漏。
本篇文章就到這里了,希望能夠給你帶來幫助,也希望您能夠多多關(guān)注腳本之家的更多內(nèi)容!
相關(guān)文章
Springmvc如何實(shí)現(xiàn)向前臺(tái)傳遞數(shù)據(jù)
這篇文章主要介紹了Springmvc如何實(shí)現(xiàn)向前臺(tái)傳遞數(shù)據(jù),文中通過示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友可以參考下2020-07-07
java中sleep方法和wait方法的五個(gè)區(qū)別
這篇文章主要介紹了java中sleep方法和wait方法的五個(gè)區(qū)別,sleep?方法和?wait?方法都是用來將線程進(jìn)入休眠狀態(tài),但是又有一些區(qū)別,下面我們就一起來看看吧2022-05-05
Java連接Sql數(shù)據(jù)庫(kù)經(jīng)常用到的操作
這篇文章主要介紹了Java連接Sql數(shù)據(jù)庫(kù)經(jīng)常用到的操作的相關(guān)資料,需要的朋友可以參考下2016-02-02
Java中String的JdbcTemplate連接SQLServer數(shù)據(jù)庫(kù)的方法
這篇文章主要介紹了Java中String的JdbcTemplate連接SQLServer數(shù)據(jù)庫(kù)的方法,在研發(fā)過程中我們需要與其他系統(tǒng)對(duì)接的場(chǎng)景,連接SQLServer拉取數(shù)據(jù),所以就用jdbc連接數(shù)據(jù)庫(kù)的方式連接外部數(shù)據(jù)源,需要的朋友可以參考下2021-10-10
詳解如何將JAVA程序制作成可以直接執(zhí)行的exe文件
這篇文章主要介紹了詳解如何將JAVA程序制作成可以直接執(zhí)行的exe文件,文中通過示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2020-09-09
淺談什么是SpringBoot異常處理自動(dòng)配置的原理
今天給大家?guī)淼氖顷P(guān)于Java的相關(guān)知識(shí),文章圍繞著SpringBoot異常處理自動(dòng)配置展開,文中有非常詳細(xì)的介紹及代碼示例,需要的朋友可以參考下2021-06-06
我總結(jié)的幾種@Transactional失效原因說明
這篇文章主要是我總結(jié)的幾種@Transactional失效原因說明,具有很好的參考價(jià)值,希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2022-11-11

