JDK源码学习系列之ThreadLocal

1. 存储结构

Thread类成员变量threadLocals是一个Map结构，每个线程都有一个独立的ThreadLoaclMap对象，其中存储的是Entry对象，它的key就是我们平时定义的ThreadLocal对象，value是其中的value，因为可能在同一个线程中定义多个ThreadLocal，所以图中每一个index下标会对应其中的一个ThreadLocal对象信息。

2. 核心成员变量

// 每个ThreadLocal对象都分配一个hashCode，用于确定上图中threadLocals的桶位
private final int threadLocalHashCode = nextHashCode();

/ 每次生成新的ThreadLocal对象都会用它来生成hashcode
private static AtomicInteger nextHashCode =
    new AtomicInteger();

3. 成员方法

public void set(T value) {
        Thread t = Thread.currentThread();
        // 获取当前线程的threadLocals对象，即上图中的数组对象
        ThreadLocalMap map = getMap(t);
        if (map != null)
            map.set(this, value);
        else
           // 如果第一次获取，则创建一个新的threadLocals
            createMap(t, value);
    }

ThreadLocalMap(ThreadLocal<?> firstKey, Object firstValue) {
            // table是Entry对象，它是一个key-value映射表结构，
            // 其中的key存储我们定义的ThreaLocal
            // value存储ThreadLocal设置的value
            table = new Entry[INITIAL_CAPACITY]; // 默认数组长度16
            int i = firstKey.threadLocalHashCode & (INITIAL_CAPACITY - 1);
            table[i] = new Entry(firstKey, firstValue);
            size = 1;
            setThreshold(INITIAL_CAPACITY);
        }

get方法

public T get() {
      // 当前线程
        Thread t = Thread.currentThread();
       // 拿到当前线程对应的ThreadLocalMap对象（threadLocals） 
        ThreadLocalMap map = getMap(t);
        if (map != null) {
           // 进入这里，说明当前线程已经创建过ThreadLocalMap对象了
           // 通过this,即当前的ThreadLocal获取到下标对应的Entry对象
            ThreadLocalMap.Entry e = map.getEntry(this);
            if (e != null) {
                @SuppressWarnings("unchecked")
                 // 说明当前ThreadLocal存在，直接放回它关联的value
                T result = (T)e.value;
                return result;
            }
        }
         // 走到这里，需要初始化当前线程的ThreadLocalMap对象，
         // 或者当前线程的ThreadLocal还未生成Entry对象到ThreadLocalMap中
        return setInitialValue();
    }

setInitialValue方法

 private T setInitialValue() {
       // 调用初始化方法，一般都由我们自己重写实现
        T value = initialValue();
        Thread t = Thread.currentThread();
       // 获取当前线程内部的threadLocals（threadLocalMap对象）
        ThreadLocalMap map = getMap(t);
        if (map != null)
           // 将定义的ThreadLocal对象放到threadLocals数组对应的下标中
            map.set(this, value);
        else
           // 如果ThreadLocalMap没初始化，则进入创建方法
            createMap(t, value);
        return value;
    }

void createMap(Thread t, T firstValue) {
    // 创建一个ThreadLocalMap对象，key-value结构
    // 其中key= this 即当前threadLocal对象
    // value = 当前threadLocal相关的局部变量
    t.threadLocals = new ThreadLocalMap(this, firstValue);
}

set方法

 public void set(T value) {
       // 跟上面setInitialValue方法差不多
        Thread t = Thread.currentThread();
        ThreadLocalMap map = getMap(t);
        if (map != null)
            map.set(this, value);
        else
            createMap(t, value);
    }

remove方法

public void remove() {
       // 获取当前线程对应的ThreadLocalMap对象
         ThreadLocalMap m = getMap(Thread.currentThread());
         if (m != null)
            // this即定义的TheadLocal对象，将其从ThreadLocalMap中移除
             m.remove(this);
     }

4. Entry内部类

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

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

发现它继承了弱引用WeakReference类，我们知道弱引用的概念就是如果对象是弱引用，那么如果从GCRoot检测到它没有强引用，那么在下一次gc时候会垃圾回收当前的ThreadLocal对象，这样设计可以避免内存泄漏的发生。
看到这里，不知道大家有没有和我一样的疑问，既然这个ThreadLocal是弱引用，即每次垃圾回收都会被回收，那在程序中每次调用它的get方法获取value时候，岂不是很危险吗，因为被垃圾回收了啊。 其实不是这样的，因为每一次请求就有一个线程引用了这个ThreadLocal对象，那就是我们的业务线程，只有当一次完整的请求结束后，这时候才没有强引用的存在，这时候才允许垃圾回收，所以是没有问题的。