Java并發-ThreadLocal

原文地址：cmsblogs.com/?p=2442

ThreadLocal介紹

ThreadLocal提供了一種解決多線程環境下成員變量的問題，但是它并不是解決多線程共享變量的問題。那么ThreadLocal到底是什么呢？

API是這樣介紹的：This class provides thread-local variables. These variables differ from their normal counterparts in that each thread that accesses one (via its get or set method) has its own, independently initialized copy of the variable. ThreadLocal instances are typically private static fields in classes that wish to associate state with a thread (e.g., a user ID or Transaction ID).

該類提供了線程局部（thread-local）變量。這些變量不同于普通對應物，因為訪問某個變量（通過其get或set方法）的每個線程都有自己的局部變量，它獨立于變量的初始化副本。ThreadLocal實例通常是類中的private static字段，它們希望將狀態與某一個線程（例如，用戶ID或事務ID）相關聯。

ThreadLocal與線程同步機制不同，線程同步機制是多個線程共享同一個變量，而ThreadLocal為了每一個線程創建一個單獨的變量副本，故而每個線程都可以獨立地改變自己所擁有的變量副本，而不會影響其他線程所對應的副本。

ThreadLocal使用示例，代碼如下：

public class SeqCount {private static ThreadLocal<Integer> seqCount = new ThreadLocal<Integer>() {// 實現initialValue()public Integer initialValue() {return 0;}};public int nextSeq() {seqCount.set(seqCount.get() + 1);return seqCount.get();}public static void main(String[] args) {SeqCount seqCount = new SeqCount();SeqThread thread1 = new SeqThread(seqCount);SeqThread thread2 = new SeqThread(seqCount);SeqThread thread3 = new SeqThread(seqCount);SeqThread thread4 = new SeqThread(seqCount);thread1.start();thread2.start();thread3.start();thread4.start();}private static class SeqThread extends Thread {private SeqCount seqCount;SeqThread(SeqCount seqCount) {this.seqCount = seqCount;}public void run() {for (int i = 0; i < 3; i++) {System.out.println(Thread.currentThread().getName() + " seqCount :"+ seqCount.nextSeq());}}}
}
復制代碼

ThreadLocal實現原理

ThreadLocal的實現是這樣的：每個Thread維護一個ThreadLocalMap映射表，這個映射表的key是 ThreadLocal實例本身，value是真正需要存儲的Object。

也就是說ThreadLocal本身并不存儲值，它只是作為一個key來讓線程從ThreadLocalMap獲取 value。值得注意的是圖中的虛線，表示ThreadLocalMap是使用ThreadLocal的弱引用作為Key的，弱引用的對象在GC時會被回收。

ThreadLocal源碼分析

ThreadLocalMap

ThreadLocalMap的構造函數如下：

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其內部利用Entry來實現key-value的存儲，如下：

static class Entry extends WeakReference<ThreadLocal<?>> {/** The value associated with this ThreadLocal. */Object value;Entry(ThreadLocal<?> k, Object v) {super(k);value = v;}
}
復制代碼

可以看出Entry的key就是ThreadLocal，而value就是值。同時，Entry也繼承WeakReference，所以說Entry所對應key（ThreadLocal實例）的引用為一個弱引用。

接下來，看看ThreadLocalMap最核心的方法set(ThreadLocal> key, Object value)、getEntry()方法。

1、set(ThreadLocal<?> key, Object value)

private void set(ThreadLocal<?> key, Object value) {Entry[] tab = table;int len = tab.length;// 根據 ThreadLocal 的散列值，查找對應元素在數組中的位置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，但是存在值（因為此處的e != null），說明之前的ThreadLocal對象已經被回收if (k == null) {// 用新元素替換陳舊的元素replaceStaleEntry(key, value, i);return;}}// ThreadLocal對應的key實例不存在則創建tab[i] = new Entry(key, value);int sz = ++size;// cleanSomeSlots 清楚陳舊的Entry（key == null）// 如果沒有清理陳舊的 Entry 并且數組中的元素大于了閾值，則進行 rehashif (!cleanSomeSlots(i, sz) && sz >= threshold)rehash();}復制代碼

set()操作除了存儲元素外，還有一個很重要的作用，就是replaceStaleEntry()和cleanSomeSlots()，這兩個方法可以清除掉key == null 的實例，防止內存泄漏。在set()方法中還有一個變量很重要：threadLocalHashCode，定義如下：

private final int threadLocalHashCode = nextHashCode();
復制代碼

從名字上面我們可以看出threadLocalHashCode應該是ThreadLocal的散列值，定義為final，表示ThreadLocal一旦創建其散列值就已經確定了，生成過程則是調用nextHashCode()：

private static AtomicInteger nextHashCode = new AtomicInteger();private static final int HASH_INCREMENT = 0x61c88647;private static int nextHashCode() {return nextHashCode.getAndAdd(HASH_INCREMENT);
}
復制代碼

nextHashCode表示分配下一個ThreadLocal實例的threadLocalHashCode的值，HASH_INCREMENT則表示分配兩個ThradLocal實例的threadLocalHashCode的增量。

2、getEntry()

private Entry getEntry(ThreadLocal<?> key) {int i = key.threadLocalHashCode & (table.length - 1);Entry e = table[i];if (e != null && e.get() == key)return e;elsereturn getEntryAfterMiss(key, i, e);
}
復制代碼

采用了開放定址法，所以當前key的散列值和元素在數組的索引并不是完全對應的，首先取一個探測數（key的散列值），如果所對應的key就是我們所要找的元素，則返回，否則調用getEntryAfterMiss()。

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;// 當key == null時，調用了expungeStaleEntry()方法，該方法用于處理key == null，// 有利于GC回收，能夠有效地避免內存泄漏。if (k == null)expungeStaleEntry(i);elsei = nextIndex(i, len);e = tab[i];}return null;}
復制代碼

ThreadLocal核心方法

set(T value)：設置當前線程的線程局部變量的值

public void set(T value) {Thread t = Thread.currentThread();ThreadLocalMap map = getMap(t);if (map != null)map.set(this, value);elsecreateMap(t, value);
}void createMap(Thread t, T firstValue) {t.threadLocals = new ThreadLocalMap(this, firstValue);
}
復制代碼

獲取當前線程所對應的ThreadLocalMap，如果不為空，則調用ThreadLocalMap的set()方法，key就是當前ThreadLocal，如果不存在，則調用createMap()方法創建。

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;}}// 如果ThreadLocalMap不存在，返回初始值。return setInitialValue();
}
復制代碼

首先通過當前線程獲取所對應的成員變量ThreadLocalMap，然后通過ThreadLocalMap獲取當前ThreadLocal的Entry，最后通過所獲取的Entry獲取目標值result。

initialValue()：返回該線程局部變量的初始值

protected T initialValue() {return null;
}
復制代碼

這個方法將在一個線程第一次使用get方法訪問變量時被調用，除非線程先前調用了set方法，在這種情況下，線程不會調用initialValue方法。通常情況下，每個線程最多調用一次此方法，但在后續調用remove和get時，可能會再次調用此方法。

默認實現返回null，如果程序員希望線程局部變量具有非null的初始值，則必須對ThreadLocal進行子類化，并重寫此方法。

remove()：將當前線程局部變量的值刪除

public void remove() {ThreadLocalMap m = getMap(Thread.currentThread());if (m != null)m.remove(this);
}
復制代碼

該方法的目的是減少內存的占用。當然，我們不需要顯示調用該方法，因為一個線程結束后，它所對應的局部變量就會被垃圾回收。

ThreadLocal為什么會內存泄漏

ThreadLocalMap使用ThreadLocal的弱引用作為key，如果一個ThreadLocal沒有外部強引用來引用它，那么系統GC的時候，這個ThreadLocal勢必會被回收，ThreadLocalMap中就會出現key為null的Entry，就沒有辦法訪問這些key為null的Entry的value。如果當前線程再遲遲不結束的話，這些key為null的Entry的value就會一直存在一條強引用鏈：Thread Ref -> Thread -> ThreaLocalMap -> Entry -> value永遠無法回收，造成內存泄漏。