Java中的ThreadLocal详解

1、ThreadLocal简介

　　多线程访问同一个共享变量的时候容易出现并发问题，特别是多个线程对一个变量进行写入的时候，为了保证线程安全，通常使用者在访问共享变量的时候须要进行额外的同步措施才能保证线程安全性。ThreadLocal是除了加锁这种同步方式以外的一种保证一种规避多线程访问出现线程不安全的方法，当咱们在建立一个变量后，若是每一个线程对其进行访问的时候访问的都是线程本身的变量这样就不会存在线程不安全问题。

　　ThreadLocal是JDK包提供的，它提供线程本地变量，若是建立一乐ThreadLocal变量，那么访问这个变量的每一个线程都会有这个变量的一个副本，在实际多线程操做的时候，操做的是本身本地内存中的变量，从而规避了线程安全问题，以下图所示

2、ThreadLocal简单使用

　　下面的例子中，开启两个线程，在每一个线程内部设置了本地变量的值，而后调用print方法打印当前本地变量的值。若是在打印以后调用本地变量的remove方法会删除本地内存中的变量，代码以下所示

 1 package test;
 2 
 3 public class ThreadLocalTest {
 4 
 5     static ThreadLocal<String> localVar = new ThreadLocal<>();
 6 
 7     static void print(String str) {
 8         //打印当前线程中本地内存中本地变量的值
 9         System.out.println(str + " :" + localVar.get());
10         //清除本地内存中的本地变量
11         localVar.remove();
12     }
13 
14     public static void main(String[] args) {
15         Thread t1  = new Thread(new Runnable() {
16             @Override
17             public void run() {
18                 //设置线程1中本地变量的值
19                 localVar.set("localVar1");
20                 //调用打印方法
21                 print("thread1");
22                 //打印本地变量
23                 System.out.println("after remove : " + localVar.get());
24             }
25         });
26 
27         Thread t2  = new Thread(new Runnable() {
28             @Override
29             public void run() {
30                 //设置线程1中本地变量的值
31                 localVar.set("localVar2");
32                 //调用打印方法
33                 print("thread2");
34                 //打印本地变量
35                 System.out.println("after remove : " + localVar.get());
36             }
37         });
38 
39         t1.start();
40         t2.start();
41     }
42 }

 下面是运行后的结果：

3、ThreadLocal的实现原理

　　下面是ThreadLocal的类图结构，从图中可知：Thread类中有两个变量threadLocals和inheritableThreadLocals，两者都是ThreadLocal内部类ThreadLocalMap类型的变量，咱们经过查看内部内ThreadLocalMap能够发现实际上它相似于一个HashMap。在默认状况下，每一个线程中的这两个变量都为null，只有当线程第一次调用ThreadLocal的set或者get方法的时候才会建立他们（后面咱们会查看这两个方法的源码）。除此以外，和我所想的不一样的是，每一个线程的本地变量不是存放在ThreadLocal实例中，而是放在调用线程的ThreadLocals变量里面（前面也说过，该变量是Thread类的变量）。也就是说，ThreadLocal类型的本地变量是存放在具体的线程空间上，其自己至关于一个装载本地变量的工具壳，经过set方法将value添加到调用线程的threadLocals中，当调用线程调用get方法时候可以从它的threadLocals中取出变量。若是调用线程一直不终止，那么这个本地变量将会一直存放在他的threadLocals中，因此不使用本地变量的时候须要调用remove方法将threadLocals中删除不用的本地变量。下面咱们经过查看ThreadLocal的set、get以及remove方法来查看ThreadLocal具体实怎样工做的

　　一、set方法源码

 1 public void set(T value) {
 2     //(1)获取当前线程（调用者线程）
 3     Thread t = Thread.currentThread();
 4     //(2)以当前线程做为key值，去查找对应的线程变量，找到对应的map
 5     ThreadLocalMap map = getMap(t);
 6     //(3)若是map不为null，就直接添加本地变量，key为当前线程，值为添加的本地变量值
 7     if (map != null)
 8         map.set(this, value);
 9     //(4)若是map为null，说明首次添加，须要首先建立出对应的map
10     else
11         createMap(t, value);
12 }

　　在上面的代码中，(2)处调用getMap方法得到当前线程对应的threadLocals(参照上面的图示和文字说明)，该方法代码以下

ThreadLocalMap getMap(Thread t) {
    return t.threadLocals; //获取线程本身的变量threadLocals，并绑定到当前调用线程的成员变量threadLocals上
}

　　若是调用getMap方法返回值不为null，就直接将value值设置到threadLocals中（key为当前线程引用，值为本地变量）；若是getMap方法返回null说明是第一次调用set方法（前面说到过，threadLocals默认值为null，只有调用set方法的时候才会建立map），这个时候就须要调用createMap方法建立threadLocals，该方法以下所示

1 void createMap(Thread t, T firstValue) {
2     t.threadLocals = new ThreadLocalMap(this, firstValue);
3 }

　　createMap方法不只建立了threadLocals，同时也将要添加的本地变量值添加到了threadLocals中。

　　二、get方法源码

　　在get方法的实现中，首先获取当前调用者线程，若是当前线程的threadLocals不为null，就直接返回当前线程绑定的本地变量值，不然执行setInitialValue方法初始化threadLocals变量。在setInitialValue方法中，相似于set方法的实现，都是判断当前线程的threadLocals变量是否为null，是则添加本地变量（这个时候因为是初始化，因此添加的值为null），不然建立threadLocals变量，一样添加的值为null。

 1 public T get() {
 2     //(1)获取当前线程
 3     Thread t = Thread.currentThread();
 4     //(2)获取当前线程的threadLocals变量
 5     ThreadLocalMap map = getMap(t);
 6     //(3)若是threadLocals变量不为null，就能够在map中查找到本地变量的值
 7     if (map != null) {
 8         ThreadLocalMap.Entry e = map.getEntry(this);
 9         if (e != null) {
10             @SuppressWarnings("unchecked")
11             T result = (T)e.value;
12             return result;
13         }
14     }
15     //(4)执行到此处，threadLocals为null，调用该更改初始化当前线程的threadLocals变量
16     return setInitialValue();
17 }
18 
19 private T setInitialValue() {
20     //protected T initialValue() {return null;}
21     T value = initialValue();
22     //获取当前线程
23     Thread t = Thread.currentThread();
24     //以当前线程做为key值，去查找对应的线程变量，找到对应的map
25     ThreadLocalMap map = getMap(t);
26     //若是map不为null，就直接添加本地变量，key为当前线程，值为添加的本地变量值
27     if (map != null)
28         map.set(this, value);
29     //若是map为null，说明首次添加，须要首先建立出对应的map
30     else
31         createMap(t, value);
32     return value;
33 }

　　三、remove方法的实现

　　remove方法判断该当前线程对应的threadLocals变量是否为null，不为null就直接删除当前线程中指定的threadLocals变量

1  public void remove() {
2     //获取当前线程绑定的threadLocals
3      ThreadLocalMap m = getMap(Thread.currentThread());
4      //若是map不为null，就移除当前线程中指定ThreadLocal实例的本地变量
5      if (m != null)
6          m.remove(this);
7  }

　　四、以下图所示：每一个线程内部有一个名为threadLocals的成员变量，该变量的类型为ThreadLocal.ThreadLocalMap类型（相似于一个HashMap），其中的key为当前定义的ThreadLocal变量的this引用，value为咱们使用set方法设置的值。每一个线程的本地变量存放在本身的本地内存变量threadLocals中，若是当前线程一直不消亡，那么这些本地变量就会一直存在（因此可能会致使内存溢出），所以使用完毕须要将其remove掉。

4、ThreadLocal不支持继承性

　　同一个ThreadLocal变量在父线程中被设置值后，在子线程中是获取不到的。（threadLocals中为当前调用线程对应的本地变量，因此两者天然是不能共享的）

 1 package test;
 2 
 3 public class ThreadLocalTest2 {
 4 
 5     //(1)建立ThreadLocal变量
 6     public static ThreadLocal<String> threadLocal = new ThreadLocal<>();
 7 
 8     public static void main(String[] args) {
 9         //在main线程中添加main线程的本地变量
10         threadLocal.set("mainVal");
11         //新建立一个子线程
12         Thread thread = new Thread(new Runnable() {
13             @Override
14             public void run() {
15                 System.out.println("子线程中的本地变量值:"+threadLocal.get());
16             }
17         });
18         thread.start();
19         //输出main线程中的本地变量值
20         System.out.println("mainx线程中的本地变量值:"+threadLocal.get());
21     }
22 }

5、InheritableThreadLocal类

　　在上面说到的ThreadLocal类是不能提供子线程访问父线程的本地变量的，而InheritableThreadLocal类则能够作到这个功能，下面是该类的源码

 1 public class InheritableThreadLocal<T> extends ThreadLocal<T> {
 2     
 3     protected T childValue(T parentValue) {
 4         return parentValue;
 5     }
 6 
 7     ThreadLocalMap getMap(Thread t) {
 8        return t.inheritableThreadLocals;
 9     }
10 
11     void createMap(Thread t, T firstValue) {
12         t.inheritableThreadLocals = new ThreadLocalMap(this, firstValue);
13     }
14 }

　　从上面代码能够看出，InheritableThreadLocal类继承了ThreadLocal类，并重写了childValue、getMap、createMap三个方法。其中createMap方法在被调用（当前线程调用set方法时获得的map为null的时候须要调用该方法）的时候，建立的是inheritableThreadLocal而不是threadLocals。同理，getMap方法在当前调用者线程调用get方法的时候返回的也不是threadLocals而是inheritableThreadLocal。

　　下面咱们看看重写的childValue方法在何时执行，怎样让子线程访问父线程的本地变量值。咱们首先从Thread类开始提及

 1 private void init(ThreadGroup g, Runnable target, String name,
 2                   long stackSize) {
 3     init(g, target, name, stackSize, null, true);
 4 }
 5 private void init(ThreadGroup g, Runnable target, String name,
 6                   long stackSize, AccessControlContext acc,
 7                   boolean inheritThreadLocals) {
 8     //判断名字的合法性
 9     if (name == null) {
10         throw new NullPointerException("name cannot be null");
11     }
12 
13     this.name = name;
14     //(1)获取当前线程(父线程)
15     Thread parent = currentThread();
16     //安全校验
17     SecurityManager security = System.getSecurityManager();
18     if (g == null) { //g:当前线程组
19         if (security != null) {
20             g = security.getThreadGroup();
21         }
22         if (g == null) {
23             g = parent.getThreadGroup();
24         }
25     }
26     g.checkAccess();
27     if (security != null) {
28         if (isCCLOverridden(getClass())) {
29             security.checkPermission(SUBCLASS_IMPLEMENTATION_PERMISSION);
30         }
31     }
32 
33     g.addUnstarted();
34 
35     this.group = g; //设置为当前线程组
36     this.daemon = parent.isDaemon();//守护线程与否(同父线程)
37     this.priority = parent.getPriority();//优先级同父线程
38     if (security == null || isCCLOverridden(parent.getClass()))
39         this.contextClassLoader = parent.getContextClassLoader();
40     else
41         this.contextClassLoader = parent.contextClassLoader;
42     this.inheritedAccessControlContext =
43             acc != null ? acc : AccessController.getContext();
44     this.target = target;
45     setPriority(priority);
46     //(2)若是父线程的inheritableThreadLocal不为null
47     if (inheritThreadLocals && parent.inheritableThreadLocals != null)
48         //（3）设置子线程中的inheritableThreadLocals为父线程的inheritableThreadLocals
49         this.inheritableThreadLocals =
50             ThreadLocal.createInheritedMap(parent.inheritableThreadLocals);
51     this.stackSize = stackSize;
52 
53     tid = nextThreadID();
54 }

　　在init方法中，首先(1)处获取了当前线程(父线程)，而后（2）处判断当前父线程的inheritableThreadLocals是否为null，而后调用createInheritedMap将父线程的inheritableThreadLocals做为构造函数参数建立了一个新的ThreadLocalMap变量，而后赋值给子线程。下面是createInheritedMap方法和ThreadLocalMap的构造方法

 1 static ThreadLocalMap createInheritedMap(ThreadLocalMap parentMap) {
 2     return new ThreadLocalMap(parentMap);
 3 }
 4 
 5 private ThreadLocalMap(ThreadLocalMap parentMap) {
 6     Entry[] parentTable = parentMap.table;
 7     int len = parentTable.length;
 8     setThreshold(len);
 9     table = new Entry[len];
10 
11     for (int j = 0; j < len; j++) {
12         Entry e = parentTable[j];
13         if (e != null) {
14             @SuppressWarnings("unchecked")
15             ThreadLocal<Object> key = (ThreadLocal<Object>) e.get();
16             if (key != null) {
17                 //调用重写的方法
18                 Object value = key.childValue(e.value);
19                 Entry c = new Entry(key, value);
20                 int h = key.threadLocalHashCode & (len - 1);
21                 while (table[h] != null)
22                     h = nextIndex(h, len);
23                 table[h] = c;
24                 size++;
25             }
26         }
27     }
28 }

　　在构造函数中将父线程的inheritableThreadLocals成员变量的值赋值到新的ThreadLocalMap对象中。返回以后赋值给子线程的inheritableThreadLocals。总之，InheritableThreadLocals类经过重写getMap和createMap两个方法将本地变量保存到了具体线程的inheritableThreadLocals变量中，当线程经过InheritableThreadLocals实例的set或者get方法设置变量的时候，就会建立当前线程的inheritableThreadLocals变量。而父线程建立子线程的时候，ThreadLocalMap中的构造函数会将父线程的inheritableThreadLocals中的变量复制一份到子线程的inheritableThreadLocals变量中。

6、从ThreadLocalMap看ThreadLocal使用不当的内存泄漏问题

一、基础概念 

　　首先咱们先看看ThreadLocalMap的类图，在前面的介绍中，咱们知道ThreadLocal只是一个工具类，他为用户提供get、set、remove接口操做实际存放本地变量的threadLocals（调用线程的成员变量），也知道threadLocals是一个ThreadLocalMap类型的变量，下面咱们来看看ThreadLocalMap这个类。在此以前，咱们回忆一下Java中的四种引用类型，相关GC只是参考前面系列的文章(JVM相关)

①强引用：Java中默认的引用类型，一个对象若是具备强引用那么只要这种引用还存在就不会被GC。

②软引用：简言之，若是一个对象具备弱引用，在JVM发生OOM以前（即内存充足够使用），是不会GC这个对象的；只有到JVM内存不足的时候才会GC掉这个对象。软引用和一个引用队列联合使用，若是软引用所引用的对象被回收以后，该引用就会加入到与之关联的引用队列中

③弱引用（这里讨论ThreadLocalMap中的Entry类的重点）：若是一个对象只具备弱引用，那么这个对象就会被垃圾回收器GC掉(被弱引用所引用的对象只能生存到下一次GC以前，当发生GC时候，不管当前内存是否足够，弱引用所引用的对象都会被回收掉)。弱引用也是和一个引用队列联合使用，若是弱引用的对象被垃圾回收期回收掉，JVM会将这个引用加入到与之关联的引用队列中。若引用的对象能够经过弱引用的get方法获得，当引用的对象呗回收掉以后，再调用get方法就会返回null

④虚引用：虚引用是全部引用中最弱的一种引用，其存在就是为了将关联虚引用的对象在被GC掉以后收到一个通知。（不能经过get方法得到其指向的对象）

二、分析ThreadLocalMap内部实现

　　上面咱们知道ThreadLocalMap内部其实是一个Entry数组，咱们先看看Entry的这个内部类

 1 /**
 2  * 是继承自WeakReference的一个类，该类中实际存放的key是
 3  * 指向ThreadLocal的弱引用和与之对应的value值(该value值
 4  * 就是经过ThreadLocal的set方法传递过来的值)
 5  * 因为是弱引用，当get方法返回null的时候意味着坑能引用
 6  */
 7 static class Entry extends WeakReference<ThreadLocal<?>> {
 8     /** value就是和ThreadLocal绑定的 */
 9     Object value;
10 
11     //k：ThreadLocal的引用，被传递给WeakReference的构造方法
12     Entry(ThreadLocal<?> k, Object v) {
13         super(k);
14         value = v;
15     }
16 }
17 //WeakReference构造方法(public class WeakReference<T> extends Reference<T> )
18 public WeakReference(T referent) {
19     super(referent); //referent：ThreadLocal的引用
20 }
21 
22 //Reference构造方法     
23 Reference(T referent) {
24     this(referent, null);//referent：ThreadLocal的引用
25 }
26 
27 Reference(T referent, ReferenceQueue<? super T> queue) {
28     this.referent = referent;
29     this.queue = (queue == null) ? ReferenceQueue.NULL : queue;
30 }

　　在上面的代码中，咱们能够看出，当前ThreadLocal的引用k被传递给WeakReference的构造函数，因此ThreadLocalMap中的key为ThreadLocal的弱引用。当一个线程调用ThreadLocal的set方法设置变量的时候，当前线程的ThreadLocalMap就会存放一个记录，这个记录的key值为ThreadLocal的弱引用，value就是经过set设置的值。若是当前线程一直存在且没有调用该ThreadLocal的remove方法，若是这个时候别的地方还有对ThreadLocal的引用，那么当前线程中的ThreadLocalMap中会存在对ThreadLocal变量的引用和value对象的引用，是不会释放的，就会形成内存泄漏。

　　考虑这个ThreadLocal变量没有其余强依赖，若是当前线程还存在，因为线程的ThreadLocalMap里面的key是弱引用，因此当前线程的ThreadLocalMap里面的ThreadLocal变量的弱引用在gc的时候就被回收，可是对应的value仍是存在的这就可能形成内存泄漏(由于这个时候ThreadLocalMap会存在key为null可是value不为null的entry项)。

　　总结：THreadLocalMap中的Entry的key使用的是ThreadLocal对象的弱引用，在没有其余地方对ThreadLoca依赖，ThreadLocalMap中的ThreadLocal对象就会被回收掉，可是对应的不会被回收，这个时候Map中就可能存在key为null可是value不为null的项，这须要实际的时候使用完毕及时调用remove方法避免内存泄漏。