ThreadLocal是什么？

• ThreadLocal 这个类提供线程局部变量，这些变量与其他正常的变量的不同之处在于：在每一个访问该变量的线程的内部，都有一个独立的初始化的变量副本；

• ThreadLocal 实例变量通常采用private static在类中修饰。

• 只要 ThreadLocal 的变量能被访问，并且线程存活，那每个线程都会持有 ThreadLocal 变量的副本。当一个线程结束时，它所持有的所有 ThreadLocal 相对的实例副本都可被回收。

• 一般使用场景在于，每个线程都需要自己独立的实例的场景，通俗来讲就是变量在线程间隔离，而在方法或类间共享的场景

如何使用，这里就不进行解说了，下面主要分析一下原理：

ThreadLocal的set方法

public void set(T value) {
        //(1)获取当前线程
        Thread t = Thread.currentThread();
        //(2)当前线程作为key，去查找对应的线程变量，找到则设置
        ThreadLocalMap map = getMap(t);
        if (map != null)
            map.set(this, value);
        else
        //(3)第一次调用则创建当前线程对应的Map
            createMap(t, value);
    }

getMap(Thread t)代码如下：

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

可知getMap(t)所做的就是获取线程自己的变量threadLocals，因此threadlocal变量是线程的成员变量。

如果map为null，则创建ThreadLocalMap，并设置为此线程的成员变量

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

ThreadLocal的get方法

public T get() {
        //(4) 获取当前线程
        Thread t = Thread.currentThread();
        //(5)获取当前线程的threadLocals变量
        ThreadLocalMap map = getMap(t);
        //(6)如果threadLocals不为null，则返回对应本地变量值
        if (map != null) {
            ThreadLocalMap.Entry e = map.getEntry(this);
            if (e != null) {
                @SuppressWarnings("unchecked")
                T result = (T)e.value;
                return result;
            }
        }
        //(7)threadLocals为空则初始化当前线程的threadLocals成员变量
        return setInitialValue();
    }

private T setInitialValue() {
        //(8)初始化为null
        T value = initialValue();
        Thread t = Thread.currentThread();
        ThreadLocalMap map = getMap(t);
        //(9)如果当前线程的threadLocals变量不为空
        if (map != null)
            map.set(this, value);
        else
        //(10)如果当前线程的threadLocals变量为空
            createMap(t, value);
        return value;
    }

   protected T initialValue() {
        return null;
    }

get 方法也比较简单，同样也是先获取当前线程的ThreadLocalMap变量，如果存在则返回值，不存在则创建并返回初始值。

通过上面分析，其实每个线程的本地变量不是存放到ThreadLocal实例里面的，而是存放到调用线程的threadLocals变量里面, 即ThreadLocal.ThreadLocalMap threadLocals。

也就是说ThreadLocal类型的本地变量是存放到具体的线程内存空间的。ThreadLocal就是一个工具壳，它通过set方法把value值放入调用线程的threadLocals里面存放起来，当调用线程调用它的get方法时候再从当前线程的threadLocals变量里面拿出来使用。如果调用线程一直不终止那么这个本地变量会一直存放到调用线程的threadLocals变量里面，所以当不需要使用本地变量时候可以通过调用ThreadLocal变量的remove方法，从当前线程的threadLocals里面删除该本地变量。

ThreadLocalMap源码分析

static class ThreadLocalMap {

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

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

        /**
         * The initial capacity -- MUST be a power of two.
         */
        private static final int INITIAL_CAPACITY = 16;

        /**
         * The table, resized as necessary.
         * table.length MUST always be a power of two.
         */
        private Entry[] table;

        /**
         * The number of entries in the table.
         */
        private int size = 0;

可以看到，虽然ThreadLocalMap没有实现Map接口，但也具有常见Map实现类的大部分属性（与HashMap不同，hash重复时在table里顺序遍历）。

重要的是Entry的实现。Entry继承了一个ThreadLocal泛型的WeakReference引用。

1. ThreadLocal说明了Entry的类型，保存的是ThreadLocal变量。
2. WeakReference是为了方便垃圾回收。

为什么要使用WeakReference？

现在如果线程死亡，线程中的ThreadLocalMap实例也将被回收。看起来一切都那么美好，但我们忽略了一个很严重的问题——如果任务对象结束而线程实例仍然存在（常见于线程池的使用中，需要复用线程实例），那么就有可能会发生内存泄露。

此时使用WeakReference就会解决一部分问题。

对于弱引用WeakReference，当一个对象仅仅被弱引用指向, 而没有任何其他强引用StrongReference指向的时候, 如果GC运行, 那么这个对象就会被回收。

在ThreadLocal变量的使用过程中，由于只有任务对象拥有ThreadLocal变量的强引用（考虑最简单的情况），所以任务对象被回收后，就没有强引用指向ThreadLocal变量，ThreadLocal变量也就会被回收。

进一步减少内存泄露

尽管现在使用了弱引用，ThreadLocalMap中仍然会发生内存泄漏。

原因很简单，ThreadLocal变量只是Entry中的key，所以Entry中的key虽然被回收了，Entry本身却仍然被引用。

为了解决这个问题，ThreadLocalMap在它的getEntry、set、remove、rehash等方法中都会主动清除ThreadLocalMap中key为null的Entry。

这样做已经可以大大减少内存泄露的可能，但如果我们声明ThreadLocal变量后，再也没有调用过上述方法，依然会发生内存泄露。不过，现实世界中线程池的容量总是有限的，所以这部分泄露的内存并不会无限增长；另一方面，一个大量线程长期空闲的线程池（这时内存泄露情况可能比较严重），也自然没有存在的必要，而一旦使用了线程，泄露的内存就能够被回收。因此，我们通常认为这种内存泄露是可以“忍受”的。

同时应该注意到，这里将ThreadLocal对象“自然”的生命周期“收紧”了一些，从而比线程的生命周期更短。

ThreadLocalMap的set方法

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

            Entry[] tab = table;
            int len = tab.length;
            // 获取hash值，用于数组的下标
            int i = key.threadLocalHashCode & (len-1);

            //如果数组该位置有对象，则进行赋值，或者清空value
            for (Entry e = tab[i]; e != null; e = tab[i = nextIndex(i, len)]) {
                ThreadLocal<?> k = e.get();
                // 覆盖
                if (k == key) {
                    e.value = value;
                    return;
                }
                // 说明此处的Entry的key对象已经被回收了，需要替换这个位置的key和value
                if (k == null) {
                    replaceStaleEntry(key, value, i);
                    return;
                }
            }
            // 不在数组中，就创建一个Entry对象
            tab[i] = new Entry(key, value);
            int sz = ++size;
            if (!cleanSomeSlots(i, sz) && sz >= threshold)
                rehash();
        }

ThreadLocalMap的getEntry方法

 private Entry getEntry(ThreadLocal<?> key) {
            int i = key.threadLocalHashCode & (table.length - 1);
            Entry e = table[i];
            if (e != null && e.get() == key)
                return e;
            else
                return getEntryAfterMiss(key, i, e);
        }

private Entry getEntryAfterMiss(ThreadLocal<?> key, int i, Entry e) {
            Entry[] tab = table;
            int len = tab.length;

            while (e != null) {
                ThreadLocal<?> k = e.get();
                if (k == key)
                    return e;
                // 前面提到的，如果被回收了，要清空值
                if (k == null)
                    expungeStaleEntry(i);
                else
                    i = nextIndex(i, len);
                e = tab[i];
            }
            return null;
        }

---

---

声明：此文章为本人学习笔记，参考于：https://juejin.im/post/59db31c16fb9a00a4843dc36

如果您觉得有用，欢迎关注我的公众号，我会不定期发布自己的学习笔记、资料、以及感悟，欢迎留言，与大家一起探索AI之路。

AI探索之路