前面我們分析了 Thread類的源碼，有了前面的鋪墊，通過源碼 了解ThreadLocal的秘密就容易多了。
ThreadLocal類 提供了 get/set線程局部變量的實作，ThreadLocal成員變量與正常的成員變量不同，每個線程都可以通過 ThreadLocal成員變量 get/set自己的專屬值。ThreadLocal執行個體 通常是類中的私有靜态變量，常用于将狀态與線程關聯，例如：使用者ID或事務ID。
public class ThreadLocal<T> {
/**
* ThreadLocal能為每個 Thread線程 綁定一個專屬值的奧秘就是：
* 每個Thread對象都持有一個 ThreadLocalMap類型的成員變量，其key為ThreadLocal對象，
* value為綁定的值，是以每個線程調用 ThreadLocal對象 的set(T value)方法時，都會将
* 該ThreadLocal對象和綁定的值 以鍵值對的形式存入目前線程，這樣，同一個ThreadLocal對象
* 就可以為每個線程綁定一個專屬值咯。
* 每個線程調用 ThreadLocal對象的get()方法時，就可以根據 目前ThreadLocal對象 get到 綁定的值。
*/
public void set(T value) {
// 擷取目前線程
Thread t = Thread.currentThread();
// 擷取目前線程對象中持有的 ThreadLocalMap類型的成員變量
// ThreadLocalMap，看名字也知道它是一個 Map類型的 類
ThreadLocalMap map = getMap(t);
if (map != null)
map.set(this, value);
else
createMap(t, value);
}
ThreadLocalMap getMap(Thread t) {
// 經過前面對 Thread類 源碼的分析，可以知道，Thread類中有一個 ThreadLocalMap 類型的
// threadLocals變量
return t.threadLocals;
}
void createMap(Thread t, T firstValue) {
t.threadLocals = new ThreadLocalMap(this, firstValue);
}
public T get() {
Thread t = Thread.currentThread();
ThreadLocalMap map = getMap(t);
if (map != null) {
// 通過目前 ThreadLocal對象，擷取綁定的值
ThreadLocalMap.Entry e = map.getEntry(this);
if (e != null) {
@SuppressWarnings("unchecked")
T result = (T)e.value;
return result;
}
}
return setInitialValue();
}
public void remove() {
// 擷取目前線程的ThreadLocalMap成員變量，不為空就将目前 ThreadLocal對象
// 對應的 鍵值對 remove掉
ThreadLocalMap m = getMap(Thread.currentThread());
if (m != null)
m.remove(this);
}
/**
* 與大部分 Map 的實作相同，底層也是使用 動态數組來儲存 鍵值對Entry，也有rehash、resize等
* 操作
*/
static class ThreadLocalMap {
/**
* 存儲鍵值對，key 為 ThreadLocal對象，value 為 與該ThreadLocal對象綁定的值
* Entry的key是對ThreadLocal的弱引用，當抛棄掉ThreadLocal對象時，垃圾收集器會
* 忽略這個key的引用而清理掉ThreadLocal對象，防止了記憶體洩漏
*/
static class Entry extends WeakReference<ThreadLocal<?>> {
Object value;
Entry(ThreadLocal<?> k, Object v) {
super(k);
value = v;
}
}
// 看過 HashMap 或 ConcurrentHashMap 源碼的同學 一定下面對這些代碼很眼熟
/**
* 數組初始容量
*/
private static final int INITIAL_CAPACITY = 16;
/**
* Entry數組，用于存儲 <ThreadLocal<?> k, Object v>鍵值對
*/
private Entry[] table;
/**
* Entry元素數量
*/
private int size = 0;
/**
* 類似于 HashMap 擴容因子機制
*/
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++;
}
}
}
}
/**
* 根據 ThreadLocal對象 擷取其對應的 Entry執行個體
*/
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);
}
/**
* 正常Map實作類 的set()方法，隻不過這裡的 key被規定為 ThreadLocal類型
*/
private void set(ThreadLocal<?> key, Object value) {
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)]) {
ThreadLocal<?> k = e.get();
// 如果key相等，覆寫value
if (k == key) {
e.value = value;
return;
}
// 如果key為null，用新key、value覆寫，同時清理曆史key=null的陳舊資料
if (k == null) {
replaceStaleEntry(key, value, i);
return;
}
}
tab[i] = new Entry(key, value);
int sz = ++size;
// 若超過閥值，則rehash
if (!cleanSomeSlots(i, sz) && sz >= threshold)
rehash();
}
/**
* Remove the entry for key.
*/
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;
}
}
}
/**
* 調整目前table的容量。首先掃描整個容器，以删除過時的條目，如果這不能充分縮小表的大小，
* 将進行擴容操作
*/
private void rehash() {
// 掃描整個容器，删除過時的條目
expungeStaleEntries();
// 若未能充分縮小表的大小，則進行擴容操作
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;
// 周遊Entry[]數組
for (int j = 0; j < oldLen; ++j) {
Entry e = oldTab[j];
if (e != null) {
ThreadLocal<?> k = e.get();
// 如果key=null，把value也置null,有助于GC回收對象
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;
}
}
}
簡單畫個圖總結一下 ThreadLocal 的原理，如下。
最後強調一下 ThreadLocal的使用注意事項：
- ThreadLocal 不是用來解決線程安全問題的，多線程不共享，不存在競争！其目的是使線程能夠使用本地變量。
- 項目如果使用了線程池，那麼線程回收後ThreadLocal變量要remove掉，否則線程池回收線程後，變量還在記憶體中，可能會帶來意想不到的後果！例如Tomcat容器的線程池，可以在攔截器中處理：繼承 HandlerInterceptorAdapter，然後複寫 afterCompletion()方法，remove掉變量！！！
![Java小案例——随機數猜測随機數猜測[圖]](data:image/gif;base64,R0lGODlhAQABAIAAAP///wAAACwAAAAAAQABAAACAkQBADs=)