Java ThreadLocal源码分析

一. 要搞清楚的问题？

1. ThreadLocal数据导致怎么存储的？
2. 源码是如何实现的？
3. ThreadLocal为什么会内存泄漏？

二. 请看一个实例

 public static void main(String[] args) throws Exception {
        final ThreadLocal<String> mainThreadLocal = new ThreadLocal<String>();
        mainThreadLocal.set("aa");
        new Thread() {
            public void run() {
                System.err.println(Thread.currentThread().getName() + ": " + mainThreadLocal.get());
            };
        }.start();
        System.err.println(Thread.currentThread().getName() + ": " + mainThreadLocal.get());
    }

//打印结果
main: aa
Thread-0: null

三. set，get方法源码分析

ThreadLocal的构造方法

 public ThreadLocal() {
    }

对不起，啥都没干，汗~~

ThreadLocal的set方法

在分析前，我们先了解一个知识： ThreadLocalMap为ThreadLocal的一个内部类，用来存储数据，先简单理解为一个map结构。 Thread类里面有一个成员变量ThreadLocalMap。他它们3个相互勾结成这样：

 public class ThreadLocal{
        //暂时理解为Map结构
        static class ThreadLocalMap {
        }
 }
 public class Thread {
        ThreadLocal.ThreadLocalMap threadLocals = null;
 }

注意： threadLocals变量在某个线程内只有全局的一份，他Map的key存储的是当前ThreadLocal类对象的this（上面实例的mainThreadLocal） ， value 存储的是 上面实例的字符串aa

再回头来看ThreadLocal 的 set方法

public void set(T value) {
        Thread t = Thread.currentThread();
        ThreadLocalMap map = getMap(t);
        if (map != null)
            // this 就是当前ThreadLocal类对象
            map.set(this, value);
        else
            createMap(t, value);
    }
    void createMap(Thread t, T firstValue) {
        t.threadLocals = new ThreadLocalMap(this, firstValue);
    }

先取得了main线程实例，然后取得main线程的变量ThreadLocalMap , 第一次肯定为空，走createMap方法去创建map，之后就成单例直接set 到这个map里面。这样就让线程独立拥有了一份map数据，各个线程互不干扰，达到线程间数据安全目的。

ThreadLocal的get方法

 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();
    }
  ThreadLocalMap getMap(Thread t) {
        return t.threadLocals;
    }

获取当前线程的ThreadLocalMap变量，如果不为空就直接从ThreadLocalMap里面取出值。如果为空的话就走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;
    }

先调用initialValue方法返回的value固定为null， 然后构造当前线程的ThreadLocalMap ，put初始值null。

四. ThreadLocalMap内存泄漏分析

我们先看下ThreadLocalMap的大致结构

 static class ThreadLocalMap {
        static class Entry extends WeakReference<ThreadLocal<?>> {
            Object value;
            Entry(ThreadLocal<?> k, Object v) {
                super(k);
                value = v;
            }
        }
}

ThreadLocal数据结构雷同Map， 但是它的Entry的key 是引用。那么这个key当内存不足时是可能被回收的，导致Entry里的key为null，但是Entry中的value就不能被程序引用了，如果当前线程一直运行的话，这些value就会一直存在一条强引用链：Thread引用 ThreadLocalMap 引用 Entry 引用value ， 就会导致内存泄漏。

温馨提示：每次使用完ThreadLocal，都必须调用它的remove()方法，清除数据。

五. 文章结尾抛出几个问题

1. 在 子线程 中怎么获取父线程的ThreadLocal的值？
2. 在 线程池 中怎么获取主线程的ThreadLocal的值？

请见我其它的两篇文章：

子线程获取父线程ThreadLocal
java子线程中获取父线程的threadLocal中的值

线程池获取ThreadLocal

TransmittableThreadLocal 源码分析

强烈推荐一套Java进阶博客，都是干货，走向架构师不是梦！

Java进阶全套博客