ThreadLocal是JDK包提供的莺琳，它提供線程本地變量还棱，如果創(chuàng)建一樂(lè)ThreadLocal變量，那么訪問(wèn)這個(gè)變量的每個(gè)線程都會(huì)有這個(gè)變量的一個(gè)副本惭等，在實(shí)際多線程操作的時(shí)候珍手，操作的是自己本地內(nèi)存中的變量，從而規(guī)避了線程安全問(wè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();
}
}
thread1 :localVar1
after remove : null
thread2 :localVar2
after remove : null
Threadlocal類(lèi)圖：
Thread類(lèi)中有兩個(gè)變量threadLocals和inheritableThreadLocals焙蹭，二者都是ThreadLocal內(nèi)部類(lèi)ThreadLocalMap類(lèi)型的變量，我們通過(guò)查看內(nèi)部?jī)?nèi)ThreadLocalMap可以發(fā)現(xiàn)實(shí)際上它類(lèi)似于一個(gè)HashMap嫂伞。
在默認(rèn)情況下孔厉，每個(gè)線程中的這兩個(gè)變量都為null
，只有當(dāng)線程第一次調(diào)用ThreadLocal的set或者get方法的時(shí)候才會(huì)創(chuàng)建他們帖努。
每個(gè)線程的本地變量不是存放在ThreadLocal實(shí)例中撰豺，而是放在調(diào)用線程的ThreadLocals變量里面（前面也說(shuō)過(guò)，該變量是Thread類(lèi)的變量）拼余。
也就是說(shuō)污桦，ThreadLocal類(lèi)型的本地變量是存放在具體的線程空間上，其本身相當(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中刪除不用的本地變量顾稀。
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);
}
ThreadLocalMap getMap(Thread t) {
return t.threadLocals; //獲取線程自己的變量threadLocals击儡，并綁定到當(dāng)前調(diào)用線程的成員變量threadLocals上
}
void createMap(Thread t, T firstValue) {
t.threadLocals = new ThreadLocalMap(this, firstValue);
}
如果調(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中吊洼。
get方法源碼
在get方法的實(shí)現(xiàn)中训貌，首先獲取當(dāng)前調(diào)用者線程，如果當(dāng)前線程的threadLocals不為null冒窍，就直接返回當(dāng)前線程綁定的本地變量值递沪，否則執(zhí)行setInitialValue方法初始化threadLocals變量。
在setInitialValue方法中综液，類(lèi)似于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的成員變量共郭，該變量的類(lèi)型為T(mén)hreadLocal.ThreadLocalMap類(lèi)型（類(lèi)似于一個(gè)HashMap）祠丝，其中的key為當(dāng)前定義的ThreadLocal變量的this引用，value為我們使用set方法設(shè)置的值除嘹。每個(gè)線程的本地變量存放在自己的本地內(nèi)存變量threadLocals中写半，如果當(dāng)前線程一直不消亡，那么這些本地變量就會(huì)一直存在（所以可能會(huì)導(dǎo)致內(nèi)存溢出）尉咕，因此使用完畢需要將其remove掉叠蝇。
2 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());
}
}
3 InheritableThreadLocal類(lèi)
在上面說(shuō)到的ThreadLocal類(lèi)是不能提供子線程訪問(wèn)父線程的本地變量的，而InheritableThreadLocal類(lèi)則可以做到這個(gè)功能单芜，下面是該類(lèi)的源碼
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類(lèi)繼承了ThreadLocal類(lèi)，并重寫(xiě)了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瘾腰。
下面我們看看重寫(xiě)的childValue方法在什么時(shí)候執(zhí)行皆的，怎樣讓子線程訪問(wèn)父線程的本地變量值。我們首先從Thread類(lèi)開(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)用重寫(xiě)的方法
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類(lèi)通過(guò)重寫(xiě)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變量中。
詳解內(nèi)存泄漏問(wèn)題
從ThreadLocalMap看ThreadLocal使用不當(dāng)?shù)膬?nèi)存泄漏問(wèn)題
1梗顺、基礎(chǔ)概念
首先我們先看看ThreadLocalMap的類(lèi)圖泡孩，在前面的介紹中，我們知道ThreadLocal只是一個(gè)工具類(lèi)寺谤，他為用戶提供get仑鸥、set、remove接口操作實(shí)際存放本地變量的threadLocals（調(diào)用線程的成員變量）变屁，也知道threadLocals是一個(gè)ThreadLocalMap類(lèi)型的變量眼俊，下面我們來(lái)看看ThreadLocalMap這個(gè)類(lèi)。在此之前粟关，我們回憶一下Java中的四種引用類(lèi)型疮胖，相關(guān)GC只是參考前面系列的文章(JVM相關(guān))
①?gòu)?qiáng)引用：Java中默認(rèn)的引用類(lèi)型，一個(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類(lèi)的重點(diǎn)）：如果一個(gè)對(duì)象只具有弱引用创泄，那么這個(gè)對(duì)象就會(huì)被垃圾回收器GC掉(被弱引用所引用的對(duì)象只能生存到下一次GC之前艺玲，當(dāng)發(fā)生GC時(shí)候，無(wú)論當(dāng)前內(nèi)存是否足夠鞠抑，弱引用所引用的對(duì)象都會(huì)被回收掉)饭聚。弱引用也是和一個(gè)引用隊(duì)列聯(lián)合使用，如果弱引用的對(duì)象被垃圾回收期回收掉搁拙，JVM會(huì)將這個(gè)引用加入到與之關(guān)聯(lián)的引用隊(duì)列中秒梳。若引用的對(duì)象可以通過(guò)弱引用的get方法得到，當(dāng)引用的對(duì)象唄回收掉之后箕速，再調(diào)用get方法就會(huì)返回null
④虛引用：虛引用是所有引用中最弱的一種引用酪碘，其存在就是為了將關(guān)聯(lián)虛引用的對(duì)象在被GC掉之后收到一個(gè)通知。（不能通過(guò)get方法獲得其指向的對(duì)象）
2盐茎、分析ThreadLocalMap內(nèi)部實(shí)現(xiàn)
上面我們知道ThreadLocalMap內(nèi)部實(shí)際上是一個(gè)Entry數(shù)組
兴垦，我們先看看Entry的這個(gè)內(nèi)部類(lèi)
/**
* 是繼承自WeakReference的一個(gè)類(lèi)，該類(lèi)中實(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為T(mén)hreadLocal的弱引用枕屉。
當(dāng)一個(gè)線程調(diào)用ThreadLocal的set方法設(shè)置變量的時(shí)候，當(dāng)前線程的ThreadLocalMap就會(huì)存放一個(gè)記錄鲤氢，這個(gè)記錄的key值為T(mén)hreadLocal的弱引用搀擂，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))食茎。
總結(jié)：THreadLocalMap中的Entry的key使用的是ThreadLocal對(duì)象的弱引用蒂破，在沒(méi)有其他地方對(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)存泄漏哎媚。
