Thread详解11：ThreadLocal的使用

首先，我们看看JDK文档是怎么描述这个类的：

该类提供了线程局部 (thread-local) 变量。这些变量不同于它们的普通对应物，因为访问某个变量（通过其 get 或 set 方法）的每个线程都有自己的局部变量，它独立于变量的初始化副本。ThreadLocal 实例通常是类中的 private static 字段，它们希望将状态与某一个线程（例如，用户 ID 或事务 ID）相关联。每个线程都保持对其线程局部变量副本的隐式引用，只要线程是活动的并且 ThreadLocal 实例是可访问的；在线程消失之后，其线程局部实例的所有副本都会被垃圾回收（除非存在对这些副本的其他引用）。

好吧，看完之后我还是不知道它是干什么的。为了讲解的需要，我先直接给出 ThreadLocal 的概述，再一点点分析证明。

ThreadLocal主要解决的问题是给每个线程绑定自己的值，这个值是和线程绑定的，是线程的局部变量，是其他线程没法访问的。所以，博主的【Thread详解系列1-10】讲的基本上都是并发访问的问题，这一篇11却不是讲并发。我们可以把 ThreadLocal 类比喻成全局存放数据的盒子，这个盒子中每个线程往里面放数据，那这个数据就是它私有的，程序员也就不用自己去维护这个对应关系。这就是 ThreadLocal 的价值所在。

先来看看 ThreadLocal 的API，再结合我的示例代码去了解它做了什么，后面我再证明它的价值。

1 用法示例

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

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

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

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

UniqueThreadIdGenerator.java

package threadLocalTest;

import java.util.concurrent.atomic.AtomicInteger;

public class UniqueThreadIdGenerator {

private static AtomicInteger uniqueId = new AtomicInteger(0);

private static ThreadLocal<Integer> uniqueNum = new ThreadLocal<Integer>() {
@Override
// 如果当前线程是第一次请求id的分配则给它赋一个初始值
protected Integer initialValue() {
return uniqueId.getAndIncrement();
}
};

// 给当前线程返回它的id
public static int getCurrentThreadId() {
return uniqueNum.get();
}

// 设置当前线程的id
public static void setCurrentThreadId(int id) {
uniqueNum.set(id);
}

}

Thread1.java

package threadLocalTest;

public class Thread1 implements Runnable {

@Override
public void run() {
// 线程的id是在它第一次run的时候才分配的，它run，它请求分配id，系统给它一个id
int id = UniqueThreadIdGenerator.getCurrentThreadId();
System.out.println(Thread.currentThread().getName() + " is running, its ID is: " + id);

// 三次向系统请求数据
for (int i = 0; i < 3; i++) {
try {
Thread.sleep(1000);
} catch (InterruptedException e) {
e.printStackTrace();
}
System.out.println(Thread.currentThread().getName() + " is asking for data, my ID is:" + id);
}
System.out.println(Thread.currentThread().getName() + " is over!----------");
}

public static void main(String[] args) {
// 新建3个线程
Thread tA = new Thread(new Thread1(), "A");
Thread tB = new Thread(new Thread1(), "B");
Thread tC = new Thread(new Thread1(), "C");
tA.start();
tB.start();
tC.start();
}
}

输出

第一次运行：

B is running, its ID is: 0
A is running, its ID is: 2
C is running, its ID is: 1
A is asking for data, my ID is:2
B is asking for data, my ID is:0
C is asking for data, my ID is:1
C is asking for data, my ID is:1
B is asking for data, my ID is:0
A is asking for data, my ID is:2
B is asking for data, my ID is:0
C is asking for data, my ID is:1
C is over!----------
A is asking for data, my ID is:2
B is over!----------
A is over!----------

第N次运行：

C is running, its ID is: 0
A is running, its ID is: 1
B is running, its ID is: 2
C is asking for data, my ID is:0
A is asking for data, my ID is:1
B is asking for data, my ID is:2
A is asking for data, my ID is:1
C is asking for data, my ID is:0
B is asking for data, my ID is:2
A is asking for data, my ID is:1
C is asking for data, my ID is:0
A is over!----------
C is over!----------
B is asking for data, my ID is:2
B is over!----------

上面的例子我提醒大家注意一点：

Thread1类没有一个 private id 这样一个成员变量，从而也没有在构造方法中用一个参数传入一个id，它的id是在run的时候才由外部逻辑生成的，而且不需要程序员主动去维护。

2 典型应用

最典型的应用就是在连接数据库的时候，线程与数据库连接的session是由数据库/服务器分配的，不是线程本身维护的，但是线程在编写一些对数据库的操作的时候却要用到session。那怎么办呢？

一种常规的做法可能是每次线程要连接数据库的时候就向数据库请求session，然后以参数的形式传入线程。而且对于session的分配还要做好并发处理，你不能给两个线程分配了同一个session，这样会造成很多混乱。而使用ThreadLocal就不用考虑这么多，减轻了程序员的负担。

public class HibernateUtil {
private static Log log = LogFactory.getLog(HibernateUtil.class);
private static final SessionFactory sessionFactory;     //定义SessionFactory

static {
try {
// 通过默认配置文件hibernate.cfg.xml创建SessionFactory
sessionFactory = new Configuration().configure().buildSessionFactory();
} catch (Throwable ex) {
log.error("初始化SessionFactory失败！", ex);
throw new ExceptionInInitializerError(ex);
}
}

//创建线程局部变量session，用来保存Hibernate的Session
public static final ThreadLocal session = new ThreadLocal();

/**
* 获取当前线程中的Session
* @return Session
* @throws HibernateException
*/
public static Session currentSession() throws HibernateException {
Session s = (Session) session.get();
// 如果Session还没有打开，则新开一个Session
if (s == null) {
s = sessionFactory.openSession();
session.set(s);         //将新开的Session保存到线程局部变量中
}
return s;
}

public static void closeSession() throws HibernateException {
//获取线程局部变量，并强制转换为Session类型
Session s = (Session) session.get();
session.set(null);
if (s != null)
s.close();
}
}

3 get 与 null

如果线程是第一次调用ThreadLocal的get方法，请求一个数据，那么get 返回的值一定是null。这个时候有两种等效的处理方式。

自己显示地增加一个逻辑：如果get 返回null，则new 一个对象，再调用set 方法把这个值放到ThreadLocal里面去。

像section1中的示例代码一样， override ThreadLocal 的 initialValue 方法