ThreadLocal 核心源碼解析

時間  2020-05-09
標籤 threadlocal 核心 源碼 解析 欄目 Java 简体版
原文   原文鏈接

1 前言

此類提供線程本地變量。這些變量與普通變量不一樣，由於每一個訪問一個變量（經過其get或set方法）的線程都有其本身的，獨立初始化的變量副本。 ThreadLocal 實例一般是指望將狀態與線程(例如，用戶ID或事務ID)關聯的類中的 private static 字段。java

例如，下面的類生成每一個線程本地的惟一標識符。線程的ID是在第一次調用ThreadId.get() 時賦值的，而且在之後的調用中保持不變。算法

圖片標題
  只要線程是活躍的而且 ThreadLocal 實例是可訪問的，則每一個線程都對其線程本地變量的副本持有隱式的引用。線程消失後，線程本地實例的全部副本都會被 GC（除非存在對這些副本的其餘引用）。

2 繼續體系

  • 繼承?不存在的,這其實也是 java.lang 包下的工具類 數組

    圖片標題

  • 可是 ThreadLocal 定義帶有泛型，說明能夠儲存任意格式的數據. 安全

    圖片標題

3 屬性

  • ThreadLocal 依賴於附加到每一個線程（Thread.threadLocals和InheritableThreadLocals）的線程線性探測哈希表. ThreadLocal 對象充當鍵，經過 threadLocalHashCode 進行搜索。這是一個自定義哈希碼(僅在ThreadLocalMaps 中有用)，它消除了在相同線程使用連續構造的threadlocal的常見狀況下的衝突，而在不太常見的狀況下仍然表現良好。 一句話總結: ThreadLocal 經過這樣的 hashCode，計算當前 ThreadLocal 在 ThreadLocalMap 中的索引 數據結構

    圖片標題
    圖片標題

  • 連續生成的哈希碼之間的差值,關於該值的設定,可參考文章ThreadLocal的hash算法（關於 0x61c88647） 工具

    圖片標題

  • 注意 static 修飾,ThreadLocalMap 會被 set 多個 ThreadLocal ，而多個 ThreadLocal 就根據 threadLocalHashCode 區分 post

    圖片標題

4 ThreadLocalMap

ThreadLocalMap 是自定義的哈希表，僅適用於維護線程本地的值。沒有操做導出到ThreadLocal類以外。 該類是包私有的，容許在 Thread 類中的字段聲明。爲了幫助處理很是長的使用壽命，哈希表節點使用 WeakReferences 做爲鍵。可是，因爲不使用引用隊列，所以僅在表空間不足時，才保證刪除過期的節點。性能

static class ThreadLocalMap {

        /** * 此哈希表中的節點使用其主引用字段做爲鍵（始終是一個 ThreadLocal 對象） * 繼承了 WeakReference。 * 請注意，空鍵（即entry.get（）== null）意味着再也不引用該鍵，所以能夠從表中刪除該節點。 * 在下面的代碼中，此類節點稱爲 "stale entries" */
        static class Entry extends WeakReference<ThreadLocal<?>> {
            /** 與此 ThreadLocal 關聯的值 */
            Object value;

            Entry(ThreadLocal<?> k, Object v) {
                super(k);
                value = v;
            }
        }

        /** * 初始容量 -- 必須是 2 的冪 */
        private static final int INITIAL_CAPACITY = 16;

        /** * table 數組,必要時擴容 * table.length 必須是 2 的冪 */
        private Entry[] table;

        /** * table 中的節點個數 */
        private int size = 0;

        /** * 下一次擴容的閾值 */
        private int threshold; // 默認爲 0
複製代碼

特色

  • key 是 ThreadLocal 的引用
  • value 是 ThreadLocal 保存的值
  • 數組的數據結構

5 set

5.1 ThreadLocal#set

將此線程本地變量的當前線程副本設置爲指定值。大多數子類將不須要重寫此方法，而僅依靠initialValue方法來設置線程本地變量的值。this

圖片標題

執行流程

  1. 獲取當前線程
  2. 獲取線程所對應的ThreadLocalMap，從這能夠看出每一個線程都是獨立的,因此此方法自然線程安全
  3. 判斷 map 是否爲 null
    • 否，則 K.V 對賦值，k 爲this,即當前的 ThreaLocal 對象
    • 是，則初始化一個 ThreadLocalMap 來維護 K.V 對

來具體看看ThreadLocalMap中的 setspa

5.2 ThreadLocalMap#set

private void set(ThreadLocal<?> key, Object value) {
    // 新引用指向 table
    Entry[] tab = table;
    int len = tab.length;
    // 獲取對應 ThreadLocal 在table 中的索引,注意這裏是 hashCode 與 2 冪次長度-1(想起來爲何這樣計算更好了嗎?)
    int i = key.threadLocalHashCode & (len-1);

    /** * 從該下標開始循環遍歷 * 一、如遇相同key，則直接替換value * 二、若是該key已經被回收失效，則替換該失效的key */
    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 被清理了,則替換當前失效的 k
        if (k == null) {
            replaceStaleEntry(key, value, i);
            return;
        }
    }
    // 找到空位，建立節點並插入
    tab[i] = new Entry(key, value);
    // table內元素size自增
    int sz = ++size;
    // 達到閾值(數組大小的三分之二)時，執行擴容
    if (!cleanSomeSlots(i, sz) && sz >= threshold)
        rehash();
}
複製代碼

注意經過 hashCode 計算的索引位置 i 處若是已經有值了，會從 i 開始，經過 +1 不斷的日後尋找，直到找到索引位置爲空的地方，把當前 ThreadLocal 做爲 key 放進去。

6 get

public T get() {
    // 獲取當前線程
    Thread t = Thread.currentThread();
    // 獲取當前線程對應的ThreadLocalMap
    ThreadLocalMap map = getMap(t);

    // 若是map不爲空
    if (map != null) {
        // 取得當前ThreadLocal對象對應的Entry
        ThreadLocalMap.Entry e = map.getEntry(this);
        // 若是不爲空，讀取當前 ThreadLocal 中保存的值
        if (e != null) {
            @SuppressWarnings("unchecked")
            T result = (T)e.value;
            return result;
        }
    }
    // 不然都執行 setInitialValue
    return setInitialValue();
}
複製代碼

private T setInitialValue() {
    // 獲取初始值，通常是子類重寫
    T value = initialValue();

    // 獲取當前線程
    Thread t = Thread.currentThread();

    // 獲取當前線程對應的ThreadLocalMap
    ThreadLocalMap map = getMap(t);

    // 若是map不爲null
    if (map != null)

        // 調用ThreadLocalMap的set方法進行賦值
        map.set(this, value);

    // 不然建立個ThreadLocalMap進行賦值
    else
        createMap(t, value);
    return value;
}
複製代碼

接着咱們來看下

ThreadLocalMap#getEntry

// 獲得當前 thradLocal 對應的值，值的類型是由 thradLocal 的泛型決定的
// 因爲 thradLocalMap set 時解決數組索引位置衝突的邏輯，致使 thradLocalMap get 時的邏輯也是對應的
// 首先嚐試根據 hashcode 取模數組大小-1 = 索引位置 i 尋找，找不到的話，自旋把 i+1，直到找到索引位置不爲空爲止
private Entry getEntry(ThreadLocal<?> key) {
    // 計算索引位置：ThreadLocal 的 hashCode 取模數組大小-1
    int i = key.threadLocalHashCode & (table.length - 1);
    Entry e = table[i];
    // e 不爲空，而且 e 的 ThreadLocal 的內存地址和 key 相同，直接返回，不然就是沒有找到，繼續經過 getEntryAfterMiss 方法找
    if (e != null && e.get() == key)
        return e;
    else
    // 這個取數據的邏輯，是由於 set 時數組索引位置衝突形成的 
        return getEntryAfterMiss(key, i, e);
}
// 自旋 i+1，直到找到爲止
private Entry getEntryAfterMiss(ThreadLocal<?> key, int i, Entry e) {
    Entry[] tab = table;
    int len = tab.length;
    // 在大量使用不一樣 key 的 ThreadLocal 時，其實還蠻耗性能的
    while (e != null) {
        ThreadLocal<?> k = e.get();
        // 內存地址同樣，表示找到了
        if (k == key)
            return e;
        // 刪除沒用的 key
        if (k == null)
            expungeStaleEntry(i);
        // 繼續使索引位置 + 1
        else
            i = nextIndex(i, len);
        e = tab[i];
    }
    return null;
}
複製代碼

6 擴容

ThreadLocalMap 中的 ThreadLocal 的個數超過閾值時，ThreadLocalMap 就要開始擴容了，咱們一塊兒來看下擴容的邏輯：

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) {
                e.value = null; // Help the GC
            } else {
                // 計算 ThreadLocal 在新數組中的位置
                int h = k.threadLocalHashCode & (newLen - 1);
                // 若是索引 h 的位置值不爲空，日後+1，直到找到值爲空的索引位置
                while (newTab[h] != null)
                    h = nextIndex(h, newLen);
                // 給新數組賦值
                newTab[h] = e;
                count++;
            }
        }
    }
    // 給新數組初始化下次擴容閾值，爲數組長度的三分之二
    setThreshold(newLen);
    size = count;
    table = newTab;
}
複製代碼

源碼註解也比較清晰，咱們注意兩點：

擴容後數組大小是原來數組的兩倍； 擴容時是絕對沒有線程安全問題的，由於 ThreadLocalMap 是線程的一個屬性，一個線程同一時刻只能對 ThreadLocalMap 進行操做，由於同一個線程執行業務邏輯必然是串行的，那麼操做 ThreadLocalMap 必然也是串行的。

7 總結

ThreadLocal 是很是重要的 API，咱們在寫一箇中間件的時候常常會用到，好比說流程引擎中上下文的傳遞，調用鏈ID的傳遞等等，很是好用，但坑也不少。

相關文章
相關標籤/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公眾號
   歡迎關注本站公眾號,獲取更多信息
聯繫我們 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程