ThreadLocal设计模式

ThreadLocal设计模式使用的也很频繁，会经常在各大框架找到它们的踪影，如struts2以及最近正在看的SpringAOP等。

ThreadLocal设计模式也有很多误解，我的理解是
（1）ThreadLocal所操作的数据是线程间不共享的。它不是用来解决多个线程竞争同一资源的多线程问题。
（2）ThreadLocal所操作的数据主要用于线程内共享数据，可以避免同一线程内函数间的传参数问题。
ThreadLocal更像是一个操作线程数据的工具类，哪个线程调用它，它就操作哪个线程的数据。

案例如下：
案例一：ThreadLocal所操作的数据是线程间不共享的，是线程间互不干扰的

1package com.lg.design.threadlocal;
2
3public class ThreadLocalTest {
4
5	public static void main(String[] args){
6		test1();
7	}
8	private static void test1(){
9		Thread t1=new Thread(){
10
11			@Override
12			public void run() {
13				System.out.println(this.getName()+"开始值:"+ThreadUtil.getName());
14				ThreadUtil.setName("线程0");
15				sleepTime(1000*10);
16				System.out.println(this.getName()+"设定后:"+ThreadUtil.getName());
17			}
18			
19		};
20		Thread t2=new Thread(){
21
22			@Override
23			public void run() {
24				sleepTime(1000*5);
25				System.out.println(this.getName()+"开始值:"+ThreadUtil.getName());
26				ThreadUtil.setName("线程1");
27				System.out.println(this.getName()+"设定后:"+ThreadUtil.getName());
28			}
29			
30		};
31		t1.start();
32		t2.start();
33	}
34	
35	private static void sleepTime(long millis){
36		try {
37			Thread.sleep(millis);
38		} catch (InterruptedException e) {
39			e.printStackTrace();
40		}
41	}
42
43}

其中ThreadUtil就是用ThreadLocal来实现的，ThreadLocal完全可以这样理解，它就是操作线程数据的工具类，哪个线程调用它的get或set方法，它就会操作调用它的线程中的数据，待会给出源码说明。如下：

1public class ThreadUtil {
2
3	private static ThreadLocal<String> nameLocal=new ThreadLocal<String>();
4	
5	public static String getName(){
6		return nameLocal.get();
7	}
8	
9	public static void setName(String name){
10		nameLocal.set(name);
11	}
12}

运行结果为：

1Thread-0开始值:null
2Thread-1开始值:null
3Thread-1设定后:线程1
4Thread-0设定后:线程0

分析过程如下：
（1）暂时可以理解为每个线程都有一个map集合，用于存放数据。首先是t1线程调用ThreadUtil.getName()，ThreadUtil.getName()即nameLocal.get()会去调用它的线程的map集合中取数据，即会从t1线程中的map集合中取数据，key为nameLocal对象。由于之前未存数据所以返回为null。
（2）紧接着t1调用ThreadUtil.setName("线程0")即nameLocal.set(name)。此时调用nameLocal.set(name)方法的线程是t1，所以nameLocal仍然是将数据存进t1的map集合中，key为nameLocal对象,然后t1睡眠10s。
（3）t2刚开始睡眠5s，然后调用ThreadUtil.getName()即nameLocal.get()，nameLocal会去调用它的线程的map集合中取数据，即从t2线程的map集合中取数据，由于之前未存，所以仍然为null。
（4）t2开始调用ThreadUtil.setName("线程1")即nameLocal.setName("线程1");，nameLocal仍然将这个值设置到调用它的线程的map集合中，即会将这个数据放到t2线程的map集合中，key为nameLocal对象。
（5）然后是t2线程调用ThreadUtil.getName()，即nameLocal会从t2线程的map集合中取数据，key为nameLocal对象，然后就取到了步骤4所设置的"线程1"。
（6）然后是t1线程调用ThreadUtil.getName()，即nameLocal会从t1线程的map集合中取数据，key为nameLocal对象，然后就取到了步骤2所设置的"线程0"。
上面一直在强调ThreadLocal对象一直是在操作调用它的线程的map数据，谁调用ThreadLocal对象的get或set方法，ThreadLocal对象就会去操作调用它的线程的map数据。这个概念一定要根深蒂固。

从上面的过程中，可以看到，ThreadLocal对象所操作的数据是线程所独有的数据，虽然两个线程使用的是同一个ThreadLocal对象，但ThreadLocal对象所操作的数据是线程间根本不共享的，互不干扰的。所以ThreadLocal模式就不是用于多个线程竞争同一资源的情况。

案例二：
ThreadLocal的作用：用于实现线程内共享数据，注意是线程内共享数据，不是线程间共享数据。

1public class ThreadLocalTest {
2
3	public static void main(String[] args){
4		test2();
5	}
6	
7	private static void test2(){
8		Thread t1=new Thread(){
9
10			@Override
11			public void run() {
12				fun1();
13				fun2();
14			}
15
16			private void fun2() {
17				System.out.println("在函数2中获取到当前线程的name数据为:"+ThreadUtil.getName());
18			}
19
20			private void fun1() {
21				ThreadUtil.setName("my own name");
22				System.out.println("函数1设置当前线程的name数据为:my own name");
23			}
24			
25		};
26		t1.start();
27	}
28}

运行结果为：

1函数1设置当前线程的name数据为:my own name
2在函数2中获取到当前线程的name数据为:my own name

分析如下:
（1）fun1（）和fun2（）都在t1线程内执行，在fun1中调用ThreadUtil.setName("my own name")，则是向调用它的t1线程的map集合中存放数据,key为nameLocal。
（2）fun2函数调用ThreadUtil.getName()，则是从调用它的t1线程的map集合中获取数据，key为nameLocal，所以就可以取到fun1中设置的数据

综上所述，通过ThreadLocal对象，把线程内要共享的数据存进该线程的map集合中，方便随时获取，实现共享。不然的话，要想实现数据的共享，则需要fun1将数据作为参数传给fun2，这个例子太简单，然而实际情况是某个线程中几十个函数嵌套调用，如果不将线程内共享数据放进该线程的map集合中，而是将共享数据作为参数传递来传递去，将会一片混乱，杂乱无章，有些函数需要这些参数，有些函数不需要。采用ThreadLocal模式，将数据放进线程的map集合中，想要获取时随时可以通过ThreadLocal对象来获取，方便快捷。

这就是ThreadLocal模式。下面源码来说明，ThreadLocal对象操作的是调用它的线程。
这就需要看下它的get和set方法：

1public T get() {
2      //重点1
3        Thread t = Thread.currentThread();
4     //重点2
5        ThreadLocalMap map = getMap(t);
6        if (map != null) {
7            //重点3
8            ThreadLocalMap.Entry e = map.getEntry(this);
9            if (e != null)
10                return (T)e.value;
11        }
12      //重点4
13        return setInitialValue();
14    }

（1）首先就是获取当前调用ThreadLocal对象的线程。如t1线程调用ThreadLocal对象的get方法，此时的Thread t就是t1.
(2)Thread类拥有这样一个属性 ThreadLocal.ThreadLocalMap threadLocals = null;
getMap(t)就是获取t线程的threadLocals，如下：

1ThreadLocalMap getMap(Thread t) {
2        return t.threadLocals;
3    }

当线程中的ThreadLocal.ThreadLocalMap threadLocals不为空，则以this即当前的ThreadLocal对象作为key来获取对应的value。
当线程中的ThreadLocal.ThreadLocalMap threadLocals为空时，则会初始化：

1private T setInitialValue() {
2        T value = initialValue();
3        Thread t = Thread.currentThread();
4        ThreadLocalMap map = getMap(t);
5        if (map != null)
6            map.set(this, value);
7        else
8            createMap(t, value);
9        return value;
10    }

通过initialValue()来获取初始值，默认是null，这个过程也很清晰明了。就是判断当前线程中ThreadLocalMap是否为空，若为空则创建一个，同时将初始值设置进ThreadLocalMap集合中，key就是ThreadLocal对象本身。其中的initialValue()如下：

1protected T initialValue() {
2        return null;
3    }

即我们可以重写该方法来设置一个初始值。

ThreadLocal的set方法：

1public void set(T value) {
2        Thread t = Thread.currentThread();
3        ThreadLocalMap map = getMap(t);
4        if (map != null)
5            map.set(this, value);
6        else
7            createMap(t, value);
8    }

也很清晰明了，就是获取当期线程的ThreadLocalMap，然后向其中存放数据，key为ThreadLocal对象本身。

这就是ThreadLocal设计模式。