Java多執行緒與併發之ThreadLocal

JAVA一方發表於2020-02-17

1. ThreadLocal是什麼?使用場景

ThreadLocal簡介

ThreadLocal是執行緒本地變數,可以為多執行緒的併發問題提供一種解決方式,當使用ThreadLocal維護變數時,ThreadLocal為每個使用該變數的執行緒提供獨立的變數副本,所以每一個執行緒都可以獨立地改變自己的副本,而不會影響其它執行緒所對應的副本。

ThreadLocal使用場景

多個執行緒去獲取一個共享變數時,要求獲取的是這個變數的初始值的副本。每個執行緒儲存這個變數的副本,對這個變數副本的改變不去影響變數本身。適用於多個執行緒依賴不同變數值完成操作的場景。比如:

  • 多資料來源的切換
  • spring宣告式事務

2. ThreadLocal的使用案例

ThreadLocal類介面:

  • void set(T value):設定當前執行緒的執行緒區域性變數的值
  • T get():獲取當前執行緒所對應的執行緒區域性變數
  • void remove():刪除當前執行緒區域性變數的值,目的是為了減少記憶體的佔用
  • T initialValue():該執行緒區域性變數的初始值(預設值為null),該方法是一個protected的懶載入方法,執行緒第1次呼叫get()或set(T value)時才執行在,而且也是為了讓子類覆蓋而設計的。
public class ThreadLocalDemo {
    private static ThreadLocal<Index> index = new ThreadLocal(){
        @Override
        protected Object initialValue() {
            return new Index();
        }
    };

    private static class Index{
        private int num;

        public void incr(){
            num++;
        }
    }

    public static void main(String[] args) {
        for(int i=0; i<5; i++){
            new Thread(() ->{
                Index local = index.get();
                local.incr();
                System.out.println(Thread.currentThread().getName() + " " + index.get().num);
            }, "thread_" + i).start();
        }
    }
}複製程式碼

輸出結果:

thread_1 1
thread_0 1
thread_3 1
thread_4 1
thread_2 1

可以看到每個執行緒的獲取的初始值都是0,並且對num++的操作也互不影響

3.ThreadLocal如何實現的

3.1 ThreadLocal的資料結構

ThreadLocal內部維護的是一個類似Map的ThreadLocalMap資料結構,而每個Thread類,都有一個ThreadLocalMap成員變數。ThreadLocalMap將執行緒本地變數(ThreadLocal)作為key,執行緒變數的副本作為value,如圖所示:

需要注意的是ThreadLocal中的Entry的key和value的關係有系統進行維護,若維護不當則可能導致多執行緒狀態下的不安全(一般不會,至少需要注意)。

3.2 get()原始碼分析

  public T get() {
          //獲取當前執行緒
          Thread t = Thread.currentThread();
          //獲取當前執行緒的ThreadLocalMap
          ThreadLocalMap map = getMap(t);
          if (map != null) {
              //如果ThreadLocalMap已經被建立了,那麼通過當前的threadLocal物件作為key,獲取value
              ThreadLocalMap.Entry e = map.getEntry(this);
              if (e != null) {
                  @SuppressWarnings("unchecked")
                  T result = (T)e.value;
                  return result;
              }
          }
          //如果ThreadLocalMap還沒有被建立或者在ThreadLocalMap中查詢不到此元素
          return setInitialValue();
      }複製程式碼

3.2.1 ThreadLocalMap沒初始化

ThreadLocalMap沒初始化,ThreadLocalMap為null時,會呼叫setInitialValue()方法:

  private T setInitialValue() {
          //initialValue方法一般會被重寫,不重寫的話,直接返回null
          T value = initialValue();
          Thread t = Thread.currentThread();
          //獲取當前執行緒的ThreadLocalMap
          ThreadLocalMap map = getMap(t);
          if (map != null)
              //ThreadLocalMap已經被建立,那麼直接設定初始值(即儲存變數副本),初始值來自initialValue方法
              map.set(this, value);
          else
              //建立ThreadLocalMap
              createMap(t, value);
          return value;
      }複製程式碼
其中,initialValue()方法是由我們重寫的,需要注意的是,返回值必須為new一個物件,而不是直接返回一個物件引用。因為如果多個執行緒都儲存同一個引用的副本的話,那他們通過這個引用修改共享變數的值,是相互影響的。我們本來的目的便是為了獲取共享變數的初始值副本,各個執行緒對副本的修改不影響變數本身。

再來看看createMap是如何建立threadLocalMap的

  void createMap(Thread t, T firstValue) {
          t.threadLocals = new ThreadLocalMap(this, firstValue);
      }複製程式碼
  ThreadLocalMap(ThreadLocal<?> firstKey, Object firstValue) {
             //建立一個初始容量為16的Entry陣列
              table = new Entry[INITIAL_CAPACITY];
              //通過threadLocal的threadLocalHashCode來定位在陣列中的位置
              int i = firstKey.threadLocalHashCode & (INITIAL_CAPACITY - 1);
              //儲存在陣列中
              table[i] = new Entry(firstKey, firstValue);
              //記錄下已用的大小
              size = 1;
              //設定閾值為容量的2/3
              setThreshold(INITIAL_CAPACITY);
          }複製程式碼

3.2.2 初始化threadLocalMap

初始化threadLocalMap之後,此執行緒再次呼叫get()方法,又做了哪些操作呢

  public T get() {
          //獲取當前執行緒
          Thread t = Thread.currentThread();
          //獲取當前執行緒的ThreadLocalMap
          ThreadLocalMap map = getMap(t);
          if (map != null) {
              //如果ThreadLocalMap已經被建立了,那麼通過當前的threadLocal物件作為key,獲取value
              ThreadLocalMap.Entry e = map.getEntry(this);
              if (e != null) {
                  @SuppressWarnings("unchecked")
                  T result = (T)e.value;
                  return result;
              }
          }
          //如果ThreadLocalMap還沒有被建立或者在ThreadLocalMap中查詢不到此元素
          return setInitialValue();
      }複製程式碼

可以看到是通過map.getEntry(this)去查詢元素的

  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
                  //如果定位的元素的key與傳入的key不相等,那麼一直往後找
                  return getEntryAfterMiss(key, i, e);
          }複製程式碼
  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)
                      //將過期的key清除掉,並把後面的元素(移動過位置的)往前移
                      expungeStaleEntry(i);
                  else
                      //往後移一位
                      i = nextIndex(i, len);
                  e = tab[i];
              }
              return null;
          }複製程式碼
  private static int nextIndex(int i, int len) {
              return ((i + 1 < len) ? i + 1 : 0);
          }複製程式碼
  private int expungeStaleEntry(int staleSlot) {
      Entry[] tab = table;
      int len = tab.length;
  
      // 清除當前元素
      tab[staleSlot].value = null;
      tab[staleSlot] = null;
      size--;
  
      //將此元素後面的,因為hash衝突移動過位置的元素往前移
      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);
              //h != i說明有過hash衝突
              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;
  }複製程式碼

如果map.getEntry(this)也找不到元素怎麼辦?

  public T get() {
          //獲取當前執行緒
          Thread t = Thread.currentThread();
          //獲取當前執行緒的ThreadLocalMap
          ThreadLocalMap map = getMap(t);
          if (map != null) {
              //如果ThreadLocalMap已經被建立了,那麼通過當前的threadLocal物件作為key,獲取value
              ThreadLocalMap.Entry e = map.getEntry(this);
              if (e != null) {
                  @SuppressWarnings("unchecked")
                  T result = (T)e.value;
                  return result;
              }
          }
          //如果ThreadLocalMap還沒有被建立或者在ThreadLocalMap中查詢不到此元素
          return setInitialValue();
      }複製程式碼

那麼繼續呼叫setInitialValue()方法

  private T setInitialValue() {
          //initialValue方法一般會被重寫,不重寫的話,直接返回null
          T value = initialValue();
          Thread t = Thread.currentThread();
          //獲取當前執行緒的ThreadLocalMap
          ThreadLocalMap map = getMap(t);
          if (map != null)
              //ThreadLocalMap已經被建立,那麼直接設定初始值(即儲存變數副本),初始值來自initialValue方法
              map.set(this, value);
          else
              //建立ThreadLocalMap
              createMap(t, value);
          return value;
      }複製程式碼

可以看到將會呼叫它裡面的map.set(this, value)方法

  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;
                  }
              }
              
              //如果在table中確實找不到,那麼新建一個
              tab[i] = new Entry(key, value);
              int sz = ++size;
              if (!cleanSomeSlots(i, sz) && sz >= threshold)
                  //如果沒有元素被清除,且超過閾值,那麼擴容並重新hash定位
                  rehash();
          }複製程式碼

3.3 set()原始碼分析

在看看set()方式處理與setInitialValue類似,少了獲取初始化值,其他都相同,可參考get()方式中

ThreadLocalMap沒初始化方式

:

public void set(T value) {
    //獲取當前執行緒
    Thread t = Thread.currentThread();
    //獲取當前執行緒的ThreadLocalMap
    ThreadLocalMap map = getMap(t);
    if (map != null)
        map.set(this, value);
    else
        createMap(t, value);
}複製程式碼

3.4 總結

  • 首先判斷當前執行緒的threadLocalMap是否存在,若不存在則建立一個。將ThreadLocal作為key,共享變數初始值的副本作為value,儲存在threadLocalMap中
  • 若threadLocalMap存在,那麼將ThreadLocal作為key,通過hash雜湊定位在陣列中的位置,查詢value
  • 如果在threadLocalMap中找不到(原因:被刪除了,或者此ThreaLocal沒有加入到threadLocalMap,畢竟threadLocalMap可以存放多個threadLocal),那麼將ThreadLocal作為key,共享變數初始值的副本作為value,儲存在threadLocalMap中
  • 在set的過程中,如果當前位置有其他元素(即hash衝突),那麼往後找,直到不存在其他元素。並且在set的過程中會清除一些過期(key為null)的元素。最後將根據size大小,決定是否擴容,重新hash定位
各位看官還可以嗎?喜歡的話,動動手指點個?,點個關注唄!!謝謝支援!

相關文章