ThreadLocal

ThreadLocal

1.什么是 ThreadLocal

ThreadLocal 提供线程局部变量，ThreadLocal 中的变量对其他线程可见，但是其他线程不能修改该变量。ThreadLocal 相当于可以为每个线程创建一个变量副本，在多线程的环境下保证各个线程的变量独立。

2.ThreadLocal 的实现

Thread 类中有一个 ThreadLocalMap 类型 的threadLocals 的变量：

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

ThreadLocal 的 set 方法先去获取当前线程的 threadLocals 也就是当前线程的 ThreadLocalMap,调用 ThreadLocalMap 的 set 方法将此 ThreadLocal 作为 key,传入的 value 作为value,形成一个 Entry 放入 ThreadLocalMap 中。若当前线程没有 ThreadLocalMap，则为当前线程创建一个 ThreadLocalMap。

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 getMap(Thread t) {
        return t.threadLocals;
    }

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

ThreadLocal 的 get 方法先去获得当前线程的 ThreadLocalMap,如果 ThreadLocalMap 不为空，则取出 Entry，则给 ThreadLocalMap 初始化一个值。

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

ThreadLocal 的 remove 方法会调用当前线程的 ThreadMap.remove 方法，该方法会遍历 ThreadLocalMap 的Entry,若 key 为当前的 ThreadLocal 则执行 Entry 的 clear 方法。

public void remove() {
    ThreadLocalMap m = getMap(Thread.currentThread());
    if (m != null)
        m.remove(this);
}

private void remove(ThreadLocal<?> key) {
            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)]) {
                if (e.get() == key) {
                    e.clear();
                    expungeStaleEntry(i);
                    return;
                }
            }
        }

3.ThreadLocalMap

ThreadLocalMap 是 ThreadLocal 的一个内部类。ThreadLocalMap 内部维护一个 Entry 类型的表来存储数据（Entry 是 ThreadLocalMap 的一个内部类）

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

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

Entry 用于保存一个键值对，key 以若引用方式保存。

ThreadLocalMap 的 set 方法将数据存储到 Entry table 中：

private void set(ThreadLocal<?> key, Object value) {

    // We don't use a fast path as with get() because it is at
    // least as common to use set() to create new entries as
    // it is to replace existing ones, in which case, a fast
    // path would fail more often than not.

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

通过 threadLocalHashCode 来计算索引位置。每个 ThreadLocal 对象会自动生成一个 threadLocalHashCode 值：

private final int threadLocalHashCode = nextHashCode();

/**
 * The next hash code to be given out. Updated atomically. Starts at
 * zero.
 */
private static AtomicInteger nextHashCode =
    new AtomicInteger();

/**
 * The difference between successively generated hash codes - turns
 * implicit sequential thread-local IDs into near-optimally spread
 * multiplicative hash values for power-of-two-sized tables.
 */
private static final int HASH_INCREMENT = 0x61c88647;
private static int nextHashCode() {
    return nextHashCode.getAndAdd(HASH_INCREMENT);
}

其中用 AtomicInteger 来保证多线程环境下的同步。

在保存数据时，如果索引位置有 Entry，且该 Entry 的 key 为 null，那么就会执行清除无效 Entry 的操作，因为 Entry 的 key 使用的是弱引用的方式，key 如果被回收（即 key 为 null），这时就无法再访问到 key 对应的 value，需要把这样的无效 Entry 清除掉来腾出空间。在调整 table 容量时，也会先清除无效对象，然后再根据需要扩容。

4.ThreadLocal 的内存泄漏问题

ThreadLocalMap 的生命周期和当前线程一样长， ThreadLocalMap 中 的 ThreadLocal 和 Value 为弱引用，是为了避免 ThreadLocal 没有被回收而引起的内存泄漏，但是 value 仍然没法回收，依然会导致内存泄漏的问题。ThreadLocalMap 的 get, set,remove 方法都会清楚 key 为 null 的 value。每次用完 ThreadLocal 需要调用 remove 方法，避免内存泄漏问题。

5. Thread,ThreadLocal,ThreadLocalMap,Entry 之间的关系

实线表示强引用，虚线表示弱引用

6.强引用、软引用、弱引用和虚引用