我们知道Spring通过各种模板类降低了开发者使用各种数据持久技术的难度。这些模板类都是线程安全的,也就是说,多个DAO可以复用同一个模板实例而不会发生冲突。我们使用模板类访问底层数据,根据持久化技术的不同,模板类需要绑定数据连接或会话的资源。但这些资源本身是非线程安全的,也就是说它们不能在同一时刻被多个线程共享。虽然模板类通过资源池获取数据连接或会话,但资源池本身解决的是数据连接或会话的缓存问题,并非数据连接或会话的线程安全问题。
  按照传统经验,如果某个对象是非线程安全的,在多线程环境下,对对象的访问必须采用synchronized进行线程同步。但模板类并未采用线程同步机制,因为线程同步会降低并发性,影响系统性能。此外,通过代码同步解决线程安全的挑战性很大,可能会增强好几倍的实现难度。那么模板类究竟仰仗何种魔法神功,可以在无须线程同步的情况下就化解线程安全的难题呢?答案就是ThreadLocal!
  ThreadLocal在Spring中发挥着重要的作用,在管理request作用域的Bean、事务管理、任务调度、AOP等模块都出现了它们的身影,起着举足轻重的作用。要想了解Spring事务管理的底层技术,ThreadLocal是必须攻克的山头堡垒。


1 ThreadLocal概述

早在JDK 1.2的版本中就提供java.lang.ThreadLocal,ThreadLocal为解决多线程程序的并发问题提供了一种新的思路。使用这个工具类可以很简洁地编写出优美的多线程程序。
  ThreadLocal,顾名思义,它不是一个线程,而是线程的一个本地化对象。当工作于多线程中的对象使用ThreadLocal维护变量时,ThreadLocal为每个使用该变量的线程分配一个独立的变量副本。所以每一个线程都可以独立地改变自己的副本,而不会影响其他线程所对应的副本。从线程的角度看,这个变量就像是线程的本地变量,这也是类名中“Local”所要表达的意思。
  线程局部变量并不是Java的新发明,很多语言(如IBM XL、FORTRAN)在语法层面就提供线程局部变量。在Java中没有提供语言级支持,而以一种变通的方法,通过ThreadLocal的类提供支持。所以,在Java中编写线程局部变量的代码相对来说要笨拙一些,这也是为什么线程局部变量没有在Java开发者中得到很好普及的原因。

  学习JDK中的类,首先看下JDK API对此类的描述,描述如下:

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

  1、ThreadLocal不是线程,是线程的一个变量,你可以先简单理解为线程类的属性变量。

  2、ThreadLocal在类中通常定义为静态变量。

  3、每个线程有自己的一个ThreadLocal,它是变量的一个“拷贝”,修改它不影响其他线程。

  既然定义为类变量,为何为每个线程维护一个副本(姑且称为“拷贝”容易理解),让每个线程独立访问?多线程编程的经验告诉我们,对于线程共享资源(你可以理解为属性),资源是否被所有线程共享,也就是说这个资源被一个线程修改是否影响另一个线程的运行,如果影响我们需要使用synchronized同步,让线程顺序访问。

  ThreadLocal适用于资源共享但不需要维护状态的情况,也就是一个线程对资源的修改,不影响另一个线程的运行;这种设计是‘空间换时间’,synchronized顺序执行是‘时间换取空间’。

2 ThreadLocal方法及使用示例

  ThreadLocal<T>类在Spring,Hibernate等框架中起到了很大的作用。为了解释ThreadLocal类的工作原理,必须同时介绍与其工作甚密的其他几个类,包括内部类ThreadLocalMap,和线程类Thread。所有方法如下图:

深入理解线程局部变量:ThreadLocal_多线程


四个核心方法说明如下:

                   T         get()                   返回此线程局部变量的当前线程副本中的值。

 protected  T         initialValue()       返回此线程局部变量的当前线程的“初始值”。

                   void remove()             移除此线程局部变量当前线程的值。

                   void set(T value)         将此线程局部变量的当前线程副本中的值设置为指定值。


可能有人会觉得Thread与ThreadLocal有什么关系,其实真正的奥秘就在Thread类中的一行代码:

ThreadLocal.ThreadLocalMap threadLocals = null;

其中ThreadLocalMap的定义是在ThreadLocal类中,真正的引用却是在Thread类中。那么ThreadLocalMap究竟是什么呢?可以看到这个类应该是一个Map,JDK的解释是:ThreadLocalMap is a customized hash map suitable only for maintaining thread local values。
  接下来的重点是ThreadLocalMap中用于存储数据的entry:


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

从中我们可以发现这个Map的key是ThreadLocal变量,value为用户的值,并不是很多人认为的key是线程的名字或者标识。到这里,我们就可以理解ThreadLocal究竟是如何工作的了。

  1. Thread类中有一个成员变量叫做ThreadLocalMap,它是一个Map,他的Key是ThreadLocal类

  2每个线程拥有自己的申明为ThreadLocal类型的变量,所以这个类的名字叫ThreadLocal:线程自己的(变量)。

  3. 此变量生命周期是由该线程决定的,开始于第一次初始化(get或者set方法)。

  4. 由ThreadLocal的工作原理决定了:每个线程独自拥有一个变量,并非共享或者拷贝。

  下面,我们通过一个具体的实例了解一下ThreadLocal的具体使用方法。

    package com.baobaotao.basic;  
      
    public class SequenceNumber {  
           
        //①通过匿名内部类覆盖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)   
        {  
             SequenceNumber sn = new SequenceNumber();  
               
             //③ 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 SequenceNumber sn;  
            public TestClient(SequenceNumber sn) {  
                this.sn = sn;  
            }  
            public void run()  
            {  
                //④每个线程打出3个序列值  
                for (int i = 0; i < 3; i++) {  
                    System.out.println("thread["+Thread.currentThread().getName()+  
                            "] sn["+sn.getNextNum()+"]");  
                }
            }  
        }  
    }

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


  1. thread[Thread-2] sn[1]  

  2. thread[Thread-0] sn[1]  

  3. thread[Thread-1] sn[1]  

  4. thread[Thread-2] sn[2]  

  5. thread[Thread-0] sn[2]  

  6. thread[Thread-1] sn[2]  

  7. thread[Thread-2] sn[3]  

  8. thread[Thread-0] sn[3]  

  9. thread[Thread-1] sn[3]  


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


  接下来分析一下ThreadLocal的源码,就更加清楚了。


3 深入源码


    ThreadLocal有一个ThreadLocalMap静态内部类,你可以简单理解为一个Map,这个Map为每个线程复制一个变量的‘拷贝’存储其中。

    当线程调用ThreadLocal.get()方法获取变量时,首先获取当前线程引用,以此为key去获取响应的ThreadLocalMap,如果此‘Map’不存在则初始化一个,否则返回其中的变量,代码如下:

    public T get() {  
            Thread t = Thread.currentThread();  
            /**  
             * 得到当前线程的ThreadLocalMap  
             */  
            ThreadLocalMap map = getMap(t);  
            if (map != null) {  
                /**  
                 * 在此线程的ThreadLocalMap中查找key为当前ThreadLocal对象的entry  
                 */  
                ThreadLocalMap.Entry e = map.getEntry(this);  
                if (e != null)  
                    return (T)e.value;  
            }  
            return setInitialValue();  
        }  
        
        
    /**   
     * 关键方法,返回当前Thread的ThreadLocalMap   
     * [[[每个Thread返回各自的ThreadLocalMap,所以各个线程中的ThreadLocal均为独立的]]]   
     */    
    ThreadLocalMap getMap(Thread t) {    
        return t.threadLocals;    
    }

调用get方法如果此Map不存在首先初始化,创建此map,将线程为key,初始化的vlaue存入其中,注意此处的initialValue,我们可以覆盖此方法,在首次调用时初始化一个适当的值。

  对于ThreadLocal在何处存储变量副本,我们看getMap方法:获取的是当前线程的ThreadLocal类型的threadLocals属性。显然变量副本存储在每一个线程中。

  setInitialValue代码如下:

    private T setInitialValue() {  
            /**  
             * 默认返回null,这个方法为protected可以继承  
             */  
            T value = initialValue();  
            Thread t = Thread.currentThread();  
            ThreadLocalMap map = getMap(t);  
            if (map != null)  
                map.set(this, value);  
            else  
                /**  
                 * 初次创建  
                 */  
                createMap(t, value);  
            return value;  
        }  
        
        /** 
     * 给当前thread初始ThreadlocalMap 
     */  
    void createMap(Thread t, T firstValue) {  
            t.threadLocals = new ThreadLocalMap(this, firstValue);  
        }

set方法相对比较简单,如果理解以上俩个方法。获取当前线程的引用,从map中获取该线程对应的map,如果map存在更新缓存值,否则创建并存储,代码如下:


    public void set(T value) {  
        Thread t = Thread.currentThread();  
        ThreadLocalMap map = getMap(t);  
        if (map != null)  
            map.set(this, value);  
        else  
            createMap(t, value);  
    }

上面我们知道变量副本存放于何处,这里我们简单说下如何被java的垃圾收集机制收集,当我们不在使用时调用set(null),此时不在将引用指向该‘map’,而线程退出时会执行资源回收操作,将申请的资源进行回收,其实就是将属性的引用设置为null。这时已经不在有任何引用指向该map,故而会被垃圾收集。

  我们自己就可以实现一个简化版本的ThreadLocal,里面有一个Map,用于存储每一个线程的变量副本,Map中元素的键为线程对象,而值对应线程的变量副本。

    public class SimpleThreadLocal {

        private Map valueMap = Collections.synchronizedMap(new HashMap()); 
 
        public void set(Object newValue) {  
            //①键为线程对象,值为本线程的变量副本  
            valueMap.put(Thread.currentThread(), newValue);  
        }

        public Object get() {  
            Thread currentThread = Thread.currentThread();  
      
            //②返回本线程对应的变量  
            Object o = valueMap.get(currentThread);   
                      
            //③如果在Map中不存在,放到Map中保存起来  
            if (o == null && !valueMap.containsKey(currentThread)) {  
                o = initialValue();  
                valueMap.put(currentThread, o);  
            }
            return o;  
        }

        public void remove() {  
            valueMap.remove(Thread.currentThread());  
        }

        public Object initialValue() {  
            return null;  
        }  
    }

 虽然上述代码清单中这个ThreadLocal实现版本显得比较幼稚,但它和JDK所提供的ThreadLocal类在实现思路上是非常相近的。


  通过以上的分析,我们发现,ThreadLocal类的使用虽然是用来解决多线程的问题的,但是还是有很明显的针对性。最明显的,ThreadLoacl变量的活动范围为某线程,并且我的理解是该线程“专有的,独自霸占”,对该变量的所有操作均有该线程完成!也就是说,ThreadLocal不是用来解决共享,竞争问题的。典型的应用莫过于Spring,Hibernate等框架中对于多线程的处理了。

  下面是hibernate中典型的ThreadLocal的应用:

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

这段代码,每个线程有自己的ThreadLocalMap,每个ThreadLocalMap中根据需要初始加载threadSession,这样的好处就是介于singleton与prototype之间,应用singleton无法解决线程,应用prototype开销又太大,有了ThreadLocal之后就好了,对于需要线程“霸占”的变量用ThreadLocal,而该类实例的方法均可以共享。

  关于内存泄漏:虽然ThreadLocalMap已经使用了weakReference,但是还是建议能够显示的使用remove方法。


4 与Thread同步机制的比较

       ThreadLocal和线程同步机制相比有什么优势呢?ThreadLocal和线程同步机制都是为了解决多线程中相同变量的访问冲突问题。

  在同步机制中,通过对象的锁机制保证同一时间只有一个线程访问变量。这时该变量是多个线程共享的,使用同步机制要求程序缜密地分析什么时候对变量进行读写,什么时候需要锁定某个对象,什么时候释放对象锁等繁杂的问题,程序设计和编写难度相对较大。
  而ThreadLocal则从另一个角度来解决多线程的并发访问。ThreadLocal为每一个线程提供一个独立的变量副本,从而隔离了多个线程对访问数据的冲突。因为每一个线程都拥有自己的变量副本,从而也就没有必要对该变量进行同步了。ThreadLocal提供了线程安全的对象封装,在编写多线程代码时,可以把不安全的变量封装进ThreadLocal。
  由于ThreadLocal中可以持有任何类型的对象,低版本JDK所提供的get()返回的是Object对象,需要强制类型转换。但JDK 5.0通过泛型很好的解决了这个问题,在一定程度上简化ThreadLocal的使用,代码清单9-2就使用了JDK 5.0新的ThreadLocal<T>版本。
  概括起来说,对于多线程资源共享的问题,同步机制采用了“以时间换空间”的方式:访问串行化,对象共享化。而ThreadLocal采用了“以空间换时间”的方式:访问并行化,对象独享化。前者仅提供一份变量,让不同的线程排队访问,而后者为每一个线程都提供了一份变量,因此可以同时访问而互不影响。


5 Spring使用ThreadLocal解决线程安全问题

      我们知道在一般情况下,只有无状态的Bean才可以在多线程环境下共享,在Spring中,绝大部分Bean都可以声明为singleton作用域。就是因为Spring对一些Bean(如RequestContextHolder、TransactionSynchronizationManager、LocaleContextHolder等)中非线程安全的“状态性对象”采用ThreadLocal进行封装,让它们也成为线程安全的“状态性对象”,因此有状态的Bean就能够以singleton的方式在多线程中正常工作了。

  一般的Web应用划分为展现层、服务层和持久层三个层次,在不同的层中编写对应的逻辑,下层通过接口向上层开放功能调用。在一般情况下,从接收请求到返回响应所经过的所有程序调用都同属于一个线程,如图9-2所示。

深入理解线程局部变量:ThreadLocal_多线程_02

这样用户就可以根据需要,将一些非线程安全的变量以ThreadLocal存放,在同一次请求响应的调用线程中,所有对象所访问的同一ThreadLocal变量都是当前线程所绑定的。
  下面的实例能够体现Spring对有状态Bean的改造思路:

  TopicDao:非线程安全

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

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


import java.sql.Connection;  
import java.sql.Statement;  
public class TopicDao {  
     
   //①使用ThreadLocal保存Connection变量  
   private static ThreadLocal<Connection> connThreadLocal = new ThreadLocal<Connection>();  
   
   public static Connection getConnection(){
       //②如果connThreadLocal没有本线程对应的Connection创建一个新的Connection,  
       //并将其保存到线程本地变量中
       if (connThreadLocal.get() == null) {  
           Connection conn = ConnectionManager.getConnection();  
           connThreadLocal.set(conn);  
             return conn;  
       }else{
           //③直接返回线程本地变量  
           return connThreadLocal.get();  
       }
   }

   public void addTopic() {
       //④从ThreadLocal中获取线程对应的  
       Statement stat = getConnection().createStatement();  
   }
}

不同的线程在使用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对有状态类线程安全化的解决思路。

参考文献:

http://stamen.iteye.com/blog/1535120

http://ari.iteye.com/blog/757478