大家好,我是小黑,一個在網際網路苟且偷生的農民工。
從前上一期【併發程式設計之:synchronized】 我們學到要保證在併發情況下對於共享資源的安全訪問,就需要用到鎖。
但是,加鎖通常情況下會讓執行效率降低,那有什麼辦法可以徹底避免對共享資源的競爭,同時又可以不影響效率呢?答案就是小黑今天要和大家講的ThreadLocal。
ThreadLocal是什麼?
該類提供了執行緒區域性 (thread-local) 變數。這些變數不同於它們的普通對應物,因為訪問某個變數(通過其 get 或 set 方法)的每個執行緒都有自己的區域性變數,它獨立於變數的初始化副本。ThreadLocal 例項通常是類中的 private static 欄位,它們希望將狀態與某一個執行緒(例如,使用者 ID 或事務 ID)相關聯。
以上來源官方API。大概可以總結為兩點:
- ThreadLocal提供get/set方法,可以訪問屬於當前執行緒的變數,也就是可以保證每個執行緒的變數不一樣。
- ThreadLocal使用時通常定義為private static的。
從字面意思理解,可能會將ThreadLocal認為是本地執行緒,其實ThreadLocal並不是執行緒,而是執行緒Thread的區域性變數。
如何使用
首先,定義一個private static的ThreadLocal物件。
private static ThreadLocal<String> threadLocal = new ThreadLocal<>();
然後每個執行緒可以將當前執行緒需要存放在區域性變數中,並且可以從中獲取。
public void setAndGet(String name) {
threadLocal.set(name);
String s = threadLocal.get();
}
最後在使用完之後,需要將ThreadLocal中的值移除。
public void remove() {
threadLocal.remove();
}
原理
那麼ThreadLocal是如何做到保證每個執行緒get出來的資料不一樣的呢?我們通過原始碼來看一下。
public void set(T value) {
Thread t = Thread.currentThread();
// 通過當前執行緒獲取出來一個ThreadLocalMap
ThreadLocalMap map = getMap(t);
if (map != null)
map.set(this, value);
else
createMap(t, value);
}
void createMap(Thread t, T firstValue) {
t.threadLocals = new ThreadLocalMap(this, firstValue);
}
我們發現在set方法中,會建立一個ThreadLocalMap,然後將要設定的值放在這個Map中,而當前這個ThreadLocal物件作為key;
然後再將這個ThreadLocalMap賦值給Thread的threadLocals裡。如果去看Thread類的程式碼會發現,在Thread類中存在兩個變數threadLocals和inheritableThreadLocals,它們的型別就是ThreadLocal.ThreadLocalMap。通過下圖可以看出Thread,ThreadLocal,ThreadLocalMap三者的關係。
這時候我們再看看get()和remove()方法的程式碼。
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();
}
ThreadLocalMap getMap(Thread t) {
return t.threadLocals;
}
public void remove() {
ThreadLocalMap m = getMap(Thread.currentThread());
if (m != null)
m.remove(this);
}
可以看出來,和我們上面圖中的結構一樣,get()方法就是從Thread中取出來ThreadLocalMap,然後通過ThreadLocal物件作為Key取出值;remove()方法則是取出ThreadLocalMap將ThreadLocal對應的資料移除。
那麼ThreadLocalMap到底是什麼呢?是java.util.Map介面的子類嗎?我們來看原始碼。
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;
}
}
private static final int INITIAL_CAPACITY = 16;
private Entry[] table;
private int size = 0;
private int threshold; // Default to 0
// 省略其他程式碼
}
通過原始碼發現,ThreadLocalMap並沒有實現Map介面,也沒有整合其他任何的Map類。是定義在ThreadLocal類中的一個靜態內部類。而它的結構和HashMap結構極其相似。有一個Entry[]陣列存放資料。而這個Entry類是繼承自WeakReference類的子類,這一點和HashMap有所不同。
ThreadLocalMap和HashMap結構有很多不同,但是還有一點和HashMap不一樣,我們來看一下ThreadLocalMap的set方法。
private void set(ThreadLocal<?> key, Object value) {
Entry[] tab = table;
int len = tab.length;
// 計算key對應放在tab中的下標
int i = key.threadLocalHashCode & (len-1);
//迴圈遍歷tab,首先獲取到下標i對應的物件,如果不為空,則執行迴圈體
// 如果不是相同的threadLocal或者位置失效,則要尋找下一個位置。
for (Entry e = tab[i];
e != null;
e = tab[i = nextIndex(i, len)]) {
ThreadLocal<?> k = e.get();
// 判斷與當前ThreadLocal是否是同一個物件,如果是則進行值替換,結束
if (k == key) {
e.value = value;
return;
}
// 如果k==null代表threadLocal的key失效了,將失效的key進行替換
if (k == null) {
replaceStaleEntry(key, value, i);
return;
}
}
tab[i] = new Entry(key, value);
int sz = ++size;
if (!cleanSomeSlots(i, sz) && sz >= threshold)
rehash();
}
程式碼中迴圈遍歷tab,首先獲取到下標i對應的物件,如果不為空,則執行迴圈體,如果在迴圈體中的兩個條件都不滿足,則會執行nextIndex()方法,這個方法的程式碼如下:
private static int nextIndex(int i, int len) {
return ((i + 1 < len) ? i + 1 : 0);
}
這個方法的邏輯就是開放定址法。而HashMap則是通過拉鍊法和rehash來做的。
哪些場景使用
通過上面的內容基本可以掌握ThreadLocal的基本用法,那麼ThreadLocal主要在什麼場景中使用呢。
ThreadLocal的作用通過以上了解我們知道主要是用來做執行緒間資料隔離。那麼在什麼場景下能用到執行緒隔離呢?
首先想到的就是SimpleDateFormat這個工具類,它不是執行緒安全的,可以通過ThreadLocal在每個執行緒中放一份,保證執行緒安全。
還有比如說使用者登入的session,或者token資料,只資料當前會話執行緒,也可以通過ThreadLocal儲存。
再比如在某些場景下,上下文資料在不同方法之間呼叫,傳遞起來非常麻煩,可以通過ThreadLocal存放,只需要在需要用到的地方獲取就可以。
除了這些場景,在某些框架原始碼中也會使用到,比如Spring中的事務也主要是通過ThreadLocal和麵向切面程式設計AOP實現的,感興趣的同學可以檢視原始碼瞭解。
避免踩坑
記憶體洩漏
ThreadLocalMap中的Entry的Key是一個弱引用,因此如果在使用後不呼叫remove方法清除掉會導致對應的value記憶體洩漏。所以在使用完以後一定要記得呼叫remove方法清除資料。
好的,今天的內容就到這裡,我們下期再見。
關注我的公眾號【小黑學Java】乾貨內容第一時間送達。