详解JUC中ThreadLocal的实现原理

ThreadLocal的使用

多线程访问共享变量时会出现竞争问题，可以使用加锁等手段来解决问题，另一种解决问题的思路是让共享变量在线程内拥有对应的本地变量，从而消灭了共享变量以消灭多线程竞争，这就是ThreadLocal。

如果你创建了一个ThreadLocal变量，那么访问这个变量的每一个线程都会有这个变量的一个本地副本，当多个线程操作这个变量时，实际操作的是自己本地内存里的变量，从而避免了线程安全问题。

需要注意的是，如果需要这个共享变量来进行线程间的一些通信，那显然是不能使用ThreadLocal的，各个线程的ThreadLocal变量副本都是互相独立的。

ThreadLocal的方法只有set、get和remove，请看下面的代码示例。

public class ThreadLocalTest {
    private static ThreadLocal threadLocal = new ThreadLocal<>();
    public static void main(String[] args) {
        threadLocal.set("Main Thread");
        new Thread(() -> {
            threadLocal.set("Thread 1");
            System.out.println(threadLocal.get());
        }).start();
        new Thread(() -> {
            threadLocal.set("Thread 2");
            System.out.println(threadLocal.get());
        }).start();
        System.out.println(threadLocal.get());

    }
}

程序输出：

Main Thread
Thread 1
Thread 2

Process finished with exit code 0

ThreadLocal的原理

简言之，在每个线程内部都有一个名为threadLocals的成员变量，该变量的类型为HashMap，其中key为我们定义的ThreadLocal变量的this引用，value则为我们使用set方法设置的值。

下面我们看一下源码。

在Thread类中，有一个名为threadLocals的成员变量，其类型为ThreadLocal.ThreadLocalMap，如下所示：

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

ThreadLocal.ThreadLocalMap的数据结构如下，其key为ThreadLocal变量，其value为我们用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> {
            /** The value associated with this ThreadLocal. */
            Object value;

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

ThreadLocal的set方法源码：

    public void set(T value) {
        // 1. 获取当前线程
        Thread t = Thread.currentThread();
        // 2. 获取当前线程中存放的threadLocals哈希表
        ThreadLocal.ThreadLocalMap map = getMap(t);
        if (map != null)
            // 3. 若哈希表存在，则设值
            map.set(this, value);
        else
            // 4. 若哈希表不存在，则创建哈希表并设值
            createMap(t, value);
    }

ThreadLocal的get方法源码：

public T get() {
        // 1. 获取当前线程
        Thread t = Thread.currentThread();
        // 2. 获取当前线程中存放的threadLocals哈希表
        ThreadLocalMap map = getMap(t);
        // 3. 从哈希表中获取值
        if (map != null) {
            ThreadLocalMap.Entry e = map.getEntry(this);
            if (e != null) {
                @SuppressWarnings("unchecked")
                T result = (T)e.value;
                return result;
            }
        }
        return setInitialValue();
    }

ThreadLocal的缺点

ThreadLocal的缺点有二，第一是使用不当容易造成内存泄漏，第二是处理哈希冲突时使用线性探测法，在极端情况下性能会退化到O(n)。

下面对第一点详细解释。

注意，使用ThreadLocal后若不及时使用remove方法清除，会造成内存泄漏。

通过上面的源码分析，我们直到，ThreadLocalMap里的key是ThreadLocal的弱引用，当代码中其它地方没有引用ThreadLocal时，遇到GC，会将ThreadLocal变量进行清除，但注意，ThreadLocalMap里的value仍然指向一个Object，这时ThreadLocalMap里面就会存在key为null但是value不为null的entry项，所以就造成了内存泄漏。

remove方法中对key和value都置为null，因此，在使用完毕后及时调用remove方法才是解决ThreadLocal内存泄漏问题的王道。

---

每日学习笔记，写于2020-05-03 星期日