ThreadLocal详解

定义

ThreadLocal的作用是提供线程内的局部变量，这种变量在线程的生命周期内起作用，减少同一个线程内多个函数或者组件之间一些公共变量的传递的复杂度。

使用场景

1. 比如线程中处理一个非常复杂的业务，可能方法有很多，那么，使用 ThreadLocal 可以代替一些参数的显式传递；
2. 比如用来存储用户 Session。Session 的特性很适合 ThreadLocal ，因为 Session 之前当前会话周期内有效，会话结束便销毁。我们先笼统但不正确的分析一次 web 请求的过程：

源码分析

1. ThreadLocalMap 映射表：ThreadLocal的实现是这样的，每个Thread 维护一个 ThreadLocalMap 映射表，这个映射表的 key 是 ThreadLocal实例本身，value 是真正需要存储的 Object，ThreadLocal 可以理解为只是一个中间工具，传递了变量值。

static class ThreadLocalMap {

        /**
         * The entries in this hash map extend WeakReference, using
         * its main ref field as the key (which is always a
         * ThreadLocal object).  Note that null keys (i.e. entry.get()
         * == null) mean that the key is no longer referenced, so the
         * entry can be expunged from table.  Such entries are referred to
         * as "stale entries" in the code that follows.
         */
        static class Entry extends WeakReference<ThreadLocal<?>> {
            /** The value associated with this ThreadLocal. */
            Object value;

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

也就是说 ThreadLocal 本身并不存储值，它只是作为一个 key 来让线程从 ThreadLocalMap 获取 value。
从源码可以看出ThreadLocalMap 是使用 ThreadLocal 的弱引用作为 Key 的，官方解释是“To help deal with very large and long-lived usages, the hash table entries use WeakReferences for keys.”，主要目的是“为了应对非常大和长时间的用途”。如果使用强引用，会出现ThreadLocal被回收，但是ThreadLocalMap还持有ThreadLocal强引用的情况，造成内存无法被回收，导致内存泄露。如果改为弱引用，则value会在下一次ThreadLocalMap调用set,get，remove的时候会被清除。

2. Set方法：调用 ThreadLocal 的 set 方法时，首先获取到了当前线程，然后获取当前线程维护的 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);
    }

3. Get方法：首先获取到当前线程，然后获取当前线程维护的ThreadLocalMap对象的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();
    }

使用注意点

1.使用不当会导致内存泄露

static class ThreadLocalMap {
       static class Entry extends WeakReference<ThreadLocal<?>> {
            Object value;

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

上面已经介绍过ThreadLocalMap 是使用 ThreadLocal 的弱引用作为 Key ，在垃圾回收时会被清理掉，但是，ThreadLocalMap中使用的这个ThreadLocal的Key会被清理掉，但是value是强引用，不会被清理，出现很多key为null的value。所以ThreadLocalMap的生命周期和Thread一样长，如果没有手动删除会导致内存泄露。

解决方法：每次使用完都调用它的remove()方法清除数据

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(); // 清除key
            expungeStaleEntry(i);  // 清除value
            return;
        }
    }
}

2.造成业务逻辑混乱

推荐文章

ThreadLocal源码分析