ThreadLocal是怎样炼成的

好久没更新博客了，一直都有学习新知识，但是没时间总结,主要因为顾着去发展模型兴趣去了哈
难得静下来写一篇博客
闲话不多说，直接进入主题

缘起

两年前因为工作关系，曾经研究过ThreadLocal源码一段时间，不过研究得不够透彻。最近偶然间又接触到ThreadLocal，又有了新的认识，因此写篇博客记录下来，顺便抛砖引玉一下。
网上很多人都会把ThreadLocal类比为Map来实现的，如果你真的这样认为，借用最近我比较喜欢的一句话来说 — 年轻人，你真的太年轻了。
一般百度”ThreadLocal实现”，得到的文章都是类似下面的描述

ThreadLocal是解决线程安全问题一个很好的思路，ThreadLocal类中有一个Map，用于存储每一个线程的变量副本，Map中元素的键为线程对象，而值对应线程的变量副本，由于Key值不可重复，每一个“线程对象”对应线程的“变量副本”，而到达了线程安全。

其实上面的说法是不准确的
ThreadLocal类并没有一个Map来保存数据，数据都是保存在线程实例上的

下面我们来剖析一下

首先我们要介绍一种存储模式

线程特有存储模式 (Thread Specific Storage)

这种模式是为了解决多线程变量共享导致线程安全和死锁问题，首先看看下面的示意图

ObjectX类会被多个线程使用到，为了避免线程安全以及可能的死锁为题，我们希望每个线程都有自己的ObjectX实例。
于是我们设计出一个代理类，用来代理保存和获取操作。

实际上JDK已经提供了上述模式的实现，那就是今天的猪脚ThreadLocal

首先看一个简单的ThreadLocal例子

public class ThreadSpecificDateFormat {

    private static final ThreadLocal<SimpleDateFormat> TS_SDF = new ThreadLocal<SimpleDateFormat>() {
        @Override
        protected SimpleDateFormat initialValue() {
            return new SimpleDateFormat();
        }
    };

    public static Date parse(String timeStamp, String format) throws ParseException {
        final SimpleDateFormat sdf = TS_SDF.get();
        sdf.applyPattern(format);
        Date date = sdf.parse(timeStamp);
        return date;
    }

    public static String format(Date date, String format) {
        final SimpleDateFormat sdf = TS_SDF.get();
        sdf.applyPattern(format);
        String strDate = sdf.format(date);
        return strDate;
    }

}

结合上图看，实例的统一接入点就是ThreadLocal.get()（TS_SDF.get()）这个方法了，通过这个接入点客户端就能拿到Object实例。

接下来再看看get方法的具体实现

public T get() {
    Thread t = Thread.currentThread();
    ThreadLocalMap map = getMap(t);
    if (map != null) {
        ThreadLocalMap.Entry e = map.getEntry(this);
        if (e != null) {
            @SuppressWarnings("unchecked")
            T result = (T)e.value;
            return result;
        }
    }
    return setInitialValue();
}

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

第一步 先获通过Thread.currentThread（）取当前线程
第二步 然后获取当前线程的threadLocals属性
第三步 在threadLocals属性里获取Entry实例
第四部 从Entry实例的value属性里获取到最后所要的Object对象

“当前线程的threadLocals(ThreadLocalMap类的实例)属性”就是担任之前说的”线程的局部存储”角色，因为实际存储的数据都是放在线程实例里的，而不是ThreadLocal实例里，客户端只是利用ThreadLocal作为一个中介去访问线程罢了

接下来讨论一下上面出现的ThreadLocalMap类以及Entry类，直接贴源码

static class ThreadLocalMap {

        static class Entry extends WeakReference<ThreadLocal<?>> {
            /** The value associated with this ThreadLocal. */
            Object value;

            Entry(ThreadLocal<?> k, Object v) {
                super(k);
                value = v;
            }
        }


        ... ...


        /**
         * The table, resized as necessary.
         * table.length MUST always be a power of two.
         */
        private Entry[] table;

        /**
         * The number of entries in the table.
         */
        private int size = 0;

        ... ... 
}

Entry是ThreadLocalMap的内部类，而且ThreadLocalMap里拥有一个类型为Entry[]的table属性，而线每个线程实例有自己的ThreadLocalMap。到这里结论已经很明显了，
负责保存ThreadLocal的key和value根本就不是一个Map类型，而是一个Entry数组!

Entry继承WeakReference，因此继承拥有一个弱引用referent，而且自身也有一个value属性。Entry利用referent来保存threadLocal实例的弱引用，利用value保存Object的强引用

最后的问题是怎样在Entry数组里定位我们需要的Entry呢
还是看代码说话

private Entry getEntry(ThreadLocal<?> key) {
    int i = key.threadLocalHashCode & (table.length - 1);
    Entry e = table[i];
    if (e != null && e.get() == key)
        return e;
    else
        return getEntryAfterMiss(key, i, e);
}

留意key.threadLocalHashCode这个属性，Entry在保存进Entry[]数组之前，会利用ThreadLocal的引用计算出一个hash值，然后利用这个hash值作为下标定位到Entry[]数组的某个位置；
相反，从Entry[]取Entry也是同样道理。

最后来一个图来总结上面说的内容

总结

客户端访问ThreadLocal实例的get方法，get方法通过Thread.getCurrentThread获得当前线程的实例，从而获得当前线程的ThreadLocalMap对象，而ThreadLocalMap里包含了一个Entry数组，里面的每个Entry保存了ThreadLocal引用以及Object引用，Entry的referent保存ThreadLocal的弱引用，Entry的value保存Object的强引用。

欢迎关注个人公众号