threadLocal 笔记

网上搜索的结果，实践验证后记录

早在JDK 1.2的版本中就提供java.lang.ThreadLocal，ThreadLocal为解决多线程程序的并发问题提供了一种新的思路。ThreadLocal并不是一个Thread，而是Thread的局部变量，也许把它命名为ThreadLocalVariable更容易让人理解一些。

当使用ThreadLocal维护变量时，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。

ThreadLocal是如何做到为每一个线程维护变量的副本的呢？其实实现的思路很简单：
在ThreadLocal类中有一个Map，用于存储每一个线程的变量副本，Map中元素的键为线程对象，而值对应线程的变量副本。我们自己就可以提供一个简单的实现版本：

代码清单
SimpleThreadLocal.java
package cn.sccl.demo;

import java.util.Collections;
import java.util.HashMap;
import java.util.Map;

public class SimpleThreadLocal {

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

public void set(Object newValue) {
   valueMap.put(Thread.currentThread(), newValue);
   // key is the current thread object,value is the copy of the variable of
   // the current thread
}

public Object get() {
   Thread currentThread = Thread.currentThread();
   Object o = valueMap.get(currentThread);
   //return the variable of the current thread
   if (o == null && !valueMap.containsKey(currentThread)) {
    // if the variable is not in the map,put it in the map
    o = initialValue();
    valueMap.put(currentThread, o);
   }
   return o;
}

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

public Object initialValue() {
   return null;
}

}


它和JDK所提供的ThreadLocal类在实现思路上是相近的。

一个TheadLocal实例

了解一下ThreadLocal的具体使用方法。

代码清单
SequenceNumber.java:

package cn.sccl.demo;

public class SequenceNumber {
// overwrite the ThreadLocal method initialValue() to set a initial value
private static ThreadLocal<Integer> seqNum = new ThreadLocal<Integer>() {
   public Integer initialValue() {
    return 0;
   }
};

// get next number
public int getNextNum() {
   seqNum.set(seqNum.get() + 1);
   return seqNum.get();
}

public static void main(String[] args) {
   SequenceNumber sn = new SequenceNumber();
   // 3 threads use the same number variable and increase it
   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++) {
     // every thread print 3 number
     System.out.println("thread[" + Thread.currentThread().getName()
       + "] sn[" + sn.getNextNum() + "]");
    }
   }
}
}

运行后控制台输出如下：
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为每一个线程提供了单独的副本。

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

同一线程贯通三层

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

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

代码清单
TopicDao.java 非线程安全

public class TopicDao {
private Connection conn;
//一个非线程安全的变量

public void addTopic(){
   Statement stat = conn.createStatement();
   //引用非线程安全变量
}
}

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

代码清单
TopicDao.java：线程安全
package cn.sccl.demo.tmp;

import java.sql.Connection;
import java.sql.SQLException;
import java.sql.Statement;

public class TopicDao {

// use ThreadLocal to hold Connection variable
private static ThreadLocal<Connection> connThreadLocal = new ThreadLocal<Connection>();

public static Connection getConnection() {
   // if connThreadLocal is empty,put a new connection in
   if (connThreadLocal.get() == null) {
    Connection conn = null;//ConnectionManager.getConnection();
    connThreadLocal.set(conn);
    return conn;
   } else {
    return connThreadLocal.get();
    // return the thread local variable
   }
}

public void addTopic() {
   // get the connection from the thread local
   try {
    Statement stat = getConnection().createStatement();
   } catch (SQLException e) {
    e.printStackTrace();
   }
}
}


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

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