簡(jiǎn)書(shū) 占小狼
轉(zhuǎn)載請(qǐng)注明原創(chuàng)出處，謝謝！

前言

ThreadLocal為變量在每個(gè)線程中都創(chuàng)建了一個(gè)副本，所以每個(gè)線程可以訪問(wèn)自己內(nèi)部的副本變量，不同線程之間不會(huì)互相干擾。本文會(huì)基于實(shí)際場(chǎng)景介紹ThreadLocal如何使用以及內(nèi)部實(shí)現(xiàn)機(jī)制。

應(yīng)用場(chǎng)景

最近的一個(gè)web項(xiàng)目中，由于Parameter對(duì)象的數(shù)據(jù)需要在多個(gè)模塊中使用，如果采用參數(shù)傳遞的方式，顯然會(huì)增加模塊之間的耦合性。先看看用ThreadLocal是如何實(shí)現(xiàn)模塊間共享數(shù)據(jù)的。

class Parameter {
  private static ThreadLocal<Parameter> _parameter= new ThreadLocal<>();
  public static Parameter init() {
      _parameter.set(new Parameter());
  }
  public static Parameter get() {
    _parameter.get();
  }
  ...省略變量聲明
}

1. 在模塊A中通過(guò)Parameter.init初始化。
2. 在模塊B或模塊C中通過(guò)Parameter.get方法可以獲得同一線程中模塊A已經(jīng)初始化的Parameter對(duì)象。

那么，在什么場(chǎng)景下比較適合使用ThreadLocal？stackoverflow上有人給出了還不錯(cuò)的回答。
When and how should I use a ThreadLocal variable?
One possible (and common) use is when you have some object that is not thread-safe, but you want to avoid synchronizing access to that object (I'm looking at you, SimpleDateFormat). Instead, give each thread its own instance of the object.

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

從線程Thread的角度來(lái)看，每個(gè)線程內(nèi)部都會(huì)持有一個(gè)對(duì)ThreadLocalMap實(shí)例的引用，ThreadLocalMap實(shí)例相當(dāng)于線程的局部變量空間，存儲(chǔ)著線程各自的數(shù)據(jù)，具體如下：

ThreadLocal.png

Entry

Entry繼承自WeakReference類(lèi)，是存儲(chǔ)線程私有變量的數(shù)據(jù)結(jié)構(gòu)。ThreadLocal實(shí)例作為引用，意味著如果ThreadLocal實(shí)例為null，就可以從table中刪除對(duì)應(yīng)的Entry。

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

ThreadLocalMap

內(nèi)部使用table數(shù)組存儲(chǔ)Entry，默認(rèn)大小INITIAL_CAPACITY(16)，先介紹幾個(gè)參數(shù)：

• size：table中元素的數(shù)量。
• threshold：table大小的2/3，當(dāng)size >= threshold時(shí)，遍歷table并刪除key為null的元素，如果刪除后size >= threshold*3/4時(shí)，需要對(duì)table進(jìn)行擴(kuò)容。

ThreadLocal.set() 實(shí)現(xiàn)

public void set(T value) {
    Thread t = Thread.currentThread();
    ThreadLocalMap map = getMap(t);
    if (map != null)
        map.set(this, value);
    else
        createMap(t, value);
}

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

從上面代碼中看出來(lái)：

1. 從當(dāng)前線程Thread中獲取ThreadLocalMap實(shí)例。
2. ThreadLocal實(shí)例和value封裝成Entry。

接下去看看Entry存入table數(shù)組如何實(shí)現(xiàn)的：

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) {
            replaceStaleEntry(key, value, i);
            return;
        }
    }

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

1. 通過(guò)ThreadLocal的nextHashCode方法生成hash值。

private static AtomicInteger nextHashCode = new AtomicInteger();
private static int nextHashCode() {    
    return nextHashCode.getAndAdd(HASH_INCREMENT);
}

從nextHashCode方法可以看出，ThreadLocal每實(shí)例化一次，其hash值就原子增加HASH_INCREMENT。

2. 通過(guò) hash & (len -1) 定位到table的位置i，假設(shè)table中i位置的元素為f。
3. 如果f != null，假設(shè)f中的引用為k：

• 如果k和當(dāng)前ThreadLocal實(shí)例一致，則修改value值，返回。
• 如果k為null，說(shuō)明這個(gè)f已經(jīng)是stale(陳舊的)的元素。調(diào)用replaceStaleEntry方法刪除table中所有陳舊的元素（即entry的引用為null）并插入新元素，返回。
• 否則通過(guò)nextIndex方法找到下一個(gè)元素f，繼續(xù)進(jìn)行步驟3。

4. 如果f == null，則把Entry加入到table的i位置中。
5. 通過(guò)cleanSomeSlots刪除陳舊的元素，如果table中沒(méi)有元素刪除，需判斷當(dāng)前情況下是否要進(jìn)行擴(kuò)容。

table擴(kuò)容

如果table中的元素?cái)?shù)量達(dá)到閾值threshold的3/4，會(huì)進(jìn)行擴(kuò)容操作，過(guò)程很簡(jiǎn)單：

private void resize() {
    Entry[] oldTab = table;
    int oldLen = oldTab.length;
    int newLen = oldLen * 2;
    Entry[] newTab = new Entry[newLen];
    int count = 0;

    for (int j = 0; j < oldLen; ++j) {
        Entry e = oldTab[j];
        if (e != null) {
            ThreadLocal<?> k = e.get();
            if (k == null) {
                e.value = null; // Help the GC
            } else {
                int h = k.threadLocalHashCode & (newLen - 1);
                while (newTab[h] != null)
                    h = nextIndex(h, newLen);
                newTab[h] = e;
                count++;
            }
        }
    }

    setThreshold(newLen);
    size = count;
    table = newTab;
}   

1. 新建新的數(shù)組newTab，大小為原來(lái)的2倍。
2. 復(fù)制table的元素到newTab，忽略陳舊的元素，假設(shè)table中的元素e需要復(fù)制到newTab的i位置，如果i位置存在元素，則找下一個(gè)空位置進(jìn)行插入。

ThreadLocal.get() 實(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();
}

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

獲取當(dāng)前的線程的threadLocals。

1. 如果threadLocals不為null，則通過(guò)ThreadLocalMap.getEntry方法找到對(duì)應(yīng)的entry，如果其引用和當(dāng)前key一致，則直接返回，否則在table剩下的元素中繼續(xù)匹配。
2. 如果threadLocals為null，則通過(guò)setInitialValue方法初始化，并返回。

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

總結(jié)

希望通過(guò)本文的介紹，大家可以對(duì)ThreadLocal有一個(gè)更加直觀清晰的認(rèn)識(shí)，而不是只見(jiàn)葉子，不見(jiàn)森林。

END。
我是占小狼。
在魔都艱苦奮斗，白天是上班族，晚上是知識(shí)服務(wù)工作者。
讀完我的文章有收獲，記得關(guān)注和點(diǎn)贊哦，如果非要打賞，我也是不會(huì)拒絕的啦！