深刻淺出ThreadLocal

前言

ThreadLocal爲變量在每一個線程中都建立了一個副本，因此每一個線程能夠訪問本身內部的副本變量，不一樣線程之間不會互相干擾。本文會基於實際場景介紹ThreadLocal如何使用以及內部實現機制。

應用場景

Parameter對象的數據須要在多個模塊中使用，若是採用參數傳遞的方式，顯然會增長模塊之間的耦合性。先看看用ThreadLocal是如何實現模塊間共享數據的。

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中經過Parameter.init初始化。
2. 在模塊B或模塊C中經過Parameter.get方法能夠得到同一線程中模塊A已經初始化的Parameter對象。

實現原理

從線程Thread的角度來看，每一個線程內部都會持有一個對ThreadLocalMap實例的引用，ThreadLocalMap實例至關於線程的局部變量空間，存儲着線程各自的數據，具體以下：

 

Entry

Entry繼承自WeakReference類，是存儲線程私有變量的數據結構。ThreadLocal實例做爲引用，意味着若是ThreadLocal實例爲null，就能夠從table中刪除對應的Entry。

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

ThreadLocalMap

內部使用table數組存儲Entry，默認大小INITIAL_CAPACITY(16)，先介紹幾個參數：

• size：table中元素的數量。
• threshold：table大小的2/3，當size >= threshold時，遍歷table並刪除key爲null的元素，若是刪除後size >= threshold*3/4時，須要對table進行擴容。

ThreadLocal.set() 實現

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

從上面代碼中看出來：

1. 從當前線程Thread中獲取ThreadLocalMap實例。
2. ThreadLocal實例和value封裝成Entry。

接下去看看Entry存入table數組如何實現的：

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. 經過ThreadLocal的nextHashCode方法生成hash值。

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

   從nextHashCode方法能夠看出，ThreadLocal每實例化一次，其hash值就原子增長HASH_INCREMENT。
   2. 經過 hash & (len -1) 定位到table的位置i，假設table中i位置的元素爲f。
   3. 若是f != null，假設f中的引用爲k：
   • 若是k和當前ThreadLocal實例一致，則修改value值，返回。
   • 若是k爲null，說明這個f已是stale(陳舊的)的元素。調用replaceStaleEntry方法刪除table中全部陳舊的元素（即entry的引用爲null）並插入新元素，返回。
   • 不然經過nextIndex方法找到下一個元素f，繼續進行步驟3。
   4. 若是f == null，則把Entry加入到table的i位置中。
   5. 經過cleanSomeSlots刪除陳舊的元素，若是table中沒有元素刪除，需判斷當前狀況下是否要進行擴容。
   table擴容
   若是table中的元素數量達到閾值threshold的3/4，會進行擴容操做，過程很簡單：

   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. 新建新的數組newTab，大小爲原來的2倍。
   2. 複製table的元素到newTab，忽略陳舊的元素，假設table中的元素e須要複製到newTab的i位置，若是i位置存在元素，則找下一個空位置進行插入。

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

   獲取當前的線程的threadLocals。

   1. 若是threadLocals不爲null，則經過ThreadLocalMap.getEntry方法找到對應的entry，若是其引用和當前key一致，則直接返回，不然在table剩下的元素中繼續匹配。
   2. 若是threadLocals爲null，則經過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;
      }

      總結
      但願經過本文的介紹，你們能夠對ThreadLocal有一個更加直觀清晰的認識。