ThreadLocal源码解密

1 背景

作为一只懒懒地程序员，其实我是不太爱看源码的，晦涩、深奥、难懂、耗费时间等等，就觉得不是我这种能力平平地小老百姓能吃得消的，但现实比人强，记得曾经我就被不懂原理的情况下乱用ThreadLocal给毒打了。

犹记得当时在一个JSF服务中的责任链的校验场景中需要在源头处增加一些返回值，并且由于大部分值都是在某几条具体的校验链中已经获取到并且其他链条中也不需要，所以当时考虑用ThreadLocal在整个链条中在做校验的时候就能顺便将需要返回的值进行填充，并在返回的时候获取从而进行最终结果的包装返回，但当时对于ThreadLocal认知比较浅显同时也没考虑到jsf线程池的问题，导致以为一个线程执行完后ThreadLocal中会自动清空，导致在运行的时候发现了一个奇怪的表象：ThreadLocal中的值拿到的是上次调用里存储的值。

好了，废话少说，咱先来看看ThreadLocal到底是个啥，然后再分析当时为啥会出现上述我所说的异常情况。

2 探索ThreadLocal

2.1 初识ThreadLocal

其实我对ThreadLocal的认知都是基于身边的同事聊天或少数场景的代码中见到过，但是对于其原理确实一窍不通，只知道它可以用来在同一个线程中起到传递数据的作用，所以在看源码之前我一直以为ThreadLocal就是一个map，key是当前线程，值是任意Object，不同线程之间的数据是隔离非共享的，只有是同一个线程中其存储的数据才是共享的。

2.2 ThreadLocal基本构成

通过查看代码可看到其由一些属性、方法、内部类构成，属性可不必太关注，只需关注我们常用的set()、get()、remove()方法以及其内部类ThreadLocalMap即可，其简略类图结构如下图所示

由图中可看出，ThreadLocal有个内部类ThreadLocalMap，而ThreadLocalMap中也有个内部类Entry，Entry类继承了WeakReference类，泛型指向是ThreadLocal本身。

2.3 ThreadLocal常用方法解析

2.3.1 set方法

public void set(T value) {
        Thread t = Thread.currentThread();
        ThreadLocalMap map = getMap(t);
        if (map != null)
            map.set(this, value);
        else
            createMap(t, value);
    }

只看以上这些的话，理解起来很简单，其实就是获取当前线程，根据当前线程拿到对应的ThreadLocalMap对象，然后判断其是否为空，空的话需要创建并对设置value的值，非空则直接设置value的值，有map.set(this,value)大概能看出value的值是跟this-->ThreadLocal本身有关联映射的，那到底是怎么映射的呢，我们接下来进行深入解析，首先进入到getMap(t)方法中进行查看，其源码如下

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

看到代码是不是很惊讶，我了个去去的，这是个啥么咚咚，就这么一行，是的，就是这么一行简简单单地代码，实质是其直接返回了当前线程内的threadLocals变量，那这个threadLocals变量有何说法呢，我们不妨耐心来来继续往下看，首先看其引用方式，其源码如下

/* ThreadLocal values pertaining to this thread. This map is maintained
     * by the ThreadLocal class. */
    ThreadLocal.ThreadLocalMap threadLocals = null;




    /*
     * InheritableThreadLocal values pertaining to this thread. This map is
     * maintained by the InheritableThreadLoca