寫這篇文章的一個(gè)原因在于，網(wǎng)上很多博客關(guān)于 ThreadLocal 的適用場(chǎng)景以及解決的問(wèn)題，描述的并不清楚，甚至是錯(cuò)的。下面是常見的對(duì)于 ThreadLocal的介紹

• ThreadLocal為解決多線程程序的并發(fā)問(wèn)題提供了一種新的思路
• ThreadLocal的目的是為了解決多線程訪問(wèn)資源時(shí)的共享問(wèn)題

還有很多文章在對(duì)比 ThreadLocal 與 synchronize 的異同。既然是作比較，那應(yīng)該是認(rèn)為這兩者解決相同或類似的問(wèn)題。

上面的描述，問(wèn)題在于，ThreadLocal 并不解決多線程 共享 變量的問(wèn)題。既然變量不共享，那就更談不上同步的問(wèn)題。

2. 合理的理解

ThreadLoal 變量，它的基本原理是，同一個(gè) ThreadLocal 所包含的對(duì)象(對(duì)ThreadLocal< String >而言即為 String 類型變量)，在不同的 Thread 中有不同的副本(實(shí)際是不同的實(shí)例，后文會(huì)詳細(xì)闡述)。這里有幾點(diǎn)需要注意

• 因?yàn)槊總€(gè) Thread 內(nèi)有自己的實(shí)例副本，且該副本只能由當(dāng)前 Thread 使用。這是也是 ThreadLocal 命名的由來(lái)
• 既然每個(gè) Thread 有自己的實(shí)例副本，且其它 Thread 不可訪問(wèn)，那就不存在多線程間共享的問(wèn)題
• 既無(wú)共享，何來(lái)同步問(wèn)題，又何來(lái)解決同步問(wèn)題一說(shuō)?

那 ThreadLocal 到底解決了什么問(wèn)題，又適用于什么樣的場(chǎng)景?

核心意思是

總的來(lái)說(shuō)，ThreadLocal 適用于每個(gè)線程需要自己獨(dú)立的實(shí)例且該實(shí)例需要在多個(gè)方法中被使用，也即變量在線程間隔離而在方法或類間共享的場(chǎng)景。后文會(huì)通過(guò)實(shí)例詳細(xì)闡述該觀點(diǎn)。另外，該場(chǎng)景下，并非必須使用 ThreadLocal ，其它方式完全可以實(shí)現(xiàn)同樣的效果，只是 ThreadLocal 使得實(shí)現(xiàn)更簡(jiǎn)潔。

二、ThreadLocal用法

1. 實(shí)例代碼

下面通過(guò)如下代碼說(shuō)明 ThreadLocal 的使用方式

public class ThreadLocalDemo { 
  public static void main(String[] args) throws InterruptedException { 
    int threads = 3; 
    CountDownLatch countDownLatch = new CountDownLatch(threads); 
    InnerClass innerClass = new InnerClass(); 
    for(int i = 1; i <= threads; i++) { 
      new Thread(() -> { 
        for(int j = 0; j < 4; j++) { 
          innerClass.add(String.valueOf(j)); 
          innerClass.print(); 
        } 
        innerClass.set("hello world"); 
        countDownLatch.countDown(); 
      }, "thread - " + i).start(); 
    } 
    countDownLatch.await(); 
  } 
  private static class InnerClass { 
    public void add(String newStr) { 
      StringBuilder str = Counter.counter.get(); 
      Counter.counter.set(str.append(newStr)); 
    } 
    public void print() { 
      System.out.printf("Thread name:%s , ThreadLocal hashcode:%s, Instance hashcode:%s, Value:%s\n", 
      Thread.currentThread().getName(), 
      Counter.counter.hashCode(), 
      Counter.counter.get().hashCode(), 
      Counter.counter.get().toString()); 
    } 
    public void set(String words) { 
      Counter.counter.set(new StringBuilder(words)); 
      System.out.printf("Set, Thread name:%s , ThreadLocal hashcode:%s,  Instance hashcode:%s, Value:%s\n", 
      Thread.currentThread().getName(), 
      Counter.counter.hashCode(), 
      Counter.counter.get().hashCode(), 
      Counter.counter.get().toString()); 
    } 
  } 
  private static class Counter { 
    private static ThreadLocal<StringBuilder> counter = new ThreadLocal<StringBuilder>() { 
      @Override 
      protected StringBuilder initialValue() { 
        return new StringBuilder(); 
      } 
    }; 
  } 
} 

2. 實(shí)例分析

ThreadLocal本身支持范型。該例使用了 StringBuilder 類型的 ThreadLocal 變量。可通過(guò) ThreadLocal 的 get() 方法讀取 StringBuidler 實(shí)例，也可通過(guò) set(T t) 方法設(shè)置 StringBuilder。

上述代碼執(zhí)行結(jié)果如下

Thread name:thread - 1 , ThreadLocal hashcode:372282300, Instance hashcode:418873098, Value:0 
Thread name:thread - 3 , ThreadLocal hashcode:372282300, Instance hashcode:1609588821, Value:0 
Thread name:thread - 2 , ThreadLocal hashcode:372282300, Instance hashcode:1780437710, Value:0 
Thread name:thread - 3 , ThreadLocal hashcode:372282300, Instance hashcode:1609588821, Value:01 
Thread name:thread - 1 , ThreadLocal hashcode:372282300, Instance hashcode:418873098, Value:01 
Thread name:thread - 3 , ThreadLocal hashcode:372282300, Instance hashcode:1609588821, Value:012 
Thread name:thread - 3 , ThreadLocal hashcode:372282300, Instance hashcode:1609588821, Value:0123 
Set, Thread name:thread - 3 , ThreadLocal hashcode:372282300,  Instance hashcode:1362597339, Value:hello world 
Thread name:thread - 2 , ThreadLocal hashcode:372282300, Instance hashcode:1780437710, Value:01 
Thread name:thread - 1 , ThreadLocal hashcode:372282300, Instance hashcode:418873098, Value:012 
Thread name:thread - 2 , ThreadLocal hashcode:372282300, Instance hashcode:1780437710, Value:012 
Thread name:thread - 1 , ThreadLocal hashcode:372282300, Instance hashcode:418873098, Value:0123 
Thread name:thread - 2 , ThreadLocal hashcode:372282300, Instance hashcode:1780437710, Value:0123 
Set, Thread name:thread - 1 , ThreadLocal hashcode:372282300,  Instance hashcode:482932940, Value:hello world 
Set, Thread name:thread - 2 , ThreadLocal hashcode:372282300,  Instance hashcode:1691922941, Value:hello world 

從上面的輸出可看出

• 從第1-3行輸出可見，每個(gè)線程通過(guò) ThreadLocal 的 get() 方法拿到的是不同的 StringBuilder 實(shí)例
• 第1-3行輸出表明，每個(gè)線程所訪問(wèn)到的是同一個(gè) ThreadLocal 變量
• 從7、12、13行輸出以及第30行代碼可見，雖然從代碼上都是對(duì) Counter 類的靜態(tài) counter 字段進(jìn)行 get() 得到 StringBuilder 實(shí)例并追加字符串，但是這并不會(huì)將所有線程追加的字符串都放進(jìn)同一個(gè) StringBuilder 中，而是每個(gè)線程將字符串追加進(jìn)各自的 StringBuidler 實(shí)例內(nèi)
• 對(duì)比第1行與第15行輸出并結(jié)合第38行代碼可知，使用 set(T t) 方法后，ThreadLocal 變量所指向的 StringBuilder 實(shí)例被替換

三、ThreadLocal原理

1. ThreadLocal維護(hù)線程與實(shí)例的映射

既然每個(gè)訪問(wèn) ThreadLocal 變量的線程都有自己的一個(gè)“本地”實(shí)例副本。一個(gè)可能的方案是 ThreadLocal 維護(hù)一個(gè) Map，鍵是 Thread，值是它在該 Thread 內(nèi)的實(shí)例。線程通過(guò)該 ThreadLocal 的 get() 方案獲取實(shí)例時(shí)，只需要以線程為鍵，從 Map 中找出對(duì)應(yīng)的實(shí)例即可。該方案如下圖所示

該方案可滿足上文提到的每個(gè)線程內(nèi)一個(gè)獨(dú)立備份的要求。每個(gè)新線程訪問(wèn)該 ThreadLocal 時(shí)，需要向 Map 中添加一個(gè)映射，而每個(gè)線程結(jié)束時(shí)，應(yīng)該清除該映射。這里就有兩個(gè)問(wèn)題：

• 增加線程與減少線程均需要寫 Map，故需保證該 Map 線程安全。雖然從ConcurrentHashMap的演進(jìn)看Java多線程核心技術(shù)一文介紹了幾種實(shí)現(xiàn)線程安全 Map 的方式，但它或多或少都需要鎖來(lái)保證線程的安全性
• 線程結(jié)束時(shí)，需要保證它所訪問(wèn)的所有 ThreadLocal 中對(duì)應(yīng)的映射均刪除，否則可能會(huì)引起內(nèi)存泄漏。(后文會(huì)介紹避免內(nèi)存泄漏的方法)

其中鎖的問(wèn)題，是 JDK 未采用該方案的一個(gè)原因。

2. Thread維護(hù)ThreadLocal與實(shí)例的映射

上述方案中，出現(xiàn)鎖的問(wèn)題，原因在于多線程訪問(wèn)同一個(gè) Map。如果該 Map 由 Thread 維護(hù)，從而使得每個(gè) Thread 只訪問(wèn)自己的 Map，那就不存在多線程寫的問(wèn)題，也就不需要鎖。該方案如下圖所示。

該方案雖然沒有鎖的問(wèn)題，但是由于每個(gè)線程訪問(wèn)某 ThreadLocal 變量后，都會(huì)在自己的 Map 內(nèi)維護(hù)該 ThreadLocal 變量與具體實(shí)例的映射，如果不刪除這些引用(映射)，則這些 ThreadLocal 不能被回收，可能會(huì)造成內(nèi)存泄漏。后文會(huì)介紹 JDK 如何解決該問(wèn)題。

四、ThreadLocal 在 JDK 8 中的實(shí)現(xiàn)

1. ThreadLocalMap與內(nèi)存泄漏

該方案中，Map 由 ThreadLocal 類的靜態(tài)內(nèi)部類 ThreadLocalMap 提供。該類的實(shí)例維護(hù)某個(gè) ThreadLocal 與具體實(shí)例的映射。與 HashMap 不同的是，ThreadLocalMap 的每個(gè) Entry 都是一個(gè)對(duì) 鍵 的弱引用，這一點(diǎn)從super(k)可看出。另外，每個(gè) Entry 都包含了一個(gè)對(duì) 值 的強(qiáng)引用。

static class Entry extends WeakReference<ThreadLocal<?>> { 
  /** The value associated with this ThreadLocal. */ 
  Object value; 
  Entry(ThreadLocal<?> k, Object v) { 
    super(k); 
    vvalue = v; 
  } 
} 

使用弱引用的原因在于，當(dāng)沒有強(qiáng)引用指向 ThreadLocal 變量時(shí)，它可被回收，從而避免上文所述 ThreadLocal 不能被回收而造成的內(nèi)存泄漏的問(wèn)題。

但是，這里又可能出現(xiàn)另外一種內(nèi)存泄漏的問(wèn)題。ThreadLocalMap 維護(hù) ThreadLocal 變量與具體實(shí)例的映射，當(dāng) ThreadLocal 變量被回收后，該映射的鍵變?yōu)?null，該 Entry 無(wú)法被移除。從而使得實(shí)例被該 Entry 引用而無(wú)法被回收造成內(nèi)存泄漏。

注：Entry雖然是弱引用，但它是 ThreadLocal 類型的弱引用(也即上文所述它是對(duì) 鍵 的弱引用)，而非具體實(shí)例的的弱引用，所以無(wú)法避免具體實(shí)例相關(guān)的內(nèi)存泄漏。

2. 讀取實(shí)例

讀取實(shí)例方法如下所示

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

讀取實(shí)例時(shí)，線程首先通過(guò)getMap(t)方法獲取自身的 ThreadLocalMap。從如下該方法的定義可見，該 ThreadLocalMap 的實(shí)例是 Thread 類的一個(gè)字段，即由 Thread 維護(hù) ThreadLocal 對(duì)象與具體實(shí)例的映射，這一點(diǎn)與上文分析一致。

ThreadLocalMap getMap(Thread t) { 
  return t.threadLocals; 
} 

獲取到 ThreadLocalMap 后，通過(guò)map.getEntry(this)方法獲取該 ThreadLocal 在當(dāng)前線程的 ThreadLocalMap 中對(duì)應(yīng)的 Entry。該方法中的 this 即當(dāng)前訪問(wèn)的 ThreadLocal 對(duì)象。

如果獲取到的 Entry 不為 null，從 Entry 中取出值即為所需訪問(wèn)的本線程對(duì)應(yīng)的實(shí)例。如果獲取到的 Entry 為 null，則通過(guò)setInitialValue()方法設(shè)置該 ThreadLocal 變量在該線程中對(duì)應(yīng)的具體實(shí)例的初始值。

3. 設(shè)置初始值

設(shè)置初始值方法如下

private T setInitialValue() { 
  T value = initialValue(); 
  Thread t = Thread.currentThread(); 
  ThreadLocalMap map = getMap(t); 
  if (map != null) 
    map.set(this, value); 
  else 
    createMap(t, value); 
  return value; 
} 

該方法為 private 方法，無(wú)法被重載。

首先，通過(guò)initialValue()方法獲取初始值。該方法為 public 方法，且默認(rèn)返回 null。所以典型用法中常常重載該方法。上例中即在內(nèi)部匿名類中將其重載。

然后拿到該線程對(duì)應(yīng)的 ThreadLocalMap 對(duì)象，若該對(duì)象不為 null，則直接將該 ThreadLocal 對(duì)象與對(duì)應(yīng)實(shí)例初始值的映射添加進(jìn)該線程的 ThreadLocalMap中。若為 null，則先創(chuàng)建該 ThreadLocalMap 對(duì)象再將映射添加其中。

這里并不需要考慮 ThreadLocalMap 的線程安全問(wèn)題。因?yàn)槊總€(gè)線程有且只有一個(gè) ThreadLocalMap 對(duì)象，并且只有該線程自己可以訪問(wèn)它，其它線程不會(huì)訪問(wèn)該 ThreadLocalMap，也即該對(duì)象不會(huì)在多個(gè)線程中共享，也就不存在線程安全的問(wèn)題。

4. 設(shè)置實(shí)例

除了通過(guò)initialValue()方法設(shè)置實(shí)例的初始值，還可通過(guò) set 方法設(shè)置線程內(nèi)實(shí)例的值，如下所示。

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 對(duì)象，然后直接將 ThreadLocal 對(duì)象(即代碼中的 this)與目標(biāo)實(shí)例的映射添加進(jìn) ThreadLocalMap 中。當(dāng)然，如果映射已經(jīng)存在，就直接覆蓋。另外，如果獲取到的 ThreadLocalMap 為 null，則先創(chuàng)建該 ThreadLocalMap 對(duì)象。

5. 防止內(nèi)存泄漏

對(duì)于已經(jīng)不再被使用且已被回收的 ThreadLocal 對(duì)象，它在每個(gè)線程內(nèi)對(duì)應(yīng)的實(shí)例由于被線程的 ThreadLocalMap 的 Entry 強(qiáng)引用，無(wú)法被回收，可能會(huì)造成內(nèi)存泄漏。

針對(duì)該問(wèn)題，ThreadLocalMap 的 set 方法中，通過(guò) replaceStaleEntry 方法將所有鍵為 null 的 Entry 的值設(shè)置為 null，從而使得該值可被回收。另外，會(huì)在 rehash 方法中通過(guò) expungeStaleEntry 方法將鍵和值為 null 的 Entry 設(shè)置為 null 從而使得該 Entry 可被回收。通過(guò)這種方式，ThreadLocal 可防止內(nèi)存泄漏。

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

五、適用場(chǎng)景

如上文所述，ThreadLocal 適用于如下兩種場(chǎng)景

• 每個(gè)線程需要有自己?jiǎn)为?dú)的實(shí)例
• 實(shí)例需要在多個(gè)方法中共享，但不希望被多線程共享

對(duì)于***點(diǎn)，每個(gè)線程擁有自己實(shí)例，實(shí)現(xiàn)它的方式很多。例如可以在線程內(nèi)部構(gòu)建一個(gè)單獨(dú)的實(shí)例。ThreadLoca 可以以非常方便的形式滿足該需求。

對(duì)于第二點(diǎn)，可以在滿足***點(diǎn)(每個(gè)線程有自己的實(shí)例)的條件下，通過(guò)方法間引用傳遞的形式實(shí)現(xiàn)。ThreadLocal 使得代碼耦合度更低，且實(shí)現(xiàn)更優(yōu)雅。

六、案例

對(duì)于 Java Web 應(yīng)用而言，Session 保存了很多信息。很多時(shí)候需要通過(guò) Session 獲取信息，有些時(shí)候又需要修改 Session 的信息。一方面，需要保證每個(gè)線程有自己?jiǎn)为?dú)的 Session 實(shí)例。另一方面，由于很多地方都需要操作 Session，存在多方法共享 Session 的需求。如果不使用 ThreadLocal，可以在每個(gè)線程內(nèi)構(gòu)建一個(gè) Session實(shí)例，并將該實(shí)例在多個(gè)方法間傳遞，如下所示。

public class SessionHandler { 
  @Data 
  public static class Session { 
    private String id; 
    private String user; 
    private String status; 
  } 
  public Session createSession() { 
    return new Session(); 
  } 
  public String getUser(Session session) { 
    return session.getUser(); 
  } 
  public String getStatus(Session session) { 
    return session.getStatus(); 
  } 
  public void setStatus(Session session, String status) { 
    session.setStatus(status); 
  } 
  public static void main(String[] args) { 
    new Thread(() -> { 
      SessionHandler handler = new SessionHandler(); 
      Session session = handler.createSession(); 
      handler.getStatus(session); 
      handler.getUser(session); 
      handler.setStatus(session, "close"); 
      handler.getStatus(session); 
    }).start(); 
  } 
} 

該方法是可以實(shí)現(xiàn)需求的。但是每個(gè)需要使用 Session 的地方，都需要顯式傳遞 Session 對(duì)象，方法間耦合度較高。

這里使用 ThreadLocal 重新實(shí)現(xiàn)該功能如下所示。

public class SessionHandler { 
  public static ThreadLocal<Session> session = new ThreadLocal<Session>(); 
  @Data 
  public static class Session { 
    private String id; 
    private String user; 
    private String status; 
  } 
  public void createSession() { 
    session.set(new Session()); 
  } 
  public String getUser() { 
    return session.get().getUser(); 
  } 
  public String getStatus() { 
    return session.get().getStatus(); 
  } 
  public void setStatus(String status) { 
    session.get().setStatus(status); 
  } 
  public static void main(String[] args) { 
    new Thread(() -> { 
      SessionHandler handler = new SessionHandler(); 
      handler.getStatus(); 
      handler.getUser(); 
      handler.setStatus("close"); 
      handler.getStatus(); 
    }).start(); 
  } 
} 

使用 ThreadLocal 改造后的代碼，不再需要在各個(gè)方法間傳遞 Session 對(duì)象，并且也非常輕松的保證了每個(gè)線程擁有自己獨(dú)立的實(shí)例。

如果單看其中某一點(diǎn)，替代方法很多。比如可通過(guò)在線程內(nèi)創(chuàng)建局部變量可實(shí)現(xiàn)每個(gè)線程有自己的實(shí)例，使用靜態(tài)變量可實(shí)現(xiàn)變量在方法間的共享。但如果要同時(shí)滿足變量在線程間的隔離與方法間的共享，ThreadLocal再合適不過(guò)。

七、總結(jié)

• ThreadLocal 并不解決線程間共享數(shù)據(jù)的問(wèn)題
• ThreadLocal 通過(guò)隱式的在不同線程內(nèi)創(chuàng)建獨(dú)立實(shí)例副本避免了實(shí)例線程安全的問(wèn)題
• 每個(gè)線程持有一個(gè) Map 并維護(hù)了 ThreadLocal 對(duì)象與具體實(shí)例的映射，該 Map 由于只被持有它的線程訪問(wèn)，故不存在線程安全以及鎖的問(wèn)題
• ThreadLocalMap 的 Entry 對(duì) ThreadLocal 的引用為弱引用，避免了 ThreadLocal 對(duì)象無(wú)法被回收的問(wèn)題
• ThreadLocalMap 的 set 方法通過(guò)調(diào)用 replaceStaleEntry 方法回收鍵為 null 的 Entry 對(duì)象的值(即為具體實(shí)例)以及 Entry 對(duì)象本身從而防止內(nèi)存泄漏
• ThreadLocal 適用于變量在線程間隔離且在方法間共享的場(chǎng)景

【本文為51CTO專欄作者“郭俊”的原創(chuàng)稿件，轉(zhuǎn)載請(qǐng)聯(lián)系原作者】

戳這里，看該作者更多好文