簡(jiǎn)介

ThreadLocal可以理解為線程局部變量thread-local variables
ThreadLocal提供了線程內(nèi)存儲(chǔ)變量的能力，這些變量不同之處在于每一個(gè)線程讀取的變量是互相獨(dú)立的。通過ThreadLocal的get和set方法就可以得到當(dāng)前線程對(duì)應(yīng)的值，而不會(huì)影響到其他線程的值

使用

可以看出兩個(gè)線程操作的都是同一個(gè)ThreadLocal變量localVar，但是不同線程保存的值卻是不同的，并且不會(huì)相互影響

package test;

public class ThreadLocalTest {

    static ThreadLocal<String> localVar = new ThreadLocal<>();

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

    public static void main(String[] args) {
        Thread t1  = new Thread(new Runnable() {
            @Override
            public void run() {
                //設(shè)置線程1中本地變量的值
                localVar.set("localVar1");
                //調(diào)用打印方法
                print("thread1");
                //打印本地變量
                System.out.println("after remove : " + localVar.get());
            }
        });

        Thread t2  = new Thread(new Runnable() {
            @Override
            public void run() {
                //設(shè)置線程1中本地變量的值
                localVar.set("localVar2");
                //調(diào)用打印方法
                print("thread2");
                //打印本地變量
                System.out.println("after remove : " + localVar.get());
            }
        });

        t1.start();
        t2.start();
    }
}

image.png

重點(diǎn)類或變量

ThreadLocalMap

查看ThreadLocal的源碼可以發(fā)現(xiàn)ThreadLocal中有一個(gè)靜態(tài)內(nèi)部類ThreadLocalMap，這個(gè)Map可以類比我們常用的HashMap，只是這里解決哈希沖突采用的方法是線性探測(cè)法。table同樣是一個(gè)Entry數(shù)組，Map的key是ThreadLocal，value是我們保存的變量

static class ThreadLocalMap {
    /**
     * 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


//ThreadLocalMap構(gòu)造方法
ThreadLocalMap(ThreadLocal<?> firstKey, Object firstValue) {
        //內(nèi)部成員數(shù)組，INITIAL_CAPACITY值為16的常量
        table = new Entry[INITIAL_CAPACITY];
        //位運(yùn)算，結(jié)果與取模相同，計(jì)算出需要存放的位置
        //threadLocalHashCode比較有趣
        int i = firstKey.threadLocalHashCode & (INITIAL_CAPACITY - 1);
        table[i] = new Entry(firstKey, firstValue);
        size = 1;
        setThreshold(INITIAL_CAPACITY);
}

//Entry為ThreadLocalMap靜態(tài)內(nèi)部類，對(duì)ThreadLocal的弱引用
//同時(shí)讓ThreadLocal和儲(chǔ)值形成key-value的關(guān)系
static class Entry extends WeakReference<ThreadLocal<?>> {
    /** The value associated with this ThreadLocal. */
    Object value;

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

Thread

ThreadLocal.ThreadLocalMap threadLocals = null;

ThreadLocal.ThreadLocalMap inheritableThreadLocals = null;

看到這里我們就很容易明白線程是如何維護(hù)各自變量的，其實(shí)就是通過Thread類的ThreadLocalMap類型變量threadLocals來維護(hù)，Map的key是ThreadLocal，value是我們保存的變量

重點(diǎn)方法

ThreadLocal.get

獲取當(dāng)前線程的ThreadLocalMap，然后以自身作為key去尋找value

public T get() {
    //(1)獲取當(dāng)前線程
    Thread t = Thread.currentThread();
    //(2)獲取當(dāng)前線程的threadLocals變量
    ThreadLocalMap map = getMap(t);
    //(3)如果threadLocals變量不為null，就可以在map中查找到本地變量的值
    if (map != null) {
        ThreadLocalMap.Entry e = map.getEntry(this);
        if (e != null) {
            @SuppressWarnings("unchecked")
            T result = (T)e.value;
            return result;
        }
    }
    //(4)執(zhí)行到此處，threadLocals為null，調(diào)用該更改初始化當(dāng)前線程的threadLocals變量
    return setInitialValue();
}

private T setInitialValue() {
    //protected T initialValue() {return null;}
    T value = initialValue();
    //獲取當(dāng)前線程
    Thread t = Thread.currentThread();
    //以當(dāng)前線程作為key值，去查找對(duì)應(yīng)的線程變量，找到對(duì)應(yīng)的map
    ThreadLocalMap map = getMap(t);
    //如果map不為null，就直接添加本地變量，key為當(dāng)前線程，值為添加的本地變量值
    if (map != null)
        map.set(this, value);
    //如果map為null，說明首次添加，需要首先創(chuàng)建出對(duì)應(yīng)的map
    else
        createMap(t, value);
    return value;
}
    
//ThreadLocalMap中g(shù)etEntry方法
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);
   }

ThreadLocal.set

獲取當(dāng)前線程的ThreadLocalMap，如果不存在則先創(chuàng)建，否則直接放進(jìn)Map

public void set(T value) {
    //(1)獲取當(dāng)前線程（調(diào)用者線程）
    Thread t = Thread.currentThread();
    //(2)以當(dāng)前線程作為key值，去查找對(duì)應(yīng)的線程變量，找到對(duì)應(yīng)的map
    ThreadLocalMap map = getMap(t);
    //(3)如果map不為null，就直接添加本地變量，key為當(dāng)前定義的ThreadLocal變量的this引用，值為添加的本地變量值
    if (map != null)
        map.set(this, value);
    //(4)如果map為null，說明首次添加，需要首先創(chuàng)建出對(duì)應(yīng)的map
    else
        createMap(t, value);
}

ThreadLocal.remove

remove方法判斷該當(dāng)前線程對(duì)應(yīng)的threadLocals變量是否為null，不為null就直接刪除當(dāng)前線程中指定的threadLocals變量

public void remove() {
    //獲取當(dāng)前線程綁定的threadLocals
     ThreadLocalMap m = getMap(Thread.currentThread());
     //如果map不為null，就移除當(dāng)前線程中指定ThreadLocal實(shí)例的本地變量
     if (m != null)
         m.remove(this);
 }

哈希沖突

ThreadLocalMap既然是類似HashMap的結(jié)構(gòu)，那就一定存在哈希沖突，ThreadLocalMap采用線性探測(cè)法來解決哈希沖突

線性探測(cè)法：把table看成一個(gè)環(huán)，假設(shè)當(dāng)前table長(zhǎng)度為16，也就是說如果計(jì)算出來key的hash值為14，如果table[14]上已經(jīng)有值，并且其key與當(dāng)前key不一致，那么就發(fā)生了hash沖突，這個(gè)時(shí)候?qū)?4加1得到15，取table[15]進(jìn)行判斷，這個(gè)時(shí)候如果還是沖突會(huì)回到0，取table[0]，以此類推，直到可以插入

弱引用

ThreadLocal在用作ThreadLocalMap的key時(shí)，是被設(shè)計(jì)為弱引用的。

ThreadLocalMap的內(nèi)部類Entry被設(shè)計(jì)為實(shí)現(xiàn)了WeakReference，Entry用來存放數(shù)據(jù)。在構(gòu)造Entry對(duì)象時(shí)，將傳進(jìn)來的ThreadLocal對(duì)象包裝成了真正的弱引用對(duì)象，而Entry對(duì)象和內(nèi)部的value對(duì)象本身是強(qiáng)引用的。

弱引用的解釋：
只具有弱引用的對(duì)象擁有更短暫的生命周期。在垃圾回收器線程掃描它所管轄的內(nèi)存區(qū)域的過程中，一旦發(fā)現(xiàn)了只具有弱引用的對(duì)象，不管當(dāng)前內(nèi)存空間足夠與否，都會(huì)回收它的內(nèi)存。不過，由于垃圾回收器是一個(gè)優(yōu)先級(jí)很低的線程，因此不一定會(huì)很快發(fā)現(xiàn)那些只具有弱引用的對(duì)象。

簡(jiǎn)單理解就是當(dāng)垃圾回收時(shí)，該對(duì)象只被WeakReference對(duì)象的弱引用字段（T reference）所引用，而未被任何強(qiáng)類型的對(duì)象引用，那么，該弱引用的對(duì)象就會(huì)被回收。

Entry.key為什么采用弱引用

為了讓程序自動(dòng)的對(duì)訪問不到的數(shù)據(jù)進(jìn)行回收提醒

內(nèi)存泄露

image

如圖所示，當(dāng)我們把ThreadLocalRef設(shè)置為null時(shí)，由于Entry中的key由于對(duì)ThreadLocal是是弱引用，此時(shí)ThreadLocal會(huì)被GC回收，我們?cè)赥hreadLocalMap不可能再訪問到這個(gè)key對(duì)應(yīng)的value，但這個(gè)value此時(shí)還存在當(dāng)前線程對(duì)應(yīng)的強(qiáng)引用，假如這個(gè)線程是線程池中的對(duì)象，一直不被訪問的話，value將永遠(yuǎn)無法被GC回收，造成內(nèi)存泄露

解決：ThreadLocal使用完畢及時(shí)調(diào)用remove方法
內(nèi)部?jī)?yōu)化：調(diào)用ThreadLocal的get/set方法時(shí)，在發(fā)生哈希沖突的情況是可能自動(dòng)幫我們清除key為null的Entry的，但還是手動(dòng)調(diào)用remove方法最好

InheritableThreadLocal

ThreadLocal不支持繼承性：同一個(gè)ThreadLocal變量在父線程中被設(shè)置值后，在子線程中是獲取不到的，如果需要這個(gè)功能可以使用InheritableThreadLocal

InheritableThreadLocal 主線程在創(chuàng)建新線程的時(shí)候能夠使新線程繼承主線程的InheritableThreadLocal 內(nèi)保存的值。
ThreadLocalMap中的構(gòu)造函數(shù)會(huì)將父線程的inheritableThreadLocals中的變量復(fù)制一份到子線程的inheritableThreadLocals變量中

TransmittableThreadLocal

github地址：https://github.com/alibaba/transmittable-thread-local

JDK的InheritableThreadLocal類可以完成父線程到子線程的值傳遞。但對(duì)于使用線程池等會(huì)池化復(fù)用線程的執(zhí)行組件的情況，線程由線程池創(chuàng)建好，并且線程是池化起來反復(fù)使用的；這時(shí)父子線程關(guān)系的ThreadLocal值傳遞已經(jīng)沒有意義，應(yīng)用需要的實(shí)際上是把 任務(wù)提交給線程池時(shí)的ThreadLocal值傳遞到 任務(wù)執(zhí)行時(shí)

ThreadLocal的需求場(chǎng)景即TransmittableThreadLocal的潛在需求場(chǎng)景，如果你的業(yè)務(wù)需要『在使用線程池等會(huì)池化復(fù)用線程的執(zhí)行組件情況下傳遞ThreadLocal值』則是TransmittableThreadLocal目標(biāo)場(chǎng)景