ThreadLocal底層原始碼解析

不會上豬的樹發表於2023-12-26
thread原始碼

ThreadLocal底層原始碼解析

ThreadLocal:顧名思義的意思是本地執行緒或者區域性執行緒的意思,其真正含義是希望多個執行緒之間擁有自己的區域性變數,多個執行緒間擁有自己的私人變數,在多執行緒間不被共享,被執行緒單獨享用,這就是ThreadLocal設計之初的原衷

因此,無論是作業系統級別還是程式語言中,我們都能看到ThreadLocal的設計實現.

1.ThreadLocal原理

ThreadLocal如何實現執行緒隔離?

具體來說，ThreadLocal在每個執行緒中維護了一個ThreadLocalMap物件。ThreadLocalMap是一個雜湊表，其中鍵是ThreadLocal變數的引用，值是ThreadLocal變數的值。

具體來看Get方法的實現:

1.1.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;
            }
        }
        return setInitialValue();
    }
  1. 獲取當前執行緒,並獲取當前執行緒的雜湊對映,也就是儲存value的地方,根據當前雜湊對映判斷鍵值對是否存在,不存在則說明未初始化,之後呼叫getEntry方法獲取ThreadLocalMap的entry,也就是存放鍵和值的地方,至於這個鍵值是什麼,後面再看,如果沒有拿到,就同時去進行初始化setInitialvalue.

1.2.setInitialValue初始化方法

在一開始執行緒的區域性變數沒初始化設定好的情況下,這個方法是一定會被呼叫的,因此瞭解他的內部實現是有必要的

 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);
        }
        if (this instanceof TerminatingThreadLocal) {
            TerminatingThreadLocal.register((TerminatingThreadLocal<?>) this);
        }
        return value;
    }
  1. 先初始化他內部的值,這個值預設情況下為null
  2. 然後獲取當前執行緒,根據當前執行緒獲取他的ThreadLocalMap
  3. 如果ThreadLocalMap存在則進行初始化賦值,如果不存在則創造
  4. 最後返回value.
  • 注:ThreadLocal並不是傳統意義上的雜湊對映
  • set方法的實現類似

1.3.ThreadLocalMap的具體實現

static class ThreadLocalMap {

        /**
         * The entries in this hash map extend WeakReference, using
         * its main ref field as the key (which is always a
         * ThreadLocal object).  Note that null keys (i.e. entry.get()
         * == null) mean that the key is no longer referenced, so the
         * entry can be expunged from table.  Such entries are referred to
         * as "stale entries" in the code that follows.
         */
        static class Entry extends WeakReference<ThreadLocal<?>> {
            /** The value associated with this ThreadLocal. */
            Object value;

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

ThreadLocalMap是一個靜態內部類,同樣內部也包含一個靜態內部類Entry,實現其真正value的儲存方式,並繼承弱引用,因此Entry的真正的實現是一個簡單的Object的物件去儲存的value,除此之外還包括幾個重要成員物件

        /**
         * The initial capacity -- MUST be a power of two.
         */
        private static final int INITIAL_CAPACITY = 16;

        /**
         * The table, resized as necessary.
         * table.length MUST always be a power of two.
         */
        private Entry[] table;

        /**
         * The number of entries in the table.
         */
        private int size = 0;

        /**
         * The next size value at which to resize.
         */
        private int threshold; // Default to 0

用來修飾雜湊表的一些重要欄位,雜湊表的真正實現是這個table陣列,而每一個Entry中的value就是其Object物件,根據其內部構造實現,便可以明白這個K也就是鍵是其ThreadLocal物件本身,也就是這個引用

  • 接下來就是面對這個雜湊表時,value的具體儲存實現了

1.4.ThreadLocalMap的set方法

private void set(ThreadLocal<?> key, Object value) {

            // We don't use a fast path as with get() because it is at
            // least as common to use set() to create new entries as
            // it is to replace existing ones, in which case, a fast
            // path would fail more often than not.

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

                if (k == key) {
                    e.value = value;
                    return;
                }

                if (k == null) {
                    replaceStaleEntry(key, value, i);
                    return;
                }
            }

            tab[i] = new Entry(key, value);
            int sz = ++size;
            if (!cleanSomeSlots(i, sz) && sz >= threshold)
                rehash();
        }
  1. 簡言之就是獲取當前ThreadLocal物件的雜湊對映,然後根據當前ThreadLocal計算雜湊值確認索引位置
  2. 獲取索引位置對應的Entry陣列的物件位置,依次向下nextIndex迴圈,每次迴圈拿到對應Entry物件,如果有相同的雜湊值的Entry物件,則將Entry物件的值賦值為value,如果找不到相同雜湊值的Entry物件,那麼呼叫replaceStaleEntry去替換舊的Entry物件
  3. 最後size++(前提是e!=null,也就是說Entry物件不存在,就不會在迴圈裡面走,立刻跳出,賦值一個新的Entry物件),同時判斷size欄位是否大於threshold欄位,並且cleanSomeSlots方法返回false,則進行rehash方法重新雜湊陣列

為什麼需要呼叫cleanSomeSlots方法:這個方法的目的是為了清除一些舊的value物件,也就是Entry物件,底層他會去部分遍歷這個雜湊表,直到n的值為0,也就是sz的值為0,也就是為了避免記憶體的佔用,至於記憶體洩露後面再將

1.5.ThreadLocalMap的remove方法

private void remove(ThreadLocal<?> key) {
            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)]) {
                if (e.get() == key) {
                    e.clear();
                    expungeStaleEntry(i);
                    return;
                }
            }
        }

其思路很清晰,就是查詢相同Entry物件,然後進行清除clear,這個方法實際上是將referent這個欄位設定為null,是Reference中的一個欄位,用來幫助我們進行GC回收的,expungeStaleEntry方法則是真正用來幫我們進行Entry物件和值的回收,設定為null.因此呼叫clear方法實際上就顯式地回收了我們弱引用關聯的物件,避免了記憶體洩漏的問題.而這個referent實際上也就是我們一開始對Entry物件進行初始化的ThreadLocal這個鍵.

1.6.ThreadLocalMap的getEntry方法

這個方法是真正去查詢ThreadLocalMap中對飲Entry物件的方法，具體實現如下：

   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
                return getEntryAfterMiss(key, i, e);
        }
  • 根據雜湊運算得到對應的索引位置，查詢對應的Entry物件,如果找到符合條件就返回,如果沒有就呼叫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;
                if (k == null)
                    expungeStaleEntry(i);
                else
                    i = nextIndex(i, len);
                e = tab[i];
            }
            return null;
        }
  • 這個方法其實也就是雜湊表的開放地址法,沒有類似HashMap去採用鏈地址開放去解決雜湊衝突,因此會一次次向下去尋找,如果發現Entry物件的k為null,那麼呼叫expungeStaleEntry方法,這個方法在此之前也出現過,簡單的英文釋義是:擦去穩定的Entry物件,具體實現後面在看.

1.7.ThreadLocalMap的expungeStaleEntry方法

這個方法的設計比較重要,主要是用於清除沒有用的ThreadLocal,還有進行重新雜湊的一個過程,具體實現如下:

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

            // expunge entry at staleSlot
            tab[staleSlot].value = null;
            tab[staleSlot] = null;
            size--;

            // Rehash until we encounter null
            Entry e;
            int i;
            for (i = nextIndex(staleSlot, len);
                 (e = tab[i]) != null;
                 i = nextIndex(i, len)) {
                ThreadLocal<?> k = e.get();
                if (k == null) {
                    e.value = null;
                    tab[i] = null;
                    size--;
                } else {
                    int h = k.threadLocalHashCode & (len - 1);
                    if (h != i) {
                        tab[i] = null;

                        // Unlike Knuth 6.4 Algorithm R, we must scan until
                        // null because multiple entries could have been stale.
                        while (tab[h] != null)
                            h = nextIndex(h, len);
                        tab[h] = e;
                    }
                }
            }
            return i;
        }
  1. 先將索引位置的key,value置空
  2. 第二步就是rehash去進行清除和運算
  3. 所謂的清除就是對Entry物件的key為null的Entry物件進行一個回收,所謂的運算就是因為在set方法中,解決雜湊衝突的實現是透過開放地址法去解決的,因此在某些Entry物件進行清理之後,這些物件的索引位置重新進行安排

1.8.ThreadLocalMap的cleanSomeSlots部分清除方法

在set方法中,這個方法有使用到,他的真正含義就是去部分清除一些物件

 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];
                if (e != null && e.get() == null) {
                    n = len;
                    removed = true;
                    i = expungeStaleEntry(i);
                }
            } while ( (n >>>= 1) != 0);
            return removed;
        }
  1. 引數解釋：
    • int i：起始索引，指明從哪個位置開始檢查。
    • int n：控制掃描範圍的引數，方法會掃描大約n/2個插槽。
  2. 迴圈掃描：
    • 方法使用一個do-while迴圈來遍歷雜湊表的一部分。
    • 在每次迭代中，它使用nextIndex(i, len)來移動到下一個索引。
    • 如果發現任何條目的ThreadLocal引用為null（意味著沒有執行緒再使用它），則呼叫expungeStaleEntry(i)來清理這個條目，並重置掃描範圍（n = len）。

可以看到這是一種均衡策略,在清除和時間效率上做出的一種決策,如果發現有引用為null的情況,就可能存在垃圾的問題,因此需要去重新呼叫expungeStaleEntry方法進行一個清除,因此這個方法的清理類似抽樣調查

為什麼在set方法最後,如果新增了一個新的Entry就需要去呼叫這個方法?

我的理解是這樣的,如果沒有定期去清除,就不能確保雜湊表的健康和效率,只新增元素而不做任何監控,這對於任何一件事情來說都是一種不可控的風險.因此在時間上,對於我們整個Entry而言,也是區域性抽樣的方式去進行檢查

1.9ThreadLocalMap的replaceStaleEntry方法

這個方法的實現相對於其他方法要複雜很多,其核心思想就是進行Entry的替換

具體實現如下:

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

            // Back up to check for prior stale entry in current run.
            // We clean out whole runs at a time to avoid continual
            // incremental rehashing due to garbage collector freeing
            // up refs in bunches (i.e., whenever the collector runs).
            int slotToExpunge = staleSlot;
            for (int i = prevIndex(staleSlot, len);
                 (e = tab[i]) != null;
                 i = prevIndex(i, len))
                if (e.get() == null)
                    slotToExpunge = i;

            // Find either the key or trailing null slot of run, whichever
            // occurs first
            for (int i = nextIndex(staleSlot, len);
                 (e = tab[i]) != null;
                 i = nextIndex(i, len)) {
                ThreadLocal<?> k = e.get();

                // If we find key, then we need to swap it
                // with the stale entry to maintain hash table order.
                // The newly stale slot, or any other stale slot
                // encountered above it, can then be sent to expungeStaleEntry
                // to remove or rehash all of the other entries in run.
                if (k == key) {
                    e.value = value;

                    tab[i] = tab[staleSlot];
                    tab[staleSlot] = e;

                    // Start expunge at preceding stale entry if it exists
                    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;
            }

            // If key not found, put new entry in stale slot
            tab[staleSlot].value = null;
            tab[staleSlot] = new Entry(key, value);

            // If there are any other stale entries in run, expunge them
            if (slotToExpunge != staleSlot)
                cleanSomeSlots(expungeStaleEntry(slotToExpunge), len);
        }

rehash之前的幾步都很明白,不過多講解,直接從Rehash看起

  • 我們要去思考在key為null的情況下,為什麼會呼叫這個方法

  1. 可以看到這個for迴圈是向前遍歷的,這是一個大前提,在第一個for迴圈中向前查詢第一個key為null的情況,因為一旦遇到Entry物件存在的情況,就會退出,因此回過頭去看set方法時是向後遍歷,與這裡是反向,也就是呼叫這個方法的前提是此Entry物件前的Entry物件的key存在且不是我要替換的key(也就不是相同的雜湊值),但是由於此時此Entry物件前存在的物件如果發生GC的情況下,此時我們存放此Entry物件的位置應該放在前面那一個位置

  2. 因此第一遍掃描是解決了一個同一時間的問題,那下一次for迴圈又是解決什麼問題,如果在我們對索引為2的位置(圖中為null的第一個區域)此時進行了安置,然後前一項發生了GC進行了處理.現在來看迴圈退出條件是Entry物件不為null,也就是說如果遇到適合的位置,為null,則直接進行賦值,和我們的set方法有相似之處,如果沒有說明此時的位置可能存在Entry物件了,後續操作就是如果找到了相同的Key,那麼進行替換,同時if (slotToExpunge == staleSlot)如果滿足,說明 staleSlot 之前沒有需要清理的元素，那麼就將 slotToExpunge 設定 i，意思是從當前元素開始進行清理,因為如果staleSlot之前的位置有需要清理的元素,兩者就不會相等(參考第一個for迴圈).

2.Thread與ThreadLocal與ThreadLocalMap的關係

廢話不多說,上圖:

示例:

public class ThreadLocalExample {

    // 建立三個執行緒區域性變數
    private static final ThreadLocal<Integer> threadLocalVar1 = new ThreadLocal<>();
    private static final ThreadLocal<String> threadLocalVar2 = new ThreadLocal<>();
    private static final ThreadLocal<Boolean> threadLocalVar3 = new ThreadLocal<>();

    public static void main(String[] args) {
        // 執行緒1
        new Thread(() -> {
            threadLocalVar1.set(100);
            threadLocalVar2.set("Hello");
            threadLocalVar3.set(true);

            System.out.println("Thread 1: " + threadLocalVar1.get());
            System.out.println("Thread 1: " + threadLocalVar2.get());
            System.out.println("Thread 1: " + threadLocalVar3.get());
        }).start();

        // 執行緒2
        new Thread(() -> {
            threadLocalVar1.set(200);
            threadLocalVar2.set("World");
            threadLocalVar3.set(false);

            System.out.println("Thread 2: " + threadLocalVar1.get());
            System.out.println("Thread 2: " + threadLocalVar2.get());
            System.out.println("Thread 2: " + threadLocalVar3.get());
        }).start();
    }
}

因此我們實際上發現其實ThreadLocal可以在不同的執行緒之間進行復用,只不過這個具體儲存的value只和每個執行緒獨有的Entry有關.

3.ThreadLocal的記憶體洩露問題

這個問題看到這裡其實就可以很容易的理解了,因為對於Entry物件而言,他的key作為ThreadLocal引用,是一個弱引用物件,也就是說當ThreadLocal物件沒有在被強引用物件引用的時候,當觸發GC就會進行垃圾回收,但Entry物件中的value物件也就是Object物件是未被回收的一個狀態,就可能導致記憶體垃圾的存在,導致記憶體洩漏問題.

如何解決記憶體洩漏問題

在次之前我們看到了如果手動呼叫remove方法是可以避免記憶體洩漏的問題,因此最簡單的方法就是手動呼叫remove方法進行垃圾回收.

相關文章