ThreadLocal 源碼淺析

首先,什麼是ThreadLocal?

看一下源碼上的定義:

/**
 * This class provides thread-local variables.  These variables differ from
 * their normal counterparts in that each thread that accesses one (via its
 * {@code get} or {@code set} method) has its own, independently initialized
 * copy of the variable.  {@code 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).
 */

英語比較差勁,湊合翻譯一下,大意是threadLoacl會提供線程局部變量,這些變量不同於其他正常的變量,在每個線程中都會有一個獨立的副本,可以通過set和get操作threadLocal中的數據,但是隻會改變本線程中的數據,並不會影響其他線程;

理解起來可能有點繞,看一下代碼,沒有代碼的解釋是沒有靈魂的。。。

  public static void main(String[] args) {

        local=new ThreadLocal<>();
        
        //在主線程中更改變量
        local.set("我是main");
        System.out.println("main:"+local.get());
        
         //在A線程中程中更改變量
        new Thread("ThreadA"){
            @Override
            public void run() {
                super.run();
                local.set("我是ThreadA");
                System.out.println("ThreadA:"+local.get());
            }
        }.start();
        
        //在B線程中程中未對變量進行操作,也沒有初始化
        new Thread("ThreadB"){
            @Override
            public void run() {
                super.run();
                System.out.println("ThreadB:"+local.get());
            }
        }.start();


    }

看一下打印的結果:

System.out: main:我是main
System.out: ThreadA:我是ThreadA
System.out: ThreadB:null

從結果來分析,上面那段註釋就很好理解了,main、threadA、threadB 三個線程中都擁有一個不同的副本,可以通過set和get方法對本線程中的變量進行操作,並不會影響到其他線程的變量;

爲什麼會這樣?

我們從源碼裏面來分析一下:

  1. 爲了方便理解,我們先看一下 ThreadLocalMap
    ThreadLocalMap 是一個爲維護線程本地value自定義的一個hashMap,一般只會在Thread類中使用。
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;
            }
        }
        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);
        }
        
 
        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;
                 e = tab[i = nextIndex(i, len)]) {
                ThreadLocal<?> k = e.get();

                if (k == key) {
                    e.value = value;
                    return;
                }
                if (k == null) {
                //如果k==null,刪除value的引用,防止泄露
                    replaceStaleEntry(key, value, i);
                    return;
                }
            }
            tab[i] = new Entry(key, value);
            int sz = ++size;
            if (!cleanSomeSlots(i, sz) && sz >= threshold)
                rehash();
        }

ThreadLocalMap 的源碼並不複雜,我這裏只看一些比較重要的方法,省略一些無用的代碼,從上述代碼可以看出來threadLocalMap用Entry類來進行存儲,以ThreadLocal 作爲key;在通過set方法或者構造方法進行賦值儲存。在set方法裏面每次調用都會檢查一遍數據,並且會清除key爲null的value

注意: ThreadLocalMap使用ThreadLocal的弱引用作爲key,如果一個ThreadLocal沒有外部強引用來引用它,那麼系統 GC 的時候,這個ThreadLocal勢必會被回收,但是ThreadLocalMap的生命週期卻和Thread一樣長,這樣一來,ThreadLocalMap中就會出現key爲null的Entry,就沒有辦法訪問這些key爲null的Entry的value,如果當前線程再遲遲不結束的話,這些key爲null的Entry的value就會一直存在一條強引用鏈:Thread -> ThreaLocalMap -> Entry -> value永遠無法回收,造成內存泄漏。在set方法裏面每次調用都會檢查一遍,並且會清除key爲null的value,但是最後一次set的值始終會存在,被回收的時候還是有泄露的可能,如果想避免此處泄露,就需要手動調用ThreadLocalMap的remove()方法

  1. 接下來我們繼續看threadLoacal方法

構造方法裏面並沒有進行任何操作,我們直接從set方法開始:

public void set(T value) {
        Thread t = Thread.currentThread();
        //獲取到當前線程中維護的ThreadLocalMap
        ThreadLocalMap map = getMap(t);
        if (map != null)
            //以ThreadLocal爲key將鍵值對進行儲存
            map.set(this, value);
        else
            //初始化並儲存value
            createMap(t, value);
    }
    
 ThreadLocalMap getMap(Thread t) {
        return t.threadLocals;
    } 
    
void createMap(Thread t, T firstValue) {
        t.threadLocals = new ThreadLocalMap(this, firstValue);
    }

set方法很簡單,獲取到當前線程中維護的 ThreadLocalMap,如果尚未初始化,就調用createMap()方法來進行初始化,並以當前的threadLocal爲key進行儲存

  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();
    }
    
    
    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);
        return value;
    }

可以看出來,get方法也是非常簡單的,僅僅是從ThreadLocalMap中取出當前線程的數據,並且在未進行初始化的時候,初始化ThreadLocalMap;setInitialValue方法則是初始化map和設置默認值的方法,可以看到,getMap獲取到的 ThreadLocalMap 爲空,或者當前線程尚未賦值的時候,會在setInitialValue方法中通過initialValue()獲取到默認值,initialValue()默認值爲null,我們可以通過重寫該方法來修改默認值;

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章