ThreadLocal理解和使用

Java并发编程：深入剖析ThreadLocal

     因为在公司项目中前辈采用ThreadLocal来实现线程变量，简化开发，想要了解学习下。个人觉得网上此文讲解不错。特转载记录下。

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

　　以下是本文目录大纲：

　　一.对ThreadLocal的理解

　　二.深入解析ThreadLocal类

　　三.ThreadLocal的应用场景

　　若有不正之处请多多谅解，并欢迎批评指正。

      请尊重作者劳动成果，转载请标明原文链接：

 　　http://www.cnblogs.com/dolphin0520/p/3920407.html

一.对ThreadLocal的理解

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

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

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

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16

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进行了修改的。

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

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28

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类提供的几个方法：

1 2 3 4

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

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

下面会详细说明。

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

　　先看下get方法的实现：

/**
 * Returns the value in the current thread's copy of this
 * thread-local variable.  If the variable has no value for the
 * current thread, it is first initialized to the value returned
 * by an invocation of the {@link #initialValue} method.
 *
 * @return the current thread's value of this thread-local
 */
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();
}

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

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

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

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

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

    /**
     * Get the map associated with a ThreadLocal. Overridden in
     * InheritableThreadLocal.
     *
     * @param  t the current thread
     * @return the map
     */
    ThreadLocalMap getMap(Thread t) {
        return t.threadLocals;
    }

　　可能大家没有想到的是，在getMap中，是调用当期线程t，返回当前线程t中的一个成员变量threadLocals。

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

    /**
     * ThreadLocalMap is a customized hash map suitable only for
     * maintaining thread local values. No operations are exported
     * outside of the ThreadLocal class. The class is package private to
     * allow declaration of fields in class Thread.  To help deal with
     * very large and long-lived usages, the hash table entries use
     * WeakReferences for keys. However, since reference queues are not
     * used, stale entries are guaranteed to be removed only when
     * the table starts running out of space.
     */
    static class ThreadLocalMap {

        /**
         * The entries in this hash map extend WeakReference, using
         * its main ref field as the key (which is always a
         * ThreadLocal object).  Note that null keys (i.e. entry.get()
         * == null) mean that the key is no longer referenced, so the
         * entry can be expunged from table.  Such entries are referred to
         * as "stale entries" in the code that follows.
         */
        static class Entry extends WeakReference<ThreadLocal<?>> {
            /** The value associated with this ThreadLocal. */
            Object value;

            Entry(ThreadLocal<?> k, Object v) {
                super(k);
                value = v;
            }
        }

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

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

    /**
     * Variant of set() to establish initialValue. Used instead
     * of set() in case user has overridden the set() method.
     *
     * @return the initial value
     */
    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;
    }

　　很容易了解，就是如果map不为空，就设置键值对，为空，再创建Map，看一下createMap的实现：

    /**
     * Create the map associated with a ThreadLocal. Overridden in
     * InheritableThreadLocal.
     *
     * @param t the current thread
     * @param firstValue value for the initial entry of the map
     */
    void createMap(Thread t, T firstValue) {
        t.threadLocals = new ThreadLocalMap(this, firstValue);
    }

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

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

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

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

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

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41

public  class  Test {      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  Test test =  new  Test();                              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线程中和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方法返回，而在setInitialValue方法中，有一个语句是T value = initialValue()， 而默认情况下，initialValue方法返回的是null。

/**
 * Returns the value in the current thread's copy of this
 * thread-local variable.  If the variable has no value for the
 * current thread, it is first initialized to the value returned
 * by an invocation of the {@link #initialValue} method.
 *
 * @return the current thread's value of this thread-local
 */
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();
}

/**
 * Variant of set() to establish initialValue. Used instead
 * of set() in case user has overridden the set() method.
 *
 * @return the initial value
 */
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;
}

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37

public  class  Test {      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  Test test =  new  Test();                    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的话，运行时会报空指针异常。

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

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48

public  class  Test {      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  Test test =  new  Test();            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了。

三.ThreadLocal的应用场景

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

1 2 3 4 5 6 7 8 9 10

private  static  ThreadLocal<Connection> connectionHolder =  new  ThreadLocal<Connection>() { public  Connection initialValue() {      return  DriverManager.getConnection(DB_URL); } };   public  static  Connection getConnection() { return  connectionHolder.get(); }

 　　下面这段代码摘自：

　　http://www.iteye.com/topic/103804

1 2 3 4 5 6 7 8 9 10 11 12 13 14

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

四.公司项目中使用的源码

构造线程私有变量VendorThreadCache

public class VendorThreadCache {
    private static final ThreadLocal<ThreadContext> cache = new ThreadLocal<ThreadContext>() {
        protected ThreadContext initialValue() {
            return new ThreadContext();
        }
    };

    private static class ThreadContext {
        private Employee employee;
        private Consumer cUser;
        private String openId;
        private List<Integer> roleIds;
        long startTime;
    }

    public static String getOpenId() {
        return cache.get().openId;
    }

    public static void setOpenId(String openId) {
        cache.get().openId = openId;
    }

    public static Employee getEmployee() {
        return cache.get().employee;
    }

    public static Consumer getCUser() {
        return cache.get().cUser;
    }

    public static void setEmployee(Employee employee) {
        cache.get().employee = employee;
    }

    public static void setCUser(Consumer cUser) {
        cache.get().cUser = cUser;
    }

    public static void setStartTime() {
        cache.get().startTime = System.currentTimeMillis();
    }

    public static long getStartTime() {
        return cache.get().startTime;
    }

    public static void clear() {
        cache.set(new ThreadContext());
    }

    public static List<Integer> getRoles() {
        return cache.get().roleIds;
    }

    public static void setRoles(List<Integer> roles) {
        cache.get().roleIds = roles;
    }
}

在拦截器中初始化数据

public class WeChatOfficialAccountsInterceptor extends HandlerInterceptorAdapter {
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        String openId = getAuthentication(request);
        Consumer consumer = consumerService.getConsumerByOpenId(openId);
        logger.info("consumer = {}", ObjectUtil.toString(consumer));
        VendorThreadCache.setCUser(consumer);
        VendorThreadCache.setOpenId(consumer.getOpenId());
        return true;
    }
}

在Controller控制器中使用线程变量

@RequestMapping("/ttmwsh/consumer")
public class Consumer2CController {

    @GetMapping(value = "/getConsumerInfo")
    public Map<String, Object> getConsumerInfo() {
        Consumer consumer = VendorThreadCache.getCUser();
        try {
            logger.info("Ttmwsh Controller getConsumerInfo consumerId:{}", consumer.getConsumerId());
            ConsumerVo consumerVo = voHelper.transfer2Vo(consumer);
            return ApiResponse.createSuccessResult(consumerVo);
        } catch (ValidateException e) {
            logger.warn("Controller getConsumerInfo error {}", e);
            return ApiResponse.createFailMsgResult(e.getMsg());
        } catch (Exception e) {
            logger.error("Controller getConsumerInfo error consumerId:{}", consumer.getConsumerId(), e);
            return ApiResponse.createFailMsgResult(ErrorType.INTERNAL_SERVER_ERROR, "获得个人信息失败");
        }
    }
}