ThreadLocal原理及使用示例

简介：本文已一个简要的代码示例介绍ThreadLocal类的基本使用方式，在此基础上结合图片阐述它的内部工作原理。

欢迎探讨，如有错误敬请指正

如需转载，请注明出处 http://www.cnblogs.com/nullzx/

1. ThreadLocal<T> 简介和使用示例

ThreadLocal只有一个无参的构造方法

public ThreadLocal()

ThreadLocal的相关方法

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

initialValue方法的访问修饰符是protected，该方法为第一次调用get方法提供一个初始值。默认情况下，第一次调用get方法返回值null。在使用时，我们一般会复写ThreadLocal的initialValue方法,使第一次调用get方法时返回一个我们设定的初始值。

下面是一个ThreadLocal的一个简单使用示例

package javalearning;

import java.util.Random;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;
import java.util.concurrent.Semaphore;

public class ThreadLocalDemo {
/*定义了1个ThreadLocal<Integer>对象，
*并复写它的initialValue方法，初始值是3*/
private ThreadLocal<Integer> tlA = new ThreadLocal<Integer>(){
protected Integer initialValue(){
return 3;
}
};

/*
private ThreadLocal<Integer> tlB = new ThreadLocal<Integer>(){
protected Integer initialValue(){
return 5;
}
};
*/

/*设置一个信号量，许可数为1，让三个线程顺序执行*/
Semaphore semaphore = new Semaphore(1);

private Random rnd = new Random();

/*Worker定义为内部类实现了Runnable接口,tlA定义在外部类中，
每个线程中调用这个对象的get方法，再调用一个set方法设置一个随机值*/
public class Worker implements Runnable{
@Override
public void run(){

try {
Thread.sleep(rnd.nextInt(1000)); /*随机延时1s以内的时间*/
semaphore.acquire();/*获取许可*/
} catch (InterruptedException e) {
e.printStackTrace();
}

int valA = tlA.get();
System.out.println(Thread.currentThread().getName() +" tlA initial val : "+ valA);
valA = rnd.nextInt();
tlA.set(valA);
System.out.println(Thread.currentThread().getName() +" tlA  new     val: "+ valA);

/*
int valB = tlB.get();
System.out.println(Thread.currentThread().getName() +" tlB initial val : "+ valB);
valB = rnd.nextInt();
tlA.set(valB);
System.out.println(Thread.currentThread().getName() +" tlB 2    new val: "+ valB);
*/

semaphore.release();

/*在线程池中,当线程退出之前一定要记得调用remove方法，因为在线程池中的线程对象是循环使用的*/
tlA.remove();
/*tlB.remove();*/
}
}

/*创建三个线程，每个线程都会对ThreadLocal对象tlA进行操作*/
public static void main(String[] args){
ExecutorService es = Executors.newFixedThreadPool(3);
ThreadLocalDemo tld = new ThreadLocalDemo();
es.execute(tld.new Worker());
es.execute(tld.new Worker());
es.execute(tld.new Worker());
es.shutdown();
}
}

运行结果

pool-1-thread-1 tlA initial val : 3
pool-1-thread-1 tlA  new     val: -1288455998
pool-1-thread-3 tlA initial val : 3
pool-1-thread-3 tlA  new     val: 112537197
pool-1-thread-2 tlA initial val : 3
pool-1-thread-2 tlA  new     val: -12271334

从运行结果可以看出，每个线程第一次调用TheadLocal对象的get方法时都得到初始值3，注意我们上面的代码是让三个线程顺序执行，显然从运行结果看，pool-1-thread-1线程结束后设置的新值，对pool-1-thread-3线程是没有影响的，pool-1-thread-3线程完成后设置的新值对pool-1-thread-2线程也没有影响。这就仿佛把ThreadLocal对象当做每个线程内部的对象一样，但实际上tlA对象是个外部类对象，内部类Worker访问到的是同一个tlA对象，也就是说是被各个线程共享的。这是如何做到的呢？我们现在就来看看ThreadLocal对象的内部原理。

2. ThreadLocal<T>的原理

首先，在Thread类中定义了一个threadLocals，它是ThreadLocal.ThreadLocalMap对象的引用,默认值是null。ThreadLocal.ThreadLocalMap对象表示了一个以开放地址形式的散列表。当我们在线程的run方法中第一次调用ThreadLocal对象的get方法时，会为当前线程创建一个ThreadLocalMap对象。也就是每个线程都各自有一张独立的散列表，以ThreadLocal对象作为散列表的key，set方法中的值作为value（第一次调用get方法时，以initialValue方法的返回值作为value）。显然我们可以定义多个ThreadLocal对象，而我们一般将ThreadLocal对象定义为static类型或者外部类中。上面所表达的意思就是，相同的key在不同的散列表中的值必然是独立的，每个线程都是在各自的散列表中执行操作。





TheadLocal中的get源代码

public T get() {
Thread t = Thread.currentThread();
ThreadLocalMap map = getMap(t);
if (map != null) {
ThreadLocalMap.Entry e = map.getEntry(this);//这里的this是指当前的ThreadLocal对象
if (e != null) {
@SuppressWarnings("unchecked")
T result = (T)e.value;
return result;
}
}
return setInitialValue();
}

3. 参考内容

[1]. Java并发编程：深入剖析ThreadLocal

[2]. [Java并发包学习七]解密ThreadLocal