threadlocal原理及常用应用场景

青旅半醒 2022-05-25 23:04 231阅读 0赞

想必很多朋友对ThreadLocal并不陌生，今天我们就来一起探讨下ThreadLocal的使用方法和实现原理。首先，本文先谈一下对ThreadLocal的理解，然后根据ThreadLocal类的源码分析了其实现原理和使用需要注意的地方，最后给出了两个应用场景。

一.对ThreadLocal的理解

ThreadLocal，很多地方叫做线程本地变量，也有些地方叫做线程本地存储，其实意思差不多。可能很多朋友都知道ThreadLocal为变量在每个线程中都创建了一个副本，那么每个线程可以访问自己内部的副本变量。

这句话从字面上看起来很容易理解，但是真正理解并不是那么容易。

我们还是先来看一个例子：

Java代码   ![收藏代码][icon_star.png]

1.  class ConnectionManager \{  
2.     
3.   private static Connection connect = null;  
4.     
5.   public static Connection openConnection() \{  
6.   if(connect == null)\{  
7.   connect = DriverManager.getConnection();  
8.   \}  
9.   return connect;  
10.  \}  
11.    
12.  public static void closeConnection() \{  
13.  if(connect!=null)  
14.  connect.close();  
15.  \}  
16. \}

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

所以出于线程安全的考虑，必须将这段代码的两个方法进行同步处理，并且在调用connect的地方需要进行同步处理。

这样将会大大影响程序执行效率，因为一个线程在使用connect进行数据库操作的时候，其他线程只有等待。

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

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

Java代码   ![收藏代码][icon_star.png]

1.  class ConnectionManager \{  
2.     
3.   private Connection connect = null;  
4.     
5.   public Connection openConnection() \{  
6.   if(connect == null)\{  
7.   connect = DriverManager.getConnection();  
8.   \}  
9.   return connect;  
10.  \}  
11.    
12.  public void closeConnection() \{  
13.  if(connect!=null)  
14.  connect.close();  
15.  \}  
16. \}  
17.    
18. class Dao\{  
19.  public void insert() \{  
20.  ConnectionManager connectionManager = new ConnectionManager();  
21.  Connection connection = connectionManager.openConnection();  
22.    
23.  //使用connection进行操作  
24.    
25.  connectionManager.closeConnection();  
26.  \}  
27. \}

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

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

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

二.深入解析ThreadLocal类

在上面谈到了对ThreadLocal的一些理解，那我们下面来看一下具体ThreadLocal是如何实现的。

先了解一下ThreadLocal类提供的几个方法：

Java代码   ![收藏代码][icon_star.png]

1.  public T get() \{ \}  
2.  public void set(T value) \{ \}  
3.  public void remove() \{ \}  
4.  protected T initialValue() \{ \}

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

首先我们来看一下ThreadLocal类是如何为每个线程创建一个变量的副本的。

先看下get方法的实现：

![199dbecb-799a-3416-a128-d28f33e452ad.jpg][]  
        第一句是取得当前线程，然后通过getMap(t)方法获取到一个map，map的类型为ThreadLocalMap。然后接着下面获取到<key,value>键值对，注意这里获取键值对传进去的是 this，而不是当前线程t。

如果获取成功，则返回value值。

如果map为空，则调用setInitialValue方法返回value。

我们上面的每一句来仔细分析：

首先看一下getMap方法中做了什么：

![698102e7-3050-3d59-abeb-88ce6fe1af09.jpg][]  
        可能大家没有想到的是，在getMap中，是调用当期线程t，返回当前线程t中的一个成员变量threadLocals。

那么我们继续取Thread类中取看一下成员变量threadLocals是什么：

![874880da-b5b7-3aac-a306-cc51290ad965.jpg][]  
        实际上就是一个ThreadLocalMap，这个类型是ThreadLocal类的一个内部类，我们继续取看ThreadLocalMap的实现：

![11057335-c0ad-3560-b166-1d486e5009d2.jpg][]  
        可以看到ThreadLocalMap的Entry继承了WeakReference，并且使用ThreadLocal作为键值。

然后再继续看setInitialValue方法的具体实现：

![ca2fe71c-b286-3f1f-8159-9d325f6ba932.jpg][]  
        很容易了解，就是如果map不为空，就设置键值对，为空，再创建Map，看一下createMap的实现：

![3a4b4822-beae-3e19-a15b-480c272917d0.jpg][]  
        至此，可能大部分朋友已经明白了ThreadLocal是如何为每个线程创建变量的副本的：

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

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

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

下面通过一个例子来证明通过ThreadLocal能达到在每个线程中创建变量副本的效果：

Java代码   ![收藏代码][icon_star.png]

1.  package com.bijian.study;  
2.    
3.  public class Test \{  
4.        
5.      ThreadLocal<Long> longLocal = new ThreadLocal<Long>();  
6.      ThreadLocal<String> stringLocal = new ThreadLocal<String>();  
7.    
8.      public void set() \{  
9.          longLocal.set(Thread.currentThread().getId());  
10.         stringLocal.set(Thread.currentThread().getName());  
11.     \}  
12.   
13.     public long getLong() \{  
14.         return longLocal.get();  
15.     \}  
16.   
17.     public String getString() \{  
18.         return stringLocal.get();  
19.     \}  
20.   
21.     public static void main(String\[\] args) throws InterruptedException \{  
22.         final Test test = new Test();  
23.   
24.         test.set();  
25.         System.out.println(test.getLong());  
26.         System.out.println(test.getString());  
27.   
28.         Thread thread1 = new Thread() \{  
29.             public void run() \{  
30.                 test.set();  
31.                 System.out.println(test.getLong());  
32.                 System.out.println(test.getString());  
33.             \};  
34.         \};  
35.         thread1.start();  
36.         thread1.join();  
37.   
38.         System.out.println(test.getLong());  
39.         System.out.println(test.getString());  
40.     \}  
41. \}

运行结果：

Text代码   ![收藏代码][icon_star.png]

1.  1  
2.  main  
3.  11  
4.  Thread-0  
5.  1  
6.  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。

![776ec899-ceb7-343d-942d-7b598bdd5771.jpg][]  
        看下面这个例子：

Java代码   ![收藏代码][icon_star.png]

1.  package com.bijian.study;  
2.    
3.  public class Test02 \{  
4.    
5.      ThreadLocal<Long> longLocal = new ThreadLocal<Long>();  
6.      ThreadLocal<String> stringLocal = new ThreadLocal<String>();  
7.    
8.      public void set() \{  
9.          longLocal.set(Thread.currentThread().getId());  
10.         stringLocal.set(Thread.currentThread().getName());  
11.     \}  
12.   
13.     public long getLong() \{  
14.         return longLocal.get();  
15.     \}  
16.   
17.     public String getString() \{  
18.         return stringLocal.get();  
19.     \}  
20.   
21.     public static void main(String\[\] args) throws InterruptedException \{  
22.         final Test02 test = new Test02();  
23.   
24.         System.out.println(test.getLong());  
25.         System.out.println(test.getString());  
26.   
27.         Thread thread1 = new Thread() \{  
28.             public void run() \{  
29.                 test.set();  
30.                 System.out.println(test.getLong());  
31.                 System.out.println(test.getString());  
32.             \};  
33.         \};  
34.         thread1.start();  
35.         thread1.join();  
36.   
37.         System.out.println(test.getLong());  
38.         System.out.println(test.getString());  
39.     \}  
40. \}

运行结果：

Text代码   ![收藏代码][icon_star.png]

1.  Exception in thread "main" java.lang.NullPointerException  
2.      at com.bijian.study.Test02.getLong(Test02.java:14)  
3.      at com.bijian.study.Test02.main(Test02.java:24)

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

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

Java代码   ![收藏代码][icon_star.png]

1.  package com.bijian.study;  
2.    
3.  public class Test03 \{  
4.    
5.      ThreadLocal<Long> longLocal = new ThreadLocal<Long>() \{  
6.          protected Long initialValue() \{  
7.              return Thread.currentThread().getId();  
8.          \};  
9.      \};  
10.       
11.     ThreadLocal<String> stringLocal = new ThreadLocal<String>() \{  
12.         protected String initialValue() \{  
13.             return Thread.currentThread().getName();  
14.         \};  
15.     \};  
16.   
17.     public void set() \{  
18.         longLocal.set(Thread.currentThread().getId());  
19.         stringLocal.set(Thread.currentThread().getName());  
20.     \}  
21.   
22.     public long getLong() \{  
23.         return longLocal.get();  
24.     \}  
25.   
26.     public String getString() \{  
27.         return stringLocal.get();  
28.     \}  
29.   
30.     public static void main(String\[\] args) throws InterruptedException \{  
31.         final Test03 test = new Test03();  
32.   
33.         //test.set();  
34.         System.out.println(test.getLong());  
35.         System.out.println(test.getString());  
36.   
37.         Thread thread1 = new Thread() \{  
38.             public void run() \{  
39.                 //test.set();  
40.                 System.out.println(test.getLong());  
41.                 System.out.println(test.getString());  
42.             \};  
43.         \};  
44.         thread1.start();  
45.         thread1.join();  
46.   
47.         System.out.println(test.getLong());  
48.         System.out.println(test.getString());  
49.     \}  
50. \}

运行结果：

Text代码   ![收藏代码][icon_star.png]

1.  1  
2.  main  
3.  8  
4.  Thread-0  
5.  1  
6.  main

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

三.ThreadLocal的应用场景

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

数据库连接：

Java代码   ![收藏代码][icon_star.png]

1.  private static ThreadLocal<Connection> connectionHolder = new ThreadLocal<Connection>() \{  
2.      public Connection initialValue() \{  
3.          return DriverManager.getConnection(DB\_URL);  
4.      \}  
5.  \};  
6.    
7.  public static Connection getConnection() \{  
8.      return connectionHolder.get();  
9.  \}

Session管理：

Java代码   ![收藏代码][icon_star.png]

1.  private static final ThreadLocal threadSession = new ThreadLocal();  
2.    
3.  public static Session getSession() throws InfrastructureException \{  
4.      Session s = (Session) threadSession.get();  
5.      try \{  
6.          if (s == null) \{  
7.              s = getSessionFactory().openSession();  
8.              threadSession.set(s);  
9.          \}  
10.     \} catch (HibernateException ex) \{  
11.         throw new InfrastructureException(ex);  
12.     \}  
13.     return s;  
14. \}    
    
15.

[icon_star.png]: /images/20220526/fd83af25b62e4ecea9bcb843e7428302.png
[199dbecb-799a-3416-a128-d28f33e452ad.jpg]: /images/20220526/77dd548c6d05405eac61d0788b30df08.png
[698102e7-3050-3d59-abeb-88ce6fe1af09.jpg]: /images/20220526/b8e22c71279f434cb8e2d1a1bd8e88f5.png
[874880da-b5b7-3aac-a306-cc51290ad965.jpg]: /images/20220526/8e2b31c9af444a788ca5890bcb1d8e4d.png
[11057335-c0ad-3560-b166-1d486e5009d2.jpg]: /images/20220526/a33c0f1c6cea4a818303d2f7c4b92321.png
[ca2fe71c-b286-3f1f-8159-9d325f6ba932.jpg]: /images/20220526/d1aad503df2c43da871a25c5d734b70c.png
[3a4b4822-beae-3e19-a15b-480c272917d0.jpg]: /images/20220526/2d8bfa51291f4b888157de9f2218bed4.png
[776ec899-ceb7-343d-942d-7b598bdd5771.jpg]: /images/20220526/a514da7f930f4931a9ef94e4959a8337.png