Java ThreadLocal分析

参考:ThreadLocal与WeakReference

线程封闭

当访问共享的可变数据时，通常需要使用同步；一种避免使用同步的方式就是不共享数据；如何数据仅仅被一个线程访问，就不需要同步，该技术就是线程封闭。

ThreadLocal就是其中一种实现。

ThreaLocal常见使用

线程池:由于JDBC连接对象不一定是线程安全的，因此，当多个线程在没有协同的情况下使用全局变量时，就不是线程安全的。通过将JDBC的连接保存到ThreadLocal对象中，每个线程都拥有属于自己的连接。

    private static ThreadLocal<Connection> connectionHolder = new
            ThreadLocal<Connection>() {
                @Override
                protected Connection initialValue() {
                    return DriverManager.getConnection("");
                }
            };
    
    public static Condition getConnection() {
        return connectionHolder.get();
    }

除此之外，Spring等各种框架大量使用了ThreadLocal(使用它来保存上下文)。

原理

Thread

在Thread对象中有一个变量(钩子)，保存Map对象。�

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

当你调用ThreadLocal中的set方法时就会生成一个Map对象，把这个Map对象赋值给Thread对象。

ThreadLocal

设值

    public void set(T value) {
        Thread t = Thread.currentThread();
        ThreadLocalMap map = getMap(t);
        if (map != null)
            map.set(this, value); // 以ThreadLocal对象作为key设值
        else
            createMap(t, value);
    }

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

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

取值

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

    protected T initialValue() { // 该方法可以重新设置初始化值
        return null;
    }

ThreadLocal本质上是给每个线程绑定一个Map对象，该Map对象key是ThreadLocal本身，value是要设置的值；这样每个value就仅仅可以被该线程自己访问到，外部其他线程不会访问到该对象，实现了线程安全。

Thread与ThreadLocal关系

Thread和ThreadLocal之间有着很紧密的关系，Thread中的Map持有ThreadLocal对象(以它作为key)。

Thread	ThreadLocal
死亡	死亡
存活	存活
存活	死亡
死亡	存活

当两者之间都已经死亡时，自然会被GC回收；当两者都“存活”时，GC不会回收它们；那么当Thread或ThreadLocal两者之间一个“死亡”时情况是什么样呢。

Thread死亡

当Thread死亡时，线程中Map也不存在了，因为Map被回收，Map中保存的key、value也会根据是否还被引用来决定是否被回收，不会导致内存泄露。

ThreadLocal死亡

当ThreadLocal死亡时，线程依然存活，Map还在，但是Map中一个以该ThreadLocal为key的Entry需要失效，该Entry中的key和value应该被GC。

为了实现这一点，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死亡时，因为Entry中key是弱引用，GC依然会回收该对象，不会导致内存泄露。

而Entry中该key对应value的回收是通过下列方法实现的:

        private boolean cleanSomeSlots(int i, int n) {
            boolean removed = false;
            Entry[] tab = table;
            int len = tab.length;
            do {
                i = nextIndex(i, len);
                Entry e = tab[i];
                if (e != null && e.get() == null) { // e.get() point
                    n = len;
                    removed = true;
                    i = expungeStaleEntry(i);
                }
            } while ( (n >>>= 1) != 0);
            return removed;
        }

expungeStaleEntry方法中:
                    e.value = null; // value set null
                    tab[i] = null;
                    size--;

通过该方法把value设置为null，以便在下次GC时能够及时回收该对象；ThreadLocal死亡时不会导致内存泄露。

注意

当前很多技术都是使用的线程池技术，线程不会频繁的创建销毁，那么存在一种可能性，比如线程池中一个线程拿到全局ThreadLocal对象并设置了一个很大的字符串对象，使用过后没有remove操作，那么由于线程和ThreadLocal都是存活的，那么该字符串对象是不会被回收的，导致内存泄露，所以当使用完毕后线程最好调用ThreadLocal中的remove方法，及时移除该对象，防止不必要的内存损耗。