ThreadLocal源碼解析
作者：追夢1819
原文：//www.cnblogs.com/yanfei1819/p/14735212.html
版權聲明：本文為部落客原創文章，轉載請附上博文鏈接！
Hash函數
在哈希表（散列表）里，Hash函數的作用就是將關鍵字Key轉化為一個固定長度數組的下標，以便存取鍵值對<Key,Value>，那當多個鍵（key）經過Hash函數處理後落在了同一個位置時怎麼辦呢？
開放地址法
所謂開放地址法就是發生衝突時在散列表（也就是數組裡）里去尋找合適的位置存取對應的元素。
這個合適的位置該怎麼找呢？
線性探測法
當前位置衝突了，那我就去找相鄰的下一個位置。
就拿放入元素舉例吧，當你放入<a,101>到下標為2的位置後，另一個<c,103>鍵值對也落入了這個位置，那麼它就向後依次加一尋找合適的位置，然後把<c,103>放入進去。
我們把這種方法稱作線性探測法,我們可以將Hash以及尋找位置的過程抽象成一個函數：
首先看(hash1(key)+0)%7 位置是自己最終的位置嗎？如果有衝突，就探測（查看）下一個位置:(hash1(key)+1)%7。依次進行
所謂探測，就是在插入的時候檢查哪個位置可以插入，或者查找時查找哪個位置是要查找的鍵值對，本質就是探尋這個鍵值對最終的位置。
但是這樣會有一個問題，就是隨著鍵值對的增多，會在哈希表裡形成連續的鍵值對
這樣的話，當插入元素時，任意一個落入這個區間的元素都要一直探測到區間末尾，並且最終將自己加入到這個區間內。這樣就會導致落在區間內的關鍵字Key要進行多次探測才能找到合適的位置，並且還會繼續增大這個連續區間，使探測時間變得更長，這樣的現象被稱為「一次聚集（primary clustering」
平方探測法
我們可以在探測時不一個挨著一個地向後探測，我們可以跳躍著探測，這樣就避免了一次聚集。
其實我們可以讓它按照 i^2 的規律來跳躍探測
這樣的話，元素就不會聚集在某一塊區域了，我們把這種方法稱為平方探測法
同樣我們可以抽象成下面的函數：
雖然平方探測法解決了線性探測法的一次聚集，但是它也有一個小問題，就是關鍵字key散列到同一位置後探測時的路徑是一樣的。
這樣對於許多落在同一位置的關鍵字而言，越是後面插入的元素，探測的時間就越長。
這種現象被稱作「二次聚集(secondary clustering)」,其實這個在線性探測法里也有。
這種現象出現的原因是由於對於落在同一個位置的關鍵字我們採取了一個依賴 i 的函數（i或者i^2）來進行探測，它不會因為關鍵字的不同或其他因素而改變探測的路徑。
又散列
我們可以再弄另外一個Hash函數，對落在同一個位置的關鍵字進行再次的Hash,探測的時候就用依賴這個Hash值去探測，比如我們可以使用下面的函數：
經過hash1的散列後，會定位到某一個地址，如果這個地址衝突，那麼就按照1hash2(key)、2hash2(key)… 的偏移去探測合適的位置。
由於Hash2函數不同於Hash1,所以兩個不同的關鍵字Hash1值和Hash2值同時相同的概率就會變得非常低。
這樣就避免了二次聚集，但同時也付出了計算另一個散列函數Hash2的代價。（而且需要避免hash2(key) = 0的情況）
ThreadLocal實現的原理
ThreadLocal、ThreadLocalMap、Thread之間的關係
ThreadLocal連接ThreadLocalMap與Thread，ThreadLocalMap是ThreadLocal內部類，由ThreadLocal創建，Thread類中有ThreadLocal.ThreadLocalMap類型的屬性。
ThreadLocalMap
用於存儲數據，採用類似HashMap的數據結構（並沒有實現Map介面），存儲了以threadLocal為key，需求隔離的數據為value的Entry鍵值對數組結構。
源碼解析
package java.lang;
import java.lang.ref.*;
import java.util.Objects;
import java.util.concurrent.atomic.AtomicInteger;
import java.util.function.Supplier;
public class ThreadLocal<T> {
// 根據hash值計算存放的Entry[]數組的下標
private final int threadLocalHashCode = nextHashCode();
private static AtomicInteger nextHashCode =
new AtomicInteger();
// 魔數:用於實現元素的完美散列
private static final int HASH_INCREMENT = 0x61c88647;
// 執行緒中每添加一個ThreadLocal,AtomicInteger類型的newHashCode值就會增加一個HASH_INCREMENT
private static int nextHashCode() {
return nextHashCode.getAndAdd(HASH_INCREMENT);
}
// 初始值
protected T initialValue() {
return null;
}
public static <S> ThreadLocal<S> withInitial(Supplier<? extends S> supplier) {
return new SuppliedThreadLocal<>(supplier);
}
public ThreadLocal() {
}
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();
}
private T setInitialValue() {
T value = initialValue();
Thread t = Thread.currentThread();
ThreadLocalMap map = getMap(t);
if (map != null)
map.set(this, value);
else
createMap(t, value);
return value;
}
public void set(T value) {
Thread t = Thread.currentThread();
// 從Thread類的成員變數中獲取ThreadLocalMap
ThreadLocalMap map = getMap(t);
// 只果ThreadLocalMap存在則將當前ThreadLocal作為key,要存儲的值作為value存在ThreadLocalMap裡面,否則新建一個ThreadLocalMap並賦值給Thread的變數threadLocals
if (map != null)
map.set(this, value);
else
createMap(t, value);
}
public void remove() {
ThreadLocalMap m = getMap(Thread.currentThread());
if (m != null)
m.remove(this);
}
ThreadLocalMap getMap(Thread t) {
return t.threadLocals;
}
void createMap(Thread t, T firstValue) {
t.threadLocals = new ThreadLocalMap(this, firstValue);
}
static ThreadLocalMap createInheritedMap(ThreadLocalMap parentMap) {
return new ThreadLocalMap(parentMap);
}
T childValue(T parentValue) {
throw new UnsupportedOperationException();
}
static final class SuppliedThreadLocal<T> extends ThreadLocal<T> {
private final Supplier<? extends T> supplier;
SuppliedThreadLocal(Supplier<? extends T> supplier) {
this.supplier = Objects.requireNonNull(supplier);
}
@Override
protected T initialValue() {
return supplier.get();
}
}
static class ThreadLocalMap {
static class Entry extends WeakReference<ThreadLocal<?>> {
/** The value associated with this ThreadLocal. */
Object value;
Entry(ThreadLocal<?> k, Object v) {
super(k);
value = v;
}
}
// 數組初始化大小為16
private static final int INITIAL_CAPACITY = 16;
// 用來保存每一個key-value鍵值對,這裡的key為ThreadLocal對象,調用ThreadlLocal對象的set方法時,把ThreadLocal對象自己當做key,放進了ThreadLocalMap中
private Entry[] table;
private int size = 0;
private int threshold; // Default to 0
private void setThreshold(int len) {
threshold = len * 2 / 3;
}
private static int nextIndex(int i, int len) {
return ((i + 1 < len) ? i + 1 : 0);
}
private static int prevIndex(int i, int len) {
return ((i - 1 >= 0) ? i - 1 : len - 1);
}
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);
}
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) {
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++;
}
}
}
}
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;
}
private void set(ThreadLocal<?> key, Object value) {
Entry[] tab = table;
int len = tab.length;
// 計算數組放置的位置,即數組下標,當len=2^n次冪時同 % n
int i = key.threadLocalHashCode & (len-1);
// 當數組位置的Entry不為null,則遍歷i到Entry為null的位置
for (Entry e = tab[i];
e != null;
e = tab[i = nextIndex(i, len)]) {
ThreadLocal<?> k = e.get();
// Entry保存的key與調用的ThreadLocal相等,則替換value值並直接返回
if (k == key) {
e.value = value;
return;
}
// 如果key為null(GC回收),用新的key、value覆蓋,同時清理歷史key=null的數據並直接返回
if (k == null) {
replaceStaleEntry(key, value, i);
return;
}
}
// 如果i位置的Entry為null,則創建key、value的Entry
tab[i] = new Entry(key, value);
int sz = ++size;
if (!cleanSomeSlots(i, sz) && sz >= threshold)
// 重新hash
rehash();
}
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;
}
}
}
private void replaceStaleEntry(ThreadLocal<?> key, Object value,
int staleSlot) {
Entry[] tab = table;
int len = tab.length;
Entry e;
int slotToExpunge = staleSlot;
for (int i = prevIndex(staleSlot, len);
(e = tab[i]) != null;
i = prevIndex(i, len))
if (e.get() == null)
slotToExpunge = i;
for (int i = nextIndex(staleSlot, len);
(e = tab[i]) != null;
i = nextIndex(i, len)) {
ThreadLocal<?> k = e.get();
if (k == key) {
e.value = value;
tab[i] = tab[staleSlot];
tab[staleSlot] = e;
// Start expunge at preceding stale entry if it exists
if (slotToExpunge == staleSlot)
slotToExpunge = i;
cleanSomeSlots(expungeStaleEntry(slotToExpunge), len);
return;
}
if (k == null && slotToExpunge == staleSlot)
slotToExpunge = i;
}
// If key not found, put new entry in stale slot
tab[staleSlot].value = null;
tab[staleSlot] = new Entry(key, value);
// If there are any other stale entries in run, expunge them
if (slotToExpunge != staleSlot)
cleanSomeSlots(expungeStaleEntry(slotToExpunge), len);
}
private int expungeStaleEntry(int staleSlot) {
Entry[] tab = table;
int len = tab.length;
// expunge entry at staleSlot
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) {
e.value = null;
tab[i] = null;
size--;
} else {
int h = k.threadLocalHashCode & (len - 1);
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);
}
} while ( (n >>>= 1) != 0);
return removed;
}
private void rehash() {
expungeStaleEntries();
// Use lower threshold for doubling to avoid hysteresis
if (size >= threshold - threshold / 4)
resize();
}
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;
}
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);
}
}
}
}
