Java ThreadLocal原理解析以及應(yīng)用場景分析案例詳解
ThreadLocal的定義
JDK對ThreadLocal的定義如下：
TheadLocal提供了線程內(nèi)部的局部變量：每個(gè)線程都有自己的獨(dú)立的副本；ThreadLocal實(shí)例通常是類中的private static字段，該類一般與線程狀態(tài)相關(guān)（或線程上下文）中使用。只要線程處于活動(dòng)狀態(tài)且ThreadLocal實(shí)例時(shí)可訪問的狀態(tài)下，每個(gè)線程都持有對其線程局部變量的副本的隱式引用，在線程消亡后，ThreadLocal實(shí)例的所有副本都將進(jìn)行垃圾回收。
ThreadLocal的應(yīng)用場景
ThreadLocal 不是用來解決多線程訪問共享變量的問題，所以不能替換掉同步方法。一般而言，ThreadLocal的最佳應(yīng)用場景是：按照線程多實(shí)例（每個(gè)線程對應(yīng)一個(gè)實(shí)例）的對象的訪問。
例如：在事務(wù)中，connection綁定到當(dāng)前線程來保證這個(gè)線程中的數(shù)據(jù)庫操作用的是同一個(gè)connection。
ThreadLocal的demo
public class ThreadLocalTest {
public static void main(String[] args) {
ThreadLocal<String> threadLocal = new ThreadLocal<>();
threadLocal.set("張三");
new Thread(()->{
threadLocal.set("李四");
System.out.println("*******"+Thread.currentThread().getName()+"獲取到的數(shù)據(jù)"+threadLocal.get());
},"線程1").start();
new Thread(()->{
threadLocal.set("王二");
System.out.println("*******"+Thread.currentThread().getName()+"獲取到的數(shù)據(jù)"+threadLocal.get());
},"線程2").start();
new Thread(()->{
System.out.println("*******"+Thread.currentThread().getName()+"獲取到的數(shù)據(jù)"+threadLocal.get());
},"線程3").start();
System.out.println("線程=" + Thread.currentThread().getName() + "獲取到的數(shù)據(jù)=" + threadLocal.get());
}
}
運(yùn)行結(jié)果：
從運(yùn)行結(jié)果，我們可以看出線程1和線程2在ThreadLocal中設(shè)置的值相互獨(dú)立，每個(gè)線程只能取到自己設(shè)置的那個(gè)值。
TheadLocal的源碼解析
ThreadLocal存儲(chǔ)數(shù)據(jù)的邏輯是：每個(gè)線程持有一個(gè)自己的ThreadLocalMap,key為ThreadLocal對象的實(shí)例，value 是我們需要設(shè)值的值。
ThreadLocal的set方法
public void set(T value) {
Thread t = Thread.currentThread();
ThreadLocalMap map = getMap(t);
if (map != null)
map.set(this, value);
else
createMap(t, value);
}
getMap的方法如下：
public class Thread implements Runnable {
//每個(gè)線程自己的ThreadLocalMap對象通過ThreadLocal保存下來
ThreadLocal.ThreadLocalMap threadLocals = null;
ThreadLocalMap getMap(Thread t) {
return t.threadLocals;
}
}
首先獲取當(dāng)前線程的ThreadLocalMap對象，該對象是通過實(shí)例變量threadLocals保存的。
2. 如果獲取得到ThreadLocalMap，則直接設(shè)值，key為當(dāng)前ThreadLocal類的this實(shí)例，如果獲取不到調(diào)用createMap方法創(chuàng)建ThreadLoalMap實(shí)例，并將值設(shè)置到這個(gè)ThreadLocalMap中，后面我們會(huì)重點(diǎn)介紹ThreadLocal的createMap方法。
接下來我們就來看看ThreadLocal的get方法。
ThreadLocal的get方法
public T get() {
Thread t = Thread.currentThread();
ThreadLocalMap map = getMap(t);
if (map != null) {
ThreadLocalMap.Entry e = map.getEntry(this);
if (e != null) {
@SuppressWarnings("unchecked")
T result = (T)e.value;
return result;
}
}
return setInitialValue();
}
1.首先獲取當(dāng)前線程的ThreadLocalMap對象，沒有的話，設(shè)置初始值（null）并返回
2. 如果可以獲取到ThreadLocalMap 則獲取其Entry對象，如果不為空則直接返回value
說完了ThreadLocal的set方法和get方法。我就來具體看看前面提到的ThreadLocalMap。
ThreadLocalMap的結(jié)構(gòu)
public class ThreadLocal<T> {
private static AtomicInteger nextHashCode =new AtomicInteger();
//初始的Hash值是0x61c88647
private static final int HASH_INCREMENT = 0x61c88647;
//每次調(diào)用就原子性的將hash值增加HASH_INCREMENT
private static int nextHashCode() {
return nextHashCode.getAndAdd(HASH_INCREMENT);
}
static class ThreadLocalMap {
//Entry繼承WeakReference
static class Entry extends WeakReference<ThreadLocal<?>> {
/** The value associated with this ThreadLocal. */
Object value;
Entry(ThreadLocal<?> k, Object v) {
super(k);
value = v;
}
}
private static final int INITIAL_CAPACITY = 16;
private void setThreshold(int len) {
threshold = len * 2 / 3;
}
void createMap(Thread t, T firstValue) {
t.threadLocals = new ThreadLocalMap(this, firstValue);
}
ThreadLocalMap(ThreadLocal<?> firstKey, Object firstValue) {
table = new Entry[INITIAL_CAPACITY];
int i = firstKey.threadLocalHashCode & (INITIAL_CAPACITY - 1);
table[i] = new Entry(firstKey, firstValue);
size = 1;
setThreshold(INITIAL_CAPACITY);
}
}
}
如上，ThreadLocalMap作為ThreadLocal的靜態(tài)內(nèi)部類，由ThreadLocal所持有，每個(gè)線程內(nèi)部通過ThreadLocal來獲取自己的ThreadLocalMap實(shí)例。結(jié)構(gòu)如下圖所示：
從上述代碼我們可以看出ThreadLocalMap實(shí)際上沒有繼承Map接口，其只是一個(gè)可擴(kuò)展的散列表結(jié)構(gòu)。初始大小是16。大于等于數(shù)據(jù)的1/2 的時(shí)候會(huì)擴(kuò)容為2倍的原數(shù)組的rehash。初始的hashCode值為0x61c88647。每創(chuàng)建一個(gè)Entry對象，hash值就會(huì)增加一個(gè)固定大小0x61c88647。同時(shí)，我們注意到，ThreadLocalMap的Entry是繼承WeakReference,和HashMap很大的區(qū)別是，Entry中沒有next字段，所以不存在鏈表的情況。那么沒有鏈表結(jié)構(gòu)，發(fā)生hash沖突了怎么辦呢？要解答這個(gè)問題就需要看看ThreadLocalMap的set方法了。
ThreadLocalMap的set方法
private void set(ThreadLocal<?> key, Object value) {
Entry[] tab = table;
int len = tab.length;
//1.根據(jù)ThreadLocal對象的hash值，定位到table中的位置i
int i = key.threadLocalHashCode & (len-1);
for (Entry e = tab[i];
e != null;
e = tab[i = nextIndex(i, len)]) {
ThreadLocal<?> k = e.get();
//判斷Entry.key等于當(dāng)前的ThreadLoacl對象key，則覆蓋舊值，退出。
if (k == key) {
e.value = value;
return;
}
if (k == null) {
replaceStaleEntry(key, value, i);
return;
}
}
tab[i] = new Entry(key, value);
int sz = ++size;
if (!cleanSomeSlots(i, sz) && sz >= threshold)
rehash();
}
前面我們提到了每個(gè)ThreadLocal對象都有一個(gè)hash值threadLocalHashCode，每創(chuàng)建一個(gè)Entry對象，hash值就增加一個(gè)固定的大小0x61c88647。
1.根據(jù)ThreadLocal對象的hash值，定位到table中的位置i
2.如果table[i]的Entry不為null
2.1. 判斷Entry.key等于當(dāng)前的ThreadLoacl對象key，則覆蓋舊值，退出。
2.2. 如果Entry.key為null,將執(zhí)行刪除兩個(gè)null 槽之間的所有過期的stale的entry，
并把當(dāng)前的位置i上初始化一個(gè)Entry對象，退出
2.3 繼續(xù)查找下一個(gè)位置i++
3.如果找到了一個(gè)位置k,table[k]為null,初始化一個(gè)Entry對象。
ThreadLocalMap的getEntry方法
private Entry getEntry(ThreadLocal<?> key) {
int i = key.threadLocalHashCode & (table.length - 1);
Entry e = table[i];
if (e != null && e.get() == key)
return e;
else
return getEntryAfterMiss(key, i, e);
}
private Entry getEntryAfterMiss(ThreadLocal<?> key, int i, Entry e) {
Entry[] tab = table;
int len = tab.length;
while (e != null) {
ThreadLocal<?> k = e.get();
if (k == key)
return e;
if (k == null)
expungeStaleEntry(i);
else
i = nextIndex(i, len);
e = tab[i];
}
return null;
}
- 根據(jù)當(dāng)前ThreadLocal的hashCode mod table.length，計(jì)算直接索引的位置i，如果e不為null并且key相同則返回e。
- 如果e為null，返回null
- 如果e不為空且key不相同，則查找下一個(gè)位置，繼續(xù)查找比較，直到e為null退出
- 在查找的過程中如果發(fā)現(xiàn)e不為空，且e的k為空的話，刪除當(dāng)前槽和下一個(gè)null槽之間的所有過期entry對象。
總結(jié)ThreadLocalMap： - ThreadLocalMap的散列表采用開放地址，線性探測的方法處理hash沖突，在hash沖突較大的時(shí)候效率低下，因?yàn)門hreadLoaclMap是一個(gè)Thread的一個(gè)屬性，所以即使在自己的代碼中控制設(shè)置的元素個(gè)數(shù)，但還是不能控制其他代碼的行為。
- ThreadLocalMap的set、get、remove操作中都帶有刪除過期元素的操作，類似緩存的lazy淘汰。
ThreadLocal的內(nèi)存泄露
ThreadLocal可能導(dǎo)致內(nèi)存泄露，為什么？先看看Entry的實(shí)現(xiàn)：
static class Entry extends WeakReference<ThreadLocal<?>> {
/** The value associated with this ThreadLocal. */
Object value;
Entry(ThreadLocal<?> k, Object v) {
super(k);
value = v;
}
}
通過之前的分析我們已經(jīng)知道，當(dāng)使用ThreadLocal保存一個(gè)value時(shí)，會(huì)在ThreadLoalMap中的數(shù)組插入一個(gè)Entry對象，按理來說key-value都可以以強(qiáng)引用保存在Entry對象中，但在ThreadLocalMap的實(shí)現(xiàn)中，key被保存到了WeakReference對象（弱引用）中，即ThreadLocalMap弱引用ThreadLocal。
Key的引用鏈?zhǔn)?br />
ThreadLocalRef---->ThreadLocal，
這就導(dǎo)致了一個(gè)問題，當(dāng)一個(gè)ThreadLocal沒有強(qiáng)引用時(shí)，threadLocal會(huì)被GC清理，會(huì)形成一個(gè)key為null的Map的引用。
但是value是強(qiáng)引用的，只有當(dāng)當(dāng)前線程結(jié)束了value的強(qiáng)引用才會(huì)結(jié)束，但線程遲遲未結(jié)束時(shí)，就會(huì)出現(xiàn)
ThreadRef---->Thread---->ThreadLocalMap—>Entry—>value這條強(qiáng)引用鏈條。
廢棄threadLocal占用的內(nèi)存會(huì)在三種情況下清理：
- thread結(jié)束，那么與之相關(guān)的threadlocal value會(huì)被清理
- GC后，thread.threadLocal(map) 的threadhold超過最大值時(shí)，會(huì)清理
- GC后，thread.threadlocals(maps)添加新的Entry時(shí)，hash算法沒有命中既有Entry時(shí)，會(huì)清理
那么何時(shí)會(huì)“內(nèi)存泄漏”？當(dāng)Thread長時(shí)間不結(jié)束，存在大量廢棄的ThreadLocal，而又不再添加新的ThreadLocal時(shí)。
如何避免內(nèi)存泄露呢
在調(diào)用ThreadLocal的get()、set()可能會(huì)清除ThreadLocalMap中key為null的Entry對象，這樣對應(yīng)的value就沒有GC Roots可達(dá)了，下次GC的時(shí)候就可以被回收，當(dāng)然如果調(diào)用remove方法，肯定會(huì)刪除對應(yīng)的Entry對象。
ThreadLocal<String> threadLocal = new ThreadLocal<>();
try {
threadLocal.set("張三");
} catch (Exception e) {
threadLocal.remove();
}
應(yīng)用實(shí)例
public class DateUtil {
private final static Map<String, ThreadLocal<SimpleDateFormat>> sdfMap = new HashMap<>();
public final static String Y2M2D2HMS_ = "yyyy/MM/dd HH:mm:ss";
private static SimpleDateFormat getsdf(final String pattern) {
ThreadLocal<SimpleDateFormat> sdfThread = sdfMap.get(pattern);
if (sdfThread == null) {
//雙重檢驗(yàn),防止sdfMap被多次put進(jìn)去值,和雙重鎖單例原因是一樣的
synchronized (DateUtil.class) {
// 只有Map中還沒有這個(gè)pattern的sdf才會(huì)生成新的sdf并放入map
// 這里是關(guān)鍵,使用ThreadLocal<SimpleDateFormat>替代原來直接new SimpleDateFormat
sdfThread = sdfMap.get(pattern);
if (sdfThread == null) {
sdfThread = ThreadLocal.withInitial(() -> new SimpleDateFormat(pattern));
sdfMap.put(pattern, sdfThread);
}
}
}
return sdfThread.get();
}
/**
* @param date 需要格式化的date
* @param pattern 給定轉(zhuǎn)換格式
* @return java.lang.String 時(shí)間串
* @description 按照指定pattern的方式格式化時(shí)間
*/
public static String formatDate(Date date, String pattern) {
return DateUtil.getsdf(pattern).format(date);
}
}
SimpleDateFormat是線程不安全的類，同時(shí)創(chuàng)建一個(gè)SimpleDateFormat類又比較耗時(shí)，所以，我們可以將SimpleDateFormat類放在ThreadLocal包裝起來。然后，根據(jù)日期格式化的類型作為key放入一個(gè)靜態(tài)的map中。
實(shí)際應(yīng)用二
private static ThreadLocal<DecimalFormat> DECIMAL_FORMAT_THREAD_LOCAL = ThreadLocal.withInitial(() -> new DecimalFormat(DECIMAL_FORMAT));
/**
* 獲取金額格式化的類
* @return
*/
public static DecimalFormat getDecimalFormat() {
return DECIMAL_FORMAT_THREAD_LOCAL.get();
}
我們可以將金額格式化的類DecimalFormat保存到ThreadLocal中。
總結(jié)
本文簡單的介紹了ThreadLocal的應(yīng)用場景，其主要用在需要每個(gè)線程獨(dú)占的元素上，例如SimpleDateFormat。然后，就是介紹了ThreadLocal的實(shí)現(xiàn)原理，詳細(xì)介紹了set()和get()方法，介紹了ThreadeLocalMap的數(shù)據(jù)結(jié)構(gòu)，最后就是說到了ThreadLocal的內(nèi)存泄露以及避免的方式。
到此這篇關(guān)于Java ThreadLocal原理解析以及應(yīng)用場景分析案例詳解的文章就介紹到這了,更多相關(guān)Java ThreadLocal原理解析以及應(yīng)用場景內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！
相關(guān)文章
Java實(shí)現(xiàn)短信驗(yàn)證碼的示例代碼
Java是一種流行的編程語言，驗(yàn)證碼是一種常用的網(wǎng)絡(luò)安全技術(shù)。Java發(fā)展至今，網(wǎng)上也出現(xiàn)了各種各樣的驗(yàn)證碼，下面是用Java實(shí)現(xiàn)短信驗(yàn)證碼的總結(jié)，感興趣的可以了解一下2023-03-03
SpringBoot配置文件中常用配置屬性詳解(application.properties/application.y
Spring Boot 的一大優(yōu)勢就是通過簡單的配置文件即可快速定制應(yīng)用行為,而無需編寫大量 XML 配置或 Java 代碼,下面我們就來看看application.properties和application.yml作為核心配置文件的常見屬性吧2025-07-07
Java分布式鎖、分布式ID和分布式事務(wù)的實(shí)現(xiàn)方案
在分布式系統(tǒng)中，分布式鎖、分布式ID和分布式事務(wù)是常用的組件，用于解決并發(fā)控制、唯一標(biāo)識(shí)和數(shù)據(jù)一致性的問題，本文將介紹Java中常用的分布式鎖、分布式ID和分布式事務(wù)的實(shí)現(xiàn)方案，并通過具體的示例代碼演示它們的用法和應(yīng)用場景2023-06-06
Mybatis-plus如何在xml中傳入自定義的SQL語句
這篇文章主要介紹了Mybatis-plus如何在xml中傳入自定義的SQL語句問題,具有很好的參考價(jià)值,希望對大家有所幫助,如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2024-05-05
java web項(xiàng)目實(shí)現(xiàn)文件下載實(shí)例代碼
現(xiàn)在項(xiàng)目里面有個(gè)需求,需要把系統(tǒng)產(chǎn)生的日志文件給下載到本地 先獲取所有的日志文件列表,顯示到界面,選擇一個(gè)日志文件,把文件名傳到后臺(tái)2013-09-09
Java中IO流之字符流與字節(jié)流的轉(zhuǎn)換方式
在Java中,字節(jié)流與字符流是處理數(shù)據(jù)的兩種方式,字節(jié)流適用于處理各種數(shù)據(jù)類型,如圖片、音頻等非文本數(shù)據(jù),而字符流專門用于處理文本數(shù)據(jù),Java提供了InputStreamReader和OutputStreamWriter這兩個(gè)類來實(shí)現(xiàn)字節(jié)流向字符流的轉(zhuǎn)換2024-10-10
這篇文章主要介紹了SpringMVC中重定向model值的獲取方式，具有很好的參考價(jià)值，希望對大家有所幫助。如有錯(cuò)誤或未考慮完全的地方，望不吝賜教2021-12-12
這篇文章主要介紹了SpringMVC和rabbitmq集成的使用案例，具有很好的參考價(jià)值，希望對大家有所幫助。一起跟隨小編過來看看吧2021-01-01
SpringCloud CircuitBreaker斷路器詳解
Hystrix是一個(gè)用于處理分布式系統(tǒng)延遲和容錯(cuò)的開源庫,而Resilience4J是其后續(xù)的替代品,本文給大家介紹SpringCloud CircuitBreaker斷路器,感興趣的朋友跟隨小編一起看看吧2025-11-11
這篇文章主要介紹了SpringBoot之LogBack配置詳解，小編覺得挺不錯(cuò)的，現(xiàn)在分享給大家，也給大家做個(gè)參考。一起跟隨小編過來看看吧2019-02-02