ThreadLocal是什麼
顧名思義，ThreadLocal爲線程局部變量
使用場景
JDBC的連接connection對象都是非線程安全對象。所以在web環境下，使用一個線程處理一個請求的時候，需要從數據庫連接池中取出connection對象，但是爲了保證connection對象的線程安全性，很簡單的一個方案就是將它線程私有化，這個時候就需要用到我們的線程局部變量ThreadLocal。
從上述例子中我們可以看出來ThreadLocal這個類的使用方法，就是將一個共享的對象綁定到一個線程上去，從而實現線程安全。
源碼分析
首先分析屬性和相關方法
/**
* 初始hashcode的值
*/
private static AtomicInteger nextHashCode =
new AtomicInteger();
/**
* 哈希增加值
*/
private static final int HASH_INCREMENT = 0x61c88647;
/**
* Returns the next hash code.
*/
private static int nextHashCode() {
return nextHashCode.getAndAdd(HASH_INCREMENT);
}
這幾個屬性後面會用到檢測hash算法是否一致。
分析一下核心的set方法。ThreadLocal的set方法是通過代理給它的內部類ThreadLocalMap實現的。
public void set(T value) {
Thread t = Thread.currentThread();
// Thread類中存在一個ThreadLocalMap的屬性，該方法就相當於t.threadLocalMap
ThreadLocalMap map = getMap(t);
if (map != null)
// 代理到內部類ThreadLocalMap
map.set(this, value);
else
//當map爲空的時候需要創建一個map
createMap(t, value);
}
void createMap(Thread t, T firstValue) {
t.threadLocals = new ThreadLocalMap(this, firstValue);
}
於是對於ThreadLocal的分析就轉換爲對內部類ThreadLocalMap的分析。首先對ThreadLocalMap相關屬性和構造方法進行分析
static class ThreadLocalMap {
//該類繼承了WeakReference是方便垃圾回收，在底層map擴容之前進行entry的回收，減
//少擴容的概率,提高性能
static class Entry extends WeakReference<ThreadLocal<?>> {
Object value;
Entry(ThreadLocal<?> k, Object v) {
super(k);
value = v;
}
}
//初始容量
private static final int INITIAL_CAPACITY = 16;
/**
* 底層數組
*/
private Entry[] table;
/**
* map中entry的個數
*/
private int size = 0;
/**
* 閾值，超過這個閾值之後就需要進行擴容
*/
private int threshold; // Default to 0
/**
* 閾值是底層數組長度的2/3
*/
private void setThreshold(int len) {
threshold = len * 2 / 3;
}
/**
* 計算下一個索引，hash算法定位失敗的時候（也就是該索引位置存在元素）
*/
private static int nextIndex(int i, int len) {
return ((i + 1 < len) ? i + 1 : 0);
}
/**
* 上一個位置索引，hash算法定位失敗的時候（也就是該索引位置存在元素）
*/
private static int prevIndex(int i, int len) {
return ((i - 1 >= 0) ? i - 1 : len - 1);
}
/**
* 根據key和value構建ThreadLocaMap
*/
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
*/
private ThreadLocalMap(ThreadLocalMap parentMap) {
//根據父容器創建一個ThreadLocalMap
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);
//該句相當於 hashcode % len但是&運算更加高效
int h = key.threadLocalHashCode & (len - 1);
//hash算法定位失敗，找下一個索引
while (table[h] != null)
h = nextIndex(h, len);
table[h] = c;
size++;
}
}
}
}
}
set方法的分析
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就直接替換
if (k == key) {
e.value = value;
return;
}
//處理key爲null的情況
if (k == null) {
replaceStaleEntry(key, value, i);
return;
}
}
//通過hash算法定位的數組索引位置爲null，直接創建一個entry放入即可
tab[i] = new Entry(key, value);
int sz = ++size;
//首先清理槽，底層數組entry的個數還是大於等於3/4*threshold就需要擴容
if (!cleanSomeSlots(i, sz) && sz >= threshold)
rehash();
}
private void replaceStaleEntry(ThreadLocal<?> key, Object value,
int staleSlot) {
Entry[] tab = table;
int len = tab.length;
Entry e;
// 首先向前掃描，記錄最前端的value爲null的entry，
// 之後清理槽的時候將它們全部清理掉
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();
// 如果找到了對應的key，首先替換value，然後將兩個槽替換
// 最後需要清理槽
if (k == key) {
//替換value
e.value = value;
//將當前位置的槽和最初hash算法定位到的槽替換
tab[i] = tab[staleSlot];
tab[staleSlot] = e;
// 該句話代表，索引i位置前的entry沒有value爲null的
if (slotToExpunge == staleSlot)
slotToExpunge = i;
//清理槽
cleanSomeSlots(expungeStaleEntry(slotToExpunge), len);
return;
}
// If we didn't find stale entry on backward scan, the
// first stale entry seen while scanning for key is the
// first still present in the run.
if (k == null && slotToExpunge == staleSlot)
slotToExpunge = i;
}
// 如果不存在對應的key，現將value賦值爲null，之後在重新創建一個
tab[staleSlot].value = null;
tab[staleSlot] = new Entry(key, value);
// 不想等證明中間肯定有key == null的slot就需要清理
if (slotToExpunge != staleSlot)
cleanSomeSlots(expungeStaleEntry(slotToExpunge), len);
}
private int expungeStaleEntry(int staleSlot) {
Entry[] tab = table;
int len = tab.length;
// 清理value和entry，此處爲何不清理key呢？
// 相信瞭解weakreference的朋友都知道，weakreference對象在最近一次
// 垃圾收集中就會被清理了，不需要我們手動去清理。
tab[staleSlot].value = null;
tab[staleSlot] = null;
size--;
// Rehash until we encounter null
Entry e;
int i;
//從當前索引位置開始，清理掉key爲null的entry
for (i = nextIndex(staleSlot, len);
(e = tab[i]) != null;
i = nextIndex(i, len)) {
ThreadLocal<?> k = e.get();
//清理key == null的slot
if (k == null) {
e.value = null;
tab[i] = null;
size--;
} else {
// 如果key不爲null，就需要計算出索引和當前索引是否一致
int h = k.threadLocalHashCode & (len - 1);
//不一致就需要進行清理，並且同時將entry覆蓋掉不爲null的slot
if (h != i) {
tab[i] = null;
//找到不爲null的slot
while (tab[h] != null)
h = nextIndex(h, len);
tab[h] = e;
}
}
}
//返回不爲null的slot的索引
return i;
}
//該方法實質是通過expungeStaleEntry清理slot
private boolean cleanSomeSlots(int i, int n) {
boolean removed = false;
Entry[] tab = table;
int len = tab.length;
// 使用一個循環，折半的方式清理slot
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); //折半，相當於 n /= 2
return removed;
}
private void rehash() {
//檢查清理
expungeStaleEntries();
// 當size大於等於3/4閾值的時候擴容
if (size >= threshold - threshold / 4)
resize();
}
/**
* 創建一個數組長度爲原來兩倍的數組，在進行復制和粘貼
* 在這個過程中和hashmap不同的是，假如key也爲null就需要清理
*/
private void resize() {
//創建一個2倍長度的新數組
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();
// 清理掉key爲null的slot
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++;
}
}
}
//循環複製完畢，設置閾值，設置map中元素個數，將table的引用指爲新創建的數組
setThreshold(newLen);
size = count;
table = newTab;
}
/**
* Expunge all stale entries in the table.
*/
private void expungeStaleEntries() {
Entry[] tab = table;
int len = tab.length;
for (int j = 0; j < len; j++) {
Entry e = tab[j];
// value爲null的slot進行清理
if (e != null && e.get() == null)
expungeStaleEntry(j);
}
}
set方法共有三種情況：1.如果對應的slot爲null就直接創建一個entry放入即可； 2.如果key存在直接替換 3.當key爲null，就需要遍歷和判斷是否存在對應key，如果存在替換value，替換slot，如果不存在直接創建一個新entry覆蓋。在此期間，還需要清理數組中key爲null，和hash算法不一致的entry。之後在map中增加了一個之後還需要檢查是否需要擴容，但是與HashMap不同的是，它首先爲進行一個slot的清理，在進行檢查。
set方法分析完畢，之後分析比較容易的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;
}
}
//map爲空的狀況
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
//處理key丟失的情況
return getEntryAfterMiss(key, i, e);
}
/**
* 處理key丟失的情況，
* 總體思想就是通過從當前位置開始循環遍歷，將下一個entry的key和當前key進
* 形比較，如果想等就返回，不想等就找下一個索引，再此期間還需要進行entry的
* 清理。如果最後沒有找到丟失的key就返回null
*/
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)
//該方法是處理清理ThreadLocalMap的slot
expungeStaleEntry(i);
else
//沒找到，下一個位置查找
i = nextIndex(i, len);
e = tab[i];
}
// 循環一週沒找到key，返回null
return null;
}
//創建一個初始值放入到map中
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;
}
//可以自行覆蓋該方法
protected T initialValue() {
return null;
}
get方法通過雙重保險機制。第一重保險就是通過當前線程獲取ThreadLocalMap，第二重保險就是通過ThreadLocal自身對象獲取value。獲得value的的時候同樣是使用了代理機制，將get方法代理到ThreadLocalMap中來，ThreadLocalMap調用getEntry方法，該方法如果找不到對應的key就調用key丟失會調用的方法。該方法總體來說就是查找key，如果不存在就返回null，存在就返回對應的value。
ThreadLocal內存泄漏
通過上訴的分析我們明白了ThreadLocal的原理大致如下圖所示：
對着原理圖來分析一下ThreadLocal內存泄漏產生的原因：
首先ThreadLocalMap用ThreadLocal對象作爲key，而ThreadLocal對象是weakreference對象，那麼在下一次GC的時候會回收Map中爲null的key對象，而此時存在另外一條強引用鏈，這一條鏈就是CurrentThread ref–>ThreadLocalMap–>value，由於這一條強引用鏈的存在導致value對象無法被回收。我們在上面分析得知set和get方法，會檢查key是否爲null，並且回收key == null的Entry，但是set和get方法的檢查只能減少內存泄漏的概**率，而無法確保不發生內存泄漏。
所以，ThreadLocal的正確使用習慣是，在不使用該對象之後調用該對象之後調用remove方法。**