Java多線程與并發(fā)之ThreadLocal

1. ThreadLocal是什么?使用場景

ThreadLocal簡介

ThreadLocal是線程本地變量,可以為多線程的并發(fā)問題提供一種解決方式,當(dāng)使用ThreadLocal維護(hù)變量時,ThreadLocal為每個使用該變量的線程提供獨(dú)立的變量副本,所以每一個線程都可以獨(dú)立地改變自己的副本,而不會影響其它線程所對應(yīng)的副本。

ThreadLocal使用場景

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

  • 多數(shù)據(jù)源的切換
  • spring聲明式事務(wù)

2. ThreadLocal的使用案例

ThreadLocal類接口:

  • void set(T value):設(shè)置當(dāng)前線程的線程局部變量的值
  • T get():獲取當(dāng)前線程所對應(yīng)的線程局部變量
  • void remove():刪除當(dāng)前線程局部變量的值,目的是為了減少內(nèi)存的占用
  • T initialValue():該線程局部變量的初始值(默認(rèn)值為null),該方法是一個protected的懶加載方法,線程第1次調(diào)用get()或set(T value)時才執(zhí)行在,而且也是為了讓子類覆蓋而設(shè)計的。
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();
        }
    }
}

輸出結(jié)果:

thread_1 1
thread_0 1
thread_3 1
thread_4 1
thread_2 1

可以看到每個線程的獲取的初始值都是0,并且對num++的操作也互不影響

學(xué)習(xí)的過程當(dāng)中有遇見學(xué)習(xí),行業(yè)方面的問題,或者說缺乏系統(tǒng)的學(xué)習(xí)路線和學(xué)習(xí)視頻可以點(diǎn)擊https://shimo.im/docs/VqQR6tPrpR3C3tjq/

3.ThreadLocal如何實現(xiàn)的

3.1 ThreadLocal的數(shù)據(jù)結(jié)構(gòu)

ThreadLocal內(nèi)部維護(hù)的是一個類似Map的ThreadLocalMap數(shù)據(jù)結(jié)構(gòu),而每個Thread類,都有一個ThreadLocalMap成員變量。ThreadLocalMap將線程本地變量(ThreadLocal)作為key,線程變量的副本作為value,如圖所示:


image.png

需要注意的是ThreadLocal中的Entry的key和value的關(guān)系有系統(tǒng)進(jìn)行維護(hù),若維護(hù)不當(dāng)則可能導(dǎo)致多線程狀態(tài)下的不安全(一般不會,至少需要注意)。

3.2 get()源碼分析

  public T get() {
          //獲取當(dāng)前線程
          Thread t = Thread.currentThread();
          //獲取當(dāng)前線程的ThreadLocalMap
          ThreadLocalMap map = getMap(t);
          if (map != null) {
              //如果ThreadLocalMap已經(jīng)被創(chuàng)建了,那么通過當(dāng)前的threadLocal對象作為key,獲取value
              ThreadLocalMap.Entry e = map.getEntry(this);
              if (e != null) {
                  @SuppressWarnings("unchecked")
                  T result = (T)e.value;
                  return result;
              }
          }
          //如果ThreadLocalMap還沒有被創(chuàng)建或者在ThreadLocalMap中查找不到此元素
          return setInitialValue();
      }

3.2.1 ThreadLocalMap沒初始化

ThreadLocalMap沒初始化,ThreadLocalMap為null時,會調(diào)用setInitialValue()方法:

  private T setInitialValue() {
          //initialValue方法一般會被重寫,不重寫的話,直接返回null
          T value = initialValue();
          Thread t = Thread.currentThread();
          //獲取當(dāng)前線程的ThreadLocalMap
          ThreadLocalMap map = getMap(t);
          if (map != null)
              //ThreadLocalMap已經(jīng)被創(chuàng)建,那么直接設(shè)置初始值(即保存變量副本),初始值來自initialValue方法
              map.set(this, value);
          else
              //創(chuàng)建ThreadLocalMap
              createMap(t, value);
          return value;
      }

其中,initialValue()方法是由我們重寫的,需要注意的是,返回值必須為new一個對象,而不是直接返回一個對象引用。因為如果多個線程都保存同一個引用的副本的話,那他們通過這個引用修改共享變量的值,是相互影響的。我們本來的目的便是為了獲取共享變量的初始值副本,各個線程對副本的修改不影響變量本身。

再來看看createMap是如何創(chuàng)建threadLocalMap的

  void createMap(Thread t, T firstValue) {
          t.threadLocals = new ThreadLocalMap(this, firstValue);
      }
  ThreadLocalMap(ThreadLocal<?> firstKey, Object firstValue) {
             //創(chuàng)建一個初始容量為16的Entry數(shù)組
              table = new Entry[INITIAL_CAPACITY];
              //通過threadLocal的threadLocalHashCode來定位在數(shù)組中的位置
              int i = firstKey.threadLocalHashCode & (INITIAL_CAPACITY - 1);
              //保存在數(shù)組中
              table[i] = new Entry(firstKey, firstValue);
              //記錄下已用的大小
              size = 1;
              //設(shè)置閾值為容量的2/3
              setThreshold(INITIAL_CAPACITY);
          }

3.2.2 初始化threadLocalMap

初始化threadLocalMap之后,此線程再次調(diào)用get()方法,又做了哪些操作呢

  public T get() {
          //獲取當(dāng)前線程
          Thread t = Thread.currentThread();
          //獲取當(dāng)前線程的ThreadLocalMap
          ThreadLocalMap map = getMap(t);
          if (map != null) {
              //如果ThreadLocalMap已經(jīng)被創(chuàng)建了,那么通過當(dāng)前的threadLocal對象作為key,獲取value
              ThreadLocalMap.Entry e = map.getEntry(this);
              if (e != null) {
                  @SuppressWarnings("unchecked")
                  T result = (T)e.value;
                  return result;
              }
          }
          //如果ThreadLocalMap還沒有被創(chuàng)建或者在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;

      // 清除當(dāng)前元素
      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() {
          //獲取當(dāng)前線程
          Thread t = Thread.currentThread();
          //獲取當(dāng)前線程的ThreadLocalMap
          ThreadLocalMap map = getMap(t);
          if (map != null) {
              //如果ThreadLocalMap已經(jīng)被創(chuàng)建了,那么通過當(dāng)前的threadLocal對象作為key,獲取value
              ThreadLocalMap.Entry e = map.getEntry(this);
              if (e != null) {
                  @SuppressWarnings("unchecked")
                  T result = (T)e.value;
                  return result;
              }
          }
          //如果ThreadLocalMap還沒有被創(chuàng)建或者在ThreadLocalMap中查找不到此元素
          return setInitialValue();
      }

那么繼續(xù)調(diào)用setInitialValue()方法

  private T setInitialValue() {
          //initialValue方法一般會被重寫,不重寫的話,直接返回null
          T value = initialValue();
          Thread t = Thread.currentThread();
          //獲取當(dāng)前線程的ThreadLocalMap
          ThreadLocalMap map = getMap(t);
          if (map != null)
              //ThreadLocalMap已經(jīng)被創(chuàng)建,那么直接設(shè)置初始值(即保存變量副本),初始值來自initialValue方法
              map.set(this, value);
          else
              //創(chuàng)建ThreadLocalMap
              createMap(t, value);
          return value;
      }

可以看到將會調(diào)用它里面的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)
                  //如果沒有元素被清除,且超過閾值,那么擴(kuò)容并重新hash定位
                  rehash();
          }

3.3 set()源碼分析

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

public void set(T value) {
    //獲取當(dāng)前線程
    Thread t = Thread.currentThread();
    //獲取當(dāng)前線程的ThreadLocalMap
    ThreadLocalMap map = getMap(t);
    if (map != null)
        map.set(this, value);
    else
        createMap(t, value);
}

3.4 總結(jié)

  • 首先判斷當(dāng)前線程的threadLocalMap是否存在,若不存在則創(chuàng)建一個。將ThreadLocal作為key,共享變量初始值的副本作為value,保存在threadLocalMap中
  • 若threadLocalMap存在,那么將ThreadLocal作為key,通過hash散列定位在數(shù)組中的位置,查找value
  • 如果在threadLocalMap中找不到(原因:被刪除了,或者此ThreaLocal沒有加入到threadLocalMap,畢竟threadLocalMap可以存放多個threadLocal),那么將ThreadLocal作為key,共享變量初始值的副本作為value,保存在threadLocalMap中
  • 在set的過程中,如果當(dāng)前位置有其他元素(即hash沖突),那么往后找,直到不存在其他元素。并且在set的過程中會清除一些過期(key為null)的元素。最后將根據(jù)size大小,決定是否擴(kuò)容,重新hash定位

各位看官還可以嗎?喜歡的話,動動手指點(diǎn)個??,點(diǎn)個關(guān)注唄??!謝謝支持!

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時請結(jié)合常識與多方信息審慎甄別。
平臺聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點(diǎn),簡書系信息發(fā)布平臺,僅提供信息存儲服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容