[JDK8]ThreadLocal源碼分析

時間 2019-12-10

原文原文鏈接

當訪問共享的可變數據時，一般須要使用同步。一種避免同步的方式就是不共享數據，僅在單線程內部訪問數據，就不須要同步。該技術稱之爲線程封閉。
當數據封裝到線程內部，即便該數據不是線程安全的，也會實現自動線程安全性。編程

維持線程封閉性能夠經過Ad-hoc線程封閉、棧封閉來實現，一種更加規範的方法是使用ThreadLocal類。ThreadLocal類提供線程局部變量，經過get、set等方法訪問變量，爲每一個使用該變量的線程建立一個獨立的副本。數組

1、ThreadLocal使用案例

案例中只開啓了一個線程threadA，展現了在線程內部設置、獲取、清除局部變量。安全

public class ThreadLocalTest {
    // 初始化ThreadLocal變量
    static ThreadLocal<String> localVariable = new ThreadLocal<>();

    static void print(String str) {
        // 打印當前線程本地內存中的變量值
        System.out.println(str + ": " + localVariable.get());
        // 清除當前線程本地內存中的變量
        localVariable.remove();
    }

    public static void main(String[] args) {
        // 建立線程A
        Thread threadA = new Thread(new Runnable() {
            @Override
            public void run() {
                // 設置線程A中的本地變量的值
                localVariable.set("threadA localVariable");
                print("threadA");
                // 獲取線程A中的本地變量的值
                System.out.println("threadA remove after: " + localVariable.get());
            }
        });
        // 啓動線程
        threadA.start();
    }
}

運行結果：
threadA: threadA localVariable
threadA remove after: null

案例二：線程惟一標識符生成器，爲每一個調用ThreadId.get()方法的線程建立id。數據結構

public class ThreadId {
    // 下一個要被分配的線程id
    private static final AtomicInteger nextId = new AtomicInteger(0);

    // 線程局部變量
    private static final ThreadLocal<Integer> threadId = new ThreadLocal<Integer>() {
        @Override
        protected Integer initialValue() {
            return nextId.getAndIncrement();
        }
    };

    // 返回當前線程惟一的id
    public static int get() {
        return threadId.get();
    }
}

2、ThreadLocal類的實現原理

在Thread類中有一個threadLocals成員變量，其類型是ThreadLocalMap，默認狀況下爲null。併發

ThreadLocal.ThreadLocalMap threadLocals = null;

當某線程首次調用ThreadLocal變量的get或set方法時，會進行對象建立。在線程退出時，當前線程的threadLocals變量被清空。ide

private void exit() {
    ...
    threadLocals = null;
    inheritableThreadLocals = null;
    ...
}

每一個線程的局部變量不是存放於ThreadLocal實例中，而是存放於線程的threadLocals變量，即線程內存空間中。threadLocals變量本質上是Map數據結構，能夠存放多個ThreadLocal變量鍵值對。性能

【助解】ThreadLocal類能夠看出一個外殼，線程中調用某ThreadLocal變量的set方法能夠將變量值放入到該線程的threadLocals變量中，數據格式是<當前線程中該ThreadLocal變量的this引用，變量值>。當調用線程調用ThreadLocal變量的get方法時，從當前線程的threadLocals變量中取出key（引用）對應的value值。
this

1. ThreadLocal類核心方法--set()

將ThreadLocal變量的當前線程副本的值設置爲指定value值。.net

public void set(T value) {
    // 獲取調用方法的當前線程
    Thread t = Thread.currentThread();
    // 獲取當前線程自身的threadLocals變量
    ThreadLocalMap map = getMap(t);
    if (map != null) 
        // map不爲空，則設置
        map.set(this, value);
    else 
        // map爲空，說明第一次調用，初始化線程的threadLocals變量
        createMap(t, value);
}

ThreadLocalMap getMap(Thread t) {
    return t.threadLocals;
}

void createMap(Thread t, T firstValue) {
    t.threadLocals = new ThreadLocalMap(this, firstValue);
}

線程的threadLocals變量，即ThreadLocal.ThreadLocalMap，是HashMap結構，它的key是當前ThreadLocal的實例對象引用，value值是該ThreadLocal實例對象調用set方法設置的值。線程

2. ThreadLocal類核心方法--T get()

返回ThreadLocal變量在當前線程副本中的值。若是當前線程中沒有該變量的值，返回值會被首次初始化爲initialValue()方法的值。

public T get() {
    // 獲取當前線程以及其threadLocals變量
    Thread t = Thread.currentThread();
    ThreadLocalMap map = getMap(t);
    // 若是threadLocals變量不爲空
    if (map != null) {
        // 根據當前ThreadLocal對象應用獲取Entry，存在則直接返回value值
        ThreadLocalMap.Entry e = map.getEntry(this);
        if (e != null) {
            @SuppressWarnings("unchecked")
            T result = (T)e.value;
            return result;
        }
    }
    // threadLocals爲空，初始化當前線程threadLocals變量
    return setInitialValue();
}

// threadLocals存在，設置初始值；不存在，初始化threadLocals變量
private T setInitialValue() {
    // 返回當前ThreadLocal變量的當前線程初始值
    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;
}

3. ThreadLocal類核心方法--void remove()

當前線程threadLocals變量存在的話，刪除當前線程的ThreadLocal實例對象。

public void remove() {
    ThreadLocal.ThreadLocalMap var1 = this.getMap(Thread.currentThread());
    if (var1 != null) {
        var1.remove(this);
    }
}

3、ThreadLocal.ThreadLocalMap結構分析

ThreadLocal類圖

ThreadLocal是一種存儲變量與線程綁定的方式，在每一個線程中用本身的ThreadLocalMap安全隔離變量，實現線程封閉。

ThreadLocalMap是ThreadLocal內的一個Map實現，沒有實現任何接口，僅用於線程內部存儲ThreadLocal變量值。

static class ThreadLocalMap { ... }

static class Entry extends WeakReference<ThreadLocal<?>> {
    Object value; // ThreadLocal變量值
    Entry(ThreadLocal<?> k, Object v) {
        super(k);
        value = v;
    }
}

底層是Entry數組，Entry的key爲ThreadLocal，value是線程的該ThreadLocal變量值。Entry內部類繼承了WeakReference類。當entry.get()方法獲得的ThreadLocal引用爲空，表示該key再也不被引用，此時Entry對象視爲【過時】，在數組中刪除。

ThreadLocalMap類的字段

private Entry[] table; // 表，必須爲2的冪次方大小
private int size = 0; // 初始Entry數
private int threshold; // resize操做，元素個數閾值
// 負載因子固定爲2/3
private void setThreshold(int len) {
    threshold = len * 2 / 3;
}

構造方法：

ThreadLocalMap(ThreadLocal<?> firstKey, Object firstValue) {
    // 初始化大小爲16的Entry數組
    table = new Entry[INITIAL_CAPACITY];
    // 取模對應數組索引
    int i = firstKey.threadLocalHashCode & (INITIAL_CAPACITY - 1);
    table[i] = new Entry(firstKey, firstValue); // 插入元素
    size = 1; // 更新size
    setThreshold(INITIAL_CAPACITY); // 設置resize閾值，此時爲10
}

1. ThreadLocalMap類之hashcode的計算

ThreadLocal變量與當前線程綁定，在HashMap中做爲key，經過threadLocalHashCode值來查找。

// 自定義hashcode，能夠用來解決同一線程連續構造ThreadLocal對象引發的衝突。
private final int threadLocalHashCode = nextHashCode()

// 下一個hashCode值，原子更新，初始值爲0
private static AtomicInteger nextHashCode = new AtomicInteger();

// 返回下一個hashcode
private static int nextHashCode() {
    return nextHashCode.getAndAdd(HASH_INCREMENT);
}

// 魔數：相鄰兩個hashcode之間的偏移
// 對2的冪次方大小的表，產生近似最優的hash值
private static final int HASH_INCREMENT = 0x61c88647;

2. ThreadLocalMap類之set()方法

設置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; // entry不爲空
         e = tab[i = nextIndex(i, len)]) {
        ThreadLocal<?> k = e.get(); // 獲取Entry的key--ThreadLocal

        // 若是當前Entry的key與形參key相等，更新value值
        if (k == key) {
            e.value = value;
            return;
        }
        // 若是當前Entry的key爲空，說明已過時，作清理！
        if (k == null) {
            // 清理過時Entry，繼續探索放置位置
            replaceStaleEntry(key, value, i); 
            return;
        }
    }

    // 若沒有找到對應key，則在空位置建立Entry
    tab[i] = new Entry(key, value);
    int sz = ++size; // 更新size
    // 清理一些過時的位置，判斷是否須要擴容
    if (!cleanSomeSlots(i, sz) && sz >= threshold)
        rehash();
}

從set方法中，能夠看出ThreadLocalMap中哈希衝突解決方法是開放地址法，而不是HashMap等採用鏈地址法。
先後索引位置--循環

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);
}

（1） replaceStaleEntry()方法

清理過時Entry，設置輸入鍵值對。

// staleSlot：key == null的位置
private void replaceStaleEntry(ThreadLocal<?> key, Object value,
                               int staleSlot) {
    Entry[] tab = table;
    int len = tab.length;
    Entry e;

    // 從前一個位置開始向前尋找過時Entry，直到entry不爲空
    // 不斷向前移動清理位置
    int slotToExpunge = staleSlot; // 清理元素的最開始位置
    for (int i = prevIndex(staleSlot, len); 
         (e = tab[i]) != null;  // entry不爲空
         i = prevIndex(i, len))
        if (e.get() == null)
            slotToExpunge = i; 

    // 從後一個位置向後探索
    for (int i = nextIndex(staleSlot, len);
         (e = tab[i]) != null; // entry不爲空
         i = nextIndex(i, len)) {
        ThreadLocal<?> k = e.get();

        // 若是找到key，須要將它與過時位置元素作交換，來維持哈希表順序。
        if (k == key) {
            e.value = value; // 更新value

            tab[i] = tab[staleSlot]; // 元素交換
            tab[staleSlot] = e; 

            // 若是相等，表示向前遍歷時沒有找到key爲null的元素
            // 前面語句進行了元素交換，此時位置i以前的元素均不須要清理
            if (slotToExpunge == staleSlot)
                slotToExpunge = i; // 更新清理開始位置
            // 從slotToExpunge位置清理過時Entry(key == null)
            cleanSomeSlots(expungeStaleEntry(slotToExpunge), len);
            return;
        }

        // 若是遍歷中找到key爲null的元素，而且向前沒有找到key爲null的位置
        // 更新清理開始位置slotToExpunge爲當前位置i
        if (k == null && slotToExpunge == staleSlot)
            slotToExpunge = i;
    }

    // 若是沒找到key，新建Entry發在staleSlot位置
    tab[staleSlot].value = null; // 清理動做
    tab[staleSlot] = new Entry(key, value);

    // 若是除了staleSlot位置，還有其餘位置元素要清理(key == null的Entry)
    if (slotToExpunge != staleSlot)
        cleanSomeSlots(expungeStaleEntry(slotToExpunge), len);
}

【注】slotToExpunge變量記錄着元素清理的最開始位置。

（2）cleanSomeSlots方法

嘗試掃描一些過時元素的位置，當添加新元素、清理其餘過時元素時被調用。

從i位置開始掃描，i位置不是過時元素。而參數n用來限制掃描次數，若是過時Entry沒有發現，能夠掃描log(n)次，log(n)的設定出於性能的考慮。

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];
        // 遍歷到key==null的Entry
        if (e != null && e.get() == null) {
            n = len; // 重置n
            removed = true; // 標誌有清理元素
            i = expungeStaleEntry(i); // 清理
        }
    } while ( (n >>>= 1) != 0); // log(n) 限制--對數次
    return removed;
}

（3）expungeStaleEntry(int staleSlot) 方法

做用：從staleSlot位置開始，清理key爲null的Entry，直到entry爲null的位置。過程當中，遇到的entry不爲空，而且entry.get()不爲空的元素，進行rehash從新肯定該元素位置。

private int expungeStaleEntry(int staleSlot) {
    Entry[] tab = table;
    int len = tab.length;

    // 清理staleSlot位置的Entry對象
    tab[staleSlot].value = null;
    tab[staleSlot] = null;
    size--;

    // rehash直到entry爲null
    Entry e;
    int i;
    for (i = nextIndex(staleSlot, len);
         (e = tab[i]) != null; // entry不爲null
         i = nextIndex(i, len)) {
        ThreadLocal<?> k = e.get();
        if (k == null) { // 過時Entry，處理方式同staleSlot
            e.value = null;
            tab[i] = null;
            size--;
        } else {
            // rehash計算出當前Entry索引
            int h = k.threadLocalHashCode & (len - 1);
            if (h != i) { // 不相等，說明原位置是探測出的。
                tab[i] = null; // 原位置對象置空

                // 若是h索引位置不爲null，向後探測，直到找到null位置
                while (tab[h] != null)
                    h = nextIndex(h, len);
                tab[h] = e;
            }
        }
    }
    return i; // i位置 (entry = tab[i]) == null
}

3. ThreadLocalMap類之getEntry()方法

根據ThreadLocal獲取對應Entry對象。

private Entry getEntry(ThreadLocal<?> key) {
    // 根據hashcode計算直接hash索引
    int i = key.threadLocalHashCode & (table.length - 1);
    Entry e = table[i];
    // 若是是找到而且是有效Entry對象，直接返回
    if (e != null && e.get() == key)
        return e;
    else // 不是目標Entry
        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) // 找到目標Entry
            return e;
        if (k == null) // 清理過時Entry
            expungeStaleEntry(i);
        else // 當前位置是有效Entry，索引右移
            i = nextIndex(i, len);
        e = tab[i];
    }
    return null; // 找不到，返回null
}

4. ThreadLocalMap類之remove()方法

移除ThreadLocal變量對應的Entry對象。

private void remove(ThreadLocal<?> key) {
    Entry[] tab = table;
    int len = tab.length;
    int i = key.threadLocalHashCode & (len-1);
    // 遍歷找到指定key的Entry對象
    for (Entry e = tab[i];
         e != null;
         e = tab[i = nextIndex(i, len)]) {
        if (e.get() == key) {
            e.clear(); // 清理引用
            expungeStaleEntry(i); // 清理過時Entry
            return;
        }
    }
}

5. ThreadLocalMap類之rehash()方法

private void rehash() {
    // 清理table中全部過時Entry對象。
    expungeStaleEntries();

    // 若是元素個數超過閾值的3/4時，進行擴容
    // 注：閾值自己是數組長度的2/3
    if (size >= threshold - threshold / 4)
        resize();
}
// 擴容至原容量的2倍
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) { // 過時Entry，清空value
                e.value = null; // 利於垃圾回收
            } else {
                // 計算索引
                int h = k.threadLocalHashCode & (newLen - 1);
                // 若是直接hash索引位置不爲空，繼續向後探索
                while (newTab[h] != null)
                    h = nextIndex(h, newLen);
                newTab[h] = e;
                count++;
            }
        }
    }
    setThreshold(newLen); // 更新閾值
    size = count;
    table = newTab;
}

4、ThreadLocal內存泄漏問題

每一個線程的ThreadLocal變量都存放在該線程的threadLocals變量中，若是當前線程一直不退出，這些ThreadLocal變量會一直存在，所以可能會致使內存泄漏。經過調用ThreadLocal類的remove方法避免這一問題。

參考博客的看法

ThreadLocalMap中採用ThreadLocal弱引用做爲Entry的key，若是一個ThreadLocal沒有外部強引用來引用它，下一次系統GC時，這個ThreadLocal必然會被回收，ThreadLocalMap中就會出現key爲null的Entry。

ThreadLocal類的set、get、remove方法均可能觸發對key爲null的Entry清理操做。expungeStaleEntry方法會清空Entry及其value，Entry會在下次GC被回收。

若是當前線程一直在運行，而且一直不執行get、set、remove方法，這些key爲null的Entry的value就會一直存在一條強引用鏈：Thread Ref -> Thread -> ThreadLocalMap -> Entry -> value，致使這些key爲null的Entry的value永遠沒法回收，形成內存泄漏。