結合源碼談談ThreadLocal!

網上有很多關於ThreadLocal的介紹,有的介紹比較簡單,也有的介紹很複雜,比較難懂,今天,自己結合它的源碼,也做個簡易梳理,記錄如下!

ThreadLocal的作用

在多請求並發訪問過程中,我們往往需要將一個指定變數隔離起來,達到只對當前執行緒可用,其他執行緒不可用的效果,因此,我們就會使用到ThreadLocal來實現。

實現原理其實就是在每個執行緒中維護了一個Map結構(ThreadLocalMap,它是ThreadLocal中的靜態內部類),ThreadLocal對象為Key,需要隔離的值為Value。為了達到執行緒全局可用,我們往往將ThreadLocal聲明為全局靜態變數。

Thread中的ThreadLocalMap對象

Thread中的ThreadLocalMap對象

那麼ThreadLocal具體如何做到執行緒隔離的?我們下面做具體分析!

ThreadLocal

我們暫時先不分析ThreadLocalMap,單獨來看ThreadLocal的幾個方法源碼介紹!

1.對象初始化

ThreadLocal初始化比較簡單!

public static final ThreadLocal<String> THREAD_LOCAL = new ThreadLocal<>();

我們往往在初始化時會給他指定一個默認值,不指定的話,默認值為null,這裡有兩種指定方式:

第一種:直接複寫ThreadLocal中的initialValue方法
第二種:利用函數式編程,創建SuppliedThreadLocal對象,由get方法直接返回初始值

public static final ThreadLocal<String> THREAD_LOCAL = new ThreadLocal<String>(){
    @Override
    protected String initialValue() {
        return "Test";
    }
};
public static final ThreadLocal<String> THREAD_LOCAL = ThreadLocal.withInitial(()->"Test");

SuppliedThreadLocal對象是對ThreadLocal的一個特定實現,通過構造函數傳入Supplier,再由實現的initialValue方法返回supplier.get()的結果,其他也沒什麼可多介紹的。

2.獲取變數

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方法我們可以看到,ThreadLocal是從當前執行緒中獲取到了ThreadLocalMap對象,然後取出其中的Entry.Value值,如果對象不存在就返回初始值,初始化方法initialValue會在這裡調用一次,其他操作不再調用。

3.設置變數

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

set方法與get方法一樣,會通過當前執行緒取出ThreadLocalMap對象,然後將當前ThreadLocal對象作為Key,存儲Value值,ThreadLocalMap不存在時,會創建新的Map。

4.移除變數

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

移除變數同樣是根據currentThread來找到的Map,然後對當前ThreadLocal做remove操作。

ThreadLocalMap

通過ThreadLocal的操作介紹我們可以看到,ThreadLocal的操作都是基於ThreadLocalMap來實現的,所以,ThreaLocalMap才是我們對ThreadLocal變數實現執行緒隔離的重點。

1.Entry

ThreadLocalMap中存儲數據關係的是Entry,它的Key是ThreadLocal對象,採用弱引用,Value是一個強引用對象Object。當Entry.get()獲取的ThreadLocal為Null時,GC回收將直接清除該對象,但Value對象,需要我們手動清除,所以,我們需要在每個ThreadLocal調用結束時,執行remove方法。關於弱引用與強引用的關係以及他們的對象回收機制,這裡不做過多介紹,有興趣的同學可以自行學習!

static class Entry extends WeakReference<ThreadLocal<?>> {
    /** The value associated with this ThreadLocal. */
    Object value;

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

2.初始化

ThreadLocalMap的操作是基於Entry[]數組table完成的,數組初始化大小為16。table是一個2的N次方的數組,ThreadLocal通過AtomicInteger類型的nextHashCode,每次偏移HASH_INCREMENT=0x61c88647的大小來實現數據在數組上的平均分布。

關於Entry[]中如何解決碰撞衝突問題,可以參考:ThreadLocal 和神奇的數字 0x61c88647

ThreadLocalMap(ThreadLocal<?> firstKey, Object firstValue) {
    table = new Entry[INITIAL_CAPACITY];
    int i = firstKey.threadLocalHashCode & (INITIAL_CAPACITY - 1);
    table[i] = new Entry(firstKey, firstValue);
    size = 1;
    setThreshold(INITIAL_CAPACITY);
}

3.獲取Entry

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

查詢table中的Entry值時,採用神奇的0x61c88647,ThreadLocal對象作為Key與Entry的Key相同時,返回此Entry,否則,採用開放定址法,從i開始迭代查找Entry。

4.設置Entry

private void set(ThreadLocal<?> key, Object value) {

  // We don't use a fast path as with get() because it is at
  // least as common to use set() to create new entries as
  // it is to replace existing ones, in which case, a fast
  // path would fail more often than not.

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

set方法中兼容新增與修改操作,如果找到同一個ThreadLocal對應的Entry時,則直接重新賦值Value,否則新建Entry執行table[i]。

5.移除Entry

private void remove(ThreadLocal<?> key) {
    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)]) {
        if (e.get() == key) {
            e.clear();
            expungeStaleEntry(i);
            return;
        }
    }
}

remove操作同樣通過循環table,找到Key相同的ThreadLocal對象,然後通過指定弱引用的Key值為Null移除,並將table[i].value也置為Null。

持續更新中…

Tags: