Java中的ThreadLocal詳解

時間 2019-12-07

原文原文鏈接

1、ThreadLocal簡介

　　多線程訪問同一個共享變量的時候容易出現併發問題，特別是多個線程對一個變量進行寫入的時候，爲了保證線程安全，通常使用者在訪問共享變量的時候須要進行額外的同步措施才能保證線程安全性。ThreadLocal是除了加鎖這種同步方式以外的一種保證一種規避多線程訪問出現線程不安全的方法，當咱們在建立一個變量後，若是每一個線程對其進行訪問的時候訪問的都是線程本身的變量這樣就不會存在線程不安全問題。html

　　ThreadLocal是JDK包提供的，它提供線程本地變量，若是建立一樂ThreadLocal變量，那麼訪問這個變量的每一個線程都會有這個變量的一個副本，在實際多線程操做的時候，操做的是本身本地內存中的變量，從而規避了線程安全問題，以下圖所示數組

2、ThreadLocal簡單使用

　　下面的例子中，開啓兩個線程，在每一個線程內部設置了本地變量的值，而後調用print方法打印當前本地變量的值。若是在打印以後調用本地變量的remove方法會刪除本地內存中的變量，代碼以下所示安全

 1 package test;
 2 
 3 public class ThreadLocalTest {
 4 
 5     static ThreadLocal<String> localVar = new ThreadLocal<>();
 6 
 7     static void print(String str) {
 8         //打印當前線程中本地內存中本地變量的值
 9         System.out.println(str + " :" + localVar.get());
10         //清除本地內存中的本地變量
11         localVar.remove();
12     }
13 
14     public static void main(String[] args) {
15         Thread t1  = new Thread(new Runnable() {
16             @Override
17             public void run() {
18                 //設置線程1中本地變量的值
19                 localVar.set("localVar1");
20                 //調用打印方法
21                 print("thread1");
22                 //打印本地變量
23                 System.out.println("after remove : " + localVar.get());
24             }
25         });
26 
27         Thread t2  = new Thread(new Runnable() {
28             @Override
29             public void run() {
30                 //設置線程1中本地變量的值
31                 localVar.set("localVar2");
32                 //調用打印方法
33                 print("thread2");
34                 //打印本地變量
35                 System.out.println("after remove : " + localVar.get());
36             }
37         });
38 
39         t1.start();
40         t2.start();
41     }
42 }

下面是運行後的結果：多線程

3、ThreadLocal的實現原理

　　下面是ThreadLocal的類圖結構，從圖中可知：Thread類中有兩個變量threadLocals和inheritableThreadLocals，兩者都是ThreadLocal內部類ThreadLocalMap類型的變量，咱們經過查看內部內ThreadLocalMap能夠發現實際上它相似於一個HashMap。在默認狀況下，每一個線程中的這兩個變量都爲null，只有當線程第一次調用ThreadLocal的set或者get方法的時候纔會建立他們（後面咱們會查看這兩個方法的源碼）。除此以外，和我所想的不一樣的是，每一個線程的本地變量不是存放在ThreadLocal實例中，而是放在調用線程的ThreadLocals變量裏面（前面也說過，該變量是Thread類的變量）。也就是說，ThreadLocal類型的本地變量是存放在具體的線程空間上，其自己至關於一個裝載本地變量的工具殼，經過set方法將value添加到調用線程的threadLocals中，當調用線程調用get方法時候可以從它的threadLocals中取出變量。若是調用線程一直不終止，那麼這個本地變量將會一直存放在他的threadLocals中，因此不使用本地變量的時候須要調用remove方法將threadLocals中刪除不用的本地變量。下面咱們經過查看ThreadLocal的set、get以及remove方法來查看ThreadLocal具體實怎樣工做的併發

　　一、set方法源碼ide

 1 public void set(T value) {
 2     //(1)獲取當前線程（調用者線程）
 3     Thread t = Thread.currentThread();
 4     //(2)以當前線程做爲key值，去查找對應的線程變量，找到對應的map
 5     ThreadLocalMap map = getMap(t);
 6     //(3)若是map不爲null，就直接添加本地變量，key爲當前線程，值爲添加的本地變量值
 7     if (map != null)
 8         map.set(this, value);
 9     //(4)若是map爲null，說明首次添加，須要首先建立出對應的map
10     else
11         createMap(t, value);
12 }

　　在上面的代碼中，(2)處調用getMap方法得到當前線程對應的threadLocals(參照上面的圖示和文字說明)，該方法代碼以下函數

ThreadLocalMap getMap(Thread t) {
    return t.threadLocals; //獲取線程本身的變量threadLocals，並綁定到當前調用線程的成員變量threadLocals上
}

　　若是調用getMap方法返回值不爲null，就直接將value值設置到threadLocals中（key爲當前線程引用，值爲本地變量）；若是getMap方法返回null說明是第一次調用set方法（前面說到過，threadLocals默認值爲null，只有調用set方法的時候纔會建立map），這個時候就須要調用createMap方法建立threadLocals，該方法以下所示工具

1 void createMap(Thread t, T firstValue) {
2     t.threadLocals = new ThreadLocalMap(this, firstValue);
3 }

　　createMap方法不只建立了threadLocals，同時也將要添加的本地變量值添加到了threadLocals中。this

　　二、get方法源碼spa

　　在get方法的實現中，首先獲取當前調用者線程，若是當前線程的threadLocals不爲null，就直接返回當前線程綁定的本地變量值，不然執行setInitialValue方法初始化threadLocals變量。在setInitialValue方法中，相似於set方法的實現，都是判斷當前線程的threadLocals變量是否爲null，是則添加本地變量（這個時候因爲是初始化，因此添加的值爲null），不然建立threadLocals變量，一樣添加的值爲null。

 1 public T get() {
 2     //(1)獲取當前線程
 3     Thread t = Thread.currentThread();
 4     //(2)獲取當前線程的threadLocals變量
 5     ThreadLocalMap map = getMap(t);
 6     //(3)若是threadLocals變量不爲null，就能夠在map中查找到本地變量的值
 7     if (map != null) {
 8         ThreadLocalMap.Entry e = map.getEntry(this);
 9         if (e != null) {
10             @SuppressWarnings("unchecked")
11             T result = (T)e.value;
12             return result;
13         }
14     }
15     //(4)執行到此處，threadLocals爲null，調用該更改初始化當前線程的threadLocals變量
16     return setInitialValue();
17 }
18 
19 private T setInitialValue() {
20     //protected T initialValue() {return null;}
21     T value = initialValue();
22     //獲取當前線程
23     Thread t = Thread.currentThread();
24     //以當前線程做爲key值，去查找對應的線程變量，找到對應的map
25     ThreadLocalMap map = getMap(t);
26     //若是map不爲null，就直接添加本地變量，key爲當前線程，值爲添加的本地變量值
27     if (map != null)
28         map.set(this, value);
29     //若是map爲null，說明首次添加，須要首先建立出對應的map
30     else
31         createMap(t, value);
32     return value;
33 }

　　三、remove方法的實現

　　remove方法判斷該當前線程對應的threadLocals變量是否爲null，不爲null就直接刪除當前線程中指定的threadLocals變量

1  public void remove() {
2     //獲取當前線程綁定的threadLocals
3      ThreadLocalMap m = getMap(Thread.currentThread());
4      //若是map不爲null，就移除當前線程中指定ThreadLocal實例的本地變量
5      if (m != null)
6          m.remove(this);
7  }

　　四、以下圖所示：每一個線程內部有一個名爲threadLocals的成員變量，該變量的類型爲ThreadLocal.ThreadLocalMap類型（相似於一個HashMap），其中的key爲當前定義的ThreadLocal變量的this引用，value爲咱們使用set方法設置的值。每一個線程的本地變量存放在本身的本地內存變量threadLocals中，若是當前線程一直不消亡，那麼這些本地變量就會一直存在（因此可能會致使內存溢出），所以使用完畢須要將其remove掉。

4、ThreadLocal不支持繼承性

　　同一個ThreadLocal變量在父線程中被設置值後，在子線程中是獲取不到的。（threadLocals中爲當前調用線程對應的本地變量，因此兩者天然是不能共享的）

 1 package test;
 2 
 3 public class ThreadLocalTest2 {
 4 
 5     //(1)建立ThreadLocal變量
 6     public static ThreadLocal<String> threadLocal = new ThreadLocal<>();
 7 
 8     public static void main(String[] args) {
 9         //在main線程中添加main線程的本地變量
10         threadLocal.set("mainVal");
11         //新建立一個子線程
12         Thread thread = new Thread(new Runnable() {
13             @Override
14             public void run() {
15                 System.out.println("子線程中的本地變量值:"+threadLocal.get());
16             }
17         });
18         thread.start();
19         //輸出main線程中的本地變量值
20         System.out.println("mainx線程中的本地變量值:"+threadLocal.get());
21     }
22 }

5、InheritableThreadLocal類

　　在上面說到的ThreadLocal類是不能提供子線程訪問父線程的本地變量的，而InheritableThreadLocal類則能夠作到這個功能，下面是該類的源碼

 1 public class InheritableThreadLocal<T> extends ThreadLocal<T> {
 2     
 3     protected T childValue(T parentValue) {
 4         return parentValue;
 5     }
 6 
 7     ThreadLocalMap getMap(Thread t) {
 8        return t.inheritableThreadLocals;
 9     }
10 
11     void createMap(Thread t, T firstValue) {
12         t.inheritableThreadLocals = new ThreadLocalMap(this, firstValue);
13     }
14 }

　　從上面代碼能夠看出，InheritableThreadLocal類繼承了ThreadLocal類，並重寫了childValue、getMap、createMap三個方法。其中createMap方法在被調用（當前線程調用set方法時獲得的map爲null的時候須要調用該方法）的時候，建立的是inheritableThreadLocal而不是threadLocals。同理，getMap方法在當前調用者線程調用get方法的時候返回的也不是threadLocals而是inheritableThreadLocal。

　　下面咱們看看重寫的childValue方法在何時執行，怎樣讓子線程訪問父線程的本地變量值。咱們首先從Thread類開始提及

 1 private void init(ThreadGroup g, Runnable target, String name,
 2                   long stackSize) {
 3     init(g, target, name, stackSize, null, true);
 4 }
 5 private void init(ThreadGroup g, Runnable target, String name,
 6                   long stackSize, AccessControlContext acc,
 7                   boolean inheritThreadLocals) {
 8     //判斷名字的合法性
 9     if (name == null) {
10         throw new NullPointerException("name cannot be null");
11     }
12 
13     this.name = name;
14     //(1)獲取當前線程(父線程)
15     Thread parent = currentThread();
16     //安全校驗
17     SecurityManager security = System.getSecurityManager();
18     if (g == null) { //g:當前線程組
19         if (security != null) {
20             g = security.getThreadGroup();
21         }
22         if (g == null) {
23             g = parent.getThreadGroup();
24         }
25     }
26     g.checkAccess();
27     if (security != null) {
28         if (isCCLOverridden(getClass())) {
29             security.checkPermission(SUBCLASS_IMPLEMENTATION_PERMISSION);
30         }
31     }
32 
33     g.addUnstarted();
34 
35     this.group = g; //設置爲當前線程組
36     this.daemon = parent.isDaemon();//守護線程與否(同父線程)
37     this.priority = parent.getPriority();//優先級同父線程
38     if (security == null || isCCLOverridden(parent.getClass()))
39         this.contextClassLoader = parent.getContextClassLoader();
40     else
41         this.contextClassLoader = parent.contextClassLoader;
42     this.inheritedAccessControlContext =
43             acc != null ? acc : AccessController.getContext();
44     this.target = target;
45     setPriority(priority);
46     //(2)若是父線程的inheritableThreadLocal不爲null
47     if (inheritThreadLocals && parent.inheritableThreadLocals != null)
48         //（3）設置子線程中的inheritableThreadLocals爲父線程的inheritableThreadLocals
49         this.inheritableThreadLocals =
50             ThreadLocal.createInheritedMap(parent.inheritableThreadLocals);
51     this.stackSize = stackSize;
52 
53     tid = nextThreadID();
54 }

　　在init方法中，首先(1)處獲取了當前線程(父線程)，而後（2）處判斷當前父線程的inheritableThreadLocals是否爲null，而後調用createInheritedMap將父線程的inheritableThreadLocals做爲構造函數參數建立了一個新的ThreadLocalMap變量，而後賦值給子線程。下面是createInheritedMap方法和ThreadLocalMap的構造方法

 1 static ThreadLocalMap createInheritedMap(ThreadLocalMap parentMap) {
 2     return new ThreadLocalMap(parentMap);
 3 }
 4 
 5 private ThreadLocalMap(ThreadLocalMap parentMap) {
 6     Entry[] parentTable = parentMap.table;
 7     int len = parentTable.length;
 8     setThreshold(len);
 9     table = new Entry[len];
10 
11     for (int j = 0; j < len; j++) {
12         Entry e = parentTable[j];
13         if (e != null) {
14             @SuppressWarnings("unchecked")
15             ThreadLocal<Object> key = (ThreadLocal<Object>) e.get();
16             if (key != null) {
17                 //調用重寫的方法
18                 Object value = key.childValue(e.value);
19                 Entry c = new Entry(key, value);
20                 int h = key.threadLocalHashCode & (len - 1);
21                 while (table[h] != null)
22                     h = nextIndex(h, len);
23                 table[h] = c;
24                 size++;
25             }
26         }
27     }
28 }

　　在構造函數中將父線程的inheritableThreadLocals成員變量的值賦值到新的ThreadLocalMap對象中。返回以後賦值給子線程的inheritableThreadLocals。總之，InheritableThreadLocals類經過重寫getMap和createMap兩個方法將本地變量保存到了具體線程的inheritableThreadLocals變量中，當線程經過InheritableThreadLocals實例的set或者get方法設置變量的時候，就會建立當前線程的inheritableThreadLocals變量。而父線程建立子線程的時候，ThreadLocalMap中的構造函數會將父線程的inheritableThreadLocals中的變量複製一份到子線程的inheritableThreadLocals變量中。

6、從ThreadLocalMap看ThreadLocal使用不當的內存泄漏問題

一、基礎概念

　　首先咱們先看看ThreadLocalMap的類圖，在前面的介紹中，咱們知道ThreadLocal只是一個工具類，他爲用戶提供get、set、remove接口操做實際存放本地變量的threadLocals（調用線程的成員變量），也知道threadLocals是一個ThreadLocalMap類型的變量，下面咱們來看看ThreadLocalMap這個類。在此以前，咱們回憶一下Java中的四種引用類型，相關GC只是參考前面系列的文章(JVM相關)

①強引用：Java中默認的引用類型，一個對象若是具備強引用那麼只要這種引用還存在就不會被GC。

②軟引用：簡言之，若是一個對象具備弱引用，在JVM發生OOM以前（即內存充足夠使用），是不會GC這個對象的；只有到JVM內存不足的時候纔會GC掉這個對象。軟引用和一個引用隊列聯合使用，若是軟引用所引用的對象被回收以後，該引用就會加入到與之關聯的引用隊列中

③弱引用（這裏討論ThreadLocalMap中的Entry類的重點）：若是一個對象只具備弱引用，那麼這個對象就會被垃圾回收器GC掉(被弱引用所引用的對象只能生存到下一次GC以前，當發生GC時候，不管當前內存是否足夠，弱引用所引用的對象都會被回收掉)。弱引用也是和一個引用隊列聯合使用，若是弱引用的對象被垃圾回收期回收掉，JVM會將這個引用加入到與之關聯的引用隊列中。若引用的對象能夠經過弱引用的get方法獲得，當引用的對象唄回收掉以後，再調用get方法就會返回null

④虛引用：虛引用是全部引用中最弱的一種引用，其存在就是爲了將關聯虛引用的對象在被GC掉以後收到一個通知。（不能經過get方法得到其指向的對象）

二、分析ThreadLocalMap內部實現

　　上面咱們知道ThreadLocalMap內部其實是一個Entry數組，咱們先看看Entry的這個內部類

 1 /**
 2  * 是繼承自WeakReference的一個類，該類中實際存放的key是
 3  * 指向ThreadLocal的弱引用和與之對應的value值(該value值
 4  * 就是經過ThreadLocal的set方法傳遞過來的值)
 5  * 因爲是弱引用，當get方法返回null的時候意味着坑能引用
 6  */
 7 static class Entry extends WeakReference<ThreadLocal<?>> {
 8     /** value就是和ThreadLocal綁定的 */
 9     Object value;
10 
11     //k：ThreadLocal的引用，被傳遞給WeakReference的構造方法
12     Entry(ThreadLocal<?> k, Object v) {
13         super(k);
14         value = v;
15     }
16 }
17 //WeakReference構造方法(public class WeakReference<T> extends Reference<T> )
18 public WeakReference(T referent) {
19     super(referent); //referent：ThreadLocal的引用
20 }
21 
22 //Reference構造方法     
23 Reference(T referent) {
24     this(referent, null);//referent：ThreadLocal的引用
25 }
26 
27 Reference(T referent, ReferenceQueue<? super T> queue) {
28     this.referent = referent;
29     this.queue = (queue == null) ? ReferenceQueue.NULL : queue;
30 }

　　在上面的代碼中，咱們能夠看出，當前ThreadLocal的引用k被傳遞給WeakReference的構造函數，因此ThreadLocalMap中的key爲ThreadLocal的弱引用。當一個線程調用ThreadLocal的set方法設置變量的時候，當前線程的ThreadLocalMap就會存放一個記錄，這個記錄的key值爲ThreadLocal的弱引用，value就是經過set設置的值。若是當前線程一直存在且沒有調用該ThreadLocal的remove方法，若是這個時候別的地方還有對ThreadLocal的引用，那麼當前線程中的ThreadLocalMap中會存在對ThreadLocal變量的引用和value對象的引用，是不會釋放的，就會形成內存泄漏。

　　考慮這個ThreadLocal變量沒有其餘強依賴，若是當前線程還存在，因爲線程的ThreadLocalMap裏面的key是弱引用，因此當前線程的ThreadLocalMap裏面的ThreadLocal變量的弱引用在gc的時候就被回收，可是對應的value仍是存在的這就可能形成內存泄漏(由於這個時候ThreadLocalMap會存在key爲null可是value不爲null的entry項)。

　　總結：THreadLocalMap中的Entry的key使用的是ThreadLocal對象的弱引用，在沒有其餘地方對ThreadLoca依賴，ThreadLocalMap中的ThreadLocal對象就會被回收掉，可是對應的不會被回收，這個時候Map中就可能存在key爲null可是value不爲null的項，這須要實際的時候使用完畢及時調用remove方法避免內存泄漏。