[java] ThreadLocal原理及内存泄露的解决

1.ThreadLocal解决了什么问题？

ThreadLocal提供了线程局部变量，通常维护一些资源或者变量，以避免线程争用或者同步问题；

2.使用方式

每个线程通过{@code get}或{@code set}方法，独立初始化的变量的副本。

3.原理是什么？

3.1 读取数据

3.1.1 读取数据的整个流程

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

3.1.2 从当前线程获取ThreadLocalMap引用

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

3.1.2 如果当前线程没有ThreadLocalMap引用，则创建一个ThreadLocalMap对象，并调用initialValue获取初始值。其中key为ThreadLocal对象，value为初始值。

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

3.1.3 新建ThreadLocalMap对象

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

3.2 设置值

设置值就是将值塞入ThreadLocalMap中，其中key是ThreadLocal对象，value是需要设置的值。

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

4、可能存在的内存泄露问题？

4.1 在ThreadLocalMap的构造函数中，会将传入的key,value组装成一个Entry放到对应的线性表中。

ThreadLocalMap(ThreadLocal<?> firstKey, Object firstValue) {
    table = new Entry[INITIAL_CAPACITY];
    int i = firstKey.threadLocalHashCode & (INITIAL_CAPACITY - 1);
    table[i] = new Entry(firstKey, firstValue);
    size = 1;
    setThreshold(INITIAL_CAPACITY);
}

4.2 但是Entry的key使用了弱引用WeakReference。

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

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

弱引用也是用来描述非必需对象的，但是它的强度比软引用更弱一些，被弱引用关联的对象只能生存到下一次垃圾收集发生之前。当垃圾收集器工作时，无论当前内存是否足够，都会回收掉只被弱引用关联的对象。

如果ThreadLocal没有被ThreadLocalMap以外的对象引用，在下一次GC的时候，ThreadLocal实例就会被回收，那么ThreadLocalMap中ThreadLocal所表示的key就是null了，那么value便不会被外部访问到；只要Thread实例一直存在，这里key为null的value就一直占用着内存。
这就是内存泄露；

4.3 如何预防内存泄露？

在ThreadLocal使用结束时，调用ThreadLocal.remove()来释放value的引用，避免在ThreadLocal对象被回收时value无法被访问却又占用着内存的情况。

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