ThreadLocal 的原理和使用？

前言

在面试环节中，考察"ThreadLocal"也是面试官的屡见不鲜，因此对它理解透彻，是很是有必要的. 有些面试官会开门见山的提问：

“知道ThreadLocal吗？” “讲讲你对ThreadLocal的理解”

固然了，也有面试官会慢慢引导到这个话题上，好比提问“在多线程环境下，如何防止本身的变量被其它线程篡改”，将主动权交给你本身，剩下的靠本身发挥。 那么ThreadLocal能够作什么，在了解它的应用场景以前，咱们先看看它的实现原理，只有知道了实现原理，才好判断它是否符合本身的业务场景。

1、内部原理

首先，它是一个数据结构，有点像HashMap，能够保存"key : value"键值对，可是一个ThreadLocal只能保存一个，而且各个线程的数据互不干扰。

ThreadLocal<String> localName = new ThreadLocal();
localName.set("赵新Stu");
String name = localName.get();
复制代码

在线程1中初始化了一个ThreadLocal对象localName，并经过set方法，保存了一个值"赵新Stu"，同时在线程1中经过localName.get()能够拿到以前设置的值，可是若是在线程2中，拿到的将是一个null。

这是为何，如何实现？不过以前也说了，ThreadLocal保证了各个线程的数据互不干扰。

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

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();
}

private T setInitialValue() {
    T value = initialValue();
    Thread t = Thread.currentThread();
    ThreadLocalMap map = getMap(t);
    if (map != null)
        map.set(this, value);
    else
        createMap(t, value);
    return value;
}

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

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

复制代码

能够发现，每一个线程中都有一个ThreadLocalMap数据结构，当执行set方法时，其值是保存在当前线程的threadLocals变量中，当执行set方法中，是从当前线程的threadLocals变量获取。

因此在线程1中set的值，对线程2来讲是摸不到的，并且在线程2中从新set的话，也不会影响到线程1中的值，保证了线程之间不会相互干扰。

那每一个线程中的ThreadLoalMap到底是什么？

本文分析的是1.7的源码。

从名字上看，能够猜到它也是一个相似HashMap的数据结构，可是在ThreadLocal中，并没实现Map接口。

在ThreadLoalMap中，也是初始化一个大小16的Entry数组，Entry对象用来保存每个key-value键值对，只不过这里的key永远都是ThreadLocal对象，是否是很神奇，经过ThreadLocal对象的set方法，结果把ThreadLocal对象本身当作key，放进了ThreadLoalMap中。

这里须要注意的是，ThreadLoalMap的Entry是继承WeakReference，和HashMap很大的区别是，Entry中没有next字段，因此就不存在链表的状况了。

private void set(ThreadLocal<?> key, Object value) {
    Entry[] tab = table;
    int len = tab.length;
    int i = key.threadLocalHashCode & (len-1);

    for (Entry e = tab[i];
         e != null;
         e = tab[i = nextIndex(i, len)]) {
        ThreadLocal<?> k = e.get();

        if (k == key) {
            e.value = value;
            return;
        }

        if (k == null) {
            replaceStaleEntry(key, value, i);
            return;
        }
    }

    tab[i] = new Entry(key, value);
    int sz = ++size;
    if (!cleanSomeSlots(i, sz) && sz >= threshold)
        rehash();
}
复制代码

每一个ThreadLocal对象都有一个hash值threadLocalHashCode，每初始化一个ThreadLocal对象，hash值就增长一个固定的大小0x61c88647。

在插入过程当中，根据ThreadLocal对象的hash值，定位到table中的位置i，过程以下： 一、若是当前位置是空的，那么正好，就初始化一个Entry对象放在位置i上；

二、不巧，位置i已经有Entry对象了，若是这个Entry对象的key正好是即将设置的key，那么从新设置Entry中的value；

三、很不巧，位置i的Entry对象，和即将设置的key不要紧，那么只能找下一个空位置； 这样的话，在get的时候，也会根据ThreadLocal对象的hash值，定位到table中的位置，而后判断该位置Entry对象中的key是否和get的key一致，若是不一致，就判断下一个位置.

能够发现，set和get若是冲突严重的话，效率很低，由于ThreadLoalMap是Thread的一个属性，因此即便在本身的代码中控制了设置的元素个数，但仍是不能控制其它代码的行为。

内存泄露

ThreadLocal可能致使内存泄漏，为何？ 先看看Entry的实现：

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

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

经过以前的分析已经知道，当使用ThreadLocal保存一个value时，会在ThreadLocalMap中的数组插入一个Entry对象，按理说key-value都应该以强引用保存在Entry对象中，但在ThreadLocalMap的实现中，key被保存到了WeakReference对象中。

这就致使了一个问题，ThreadLocal在没有外部强引用时，发生GC时会被回收，若是建立ThreadLocal的线程一直持续运行，那么这个Entry对象中的value就有可能一直得不到回收，发生内存泄露。

如何避免内存泄露

既然已经发现有内存泄露的隐患，天然有应对的策略，在调用ThreadLocal的get()、set()可能会清除ThreadLocalMap中key为null的Entry对象，这样对应的value就没有GC Roots可达了，下次GC的时候就能够被回收，固然若是调用remove方法，确定会删除对应的Entry对象。

若是使用ThreadLocal的set方法以后，没有显示的调用remove方法，就有可能发生内存泄露，因此养成良好的编程习惯十分重要，使用完ThreadLocal以后，记得调用remove方法。

ThreadLocal<String> localName = new ThreadLocal();
try {
    localName.set("赵新Stu");
    // 其它业务逻辑
} finally {
    localName.remove();
}
复制代码

2、使用场景

ThreadLocal的用法，这个类提供“thread-local”变量，这些变量与线程的局部变量不一样，每一个线程都保存一份改变量的副本，能够经过get或者set方法访问。若是开发者但愿将类的某个静态变量（user ID或者transaction ID）与线程状态关联，则能够考虑使用ThreadLocal。