前言

這幾天看《Java并發(fā)編程之美》的時候又遇到了ThradLocal這個類，不得不說，這個類在平時很多場景都遇得到，所以對其進(jìn)行一個系統(tǒng)性的學(xué)習(xí)，然后再輸出成這篇博客。 那么，什么是ThreadLocal呢？ 我們都知道，多線程訪問同一個共享變量很容易出現(xiàn)并發(fā)問題，特別是當(dāng)多個線程對同一個共享變量進(jìn)行寫入操作時。一般為了避免這種情況，我們會使用synchronized這個關(guān)鍵字對代碼塊加鎖。但是這種方式一是會讓沒獲取到鎖的線程進(jìn)行阻塞等待，二是需要使用者對鎖有一定的了解，無疑提高了編程的難度。其實(shí)ThreadLocal 就可以做這件事情，雖然ThreadLocal 并不是為了解決這個問題而出現(xiàn)的。 ThreadLocal 是JDK 包提供的，它提供了線程本地變量，也就是如果你創(chuàng)建了一個ThreadLocal 變量，那么訪問這個變量的每個線程都會有這個變量的一個本地副本。當(dāng)多個線程操作這個變量時，實(shí)際操作的是自己本地內(nèi)存里面的變量，從而避免了線程安全問題。

如圖所示： 

快速開始

接下來我們就先用一個簡單的樣例給大家展示一下ThreadLocal的基本用法

package cuit.pymjl.thradlocal;

/**
 * @author Pymjl
 * @version 1.0
 * @date 2022/7/1 10:56
 **/
public class MainTest {
 ? ?static ThreadLocal<String> threadLocal = new ThreadLocal<>();
?
 ? ?static void print(String str) {
 ? ? ? ?//打印當(dāng)前線程中本地內(nèi)存中本地變量的值
 ? ? ? ?System.out.println(str + " :" + threadLocal.get());
 ? ? ? ?//清除本地內(nèi)存中的本地變量
 ? ? ? ?threadLocal.remove();
 ?  }
?
 ? ?public static void main(String[] args) {
 ? ? ? ?Thread t1 = new Thread(new Runnable() {
 ? ? ? ? ? ?@Override
 ? ? ? ? ? ?public void run() {
 ? ? ? ? ? ? ? ?//設(shè)置線程1中本地變量的值
 ? ? ? ? ? ? ? ?threadLocal.set("thread1 local variable");
 ? ? ? ? ? ? ? ?//調(diào)用打印方法
 ? ? ? ? ? ? ? ?print("thread1");
 ? ? ? ? ? ? ? ?//打印本地變量
 ? ? ? ? ? ? ? ?System.out.println("after remove : " + threadLocal.get());
 ? ? ? ? ?  }
 ? ? ?  });
?
 ? ? ? ?Thread t2 = new Thread(new Runnable() {
 ? ? ? ? ? ?@Override
 ? ? ? ? ? ?public void run() {
 ? ? ? ? ? ? ? ?//設(shè)置線程1中本地變量的值
 ? ? ? ? ? ? ? ?threadLocal.set("thread2 local variable");
 ? ? ? ? ? ? ? ?//調(diào)用打印方法
 ? ? ? ? ? ? ? ?print("thread2");
 ? ? ? ? ? ? ? ?//打印本地變量
 ? ? ? ? ? ? ? ?System.out.println("after remove : " + threadLocal.get());
 ? ? ? ? ?  }
 ? ? ?  });
?
 ? ? ? ?t1.start();
 ? ? ? ?t2.start();
 ?  }
}

運(yùn)行結(jié)果如圖所示：

ThreadLocal的原理

ThreadLocal相關(guān)類圖

我們先來看一下ThreadLocal 相關(guān)類的類圖結(jié)構(gòu)，如圖所示： 

 由該圖可知， Thread 類中有一個threadLocals 和一個inheritableThreadLocals ， 它們都是ThreadLocalMap 類型的變量， 而ThreadLocalMap 是一個定制化的Hashmap 。在默認(rèn)情況下， 每個線程中的這兩個變量都為null ，只有當(dāng)前線程第一次調(diào)用ThreadLocal 的set 或者get 方法時才會創(chuàng)建它們。其實(shí)每個線程的本地變量不是存放在ThreadLocal 實(shí)例里面，而是存放在調(diào)用線程的threadLocals 變量里面。也就是說， ThreadLocal 類型的本地變量存放在具體的線程內(nèi)存空間中。ThreadLocal 就是一個工具殼，它通過set 方法把value 值放入調(diào)用線程的threadLocals 里面并存放起來， 當(dāng)調(diào)用線程調(diào)用它的get 方法時，再從當(dāng)前線程的threadLocals 變量里面將其拿出來使用。 如果調(diào)用線程一直不終止， 那么這個本地變量會一直存放在調(diào)用線程的threadLocals 變量里面，所以當(dāng)不需要使用本地變量時可以通過調(diào)用ThreadLocal 變量的remove 方法，從當(dāng)前線程的threadLocals 里面刪除該本地變量。另外， Thread 里面的threadLocals 為何被設(shè)計(jì)為map 結(jié)構(gòu)？很明顯是因?yàn)槊總€線程可以關(guān)聯(lián)多個ThreadLocal 變量。 接下來我們來看看ThreadLocal的set、get、以及remove的源碼

set

 ? ?public void set(T value) {
 ? ? ? ?// 1.獲取當(dāng)前線程（調(diào)用者線程）
 ? ? ? ?Thread t = Thread.currentThread();
 ? ? ? ?// 2.以當(dāng)前線程作為key值，去查找對應(yīng)的線程變量，找到對應(yīng)的map
 ? ? ? ?ThreadLocalMap map = getMap(t);
 ? ? ? ?if (map != null) {
 ? ? ? ? ? ?// 3.如果map不為null，則直接添加元素
 ? ? ? ? ? ?map.set(this, value);
 ? ? ?  } else {
 ? ? ? ? ? ?// 4.否則就先創(chuàng)建map，再添加元素
 ? ? ? ? ? ?createMap(t, value);
 ? ? ?  }
 ?  }

 ? ?void createMap(Thread t, T firstValue) {
 ? ? ? ?/**
 ? ? ? ? * 這里是創(chuàng)建一個ThreadLocalMap，以當(dāng)前調(diào)用線程的實(shí)例對象為key，初始值為value
 ? ? ? ? * 然后放入當(dāng)前線程的Therad.threadLocals屬性里面
 ? ? ? ? */
 ? ? ? ?t.threadLocals = new ThreadLocalMap(this, firstValue);
 ?  }

 ? ?ThreadLocalMap getMap(Thread t) {
 ? ? ? ?//這里就是直接獲取調(diào)用線程的成員屬性threadlocals
 ? ? ? ?return t.threadLocals;
 ?  }

get

 ? ?public T get() {
 ? ? ? ?// 1.獲取當(dāng)前線程
 ? ? ? ?Thread t = Thread.currentThread();
 ? ? ? ?// 2.獲取當(dāng)前線程的threadlocals，即ThreadLocalMap
 ? ? ? ?ThreadLocalMap map = getMap(t);
 ? ? ? ?// 3.如果map不為null，則直接返回對應(yīng)的值
 ? ? ? ?if (map != null) {
 ? ? ? ? ? ?ThreadLocalMap.Entry e = map.getEntry(this);
 ? ? ? ? ? ?if (e != null) {
 ? ? ? ? ? ? ? ?@SuppressWarnings("unchecked")
 ? ? ? ? ? ? ? ?T result = (T)e.value;
 ? ? ? ? ? ? ? ?return result;
 ? ? ? ? ?  }
 ? ? ?  }
 ? ? ? ?// 4.否則，則進(jìn)行初始化
 ? ? ? ?return setInitialValue();
 ?  }

下面是setInitialValue的代碼

private T setInitialValue() {
 ? ?//初始化屬性，其實(shí)就是null
 ? ?T value = initialValue();
 ? ?//獲取當(dāng)前線程
 ? ?Thread t = Thread.currentThread();
 ? ?//通過當(dāng)前線程獲取ThreadLocalMap
 ? ?ThreadLocalMap map = getMap(t);
 ? ?//如果map不為null，則直接添加元素
 ? ?if (map != null) {
 ? ? ? ?map.set(this, value);
 ?  } else {
 ? ? ? ?//否則就創(chuàng)建，然后將創(chuàng)建好的map放入當(dāng)前線程的屬性threadlocals
 ? ? ? ?createMap(t, value);
 ?  }
 ? ? ? ?//將當(dāng)前ThreadLocal實(shí)例注冊進(jìn)TerminatingThreadLocal類里面
 ? ?if (this instanceof TerminatingThreadLocal) {
 ? ? ? ?TerminatingThreadLocal.register((TerminatingThreadLocal<?>) this);
 ?  }
 ? ?return value;
}

這里我需要補(bǔ)充說明一下TerminatingThreadLocal。這個類是jdk11新出的，jdk8中并沒有這個類，所以在網(wǎng)上很多源碼分析中并未看見這個類的相關(guān)說明。 這個類我看了一下源碼，其作用應(yīng)該是避免ThreadLocal內(nèi)存泄露的問題(感興趣的可以去看看源碼，若有錯誤，還請指正)。 這是官方對其的解釋：

/**
 * A thread-local variable that is notified when a thread terminates and
 * it has been initialized in the terminating thread (even if it was
 * initialized with a null value).
 * 一個線程局部變量，
 * 當(dāng)一個線程終止并且它已經(jīng)在終止線程中被初始化時被通知（即使它被初始化為一個空值）。
 */

remove

 ? ? public void remove() {
 ? ? ? ? //如果當(dāng)前線程的threadLocals 變量不為空， 則刪除當(dāng)前線程中指定ThreadLocal 實(shí)例的本地變量。
 ? ? ? ? ThreadLocalMap m = getMap(Thread.currentThread());
 ? ? ? ? if (m != null) {
 ? ? ? ? ? ? m.remove(this);
 ? ? ? ? }
 ? ? }

小結(jié)

在每個線程內(nèi)部都有一個名為threadLocals 的成員變量， 該變量的類型為Hash Map ， 其中key 為我們定義的ThreadLocal 變量的this 引用， value 則為我們使用set 方法設(shè)置的值。每個線程的本地變量存放在線程自己的內(nèi)存變量threadLocals 中，如果當(dāng)前線程一直不消亡， 那么這些本地變量會一直存在， 所以可能會造成內(nèi)存溢出， 因此使用完畢后要記得調(diào)用ThreadLocal 的remove 方法刪除對應(yīng)線程的threadLocals 中的本地變量。

ThreadLocal內(nèi)存泄露

為什么會出現(xiàn)內(nèi)存泄漏？

ThreadLocalMap使用ThreadLocal的弱引用作為key，如果一個ThreadLocal沒有外部強(qiáng)引用來引用它，那么系統(tǒng) GC 的時候，這個ThreadLocal勢必會被回收，這樣一來，ThreadLocalMap中就會出現(xiàn)key為null的Entry，就沒有辦法訪問這些key為null的Entry的value，如果當(dāng)前線程再遲遲不結(jié)束的話，這些key為null的Entry的value就會一直存在一條強(qiáng)引用鏈：Thread Ref -> Thread -> ThreaLocalMap -> Entry -> value永遠(yuǎn)無法回收，造成內(nèi)存泄漏。 其實(shí)，ThreadLocalMap的設(shè)計(jì)中已經(jīng)考慮到這種情況，也加上了一些防護(hù)措施：在ThreadLocal的get(),set(),remove()的時候都會清除線程ThreadLocalMap里所有key為null的value。 但是這些被動的預(yù)防措施并不能保證不會內(nèi)存泄漏：

• 使用static的ThreadLocal，延長了ThreadLocal的生命周期，可能導(dǎo)致的內(nèi)存泄漏
• 分配使用了ThreadLocal又不再調(diào)用get(),set(),remove()方法，那么就會導(dǎo)致內(nèi)存泄漏

為什么使用弱引用？

既然我們都知道，使用了弱引用會造成ThreadLocalMap內(nèi)存泄漏，那么官方為什么依然使用弱引用而不是強(qiáng)引用呢？這就要從使用弱引用和強(qiáng)引用的區(qū)別來說起了：

• 如果使用強(qiáng)引用：我們知道，ThreadLocalMap的生命周期基本和Thread的生命周期一樣，當(dāng)前線程如果沒有終止，那么ThreadLocalMap始終不會被GC回收，而ThreadLocalMap持有對ThreadLocal的強(qiáng)引用，那么ThreadLocal也不會被回收，當(dāng)線程生命周期長，如果沒有手動刪除，則會造成kv累積，從而導(dǎo)致OOM
• 如果使用弱引用：弱引用中的對象具有很短的聲明周期，因?yàn)樵谙到y(tǒng)GC時，只要發(fā)現(xiàn)弱引用，不管堆空間是否足夠，都會將對象進(jìn)行回收。而當(dāng)ThreadLocal的強(qiáng)引用被回收時，ThreadLocalMap所持有的弱引用也會被回收，如果沒有手動刪除kv，那么會造成value累積，也會導(dǎo)致OOM

對比可知，使用弱引用至少可以保證不會因?yàn)閙ap的key累積從而導(dǎo)致OOM，而對應(yīng)的value可以通過remove，get，set方法在下一次調(diào)用時被清除?？梢?，內(nèi)存泄露的根源不是弱引用，而是ThreadLocalMap的生命周期和Thread一樣長，造成累積導(dǎo)致的

解決方法

既然問題的根源是value的累積造成OOM，那么我們對癥下藥，每次使用完ThreadLocal調(diào)用remove()方法清理掉就行了。

總結(jié)

到此這篇關(guān)于Java ThreadLocal類詳解的文章就介紹到這了,更多相關(guān)Java ThreadLocal 內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！