ThreadLocal

 

ThreadLocal

百科名片

JDK 1.2的版本中就提供java.lang.ThreadLocal，ThreadLocal为解决多线程程序的并发问题提供了一种新的思路。使用这个工具类可以很简洁地编写出优美的多线程程序，ThreadLocal并不是一个Thread，而是Thread的局部变量。

介绍

线程程序介绍

　　早在JDK 1.2的版本中就提供java.lang.ThreadLocal，ThreadLocal为解决多线程程序的并发问题提供了一种新的思路。使用这个工具类可以很简洁地编写出优美的多线程程序。

Threadlocal变量

　　ThreadLocal很容易让人望文生义，想当然地认为是一个“本地线程”。其实，ThreadLocal并不是一个Thread，而是Thread的局部变量，也许把它命名为ThreadLocalVariable更容易让人理解一些。

　　当使用ThreadLocal维护变量时，ThreadLocal为每个使用该变量的线程提供独立的变量副本，所以每一个线程都可以独立地改变自己的副本，而不会影响其它线程所对应的副本。

　　从线程的角度看，目标变量就象是线程的本地变量，这也是类名中“Local”所要表达的意思。

　　线程局部变量并不是Java的新发明，很多语言（如IBM IBM XL FORTRAN）在语法层面就提供线程局部变量。在Java中没有提供在语言级支持，而是变相地通过ThreadLocal的类提供支持。

　　所以，在Java中编写线程局部变量的代码相对来说要笨拙一些，因此造成线程局部变量没有在Java开发者中得到很好的普及。

　　ThreadLocal的接口方法

　　ThreadLocal类接口很简单，只有4个方法，我们先来了解一下：

　　void set(Object value)

　　设置当前线程的线程局部变量的值。

　　public Object get()

　　该方法返回当前线程所对应的线程局部变量。

　　public void remove()

　　将当前线程局部变量的值删除，目的是为了减少内存的占用，该方法是JDK 5.0新增的方法。需要指出的是，当线程结束后，对应该线程的局部变量将自动被垃圾回收，所以显式调用该方法清除线程的局部变量并不是必须的操作，但它可以加快内存回收的速度。

　　protected Object initialValue()

　　返回该线程局部变量的初始值，该方法是一个protected的方法，显然是为了让子类覆盖而设计的。这个方法是一个延迟调用方法，在线程第1次调用get()或set(Object)时才执行，并且仅执行1次。ThreadLocal中的缺省实现直接返回一个null。

　　值得一提的是，在JDK5.0中，ThreadLocal已经支持泛型，该类的类名已经变为ThreadLocal<T>。API方法也相应进行了调整，新版本的API方法分别是void set(T value)、T get()以及T initialValue()。

　　ThreadLocal是如何做到为每一个线程维护变量的副本的呢？其实实现的思路很简单：在ThreadLocal类中定义了一个ThreadLocalMap，每一个Tread中都有一个该类型的变量——threadLocals——用于存储每一个线程的变量副本，Map中元素的键为线程对象，而值对应线程的变量副本。

线程

基本概念

　　为每一个使用该变量的线程都提供一个变量值的副本，是每一个线程都可以独立地改变自己的副本，而不会和其它线程的副本冲突。从线程的角度看，就好像每一个线程都完全拥有该变量。使用场景

　　To keep state with a thread (user-id, transaction-id, logging-id) To cache objects which you need frequently ThreadLocal类

　　它主要由四个方法组成initialValue()，get()，set(T)，remove()，其中值得注意的是initialValue()，该方法是一个protected的方法，显然是为了子类重写而特意实现的。该方法返回当前线程在该线程局部变量的初始值，这个方法是一个延迟调用方法，在一个线程第1次调用get()或者set(Object)时才执行，并且仅执行1次。ThreadLocal中的确实实现直接返回一个null：

举例

　　ThreadLocal的原理

　　ThreadLocal是如何做到为每一个线程维护变量的副本的呢？其实实现的思路很简单，在ThreadLocal类中有一个Map，用于存储每一个线程的变量的副本。比如下面的示例实现：

　　public class ThreadLocal

　　{

　　private Map values = Collections.synchronizedMap(new HashMap());

　　public Object get()

　　{

　　Thread curThread = Thread.currentThread();

　　Object o = values.get(curThread);

　　if (o == null && !values.containsKey(curThread))

　　{

　　o = initialValue();

　　values.put(curThread, o);

　　}

　　return o;

　　}

　　public void set(Object newValue)

　　{

　　values.put(Thread.currentThread(), newValue);

　　}

　　public Object initialValue()

　　{

　　return null;

　　}

　　}

使用方法

　　 ThreadLocal 的使用

　　使用方法一：

　　Hibernate的文档时看到了关于使ThreadLocal管理多线程访问的部分。具体代码如下

　　1. public static final ThreadLocal session = new ThreadLocal();

　　2. public static Session currentSession() {

　　3. Session s = (Session)session.get();

　　4. //open a new session,if this session has none

　　5. if(s == null){

　　6. s = sessionFactory.openSession();

　　7. session.set(s);

　　8. }

　　return s;

　　9. }

　　我们逐行分析

　　1。 初始化一个ThreadLocal对象，ThreadLocal有三个成员方法 get()、set()、initialvalue()。

　　如果不初始化initialvalue，则initialvalue返回null。

　　3。session的get根据当前线程返回其对应的线程内部变量，也就是我们需要的net.sf.hibernate.Session（相当于对应每个数据库连接）.多线程情况下共享数据库链接是不安全的。ThreadLocal保证了每个线程都有自己的s（数据库连接）。

　　5。如果是该线程初次访问，自然，s（数据库连接）会是null，接着创建一个Session，具体就是行6。

　　6。创建一个数据库连接实例 s

　　7。保存该数据库连接s到ThreadLocal中。

　　8。如果当前线程已经访问过数据库了，则从session中get()就可以获取该线程上次获取过的连接实例。

　　使用方法二

　　当要给线程初始化一个特殊值时，需要自己实现ThreadLocal的子类并重写该方法，通常使用一个内部匿名类对ThreadLocal进行子类化，EasyDBO中创建jdbc连接上下文就是这样做的：

　　public class JDBCContext{

　　private static Logger logger = Logger.getLogger(JDBCContext.class);

　　private DataSource ds;

　　protected Connection connection;

　　private boolean isValid = true;

　　private static ThreadLocal jdbcContext;

　　private JDBCContext(DataSource ds){

　　this.ds = ds;

　　createConnection();

　　}

　　public static JDBCContext getJdbcContext(javax.sql.DataSource ds)

　　{

　　if(jdbcContext==null)jdbcContext=new JDBCContextThreadLocal(ds);

　　JDBCContext context = (JDBCContext) jdbcContext.get();

　　if (context == null) {

　　context = new JDBCContext(ds);

　　}

　　return context;

　　}

　　private static class JDBCContextThreadLocal extends ThreadLocal {

　　public javax.sql.DataSource ds;

　　public JDBCContextThreadLocal(javax.sql.DataSource ds)

　　{

　　this.ds=ds;

　　}

　　protected synchronized Object initialValue() {

　　return new JDBCContext(ds);

　　}

　　}

　　}

　　简单的实现版本

　　代码清单1 SimpleThreadLocal

　　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);②返回本线程对应的变量

　　if (o == null && !valueMap.containsKey(currentThread)) {③如果在Map中不存在，放到Map

　　中保存起来。

　　o = initialValue();

　　valueMap.put(currentThread, o);

　　}

　　return o;

　　}

　　public void remove() {

　　valueMap.remove(Thread.currentThread());

　　}

　　public Object initialValue() {

　　return null;

　　}

　　}

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

实例

举例

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

　　代码清单2 SequenceNumber

　　package com.baobaotao.basic;

　　public class SequenceNumber {

　　①通过匿名内部类覆盖ThreadLocal的initialValue()方法，指定初始值

　　private static ThreadLocal seqNum = new ThreadLocal(){

　　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()

　　{

　　for (int i = 0; i < 3; i++) {④每个线程打出3个序列值

　　System.out.println("thread["+Thread.currentThread().getName()+

　　"] sn["+sn.getNextNum()+"]");

　　}

　　}

　　}

　　}

分析

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

　　thread[Thread-2] sn[1]

　　thread[Thread-0] sn[1]

　　thread[Thread-1] sn[1]

　　thread[Thread-2] sn[2]

　　thread[Thread-0] sn[2]

　　thread[Thread-1] sn[2]

　　thread[Thread-2] sn[3]

　　thread[Thread-0] sn[3]

　　thread[Thread-1] sn[3]

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

场景

说明

　　在Java的多线程编程中，为保证多个线程对共享变量的安全访问，通常会使用synchronized来保证同一时刻只有一个线程对共享变量进行操作。但在有些情况下，synchronized不能保证多线程对共享变量的正确读写。例如类有一个类变量，该类变量会被多个类方法读写，当多线程操作该类的实例对象时，如果线程对类变量有读取、写入操作就会发生类变量读写错误，即便是在类方法前加上synchronized也无效，因为同一个线程在两次调用方法之间时锁是被释放的，这时其它线程可以访问对象的类方法，读取或修改类变量。这种情况下可以将类变量放到ThreadLocal类型的对象中，使变量在每个线程中都有独立拷贝，不会出现一个线程读取变量时而被另一个线程修改的现象。

　　下面举例说明：

　　public class QuerySvc {

　　private String sql;

　　private static ThreadLocal sqlHolder = new ThreadLocal();

　　public QuerySvc() {

　　}

　　public void execute() {

　　System.out.println("Thread " + Thread.currentThread().getId() +" Sql is " + sql);

　　System.out.println("Thread " + Thread.currentThread().getId() +" Thread Local variable Sql is " + sqlHolder.get());

　　}

　　public String getSql() {

　　return sql;

　　}

　　public void setSql(String sql) {

　　this.sql = sql;

　　sqlHolder.set(sql);

　　}

　　}

多线程访问

　　为了说明多线程访问对于类变量和ThreadLocal变量的影响，QuerySvc中分别设置了类变量sql和ThreadLocal变量，使用时先创建 QuerySvc的一个实例对象，然后产生多个线程，分别设置不同的sql实例对象，然后再调用execute方法，读取sql的值，看是否是set方法中写入的值。这种场景类似web应用中多个请求线程携带不同查询条件对一个servlet实例的访问，然后servlet调用业务对象，并传入不同查询条件，最后要保证每个请求得到的结果是对应的查询条件的结果。

　　使用QuerySvc的工作线程如下：

　　public class Work extends Thread {

　　private QuerySvc querySvc;

　　private String sql;

　　public Work(QuerySvc querySvc,String sql) {

　　this.querySvc = querySvc;

　　this.sql = sql;

　　}

　　public void run() {

　　querySvc.setSql(sql);

　　querySvc.execute();

　　}

　　}

　　运行线程代码如下：

　　QuerySvc qs = new QuerySvc();

　　for (int k=0; k<10; k++)

　　String sql = "Select * from table where id =" + k;

　　new Work(qs,sql).start();

　　}

　　先创建一个QuerySvc实例对象，然后创建若干线程来调用QuerySvc的set和execute方法，每个线程传入的sql都不一样，从运行结果可以看出sql变量中值不能保证在execute中值和set设置的值一样，在 web应用中就表现为一个用户查询的结果不是自己的查询条件返回的结果，而是另一个用户查询条件的结果；而ThreadLocal中的值总是和set中设置的值一样，这样通过使用ThreadLocal获得了线程安全性。

　　如果一个对象要被多个线程访问，而该对象存在类变量被不同类方法读写，为获得线程安全，可以用ThreadLocal来替代类变量。

　　Thread同步机制的比较

说明

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

　　在同步机制中，通过对象的锁机制保证同一时间只有一个线程访问变量。这时该变量是多个线程共享的，使用同步机制要求程序慎密地分析什么时候对变量进行读写，什么时候需要锁定某个对象，什么时候释放对象锁等繁杂的问题，程序设计和编写难度相对较大。

　　而ThreadLocal则从另一个角度来解决多线程的并发访问。 ThreadLocal会为每一个线程提供一个独立的变量副本，从而隔离了多个线程对数据的访问冲突。因为每一个线程都拥有自己的变量副本，从而也就没有必要对该变量进行同步了。ThreadLocal提供了线程安全的共享对象，在编写多线程代码时，可以把不安全的变量封装进ThreadLocal。

　　由于ThreadLocal中可以持有任何类型的对象，低版本JDK所提供的get()返回的是Object对象，需要强制类型转换。但JDK 5.0通过泛型很好的解决了这个问题，在一定程度地简化ThreadLocal的使用，代码清单 9 2就使用了JDK 5.0新的ThreadLocal<T>版本。

　　概括起来说，对于多线程资源共享的问题，同步机制采用了“以时间换空间”的方式，而ThreadLocal采用了“以空间换时间”的方式。前者仅提供一份变量，让不同的线程排队访问，而后者为每一个线程都提供了一份变量，因此可以同时访问而互不影响。

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

　　我们知道在一般情况下，只有无状态的Bean才可以在多线程环境下共享，在Spring中，绝大部分Bean都可以声明为singleton作用域。就是因为Spring对一些Bean（如RequestContextHolder、TransactionSynchronizationManager、LocaleContextHolder等）中非线程安全状态采用ThreadLocal进行处理，让它们也成为线程安全的状态，因为有状态的Bean就可以在多线程中共享了。

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

  

9-2

图1同一线程贯通三层

　　这样你就可以根据需要，将一些非线程安全的变量以ThreadLocal存放，在同一次请求响应的调用线程中，所有关联的对象引用到的都是同一个变量。

　　下面的实例能够体现Spring对有状态Bean的改造思路：

　　代码清单3 TopicDao：非线程安全

　　public class TopicDao {

　　private Connection conn;①一个非线程安全的变量

　　public void addTopic(){

　　Statement stat = conn.createStatement();②引用非线程安全变量

　　…

　　}

　　}

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

　　代码清单4 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中获取线程对应的Connection

　　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。

　　小结

解决方法

　　 ThreadLocal是解决线程安全问题一个很好的思路，它通过为每个线程提供一个独立的变量副本解决了变量并发访问的冲突问题。在很多情况下，ThreadLocal比直接使用synchronized同步机制解决线程安全问题更简单，更方便，且结果程序拥有更高的并发性。