ThreadLocal簡(jiǎn)介

變量值的共享可以使用public static的形式，所有線(xiàn)程都使用同一個(gè)變量，如果想實(shí)現(xiàn)每一個(gè)線(xiàn)程都有自己的共享變量該如何實(shí)現(xiàn)呢？JDK中的ThreadLocal類(lèi)正是為了解決這樣的問(wèn)題。

ThreadLocal類(lèi)并不是用來(lái)解決多線(xiàn)程環(huán)境下的共享變量問(wèn)題，而是用來(lái)提供線(xiàn)程內(nèi)部的共享變量，在多線(xiàn)程環(huán)境下，可以保證各個(gè)線(xiàn)程之間的變量互相隔離、相互獨(dú)立。在線(xiàn)程中，可以通過(guò)get()/set()方法來(lái)訪(fǎng)問(wèn)變量。ThreadLocal實(shí)例通常來(lái)說(shuō)都是private static類(lèi)型的，它們希望將狀態(tài)與線(xiàn)程進(jìn)行關(guān)聯(lián)。這種變量在線(xiàn)程的生命周期內(nèi)起作用，可以減少同一個(gè)線(xiàn)程內(nèi)多個(gè)函數(shù)或者組件之間一些公共變量的傳遞的復(fù)雜度。

我們先通過(guò)一個(gè)例子來(lái)看一下ThreadLocal的基本用法：

public class ThreadLocalTest {
	static class MyThread extends Thread {
		private static ThreadLocal<Integer> threadLocal = new ThreadLocal<>();
		
		@Override
		public void run() {
			super.run();
			for (int i = 0; i < 3; i++) {
				threadLocal.set(i);
				System.out.println(getName() + " threadLocal.get() = " + threadLocal.get());
			}
		}
	}
	
	public static void main(String[] args) {
		MyThread myThreadA = new MyThread();
		myThreadA.setName("ThreadA");
		
		MyThread myThreadB = new MyThread();
		myThreadB.setName("ThreadB");
		
		myThreadA.start();
		myThreadB.start();
	}
}

運(yùn)行結(jié)果（不唯一）：

ThreadA threadLocal.get() = 0
ThreadB threadLocal.get() = 0
ThreadA threadLocal.get() = 1
ThreadA threadLocal.get() = 2
ThreadB threadLocal.get() = 1
ThreadB threadLocal.get() = 2

雖然兩個(gè)線(xiàn)程都在向threadLocal對(duì)象中set()數(shù)據(jù)值，但每個(gè)線(xiàn)程都還是能取出自己設(shè)置的數(shù)據(jù)，確實(shí)可以達(dá)到隔離線(xiàn)程變量的效果。

ThreadLocal源碼解析

ThreadLocal常用方法介紹

• get()方法：獲取與當(dāng)前線(xiàn)程關(guān)聯(lián)的ThreadLocal值。
• set(T value)方法：設(shè)置與當(dāng)前線(xiàn)程關(guān)聯(lián)的ThreadLocal值。
• initialValue()方法：設(shè)置與當(dāng)前線(xiàn)程關(guān)聯(lián)的ThreadLocal初始值。

當(dāng)調(diào)用get()方法的時(shí)候，若是與當(dāng)前線(xiàn)程關(guān)聯(lián)的ThreadLocal值已經(jīng)被設(shè)置過(guò)，則不會(huì)調(diào)用initialValue()方法；否則，會(huì)調(diào)用initialValue()方法來(lái)進(jìn)行初始值的設(shè)置。通常initialValue()方法只會(huì)被調(diào)用一次，除非調(diào)用了remove()方法之后又調(diào)用get()方法，此時(shí)，與當(dāng)前線(xiàn)程關(guān)聯(lián)的ThreadLocal值處于沒(méi)有設(shè)置過(guò)的狀態(tài)（其狀態(tài)體現(xiàn)在源碼中，就是線(xiàn)程的ThreadLocalMap對(duì)象是否為null），initialValue()方法仍會(huì)被調(diào)用。

initialValue()方法是protected類(lèi)型的，很顯然是建議在子類(lèi)重載該函數(shù)的，所以通常該方法都會(huì)以匿名內(nèi)部類(lèi)的形式被重載，以指定初始值，例如：

public class ThreadLocalTest {
	public static ThreadLocal<Integer> threadLocal = new ThreadLocal<Integer>() {
		@Override
		protected Integer initialValue() {
			return Integer.valueOf(1);
		}
	};
}

remove()方法：將與當(dāng)前線(xiàn)程關(guān)聯(lián)的ThreadLocal值刪除。

實(shí)現(xiàn)原理

ThreadLocal最簡(jiǎn)單的實(shí)現(xiàn)方式就是ThreadLocal類(lèi)內(nèi)部有一個(gè)線(xiàn)程安全的Map，然后用線(xiàn)程的ID作為Map的key，實(shí)例對(duì)象作為Map的value，這樣就能達(dá)到各個(gè)線(xiàn)程的值隔離的效果。

JDK最早期的ThreadLocal就是這樣設(shè)計(jì)的，但是，之后ThreadLocal的設(shè)計(jì)換了一種方式，我們先看get()方法的源碼，然后進(jìn)一步介紹ThreadLocal的實(shí)現(xiàn)方式：

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

get()方法主要做了以下事情：

1、調(diào)用Thread.currentThread()獲取當(dāng)前線(xiàn)程對(duì)象t；

2、根據(jù)當(dāng)前線(xiàn)程對(duì)象，調(diào)用getMap(Thread)獲取線(xiàn)程對(duì)應(yīng)的ThreadLocalMap對(duì)象：

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

threadLocals是Thread類(lèi)的成員變量，初始化為null：

/* ThreadLocal values pertaining to this thread. This map is maintained
     * by the ThreadLocal class. */
ThreadLocal.ThreadLocalMap threadLocals = null;

3、如果獲取的map不為空，則在map中以ThreadLocal的引用作為key來(lái)在map中獲取對(duì)應(yīng)的value e，否則轉(zhuǎn)到步驟5；

4、若e不為null，則返回e中存儲(chǔ)的value值，否則轉(zhuǎn)到步驟5；

5、調(diào)用setInitialValue()方法，對(duì)線(xiàn)程的ThreadLocalMap對(duì)象進(jìn)行初始化操作，ThreadLocalMap對(duì)象的key為T(mén)hreadLocal對(duì)象，value為initialValue()方法的返回值。

從上面的分析中，可以看到，ThreadLocal的實(shí)現(xiàn)離不開(kāi)ThreadLocalMap類(lèi)，ThreadLocalMap類(lèi)是ThreadLocal的靜態(tài)內(nèi)部類(lèi)。每個(gè)Thread維護(hù)一個(gè)ThreadLocalMap映射表，這個(gè)映射表的key是ThreadLocal實(shí)例本身，value是真正需要存儲(chǔ)的Object。這樣的設(shè)計(jì)主要有以下幾點(diǎn)優(yōu)勢(shì)：

• 這樣設(shè)計(jì)之后每個(gè)Map的Entry數(shù)量變小了：之前是Thread的數(shù)量，現(xiàn)在是ThreadLocal的數(shù)量，能提高性能；
• 當(dāng)Thread銷(xiāo)毀之后對(duì)應(yīng)的ThreadLocalMap也就隨之銷(xiāo)毀了，能減少內(nèi)存使用量。

ThreadLocalMap源碼分析

ThreadLocalMap是用來(lái)存儲(chǔ)與線(xiàn)程關(guān)聯(lián)的value的哈希表，它具有HashMap的部分特性，比如容量、擴(kuò)容閾值等，它內(nèi)部通過(guò)Entry類(lèi)來(lái)存儲(chǔ)key和value，Entry類(lèi)的定義為：

static class Entry extends WeakReference<ThreadLocal<?>> {
    /** The value associated with this ThreadLocal. */
    Object value;
 
    Entry(ThreadLocal<?> k, Object v) {
        super(k);
        value = v;
    }
}

Entry繼承自WeakReference，通過(guò)上述源碼super(k);可以知道，ThreadLocalMap是使用ThreadLocal的弱引用作為Key的。

分析到這里，我們可以得到下面這個(gè)對(duì)象之間的引用結(jié)構(gòu)圖（其中，實(shí)線(xiàn)為強(qiáng)引用，虛線(xiàn)為弱引用）：

我們知道，弱引用對(duì)象在Java虛擬機(jī)進(jìn)行垃圾回收時(shí)，就會(huì)被釋放，那我們考慮這樣一個(gè)問(wèn)題：

ThreadLocalMap使用ThreadLocal的弱引用作為key，如果一個(gè)ThreadLocal沒(méi)有外部關(guān)聯(lián)的強(qiáng)引用，那么在虛擬機(jī)進(jìn)行垃圾回收時(shí)，這個(gè)ThreadLocal會(huì)被回收，這樣，ThreadLocalMap中就會(huì)出現(xiàn)key為null的Entry，這些key對(duì)應(yīng)的value也就再無(wú)妨訪(fǎng)問(wèn)，但是value卻存在一條從Current Thread過(guò)來(lái)的強(qiáng)引用鏈。因此只有當(dāng)Current Thread銷(xiāo)毀時(shí)，value才能得到釋放。

該強(qiáng)引用鏈如下：

CurrentThread Ref -> Thread -> ThreadLocalMap -> Entry -> value

因此，只要這個(gè)線(xiàn)程對(duì)象被gc回收，那些key為null對(duì)應(yīng)的value也會(huì)被回收，這樣也沒(méi)什么問(wèn)題，但在線(xiàn)程對(duì)象不被回收的情況下，比如使用線(xiàn)程池的時(shí)候，核心線(xiàn)程是一直在運(yùn)行的，線(xiàn)程對(duì)象不會(huì)回收，若是在這樣的線(xiàn)程中存在上述現(xiàn)象，就可能出現(xiàn)內(nèi)存泄露的問(wèn)題。

那在ThreadLocalMap中是如何解決這個(gè)問(wèn)題的呢？

在獲取key對(duì)應(yīng)的value時(shí)，會(huì)調(diào)用ThreadLocalMap的getEntry(ThreadLocal<?> key)方法，該方法源碼如下：

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

通過(guò)key.threadLocalHashCode & (table.length - 1)來(lái)計(jì)算存儲(chǔ)key的Entry的索引位置，然后判斷對(duì)應(yīng)的key是否存在，若存在，則返回其對(duì)應(yīng)的value，否則，調(diào)用getEntryAfterMiss(ThreadLocal<?>, int, Entry)方法，源碼如下：

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

ThreadLocalMap采用線(xiàn)性探查的方式來(lái)處理哈希沖突，所以會(huì)有一個(gè)while循環(huán)去查找對(duì)應(yīng)的key，在查找過(guò)程中，若發(fā)現(xiàn)key為null，即通過(guò)弱引用的key被回收了，會(huì)調(diào)用expungeStaleEntry(int)方法，其源碼如下：

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

通過(guò)上述代碼可以發(fā)現(xiàn)，若key為null，則該方法通過(guò)下述代碼來(lái)清理與key對(duì)應(yīng)的value以及Entry：

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

此時(shí)，CurrentThread Ref不存在一條到Entry對(duì)象的強(qiáng)引用鏈，Entry到value對(duì)象也不存在強(qiáng)引用，那在程序運(yùn)行期間，它們自然也就會(huì)被回收。expungeStaleEntry(int)方法的后續(xù)代碼就是以線(xiàn)性探查的方式，調(diào)整后續(xù)Entry的位置，同時(shí)檢查key的有效性。

在ThreadLocalMap中的set()/getEntry()方法中，都會(huì)調(diào)用expungeStaleEntry(int)方法，但是如果我們既不需要添加value，也不需要獲取value，那還是有可能產(chǎn)生內(nèi)存泄漏的。所以很多情況下需要使用者手動(dòng)調(diào)用ThreadLocal的remove()函數(shù)，手動(dòng)刪除不再需要的ThreadLocal，防止內(nèi)存泄露。若對(duì)應(yīng)的key存在，remove()方法也會(huì)調(diào)用expungeStaleEntry(int)方法，來(lái)刪除對(duì)應(yīng)的Entry和value。

其實(shí)，最好的方式就是將ThreadLocal變量定義成private static的，這樣的話(huà)ThreadLocal的生命周期就更長(zhǎng)，由于一直存在ThreadLocal的強(qiáng)引用，所以ThreadLocal也就不會(huì)被回收，也就能保證任何時(shí)候都能根據(jù)ThreadLocal的弱引用訪(fǎng)問(wèn)到Entry的value值，然后remove它，可以防止內(nèi)存泄露。

InheritableThreadLocal

InheritableThreadLocal繼承自ThreadLocal，使用InheritableThreadLocal類(lèi)可以使子線(xiàn)程繼承父線(xiàn)程的值，來(lái)看一段示例代碼：

public class ThreadLocalTest {
	private static InheritableThreadLocal<Integer> inheritableThreadLocal = new InheritableThreadLocal<Integer>() {
		@Override
		protected Integer initialValue() {
			return Integer.valueOf(10);
		}
	};
	
	static class MyThread extends Thread {
		@Override
		public void run() {
			super.run();
			System.out.println(getName() + " inheritableThreadLocal.get() = " + inheritableThreadLocal.get());
		}
	}
	
	public static void main(String[] args) {
		System.out.println(Thread.currentThread().getName() + " inheritableThreadLocal.get() = " + inheritableThreadLocal.get());
		
		MyThread myThread = new MyThread();
		myThread.setName("線(xiàn)程A");
		myThread.start();
	}
}

運(yùn)行結(jié)果：

main inheritableThreadLocal.get() = 10

線(xiàn)程A inheritableThreadLocal.get() = 10

可以看到子線(xiàn)程成功繼承了父線(xiàn)程的值。

父線(xiàn)程還可以設(shè)置子線(xiàn)程的初始值，只需要重寫(xiě)InheritableThreadLocal類(lèi)的childValue(T)方法即可，將上述代碼的inheritableThreadLocal 定義修改為如下方式：

private static InheritableThreadLocal<Integer> inheritableThreadLocal = new InheritableThreadLocal<Integer>() {
    @Override
    protected Integer initialValue() {
        return Integer.valueOf(10);
    }
    
    @Override
    protected Integer childValue(Integer parentValue) {
        return Integer.valueOf(5);
    }
};

運(yùn)行結(jié)果為：

main inheritableThreadLocal.get() = 10

線(xiàn)程A inheritableThreadLocal.get() = 5

可以看到，子進(jìn)程成功獲取到了父進(jìn)程設(shè)置的初始值。

使用InheritableThreadLocal類(lèi)需要注意的一點(diǎn)是，如果子線(xiàn)程在取得值的同時(shí)，主線(xiàn)程將InheritableThreadLocal中的值進(jìn)行更改，那子線(xiàn)程獲取的還是舊值。

線(xiàn)程中用來(lái)實(shí)現(xiàn)上述功能的ThreadLocalMap類(lèi)變量為

ThreadLocal.ThreadLocalMap inheritableThreadLocals = null;

InheritableThreadLocal類(lèi)的實(shí)現(xiàn)很簡(jiǎn)單，主要是重寫(xiě)了ThreadLocal類(lèi)的getMap(Thread)方法和createMap(Thread, T)方法，將其中操作的ThreadLocalMap變量修改為了inheritableThreadLocals，這里不再進(jìn)一步敘述。

參考資料

高洪巖：《Java多線(xiàn)程編程核心技術(shù)》

ThreadLocal和synchronized的區(qū)別

到此這篇關(guān)于深入理解Java并發(fā)編程之ThreadLocal 的文章就介紹到這了,更多相關(guān)Java ThreadLocal 內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！