一、ThreadLocal简介

ThreadLocal叫做线程变量，意思是ThreadLocal中填充的变量属于当前线程，该变量对其他线程而言是隔离的，也就是说该变量是当前线程独有的变量。ThreadLocal为变量在每个线程中都创建了一个副本，那么每个线程可以访问自己内部的副本变量。
ThreadLoal 变量，线程局部变量，同一个 ThreadLocal 所包含的对象，在不同的 Thread 中有不同的副本。这里有几点需要注意：

  • 因为每个 Thread 内有自己的实例副本，且该副本只能由当前 Thread 使用。这是也是 ThreadLocal 命名的由来。
  • 既然每个 Thread 有自己的实例副本，且其它 Thread 不可访问，那就不存在多线程间共享的问题。

ThreadLocal 提供了线程本地的实例。它与普通变量的区别在于，每个使用该变量的线程都会初始化一个完全独立的实例副本。ThreadLocal 变量通常被private static修饰。当一个线程结束时，它所使用的所有 ThreadLocal 相对的实例副本都可被回收。
总的来说，ThreadLocal 适用于每个线程需要自己独立的实例且该实例需要在多个方法中被使用，也即变量在线程间隔离而在方法或类间共享的场景
下图可以增强理解：
image.png

  1.                                                              图1-1  ThreadLocal在使用过程中状态

二、ThreadLocal与Synchronized的区别

ThreadLocal其实是与线程绑定的一个变量。ThreadLocal和Synchonized都用于解决多线程并发访问。
但是ThreadLocal与synchronized有本质的区别：
1、Synchronized用于线程间的数据共享，而ThreadLocal则用于线程间的数据隔离。
2、Synchronized是利用锁的机制，使变量或代码块在某一时该只能被一个线程访问。而ThreadLocal为每一个线程都提供了变量的副本，使得每个线程在某一时间访问到的并不是同一个对象，这样就隔离了多个线程对数据的数据共享。而Synchronized却正好相反，它用于在多个线程间通信时能够获得数据共享。
一句话理解ThreadLocal，向ThreadLocal里面存东西就是向它里面的Map存东西的，然后ThreadLocal把这个Map挂到当前的线程底下，这样Map就只属于这个线程了。

三、ThreadLocal的简单使用

直接上代码：

  2. public class ThreadLocaDemo {
  4.     private static ThreadLocal<String> localVar = new ThreadLocal<String>();
  6.     static void print(String str) {
  7.         //打印当前线程中本地内存中本地变量的值
  8.         System.out.println(str + " :" + localVar.get());
  9.         //清除本地内存中的本地变量
  10.         localVar.remove();
  11.     }
  12.     public static void main(String[] args) throws InterruptedException {
  14.         new Thread(new Runnable() {
  15.             public void run() {
  16.                 ThreadLocaDemo.localVar.set("local_A");
  17.                 print("A");
  18.                 //打印本地变量
  19.                 System.out.println("after remove : " + localVar.get());
  21.             }
  22.         },"A").start();
  24.         Thread.sleep(1000);
  26.         new Thread(new Runnable() {
  27.             public void run() {
  28.                 ThreadLocaDemo.localVar.set("local_B");
  29.                 print("B");
  30.                 System.out.println("after remove : " + localVar.get());
  32.             }
  33.         },"B").start();
  34.     }
  35. }
  37. A :local_A
  38. after remove : null
  39. B :local_B
  40. after remove : null

从这个示例中我们可以看到，两个线程分表获取了自己线程存放的变量，他们之间变量的获取并不会错乱。这个的理解也可以结合图1-1，相信会有一个更深刻的理解。

四、ThreadLocal的原理

要看原理那么就得从源码看起。

4.1 ThreadLocal的set()方法：

  1. public void set(T value) {
  2.     //1、获取当前线程
  3.     Thread t = Thread.currentThread();
  4.     //2、获取线程中的属性 threadLocalMap ,如果threadLocalMap 不为空，
  5.     //则直接更新要保存的变量值，否则创建threadLocalMap，并赋值
  6.     ThreadLocalMap map = getMap(t);
  7.     if (map != null)
  8.         map.set(this, value);
  9.     else
  10.         // 初始化thradLocalMap 并赋值
  11.         createMap(t, value);
  12. }
  1.      从上面的代码可以看出，ThreadLocal  set赋值的时候首先会获取当前线程thread,并获取thread线程中的ThreadLocalMap属性。如果map属性不为空，则直接更新value值，如果map为空，则实例化threadLocalMap,并将value值初始化。<br />那么ThreadLocalMap又是什么呢，还有createMap又是怎么做的，我们继续往下看。大家最后自己再idea上跟下源码，会有更深的认识。
  1.   static class ThreadLocalMap {
  3.         /**
  4.          * The entries in this hash map extend WeakReference, using
  5.          * its main ref field as the key (which is always a
  6.          * ThreadLocal object).  Note that null keys (i.e. entry.get()
  7.          * == null) mean that the key is no longer referenced, so the
  8.          * entry can be expunged from table.  Such entries are referred to
  9.          * as "stale entries" in the code that follows.
  10.          */
  11.         static class Entry extends WeakReference<ThreadLocal<?>> {
  12.             /** The value associated with this ThreadLocal. */
  13.             Object value;
  15.             Entry(ThreadLocal<?> k, Object v) {
  16.                 super(k);
  17.                 value = v;
  18.             }
  19.         }
  22.     }

可看出ThreadLocalMap是ThreadLocal的内部静态类，而它的构成主要是用Entry来保存数据 ，而且还是继承的弱引用。在Entry内部使用ThreadLocal作为key，使用我们设置的value作为value。详细内容要大家自己去跟。

  1. //这个是threadlocal 的内部方法
  2. void createMap(Thread t, T firstValue) {
  3.         t.threadLocals = new ThreadLocalMap(this, firstValue);
  4.     }
  7.     //ThreadLocalMap 构造方法
  8. ThreadLocalMap(ThreadLocal<?> firstKey, Object firstValue) {
  9.             table = new Entry[INITIAL_CAPACITY];
  10.             int i = firstKey.threadLocalHashCode & (INITIAL_CAPACITY - 1);
  11.             table[i] = new Entry(firstKey, firstValue);
  12.             size = 1;
  13.             setThreshold(INITIAL_CAPACITY);
  14.         }

4.2 ThreadLocal的get方法

  1.     public T get() {
  2.         //1、获取当前线程
  3.         Thread t = Thread.currentThread();
  4.         //2、获取当前线程的ThreadLocalMap
  5.         ThreadLocalMap map = getMap(t);
  6.         //3、如果map数据为空，
  7.         if (map != null) {
  8.             //3.1、获取threalLocalMap中存储的值
  9.             ThreadLocalMap.Entry e = map.getEntry(this);
  10.             if (e != null) {
  11.                 @SuppressWarnings("unchecked")
  12.                 T result = (T)e.value;
  13.                 return result;
  14.             }
  15.         }
  16.         //如果是数据为null，则初始化，初始化的结果，TheralLocalMap中存放key值为threadLocal，值为null
  17.         return setInitialValue();
  18.     }
  21. private T setInitialValue() {
  22.         T value = initialValue();
  23.         Thread t = Thread.currentThread();
  24.         ThreadLocalMap map = getMap(t);
  25.         if (map != null)
  26.             map.set(this, value);
  27.         else
  28.             createMap(t, value);
  29.         return value;
  30.     }

4.3 ThreadLocal的remove方法

  1.  public void remove() {
  2.          ThreadLocalMap m = getMap(Thread.currentThread());
  3.          if (m != null)
  4.              m.remove(this);
  5.      }

remove方法，直接将ThrealLocal 对应的值从当前相差Thread中的ThreadLocalMap中删除。为什么要删除，这涉及到内存泄露的问题。
实际上 ThreadLocalMap 中使用的 key 为 ThreadLocal 的弱引用，弱引用的特点是，如果这个对象只存在弱引用，那么在下一次垃圾回收的时候必然会被清理掉。
所以如果 ThreadLocal 没有被外部强引用的情况下，在垃圾回收的时候会被清理掉的，这样一来 ThreadLocalMap中使用这个 ThreadLocal 的 key 也会被清理掉。但是，value 是强引用，不会被清理，这样一来就会出现 key 为 null 的 value。
ThreadLocal其实是与线程绑定的一个变量，如此就会出现一个问题：如果没有将ThreadLocal内的变量删除（remove）或替换，它的生命周期将会与线程共存。通常线程池中对线程管理都是采用线程复用的方法，在线程池中线程很难结束甚至于永远不会结束，这将意味着线程持续的时间将不可预测，甚至与JVM的生命周期一致。举个例字，如果ThreadLocal中直接或间接包装了集合类或复杂对象，每次在同一个ThreadLocal中取出对象后，再对内容做操作，那么内部的集合类和复杂对象所占用的空间可能会开始持续膨胀。

4.4 ThreadLocal与Thread，ThreadLocalMap之间的关系

image.png
image.png
图4-1 Thread、THreadLocal、ThreadLocalMap之间啊的数据关系图
从这个图中我们可以非常直观的看出，ThreadLocalMap其实是Thread线程的一个属性值，而ThreadLocal是维护ThreadLocalMap
这个属性指的一个工具类。Thread线程可以拥有多个ThreadLocal维护的自己线程独享的共享变量（这个共享变量只是针对自己线程里面共享）

五、ThreadLocal 常见使用场景

如上文所述，ThreadLocal 适用于如下两种场景
1、每个线程需要有自己单独的实例
2、实例需要在多个方法中共享，但不希望被多线程共享
对于第一点，每个线程拥有自己实例，实现它的方式很多。例如可以在线程内部构建一个单独的实例。ThreadLocal 可以以非常方便的形式满足该需求。
对于第二点，可以在满足第一点（每个线程有自己的实例）的条件下，通过方法间引用传递的形式实现。ThreadLocal 使得代码耦合度更低，且实现更优雅。
场景
1）存储用户Session
一个简单的用ThreadLocal来存储Session的例子：

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

场景二、数据库连接，处理数据库事务
场景三、数据跨层传递（controller,service, dao）
每个线程内需要保存类似于全局变量的信息（例如在拦截器中获取的用户信息），可以让不同方法直接使用，避免参数传递的麻烦却不想被多线程共享（因为不同线程获取到的用户信息不一样）。
例如，用 ThreadLocal 保存一些业务内容（用户权限信息、从用户系统获取到的用户名、用户ID 等），这些信息在同一个线程内相同，但是不同的线程使用的业务内容是不相同的。
在线程生命周期内，都通过这个静态 ThreadLocal 实例的 get() 方法取得自己 set 过的那个对象，避免了将这个对象（如 user 对象）作为参数传递的麻烦。
比如说我们是一个用户系统，那么当一个请求进来的时候，一个线程会负责执行这个请求，然后这个请求就会依次调用service-1()、service-2()、service-3()、service-4()，这4个方法可能是分布在不同的类中的。这个例子和存储session有些像。

  2. package com.kong.threadlocal;
  5. public class ThreadLocalDemo05 {
  6.     public static void main(String[] args) {
  7.         User user = new User("jack");
  8.         new Service1().service1(user);
  9.     }
  11. }
  13. class Service1 {
  14.     public void service1(User user){
  15.         //给ThreadLocal赋值，后续的服务直接通过ThreadLocal获取就行了。
  16.         UserContextHolder.holder.set(user);
  17.         new Service2().service2();
  18.     }
  19. }
  21. class Service2 {
  22.     public void service2(){
  23.         User user = UserContextHolder.holder.get();
  24.         System.out.println("service2拿到的用户:"+user.name);
  25.         new Service3().service3();
  26.     }
  27. }
  29. class Service3 {
  30.     public void service3(){
  31.         User user = UserContextHolder.holder.get();
  32.         System.out.println("service3拿到的用户:"+user.name);
  33.         //在整个流程执行完毕后，一定要执行remove
  34.         UserContextHolder.holder.remove();
  35.     }
  36. }
  38. class UserContextHolder {
  39.     //创建ThreadLocal保存User对象
  40.     public static ThreadLocal<User> holder = new ThreadLocal<>();
  41. }
  43. class User {
  44.     String name;
  45.     public User(String name){
  46.         this.name = name;
  47.     }
  48. }
  50. 执行的结果：
  52. service2拿到的用户:jack
  53. service3拿到的用户:jack

场景四、Spring使用ThreadLocal解决线程安全问题
我们知道在一般情况下，只有无状态的Bean才可以在多线程环境下共享，在Spring中，绝大部分Bean都可以声明为singleton作用域。就是因为Spring对一些Bean（如RequestContextHolder、TransactionSynchronizationManager、LocaleContextHolder等）中非线程安全的“状态性对象”采用ThreadLocal进行封装，让它们也成为线程安全的“状态性对象”，因此有状态的Bean就能够以singleton的方式在多线程中正常工作了。
一般的Web应用划分为展现层、服务层和持久层三个层次，在不同的层中编写对应的逻辑，下层通过接口向上层开放功能调用。在一般情况下，从接收请求到返回响应所经过的所有程序调用都同属于一个线程，如图9-2所示。
image.png
这样用户就可以根据需要，将一些非线程安全的变量以ThreadLocal存放，在同一次请求响应的调用线程中，所有对象所访问的同一ThreadLocal变量都是当前线程所绑定的。
下面的实例能够体现Spring对有状态Bean的改造思路：
代码清单9-5 TopicDao：非线程安全

  1. public class TopicDao {
  2.    //①一个非线程安全的变量
  3.    private Connection conn; 
  4.    public void addTopic(){
  5.         //②引用非线程安全变量
  6.        Statement stat = conn.createStatement();
  7.        …
  8.    }

由于①处的conn是成员变量，因为addTopic()方法是非线程安全的，必须在使用时创建一个新TopicDao实例（非singleton）。下面使用ThreadLocal对conn这个非线程安全的“状态”进行改造：
代码清单9-6 TopicDao：线程安全 

  1. import java.sql.Connection;
  2. import java.sql.Statement;
  3. public class TopicDao {
  5.   //①使用ThreadLocal保存Connection变量
  6. private static ThreadLocal<Connection> connThreadLocal = new ThreadLocal<Connection>();
  7. public static Connection getConnection(){
  9.         //②如果connThreadLocal没有本线程对应的Connection创建一个新的Connection，
  10.         //并将其保存到线程本地变量中。
  11.         if (connThreadLocal.get() == null) {
  12.             Connection conn = ConnectionManager.getConnection();
  13.             connThreadLocal.set(conn);
  14.               return conn;
  15.         }else{
  16.               //③直接返回线程本地变量
  17.             return connThreadLocal.get();
  18.         }
  19.     }
  20.     public void addTopic() {
  22.         //④从ThreadLocal中获取线程对应的
  23.          Statement stat = getConnection().createStatement();
  24.     }

不同的线程在使用TopicDao时，先判断connThreadLocal.get()是否为null，如果为null，则说明当前线程还没有对应的Connection对象，这时创建一个Connection对象并添加到本地线程变量中；如果不为null，则说明当前的线程已经拥有了Connection对象，直接使用就可以了。这样，就保证了不同的线程使用线程相关的Connection，而不会使用其他线程的Connection。因此，这个TopicDao就可以做到singleton共享了。
当然，这个例子本身很粗糙，将Connection的ThreadLocal直接放在Dao只能做到本Dao的多个方法共享Connection时不发生线程安全问题，但无法和其他Dao共用同一个Connection，要做到同一事务多Dao共享同一个Connection，必须在一个共同的外部类使用ThreadLocal保存Connection。但这个实例基本上说明了Spring对有状态类线程安全化的解决思路。在本章后面的内容中，我们将详细说明Spring如何通过ThreadLocal解决事务管理的问题。