ThreadLocal是什么？

該類提供了線程局部 (thread-local) 變量。這些變量不同于它們的普通對應(yīng)物，因?yàn)樵L問某個變量（通過其 get 或 set 方法）的每個線程都有自己的局部變量，它獨(dú)立于變量的初始化副本。ThreadLocal 實(shí)例通常是類中的 private static 字段，它們希望將狀態(tài)與某一個線程（例如，用戶 ID 或事務(wù) ID）相關(guān)聯(lián)。

以上來源官方API。大概可以總結(jié)為兩點(diǎn)：

• 1.ThreadLocal提供get/set方法，可以訪問屬于當(dāng)前線程的變量，也就是可以保證每個線程的變量不一樣。
• 2.ThreadLocal使用時通常定義為private static的。

從字面意思理解，可能會將ThreadLocal認(rèn)為是本地線程，其實(shí)ThreadLocal并不是線程，而是線程Thread的局部變量。

如何使用

首先，定義一個private static的ThreadLocal對象。

private static ThreadLocal<String> threadLocal = new ThreadLocal<>();

然后每個線程可以將當(dāng)前線程需要存放在局部變量中，并且可以從中獲取。

public void setAndGet(String name) {
    threadLocal.set(name);
    String s = threadLocal.get();
}

最后在使用完之后，需要將ThreadLocal中的值移除。

public void remove() {
    threadLocal.remove();
}

原理

那么ThreadLocal是如何做到保證每個線程get出來的數(shù)據(jù)不一樣的呢？我們通過源碼來看一下。

public void set(T value) {
    Thread t = Thread.currentThread();
    // 通過當(dāng)前線程獲取出來一個ThreadLocalMap
    ThreadLocalMap map = getMap(t);
    if (map != null)
        map.set(this, value);
    else
        createMap(t, value);
}
void createMap(Thread t, T firstValue) {
    t.threadLocals = new ThreadLocalMap(this, firstValue);
}

我們發(fā)現(xiàn)在set方法中，會創(chuàng)建一個ThreadLocalMap，然后將要設(shè)置的值放在這個Map中，而當(dāng)前這個ThreadLocal對象作為key；

然后再將這個ThreadLocalMap賦值給Thread的threadLocals里。如果去看Thread類的代碼會發(fā)現(xiàn)，在Thread類中存在兩個變量threadLocals和inheritableThreadLocals，它們的類型就是ThreadLocal.ThreadLocalMap。通過下圖可以看出Thread，ThreadLocal，ThreadLocalMap三者的關(guān)系。

這時候我們再看看get()和remove()方法的代碼。

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

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

public void remove() {
    ThreadLocalMap m = getMap(Thread.currentThread());
    if (m != null)
        m.remove(this);
}

可以看出來，和我們上面圖中的結(jié)構(gòu)一樣，get()方法就是從Thread中取出來ThreadLocalMap，然后通過ThreadLocal對象作為Key取出值；remove()方法則是取出ThreadLocalMap將ThreadLocal對應(yīng)的數(shù)據(jù)移除。

那么ThreadLocalMap到底是什么呢？是java.util.Map接口的子類嗎？我們來看源碼。

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;
        }
    }
    private static final int INITIAL_CAPACITY = 16;
    private Entry[] table;
    private int size = 0;
    private int threshold; // Default to 0
    // 省略其他代碼
}

通過源碼發(fā)現(xiàn)，ThreadLocalMap并沒有實(shí)現(xiàn)Map接口，也沒有集成其他任何的Map類。是定義在ThreadLocal類中的一個靜態(tài)內(nèi)部類。而它的結(jié)構(gòu)和HashMap結(jié)構(gòu)極其相似。有一個Entry[]數(shù)組存放數(shù)據(jù)。而這個Entry類是繼承自WeakReference類的子類，這一點(diǎn)和HashMap有所不同。

ThreadLocalMap和HashMap結(jié)構(gòu)有很多不同，但是還有一點(diǎn)和HashMap不一樣，我們來看一下ThreadLocalMap的set方法。

private void set(ThreadLocal<?> key, Object value) {
    Entry[] tab = table;
    int len = tab.length;
    // 計算key對應(yīng)放在tab中的下標(biāo)
    int i = key.threadLocalHashCode & (len-1);

    //循環(huán)遍歷tab,首先獲取到下標(biāo)i對應(yīng)的對象，如果不為空,則執(zhí)行循環(huán)體
    // 如果不是相同的threadLocal或者位置失效，則要尋找下一個位置。
    for (Entry e = tab[i];
         e != null;
         e = tab[i = nextIndex(i, len)]) {
        ThreadLocal<?> k = e.get();
	    // 判斷與當(dāng)前ThreadLocal是否是同一個對象，如果是則進(jìn)行值替換，結(jié)束
        if (k == key) {
            e.value = value;
            return;
        }
		// 如果k==null代表threadLocal的key失效了，將失效的key進(jìn)行替換
        if (k == null) {
            replaceStaleEntry(key, value, i);
            return;
        }
    }

    tab[i] = new Entry(key, value);
    int sz = ++size;
    if (!cleanSomeSlots(i, sz) && sz >= threshold)
        rehash();
}

代碼中循環(huán)遍歷tab,首先獲取到下標(biāo)i對應(yīng)的對象，如果不為空,則執(zhí)行循環(huán)體，如果在循環(huán)體中的兩個條件都不滿足，則會執(zhí)行nextIndex()方法，這個方法的代碼如下：

private static int nextIndex(int i, int len) {
    return ((i + 1 < len) ? i + 1 : 0);
}

這個方法的邏輯就是開放尋址法。而HashMap則是通過拉鏈法和rehash來做的。

哪些場景使用

通過上面的內(nèi)容基本可以掌握ThreadLocal的基本用法，那么ThreadLocal主要在什么場景中使用呢。

ThreadLocal的作用通過以上了解我們知道主要是用來做線程間數(shù)據(jù)隔離。那么在什么場景下能用到線程隔離呢？

首先想到的就是SimpleDateFormat這個工具類，它不是線程安全的，可以通過ThreadLocal在每個線程中放一份，保證線程安全。

還有比如說用戶登錄的session，或者token數(shù)據(jù)，只數(shù)據(jù)當(dāng)前會話線程，也可以通過ThreadLocal存儲。

再比如在某些場景下，上下文數(shù)據(jù)在不同方法之間調(diào)用，傳遞起來非常麻煩，可以通過ThreadLocal存放，只需要在需要用到的地方獲取就可以。

除了這些場景，在某些框架源碼中也會使用到，比如Spring中的事務(wù)也主要是通過ThreadLocal和面向切面編程AOP實(shí)現(xiàn)的，感興趣的同學(xué)可以查看源碼了解。

避免踩坑

內(nèi)存泄漏

ThreadLocalMap中的Entry的Key是一個弱引用，因此如果在使用后不調(diào)用remove方法清除掉會導(dǎo)致對應(yīng)的value內(nèi)存泄漏。所以在使用完以后一定要記得調(diào)用remove方法清除數(shù)據(jù)。

以上就是java并發(fā)編程之ThreadLocal詳解的詳細(xì)內(nèi)容，更多關(guān)于java并發(fā)編程 ThreadLocal的資料請關(guān)注腳本之家其它相關(guān)文章！

最新評論