深入剖析ThreadLocal

Posted 2022-12-03 仲翎逸仙

一、对ThreadLocal的理解

ThreadLocal，很多地方叫做线程本地变量，也有些地方叫做线程本地存储，其实意思差不多。可能很多朋友都知道ThreadLocal为变量在每个线程中都创建了一个副本，那么每个线程可以访问自己内部的副本变量。这句话从字面上看起来很容易理解，但是真正理解并不是那么容易。

ThreadLocal的官方API解释为：

“该类提供了线程局部 (thread-local) 变量。这些变量不同于它们的普通对应物，因为访问某个变量（通过其 get 或 set 方法）的每个线程都有自己的局部变量，它独立于变量的初始化副本。ThreadLocal 实例通常是类中的 private static 字段，它们希望将状态与某一个线程（例如，用户 ID 或事务 ID）相关联。”

大概的意思有两点：

1、ThreadLocal提供了一种访问某个变量的特殊方式：访问到的变量属于当前线程，即保证每个线程的变量不一样，而同一个线程在任何地方拿到的变量都是一致的，这就是所谓的线程隔离。

2、如果要使用ThreadLocal，通常定义为private static类型，在我看来最好是定义为private static final类型。

 很多博客都这样说：ThreadLocal为解决多线程程序的并发问题提供了一种新的思路；ThreadLocal的目的是为了解决多线程访问资源时的共享问题。如果你也这样认为的，那现在给你10秒钟，清空之前对ThreadLocal的错误的认知！

 ThreadLocal可以总结为一句话：ThreadLocal的作用是提供线程内的局部变量，这种变量在线程的生命周期内起作用，减少同一个线程内多个函数或者组件之间一些公共变量的传递的复杂度。

我们还是先来看一个例子：
复制代码

class ConnectionManager

private static Connection connect = null;
 
public static Connection openConnection() 
    if(connect == null)
        connect = DriverManager.getConnection();
    
    return connect;

 
public static void closeConnection() 
    if(connect!=null)
        connect.close();

复制代码

 假设有这样一个数据库链接管理类，这段代码在单线程中使用是没有任何问题的，但是如果在多线程中使用呢？很显然，在多线程中使用会存在线程安全问题：第一，这里面的2个方法都没有进行同步，很可能在openConnection方法中会多次创建connect；第二，由于connect是共享变量，那么必然在调用connect的地方需要使用到同步来保障线程安全，因为很可能一个线程在使用connect进行数据库操作，而另外一个线程调用closeConnection关闭链接。

 所以出于线程安全的考虑，必须将这段代码的两个方法进行同步处理，并且在调用connect的地方需要进行同步处理。这样将会大大影响程序执行效率，因为一个线程在使用connect进行数据库操作的时候，其他线程只有等待。

那么大家来仔细分析一下这个问题，这地方到底需不需要将connect变量进行共享？事实上，是不需要的。假如每个线程中都有一个connect变量，各个线程之间对connect变量的访问实际上是没有依赖关系的，即一个线程不需要关心其他线程是否对这个connect进行了修改的。

 到这里，可能会有朋友想到，既然不需要在线程之间共享这个变量，可以直接这样处理，在每个需要使用数据库连接的方法中具体使用时才创建数据库链接，然后在方法调用完毕再释放这个连接。比如下面这样：

复制代码

class ConnectionManager

private  Connection connect = null;
 
public Connection openConnection() 
    if(connect == null)
        connect = DriverManager.getConnection();
    
    return connect;

 
public void closeConnection() 
    if(connect!=null)
        connect.close();

class Dao
public void insert()
ConnectionManager connectionManager = new ConnectionManager();
Connection connection = connectionManager.openConnection();

    //使用connection进行操作
     
    connectionManager.closeConnection();

复制代码

 这样处理确实也没有任何问题，由于每次都是在方法内部创建的连接，那么线程之间自然不存在线程安全问题。但是这样会有一个致命的影响：导致服务器压力非常大，并且严重影响程序执行性能。由于在方法中需要频繁地开启和关闭数据库连接，这样不尽严重影响程序执行效率，还可能导致服务器压力巨大。

 那么这种情况下使用ThreadLocal是再适合不过的了，因为ThreadLocal在每个线程中对该变量会创建一个副本，即每个线程内部都会有一个该变量，且在线程内部任何地方都可以使用，线程之间互不影响，这样一来就不存在线程安全问题，也不会严重影响程序执行性能。

 但是要注意，虽然ThreadLocal能够解决上面说的问题，但是由于在每个线程中都创建了副本，所以要考虑它对资源的消耗，比如内存的占用会比不使用ThreadLocal要大。

二、深入解析ThreadLocal类

在上面谈到了对ThreadLocal的一些理解，那我们下面来看一下具体ThreadLocal是如何实现的。先了解一下ThreadLocal类提供的几个方法：

public T get()
public void set(T value)
public void remove()
protected T initialValue()

 get()方法是用来获取ThreadLocal在当前线程中保存的变量副本，set()用来设置当前线程中变量的副本，remove()用来移除当前线程中变量的副本，initialValue()是一个protected方法，用来返回此线程局部变量的当前线程的初始值，一般是在使用时进行重写的，它是一个延迟加载方法，下面会详细说明。

首先我们来看一下ThreadLocal类是如何为每个线程创建一个变量的副本的。先看下get方法的实现：
复制代码

1 public T get()
2 //1.首先获取当前线程
3 Thread t = Thread.currentThread();
4 //2.获取线程的map对象
5 ThreadLocalMap map = getMap(t);
6 //3.如果map不为空，以threadlocal实例为key获取到对应Entry，然后从Entry中取出对象即可。
7 if (map != null)
8 ThreadLocalMap.Entry e = map.getEntry(this);
9 if (e != null)
10 return (T)e.value;
11
12 //如果map为空，也就是第一次没有调用set直接get（或者调用过set，又调用了remove）时，为其设定初始值
13 return setInitialValue();
14

复制代码

 第3行是取得当前线程，然后通过getMap(t)方法获取到一个map，map的类型为ThreadLocalMap。然后接着下面获取到<key,value>键值对，注意这里获取键值对传进去的是  this，而不是当前线程t。如果获取成功，则返回value值。如果map为空，则调用setInitialValue方法返回value。

下面我们对上面的每一句来仔细分析。首先看一下getMap方法中做了什么：

ThreadLocalMap getMap(Thread t)
return t.threadLocals;

可能大家没有想到的是，在getMap中，是调用当期线程t，返回当前线程t中的一个成员变量threadLocals。那么我们继续取Thread类中取看一下成员变量threadLocals是什么：

/* ThreadLocal values pertaining to this thread. This map is maintained

• by the ThreadLocal class. */
  ThreadLocal.ThreadLocalMap threadLocals = null;

实际上就是一个ThreadLocalMap，这个类型是ThreadLocal类的一个内部类，我们继续取看ThreadLocalMap的实现：

可以看到ThreadLocalMap的Entry继承了WeakReference，并且使用ThreadLocal作为键值。

 总结一下，get()方法的第3和第5行很明显是获取属于当前线程的ThreadLocalMap，如果这个map不为空，我们就以当前的ThreadLocal为键，去获取相应的Entry，Entry是ThreadLocalMap的静态内部类，它继承于弱引用，所以在get()方法里面如第10行一样调用e.value方法就可以获取实际的资源副本值。但是如果有一个为空，说明属于该线程的资源副本还不存在，则需要去创建资源副本，从代码中可以看到是调用setInitialValue()方法，其定义如下：

复制代码

1 /**
2 * Variant of set() to establish initialValue. Used instead
3 * of set() in case user has overridden the set() method.
4 *
5 * @return the initial value
6 */
7 private T setInitialValue()
8 T value = initialValue();
9 Thread t = Thread.currentThread();
10 ThreadLocalMap map = getMap(t);
11 if (map != null)
12 map.set(this, value);
13 else
14 createMap(t, value);
15 return value;
16

复制代码

 第8行调用initialValue()方法初始化一个值。接下来是判断线程的ThreadLocalMap是否为空，不为空就直接设置值（键为this，值为value），为空则创建一个Map，调用方法为createMap()，其定义如下：

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

简单明了，而ThreadLocalMap的这个构造方法的实现如下：
复制代码

/**

• Construct a new map initially containing (firstKey, firstValue).
• ThreadLocalMaps are constructed lazily, so we only create
• one when we have at least one entry to put in it.
  */
  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);
  

复制代码

实例化table数组用于存储键值对，然后通过映射将键值对存储进入相应的位置。

下面再来看set方法。
复制代码

/**

• Sets the current thread’s copy of this thread-local variable
• to the specified value. Most subclasses will have no need to
• override this method, relying solely on the @link #initialValue
• method to set the values of thread-locals.
• @param value the value to be stored in the current thread’s copy of

•    this thread-local. 
  

*/
public void set(T value)
// 获取当前线程对象
Thread t = Thread.currentThread();
// 获取当前线程本地变量Map
ThreadLocalMap map = getMap(t);
// map不为空
if (map != null)
// 存值
map.set(this, value);
else
// 创建一个当前线程本地变量Map
createMap(t, value);

复制代码

 在这个方法内部我们看到，首先通过getMap(Thread t)方法获取一个和当前线程相关的ThreadLocalMap，然后将变量的值设置到这个ThreadLocalMap对象中，当然如果获取到的ThreadLocalMap对象为空，就通过createMap方法创建。     

 至此，可能大部分朋友已经明白了ThreadLocal是如何为每个线程创建变量的副本的：

首先，在每个线程Thread内部有一个ThreadLocal.ThreadLocalMap类型的成员变量threadLocals，这个threadLocals就是用来存储实际的变量副本的，键值为当前ThreadLocal变量，value为变量副本（即T类型的变量）。

初始时，在Thread里面，threadLocals为空，当通过ThreadLocal变量调用get()方法或者set()方法，就会对Thread类中的threadLocals进行初始化，并且以当前ThreadLocal变量为键值，以ThreadLocal要保存的副本变量为value，存到threadLocals。

然后在当前线程里面，如果要使用副本变量，就可以通过get方法在threadLocals里面查找。

三、示例

示例1：

下面通过一个例子来证明通过ThreadLocal能达到在每个线程中创建变量副本的效果：
按 Ctrl+C 复制代码
按 Ctrl+C 复制代码

这段代码的输出结果为：

1
main
8
Thread-0
1
main

 从这段代码的输出结果可以看出，在main线程中和thread1线程中，longLocal保存的副本值和stringLocal保存的副本值都不一样。最后一次在main线程再次打印副本值是为了证明在main线程中和thread1线程中的副本值确实是不同的。

总结一下：

1）实际的通过ThreadLocal创建的副本是存储在每个线程自己的threadLocals中的；

2）为何threadLocals的类型ThreadLocalMap的键值为ThreadLocal对象，因为每个线程中可有多个threadLocal变量，就像上面代码中的longLocal和stringLocal；

3）在进行get之前，必须先set，否则会报空指针异常。 如果想在get之前不需要调用set就能正常访问的话，必须重写initialValue()方法。

 因为在上面的代码分析过程中，我们发现如果没有先set的话，即在map中查找不到对应的存储，则会通过调用setInitialValue方法返回i，而在setInitialValue方法中，有一个语句是T value = initialValue()， 而默认情况下，initialValue方法返回的是null。

注意 ：默认情况下 initValue(), 返回 null 。线程在没有调用 set 之前，第一次调用 get 的时候， get方法会默认去调用 initValue 这个方法。所以如果没有覆写这个方法，可能导致 get 返回的是 null 。当然如果调用过 set 就不会有这种情况了。但是往往在多线程情况下我们不能保证每个线程的在调用 get 之前都调用了set ，所以最好对 initValue 进行覆写，以免导致空指针异常。

看下面这个例子：
复制代码

package com.demo.test;

public class TestThreadLocal

ThreadLocal<Long> longLocal = new ThreadLocal<Long>();
ThreadLocal<String> stringLocal = new ThreadLocal<String>();

public void set() 
    longLocal.set(Thread.currentThread().getId());
    stringLocal.set(Thread.currentThread().getName());

 
public long getLong() 
    return longLocal.get();

 
public String getString() 
    return stringLocal.get();

 
public static void main(String[] args) throws InterruptedException 
    final TestThreadLocal test = new TestThreadLocal();
     
    //test.set();
    System.out.println(test.getLong());
    System.out.println(test.getString());
     
    Thread thread1 = new Thread()
        public void run() 
            test.set();
            System.out.println(test.getLong());
            System.out.println(test.getString());
        ;
    ;
    thread1.start();
    thread1.join();
     
    System.out.println(test.getLong());
    System.out.println(test.getString());

复制代码

在main线程中，没有先set，直接get的话，运行时会报空指针异常。

Exception in thread “main” java.lang.NullPointerException
at com.demo.test.TestThreadLocal.getLong(TestThreadLocal.java:14)
at com.demo.test.TestThreadLocal.main(TestThreadLocal.java:25)

但是如果改成下面这段代码，即重写了initialValue方法：
复制代码

package com.demo.test;

public class TestThreadLocal

ThreadLocal<Long> longLocal = new ThreadLocal<Long>()
     protected Long initialValue() 
         return Thread.currentThread().getId();
     ;
;
ThreadLocal<String> stringLocal = new ThreadLocal<String>()
     protected String initialValue() 
         return Thread.currentThread().getName();
     ;
;

public void set() 
    longLocal.set(Thread.currentThread().getId());
    stringLocal.set(Thread.currentThread().getName());

 
public long getLong() 
    return longLocal.get();

 
public String getString() 
    return stringLocal.get();

 
public static void main(String[] args) throws InterruptedException 
    final TestThreadLocal test = new TestThreadLocal();
     
    //test.set();
    System.out.println(test.getLong());
    System.out.println(test.getString());
     
    Thread thread1 = new Thread()
        public void run() 
            test.set();
            System.out.println(test.getLong());
            System.out.println(test.getString());
        ;
    ;
    thread1.start();
    thread1.join();
     
    System.out.println(test.getLong());
    System.out.println(test.getString());

复制代码

就可以直接不用先set而直接调用get了。

示例2：
复制代码

package com.demo.test;

public class TestNum

// ①通过匿名内部类覆盖ThreadLocal的initialValue()方法，指定初始值  
private static ThreadLocal<Integer> seqNum = new ThreadLocal<Integer>()   
    public Integer initialValue()   
        return 0;  
      
;  

// ②获取下一个序列值  
public int getNextNum()   
    seqNum.set(seqNum.get() + 1);  
    return seqNum.get();  
  

public static void main(String[] args)   
    TestNum sn = new TestNum();  
    // ③ 3个线程共享sn，各自产生序列号  
    TestClient t1 = new TestClient(sn);  
    TestClient t2 = new TestClient(sn);  
    TestClient t3 = new TestClient(sn);  
    t1.start();  
    t2.start();  
    t3.start();  
  

private static class TestClient extends Thread   
    private TestNum sn;  

    public TestClient(TestNum sn)   
        this.sn = sn;  
      

    public void run()   
        for (int i = 0; i < 3; i++)   
            // ④每个线程打出3个序列值  
            System.out.println("thread[" + Thread.currentThread().getName() + "] --> sn["  
                     + sn.getNextNum() + "]");  
          
      
  

复制代码

  通常我们通过匿名内部类的方式定义ThreadLocal的子类，提供初始的变量值，如例子中①处所示。TestClient线程产生一组序列号，在③处，我们生成3个TestClient，它们共享同一个TestNum实例。运行以上代码，在控制台上输出以下的结果：

复制代码

thread[Thread-0] --> sn[1]
thread[Thread-1] --> sn[1]
thread[Thread-2] --> sn[1]
thread[Thread-1] --> sn[2]
thread[Thread-0] --> sn[2]
thread[Thread-1] --> sn[3]
thread[Thread-2] --> sn[2]
thread[Thread-0] --> sn[3]
thread[Thread-2] --> sn[3]

复制代码

 考察输出的结果信息，我们发现每个线程所产生的序号虽然都共享同一个TestNum实例，但它们并没有发生相互干扰的情况，而是各自产生独立的序列号，这是因为我们通过ThreadLocal为每一个线程提供了单独的副本。

四、ThreadLocal的应用场景

最常见的ThreadLocal使用场景为 用来解决 数据库连接、Session管理等。

如：
复制代码

private static ThreadLocal connectionHolder
= new ThreadLocal()
public Connection initialValue()
return DriverManager.getConnection(DB_URL);

;

public static Connection getConnection()
return connectionHolder.get();

复制代码
复制代码

private static final ThreadLocal threadSession = new ThreadLocal();

public static Session getSession() throws InfrastructureException
Session s = (Session) threadSession.get();
try
if (s == null)
s = getSessionFactory().openSession();
threadSession.set(s);

catch (HibernateException ex)
throw new InfrastructureException(ex);

return s;

复制代码

ThreadLocal对象通常用于防止对可变的单实例变量或全局变量进行共享。

当一个类中使用了static成员变量的时候，一定要多问问自己，这个static成员变量需要考虑线程安全吗？也就是说，多个线程需要独享自己的static成员变量吗？如果需要考虑，不妨使用ThreadLocal。

ThreadLocal的主要应用场景为多线程多实例（每个线程对应一个实例）的对象的访问，并且这个对象很多地方都要用到。例如：同一个网站登录用户，每个用户服务器会为其开一个线程，每个线程中创建一个ThreadLocal，里面存用户基本信息等，在很多页面跳转时，会显示用户信息或者得到用户的一些信息等频繁操作，这样多线程之间并没有联系而且当前线程也可以及时获取想要的数据。

  ThreadLocal通常用来共享数据，当你想在多个方法中使用某个变量，这个变量是当前线程的状态，其它线程不依赖这个变量，你第一时间想到的就是把变量定义在方法内部，然后再方法之间传递参数来使用，这个方法能解决问题，但是有个烦人的地方就是，每个方法都需要声明形参，多处声明，多处调用。影响代码的美观和维护。有没有一种方法能将变量像private static形式来访问呢？这样在类的任何一处地方就都能使用。这个时候ThreadLocal大显身手了。

五、总结

1、ThreadLocal 的实现思想，我们在前面已经说了，每个线程维护一个 ThreadLocalMap 的映射表，映射表的 key 是 ThreadLocal 实例本身，value 是要存储的副本变量。ThreadLocal 实例本身并不存储值，它只是提供一个在当前线程中找到副本值的 key。 如下图所示：

2、线程隔离的秘密，就在于ThreadLocalMap这个类。ThreadLocalMap是ThreadLocal类的一个静态内部类，它实现了键值对的设置和获取（对比Map对象来理解），每个线程中都有一个独立的ThreadLocalMap副本，它所存储的值，只能被当前线程读取和修改。ThreadLocal类通过操作每一个线程特有的ThreadLocalMap副本，从而实现了变量访问在不同线程中的隔离。因为每个线程的变量都是自己特有的，完全不会有并发错误。还有一点就是，ThreadLocalMap存储的键值对中的键是this对象指向的ThreadLocal对象，而值就是你所设置的对象了。

3、ThreadLocalMap并不是为了解决线程安全问题，而是提供了一种将实例绑定到当前线程的机制，类似于隔离的效果，实际上自己在方法中new出来变量也能达到类似的效果。ThreadLocalMap跟线程安全基本不搭边，绑定上去的实例也不是多线程公用的，而是每个线程new一份，这个实例肯定不是共用的，如果共用了，那就会引发线程安全问题。ThreadLocalMap最大的用处就是用来把实例变量共享成全局变量，在程序的任何方法中都可以访问到该实例变量而已。网上很多人说ThreadLocalMap是解决了线程安全问题，其实是望文生义，两者不是同类问题。

4、ThreadLocal设计的初衷是为了解决多线程编程中的资源共享问题。提起这个，大家一般会想到synchronized，synchronized采取的是“以时间换空间”的策略，本质上是对关键资源上锁，让大家排队操作。而ThreadLocal采取的是“以空间换时间”的思路，为每个使用该变量的线程提供独立的变量副本，在本线程内部，它相当于一个“全局变量”，可以保证本线程任何时间操纵的都是同一个对象。

5、ThreadLocal类最重要的一个概念是，其原理是通过一个ThreadLocal的静态内部类ThreadLocalMap实现，但是实际中，ThreadLocal不保存ThreadLocalMap，而是有每个Thread内部维护ThreadLocal.ThreadLocalMap threadLocals一份数据结构。

这里画张图更容易理解，假如我们有如下的代码：

class ThreadLocalDemo

ThreadLocal localA = new ThreadLocal();
ThreadLocal localB = new ThreadLocal();

在多线程环境下，数据结构应该是如下图所示：

6、ThreadLocal使用的一般步骤：

（1）在多线程的类（如ThreadDemo类）中，创建一个ThreadLocal对象threadXxx，用来保存线程间需要隔离处理的对象xxx。

（2）在ThreadDemo类中，创建一个获取要隔离访问的数据的方法getXxx()，在方法中判断，若ThreadLocal对象为null时候，应该new()一个隔离访问类型的对象，并强制转换为要应用的类型。

（3）在ThreadDemo类的run()方法中，通过getXxx()方法获取要操作的数据，这样可以保证每个线程对应一个数据对象，在任何时刻都操作的是这个对象。

7、ThreadLocal 与 synchronized 的对比

（1）ThreadLocal和synchonized都用于解决多线程并发访问。但是ThreadLocal与synchronized有本质的区别。synchronized是利用锁的机制，使变量或代码块在某一时该只能被一个线程访问。而ThreadLocal为每一个线程都提供了变量的副本，使得每个线程在某一时间访问到的并不是同一个对象，这样就隔离了多个线程对数据的数据共享。而synchronized却正好相反，它用于在多个线程间通信时能够获得数据共享。

（2）synchronized用于线程间的数据共享，而ThreadLocal则用于线程间的数据隔离。

8、一句话理解ThreadLocal：向ThreadLocal里面存东西就是向它里面的Map存东西的，然后ThreadLocal把这个Map挂到当前的线程底下，这样Map就只属于这个线程了。