深入學(xué)習(xí)java ThreadLocal的源碼知識(shí)

public void set(T value) {
Thread t = Thread.currentThread();
ThreadLocalMap map = getMap(t); // 根據(jù)當(dāng)前線程獲得ThreadLocalMap對(duì)象
if (map != null)
map.set(this, value); // 如果有則set
else
createMap(t, value); // 否則創(chuàng)建ThreadLocalMap對(duì)象
}
ThreadLocalMap getMap(Thread t) {
return t.threadLocals;
}
void createMap(Thread t, T firstValue) {
t.threadLocals = new ThreadLocalMap(this, firstValue);
}

// 哈希映射表中的元素使用其引用字段作為鍵（它始終是ThreadLocal對(duì)象）繼承WeakReference。
// 注意，null鍵（即entry.get（）== null）表示不再引用該鍵，因此可以從表中刪除該元素。
// 這些元素在下面的代碼中稱(chēng)為“舊元素”。
// 這些“舊元素”就是臟對(duì)象，因?yàn)榇嬖谝貌粫?huì)被GC，
// 為避免內(nèi)存泄露需要代碼里清理，將引用置為null，那么這些對(duì)象之后就會(huì)被GC清理。
// 實(shí)際上后面的代碼很大程度上都是在描述如何清理“舊元素”的引用
static class Entry extends WeakReference<ThreadLocal<?>> {
Object value;
Entry(ThreadLocal<?> k, Object v) {
super(k);
value = v;
}
}

private void set(ThreadLocal<?> key, Object value) {
// We do not 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.
// 我們不像get（）那樣先使用快速路徑（直接散列）判斷
// 因?yàn)槭褂胹et（）創(chuàng)建新元素至少與替換現(xiàn)有元素一樣頻繁，在這種情況下，散列后立刻判斷會(huì)容易失敗。
// 所以直接先線性探測(cè)
Entry[] tab = table;
int len = tab.length;
// 根據(jù)hashcode散列到數(shù)組位置
int i = key.threadLocalHashCode & (len-1);
// 開(kāi)放地址法處理散列沖突，線性探測(cè)找到可以存放位置
// 遍歷數(shù)組找到下一個(gè)可以存放元素的位置，這種位置包含三種情況
// 1.元素的key已存在，直接賦值value
// 2.元素的key位null，說(shuō)明k作為弱引用被GC清理，該位置為舊數(shù)據(jù)，需要被替換
// 3.直到遍歷到一個(gè)數(shù)組位置為null的位置賦值
for (Entry e = tab[i];
e != null;
e = tab[i = nextIndex(i, len)]) {
ThreadLocal<?> k = e.get();
if (k == key) {//key已存在則直接更新
e.value = value;
return;
}
if (k == null) { //e不為null但k為null說(shuō)明k作為弱引用被GC，是舊數(shù)據(jù)需要被清理
// i為舊數(shù)據(jù)位置，清理該位置并依據(jù)key合理地散列或?qū)alue替換到數(shù)組中
// 然后重新散列i后面的元素，并順便清理i位置附近的其他舊元素
replaceStaleEntry(key, value, i);
return;
}
}
// 遍歷到一個(gè)數(shù)組位置為null的位置賦值
tab[i] = new Entry(key, value);
int sz = ++size;
// 調(diào)用cleanSomeSlots嘗試性發(fā)現(xiàn)并清理舊元素，如果沒(méi)有發(fā)現(xiàn)且舊元素當(dāng)前容量超過(guò)閾值，則調(diào)用rehash
if (!cleanSomeSlots(i, sz) && sz >= threshold)
// 此時(shí)認(rèn)為表空間不足，全量遍歷清理舊元素，清理后判斷容量若大于閾值的3/4，若是則擴(kuò)容并從新散列
rehash();
}

private void replaceStaleEntry(ThreadLocal<?> key, Object value, int staleSlot) {
Entry[] tab = table;
int len = tab.length;
Entry e;
// Back up to check for prior stale entry in current run.
// We clean out whole runs at a time to avoid continual
// incremental rehashing due to garbage collector freeing
// up refs in bunches (i.e., whenever the collector runs).
// 向前檢查是否存在舊元素，一次性徹底清理由于GC清除的弱引用key導(dǎo)致的舊數(shù)據(jù)，避免多次執(zhí)行
int slotToExpunge = staleSlot;
// 向前遍歷找到entry不為空且key為null的位置賦值給slotToExpunge
for (int i = prevIndex(staleSlot, len);
(e = tab[i]) != null;
i = prevIndex(i, len))
if (e.get() == null)
slotToExpunge = i;
// Find either the key or trailing null slot of run, whichever
// occurs first
// staleSlot位置向后遍歷如果位置不為空，判斷key是否已經(jīng)存在
// 回想前面我們是set實(shí)例的時(shí)候，碰到舊元素的情況下調(diào)用該方法，所以很可能在staleSlot后面key是已經(jīng)存在的
for (int i = nextIndex(staleSlot, len);
(e = tab[i]) != null;
i = nextIndex(i, len)) {
ThreadLocal<?> k = e.get();
// If we find key, then we need to swap it
// with the stale entry to maintain hash table order.
// The newly stale slot, or any other stale slot
// encountered above it, can then be sent to expungeStaleEntry
// to remove or rehash all of the other entries in run.
// 如果我們找到鍵，那么我們需要將它與舊元素交換以維護(hù)哈希表順序。
// 然后可以將交換后得到的舊索引位置
// 或其上方遇到的任何其他舊索引位置傳給expungeStaleEntry清理舊條
// 如果碰到key相同的值則覆蓋value
if (k == key) {
e.value = value;
// i位置與staleSlot舊數(shù)據(jù)位置做交換，將數(shù)組元素位置規(guī)范化，維護(hù)哈希表順序
// 這里維護(hù)哈希表順序是必要的，舉例來(lái)說(shuō)，回想前面threadLocal.set實(shí)例的判斷，是線性探測(cè)找到可以賦值的位置
// 如果哈希順序不維護(hù)，可能造成同一個(gè)實(shí)例被賦值多次的情況
// 包括后面清理舊元素的地方都要重新維護(hù)哈希表順序
tab[i] = tab[staleSlot];
tab[staleSlot] = e;
// Start expunge at preceding stale entry if it exists
// 開(kāi)始清理前面的舊元素
// 如果前面向前或向后查找的舊元素不存在，也就是slotToExpunge == staleSlot
//此時(shí)slotToExpunge = i，此時(shí)位置i的元素是舊元素，需要被清理
// slotToExpunge用來(lái)存儲(chǔ)第一個(gè)需要被清理的舊元素位置
if (slotToExpunge == staleSlot)
slotToExpunge = i;
// 清理完slotToExpunge位置及其后面非空連續(xù)位置后，通過(guò)調(diào)用cleanSomeSlots嘗試性清理一些其他位置的舊元素
// cleanSomeSlots不保證清理全部舊元素，它的時(shí)間復(fù)雜度O(log2n)，他只是全量清理舊元素或不清理的折中
cleanSomeSlots(expungeStaleEntry(slotToExpunge), len);
return;
}
// If we do not find stale entry on backward scan, the
// first stale entry seen while scanning for key is the
// first still present in the run.
// 如果前面向前查找的舊元素不存在，也就是slotToExpunge == staleSlot,而此時(shí)位置i為舊元素，所以將i賦值給slotToExpunge
// slotToExpunge用來(lái)存儲(chǔ)第一個(gè)需要被清理的舊元素位置
if (k == null && slotToExpunge == staleSlot)
slotToExpunge = i;
}
// If key not found, put new entry in stale slot
// 如果向后遍歷非空entry都沒(méi)有找到key，則直接賦值給當(dāng)前staleSlot舊元素位置
tab[staleSlot].value = null;
tab[staleSlot] = new Entry(key, value);

// If there are any other stale entries in run, expunge them
// 通過(guò)前面根據(jù)staleSlot向前/向后遍歷，如果發(fā)現(xiàn)有舊元素則清理
if (slotToExpunge != staleSlot)
// 清理完slotToExpunge位置及其后面非空連續(xù)位置后，通過(guò)調(diào)用cleanSomeSlots嘗試性清理一些其他位置的舊元素
// cleanSomeSlots不保證清理全部舊元素，它的時(shí)間復(fù)雜度O(log2n)，他只是全量清理舊元素或不清理的折中
cleanSomeSlots(expungeStaleEntry(slotToExpunge), len);
}

private int expungeStaleEntry(int staleSlot) {
Entry[] tab = table;
int len = tab.length;
// expunge entry at staleSlot
// 清空staleSlot位置的元素
tab[staleSlot].value = null;
tab[staleSlot] = null;
size--;
// Rehash until we encounter null
// 舊位置清理后，后面的元素需要重新散列到數(shù)組里，直到遇到數(shù)組位置為null。即維護(hù)哈希順序。
Entry e;
int i;
for (i = nextIndex(staleSlot, len);
(e = tab[i]) != null;
i = nextIndex(i, len)) {
ThreadLocal<?> k = e.get();
if (k == null) { // k == null說(shuō)明此位置也是舊數(shù)據(jù)，需要清理
e.value = null;
tab[i] = null;
size--;
} else {
int h = k.threadLocalHashCode & (len - 1);
// 將staleSlot后面不為空位置重新散列，如果與當(dāng)前位置不同，則向前移動(dòng)到h位置后面（包括h）的首個(gè)空位置
if (h != i) {
tab[i] = null;
// Unlike Knuth 6.4 Algorithm R, we must scan until
// null because multiple entries could have been stale.
while (tab[h] != null)
h = nextIndex(h, len);
tab[h] = e;
}
}
}
return i;
}

private boolean cleanSomeSlots(int i, int n) {
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);
}
// n >>>= 1無(wú)符號(hào)右移1位，即移動(dòng)次數(shù)以n的二進(jìn)制最高位的1的位置為基準(zhǔn)
// 所以時(shí)間復(fù)雜度log2(n)
} while ( (n >>>= 1) != 0);
return removed;
}

// rehash全量地遍歷清理舊元素，然后判斷容量若大于閾值的3/4，則擴(kuò)容并從新散列
// 程序認(rèn)為表空間不足時(shí)會(huì)調(diào)用該方法
private void rehash() {
// 全量遍歷清理舊元素
expungeStaleEntries();
// Use lower threshold for doubling to avoid hysteresis
// 適當(dāng)?shù)臄U(kuò)容，以避免hash散列到數(shù)組時(shí)過(guò)多的位置沖突
if (size >= threshold - threshold / 4)
// 2倍擴(kuò)容并重新散列
resize();
}
// 全量遍歷清理舊元素
private void expungeStaleEntries() {
Entry[] tab = table;
int len = tab.length;
for (int j = 0; j < len; j++) {
Entry e = tab[j];
if (e != null && e.get() == null)
expungeStaleEntry(j);
}
}
// 二倍擴(kuò)容
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);
while (newTab[h] != null)
h = nextIndex(h, newLen);
newTab[h] = e;
count++;
}
}
}
setThreshold(newLen);
size = count;
table = newTab;
}

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;
}
}
// 如果map不為null初始化一個(gè)key為當(dāng)前threadLocal值為null的ThreadLocalMap對(duì)象
return setInitialValue();
}
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 // 直接散列找不到的情況，調(diào)用getEntryAfterMiss線性探測(cè)查找期望元素
return getEntryAfterMiss(key, i, e);
}
private Entry getEntryAfterMiss(ThreadLocal<?> key, int i, Entry e) {
Entry[] tab = table;
int len = tab.length;
// 線性探測(cè)找到符合的元素，若遇到舊元素則進(jìn)行清理
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;
}

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;
}
}
}