ThreadLocal數(shù)據(jù)存儲結構原理解析
一：簡述
我們很多時候為了實現(xiàn)數(shù)據(jù)在線程級別下的隔離，會使用到ThreadLocal，那么TheadLocal是如何實現(xiàn)數(shù)據(jù)隔離的呢？今天就和大家一起分析一下ThreadLocal的實現(xiàn)原理。
二：TheadLocal的原理分析
1.ThreadLocal的存儲結構
每個Thread對象中都有一個threadLocals成員變量，threadLocals是一個類型為ThreadLocalMap的map，而ThreadLocal正是基于這個map來實現(xiàn)線程級別的數(shù)據(jù)隔離的。
我們先看ThreadLocalMap的成員變量
//默認的初始化容量大小
private static final int INITIAL_CAPACITY = 16;
//Entry數(shù)組 真正存儲的數(shù)據(jù)結構
private Entry[] table;
//記錄當前元素的數(shù)量
private int size = 0;
//擴容的閾值
private int threshold;
Entry數(shù)組是真正存儲數(shù)據(jù)的地方，可以看出Entry是一個key-value的存儲結構，以當前ThreadLocal對象的引用作為key，存儲的值為value。Entry繼承了WeakReference，并且在構造函數(shù)的時候，調用super(k)（也就是WeakReference的構造函數(shù)）來對key進行初始化，所以Entry的key是一個弱引用。
static class Entry extends WeakReference<ThreadLocal<?>> {
/** The value associated with this ThreadLocal. */
Object value;
Entry(ThreadLocal<?> k, Object v) {
super(k);
value = v;
}
}
根據(jù)上面的分析，我們可以知道ThreadLocal的存儲結構大概是這樣的：
2.源碼分析
接下來我們從ThreadLocal的set()，get(),remove()方法為入口對ThreadLocal的源碼進行分析。
set()方法
首先判斷當前線程的threadLocals是否初始化，如果沒有初始化，那么調用createMap()方法進行初始化并設置值，否則調用ThreadLocalMap的set()方法設置值。
流程圖：
三：源碼分析
public void set(T value) {
//利用當前線程獲取它的threadLocals（threadLocals是一個ThreadLocalMap）
Thread t = Thread.currentThread();
ThreadLocalMap map = getMap(t);
//如果已經(jīng)初始化 那么就調用ThreadLocalMap的set()方法
if (map != null)
map.set(this, value);
else
// 沒有初始化 先進行初始化
createMap(t, value);
}
ThreadLocalMap getMap(Thread t) {
//返回當前線程的threadLocals
return t.threadLocals;
}
createMap()
createMap()會調用ThreadLocalMap的構造函數(shù)對當前線程的threadLocals初始化，并且初始化Entry數(shù)組，然后利用hash算法計算出數(shù)組下標，將需要set的值存儲在Entry數(shù)組。
void createMap(Thread t, T firstValue) {
t.threadLocals = new ThreadLocalMap(this, firstValue);
}
ThreadLocalMap(ThreadLocal<?> firstKey, Object firstValue) {
// 初始化Entry數(shù)組
table = new Entry[INITIAL_CAPACITY];
//計算數(shù)組下標
int i = firstKey.threadLocalHashCode & (INITIAL_CAPACITY - 1);
table[i] = new Entry(firstKey, firstValue);
size = 1;
//設置默認的擴容閾值 和默認容量一樣
setThreshold(INITIAL_CAPACITY);
}
如果threadLocals已經(jīng)初始化，直接調用ThreadLocalMap的set()，接下來看ThreadLocalMap的set()方法。
首先利用hash算法計算數(shù)組下標，如果計算出的位置沒有值，直接將值設置進去，如果存在值（出現(xiàn)hash沖突），分為三種情況：
1.如果key相同，那么直接覆蓋值
2.如果計算出的位置的Entry的key為null，那么說明是無效的數(shù)據(jù)（key為null，entry不為null）,為了避免內存泄漏需要清除這種數(shù)據(jù)。所以調用replaceStaleEntry()方法將無效數(shù)據(jù)清除并且將需要設置的值設置到Entry數(shù)組中。
3.如果key不相同，而且計算出的位置的Entry的key不為null，那么進入到下一次for循環(huán)將計算出的下標+1，（如果到達下標最大值，則設置為0），利用新的位置重新進行判斷，直到獲取到一個合法的位置（線性尋址法解決hash沖突的問題）。
注：這里大家可以評論區(qū)討論下為什么不和HashMap那樣利用鏈表法解決hash沖突。我個人的看法是因為ThreadLocal的數(shù)據(jù)量不會向HashMap那么多，所以不需要利用鏈表和紅黑樹來解決hash沖突，鏈表法解決代碼相對比較復雜而且擴容遷移數(shù)據(jù)的數(shù)據(jù)會比較麻煩。
源碼：
private void set(ThreadLocal<?> key, Object value) {
// We don't use a fast path as with get() because it is at
// least as common to use set() to create new entries as
// it is to replace existing ones, in which case, a fast
// path would fail more often than not.
Entry[] tab = table;
int len = tab.length;
// 計算數(shù)組下標
int i = key.threadLocalHashCode & (len-1);
//如果出現(xiàn)hash沖突會進入for循環(huán)
for (Entry e = tab[i];
e != null;
e = tab[i = nextIndex(i, len)]) {
ThreadLocal<?> k = e.get();
//如果key相同 那么直接將值覆蓋
if (k == key) {
e.value = value;
return;
}
//如果key為null 那么說明是無效的數(shù)據(jù) 需要進行清除
if (k == null) {
//調用replaceStaleEntry()方法進行清除數(shù)據(jù) 并設置值
replaceStaleEntry(key, value, i);
return;
}
}
//如果沒有hash沖突 直接賦值到對應下標的位置
tab[i] = new Entry(key, value);
// 將當前元素個數(shù)+1
int sz = ++size;
//如果沒有需要清除的元素，并且當前元素個數(shù)已經(jīng)達到擴容的閾值，那么進行擴容
if (!cleanSomeSlots(i, sz) && sz >= threshold)
rehash();
}
接下來看replaceStaleEntry()，看ThreadLocal是如何清除無效的數(shù)據(jù)的。
當前節(jié)點是無效的數(shù)據(jù)，那么周圍也可能存在無效的數(shù)據(jù)，所以ThreadLocal在清除無效的數(shù)據(jù)時，會順便清除周圍的連續(xù)的無效數(shù)據(jù)，先利用for循環(huán)從當前節(jié)點向前遍歷，調整slotToExpunge的值（slotToExpunge 用于保存開始清除無效數(shù)據(jù)的下標位置）， 然后向后遍歷，如果有entry的key和需要存放的數(shù)據(jù)的key相同，那么直接覆蓋值，并且交換當前節(jié)點和新設置的entry的值。
流程圖：
private void replaceStaleEntry(ThreadLocal<?> key, Object value,
int staleSlot) {
Entry[] tab = table;
int len = tab.length;
Entry e;
// slotToExpunge 用于保存開始清除無效數(shù)據(jù)的下標位置
int slotToExpunge = staleSlot;
//從當前位置向前遍歷，直到找到一個有效數(shù)據(jù)的下標
for (int i = prevIndex(staleSlot, len);
(e = tab[i]) != null;
i = prevIndex(i, len))
//e.get()返回Entry的key，威null代表是無效數(shù)據(jù)
//（因為只有entry不為null才會進入for循環(huán)） 所以key為null，就是無效數(shù)據(jù)
//for循環(huán)將清除無效數(shù)據(jù)的下標往前挪
if (e.get() == null)
slotToExpunge = i;
//從當前位置往后遍歷
for (int i = nextIndex(staleSlot, len);
(e = tab[i]) != null;
i = nextIndex(i, len)) {
ThreadLocal<?> k = e.get();
//如果遍歷的是否發(fā)現(xiàn)有和當前Entry相同的key的entry，那么交換兩者的位置
if (k == key) {
e.value = value;
tab[i] = tab[staleSlot];
tab[staleSlot] = e;
//如果slotToExpunge和staleSlot相等
//證明當前節(jié)點的前面沒有和當前節(jié)點連續(xù)的無效數(shù)據(jù)
//所以從交換完的位置開始清除無效數(shù)據(jù) 調用cleanSomeSlots()方法和expungeStaleEntry()方法清除無效數(shù)據(jù) 清除完返回。
if (slotToExpunge == staleSlot)
slotToExpunge = i;
cleanSomeSlots(expungeStaleEntry(slotToExpunge), len);
return;
}
//如果key為null 而且當前entry之前沒有與當前節(jié)點連續(xù)的無效數(shù)據(jù)
//刷新開始清除無效數(shù)據(jù)的下標
if (k == null && slotToExpunge == staleSlot)
slotToExpunge = i;
}
// If key not found, put new entry in stale slot
//如果沒有找到連續(xù)的無效數(shù)據(jù) 把當前的節(jié)點的value重置為null 并且將新的值賦值到當前位置
//因為當前的entry是無效的數(shù)據(jù)
tab[staleSlot].value = null;
tab[staleSlot] = new Entry(key, value);
// If there are any other stale entries in run, expunge them
//如果slotToExpunge 和 staleSlot不相等 說明有連續(xù)的無效數(shù)據(jù)需要順便清除
if (slotToExpunge != staleSlot)
cleanSomeSlots(expungeStaleEntry(slotToExpunge), len);
}
注：大家可以在評論區(qū)討論一下，這里為什么要交換一下數(shù)據(jù)，我個人認為，第一是為了保證數(shù)據(jù)存儲的位置盡可能的在hash計算出位置，有利于后續(xù)的get()方法，第二：交換位置之后有利于讓無效的數(shù)據(jù)連續(xù)起來，提高清除無效數(shù)據(jù)的效率。
真正清除無效數(shù)據(jù)的方法是expungeStaleEntry()方法和cleanSomeSlots()方法
我們先看expungeStaleEntry()方法
expungeStaleEntry()
expungeStaleEntry()方法從當前節(jié)點開始向后遍歷（直到遇到enrty為null的節(jié)點），將無效數(shù)據(jù)清除，并且重新計算有效的entry的數(shù)組下標，如果計算出的下標和entry的下標不相同（這是因為采用了線性尋址法，所以hash計算出下標可能和實際的下標不一樣），重新找到合適的位置。
private int expungeStaleEntry(int staleSlot) {
Entry[] tab = table;
int len = tab.length;
// expunge entry at staleSlot
//先將當前節(jié)點清除
tab[staleSlot].value = null;
tab[staleSlot] = null;
size--;
// Rehash until we encounter null
Entry e;
int i;
for (i = nextIndex(staleSlot, len);
(e = tab[i]) != null;
i = nextIndex(i, len)) {
ThreadLocal<?> k = e.get();
if (k == null) {
//key為null 證明是無效數(shù)據(jù) 清除
e.value = null;
tab[i] = null;
size--;
} else {
//重新計算數(shù)組下標 如果數(shù)組下標發(fā)生變化 那么將數(shù)據(jù)遷移到新的位置上
int h = k.threadLocalHashCode & (len - 1);
if (h != i) {
tab[i] = null;
//重新利用線性尋址法尋找合適的下標位置
while (tab[h] != null)
h = nextIndex(h, len);
tab[h] = e;
}
}
}
return i;
}
然后是cleanSomeSlots()方法
cleanSomeSlots()
調用log(n)次expungeStaleEntry()方法進行清除無效數(shù)據(jù)。這個官方說不調用n次來清除，為了效率，而且經(jīng)過測試調用log(n)次清除無效的數(shù)據(jù)的效果已經(jīng)很好了。(n代表entry數(shù)組的長度)。
private boolean cleanSomeSlots(int i, int n) {
//removed 是否清除了數(shù)據(jù)的標記
boolean removed = false;
Entry[] tab = table;
int len = tab.length;
do {
i = nextIndex(i, len);
Entry e = tab[i];
if (e != null && e.get() == null) {
n = len;
removed = true;
i = expungeStaleEntry(i);
}
} while ( (n >>>= 1) != 0);
return removed;
}
如果set()方法設置值之后，需要擴容會調用rehash()方法進行擴容。
先調用expungeStaleEntries()清除一下數(shù)據(jù)，如果還是需要擴容，那么調用resize()進行擴容。
rehash()
private void rehash() {
//再試清除一下數(shù)據(jù)
expungeStaleEntries();
// Use lower threshold for doubling to avoid hysteresis
//如果還是需要擴容 那么會調用 resize()進行擴容
if (size >= threshold - threshold / 4)
resize();
}
resize()
resize()方法會創(chuàng)建一個容量為原來兩倍的數(shù)組，并且將數(shù)據(jù)遷移到新的數(shù)組上面，將新的數(shù)組賦值給table變量。（擴容方法比較簡單）
private void resize() {
Entry[] oldTab = table;
int oldLen = oldTab.length;
int newLen = oldLen * 2;
Entry[] newTab = new Entry[newLen];
int count = 0;
for (int j = 0; j < oldLen; ++j) {
Entry e = oldTab[j];
if (e != null) {
ThreadLocal<?> k = e.get();
if (k == null) {
e.value = null; // Help the GC
} else {
int h = k.threadLocalHashCode & (newLen - 1);
//線性尋址法解決hash沖突
while (newTab[h] != null)
h = nextIndex(h, newLen);
newTab[h] = e;
count++;
}
}
}
setThreshold(newLen);
size = count;
table = newTab;
}
get()方法
獲取到當前線程的threadLocals，如果threadLocals已經(jīng)初始化，那么調用getEntry()方法獲取值。否則調用setInitialValue()獲取我們在initialValue()設置的初始化的值。
public T get() {
Thread t = Thread.currentThread();
//利用當前線程獲取它的threadLocals（threadLocals是一個ThreadLocalMap）
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();
}
現(xiàn)在我們看getEntry()方法
如果找到key相同的Entry 直接返回，否則調用getEntryAfterMiss()方法
getEntry()
private Entry getEntry(ThreadLocal<?> key) {
int i = key.threadLocalHashCode & (table.length - 1);
Entry e = table[i];
//如果找到key相同的Entry 直接返回
if (e != null && e.get() == key)
return e;
else
return getEntryAfterMiss(key, i, e);
}
getEntryAfterMiss()
getEntryAfterMiss()從當前節(jié)點往后遍歷查找，遍歷找到key相同的entry，找到就返回，否則返回null，如果有無效數(shù)據(jù)，順便清除一下。
private Entry getEntryAfterMiss(ThreadLocal<?> key, int i, Entry e) {
Entry[] tab = table;
int len = tab.length;
while (e != null) {
ThreadLocal<?> k = e.get();
//找到key相同的entry 直接返回
if (k == key)
return e;
if (k == null)
//當前數(shù)據(jù)為無效數(shù)據(jù) 清除一下
expungeStaleEntry(i);
else
//否則向后繼續(xù)查找
i = nextIndex(i, len);
e = tab[i];
}
return null;
}
最后是remove()方法
remove()
利用hash算法計算下標，從下標位置開始往后遍歷，找到key相同的entry，將entry刪除，順便調用expungeStaleEntry()方法清除一下無效的數(shù)據(jù)。
public void remove() {
ThreadLocalMap m = getMap(Thread.currentThread());
if (m != null)
m.remove(this);
}
private void remove(ThreadLocal<?> key) {
Entry[] tab = table;
int len = tab.length;
int i = key.threadLocalHashCode & (len-1);
for (Entry e = tab[i];
e != null;
e = tab[i = nextIndex(i, len)]) {
if (e.get() == key) {
e.clear();
expungeStaleEntry(i);
return;
}
}
}
四：總結
本篇文章對ThreadLocal的數(shù)據(jù)存儲結構，以及set()，get()，remove()方法進行了分析。最后給大家可以再討論一個問題：為什么ThreadLocal的Entry的key要使用弱引用？
以上就是ThreadLocal數(shù)據(jù)存儲結構原理解析的詳細內容，更多關于ThreadLocal數(shù)據(jù)存儲結構的資料請關注腳本之家其它相關文章！
相關文章
今天給大家分析一下 Spring 框架本身對這些緩存具體實現(xiàn)的支持和融合。使用 Spring Cache 將大大的減少我們的Spring項目中緩存使用的復雜度，提高代碼可讀性。本文將從以下幾個方面來認識Spring Cache框架。感興趣的小伙伴們可以參考一下2018-11-11
JAVA CountDownLatch與thread-join()的區(qū)別解析
這篇文章主要介紹了JAVA CountDownLatch與thread-join()的區(qū)別解析,文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值,需要的朋友可以參考下2019-08-08
本篇文章主要介紹了Java實現(xiàn)郵箱激活賬戶實例代碼，這里整理了詳細的代碼,具有一定的參考價值，有需要的小伙伴可以參考下。2017-07-07
HTML的全稱為超文本標記語言，是一種標記語言。它包括一系列標簽．通過這些標簽可以將網(wǎng)絡上的文檔格式統(tǒng)一，使分散的Internet資源連接為一個邏輯整體。HTML文本是由HTML命令組成的描述性文本，HTML命令可以說明文字，圖形、動畫、聲音、表格、鏈接等2022-03-03
Idea之沒有網(wǎng)絡的情況下創(chuàng)建SpringBoot項目的方法實現(xiàn)
本文主要介紹了Idea之沒有網(wǎng)絡的情況下創(chuàng)建SpringBoot項目的方法實現(xiàn)，文中通過圖文介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值，需要的朋友們下面隨著小編來一起學習學習吧2023-09-09
SpringBoot統(tǒng)一數(shù)據(jù)返回的方法實現(xiàn)
在前后端交互過程中,為了便于數(shù)據(jù)處理,后端數(shù)據(jù)需要進行統(tǒng)一封裝返回給前端,這種做法不僅方便前后端溝通,降低了溝通成本,還有助于項目的統(tǒng)一維護和后端技術部門的規(guī)范制定,本文就來介紹一下2024-10-10
這篇文章主要介紹了Linux部署springboot項目彩色日志打印方式，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教2023-04-04
Kruskal算法是一種用來尋找最小生成樹的算法，由Joseph Kruskal在1956年發(fā)表。用來解決同樣問題的還有Prim算法和Boruvka算法等。本文將介紹用Java語言實現(xiàn)Kruskal算法的示例代碼，需要的可以參考一下2022-07-07
這篇文章主要介紹了SpringBoot設置接口超時的方法小結,包括配置文件，config配置類及相關示例代碼，代碼簡單易懂，對大家的學習或工作具有一定的參考借鑒價值，需要的朋友可以參考下2021-09-09
這篇文章主要介紹了java實現(xiàn)時間控制的幾種方案,本文從多個方面給大家介紹的非常詳細，具有一定的參考借鑒價值，需要的朋友可以參考下2019-07-07