ThreadLocal源码解析-Java8

package cn.ganlixin;

import org.junit.Test;

import java.util.Arrays;
import java.util.List;

public class TestThreadLocal {

    private static class Goods {
        public Integer id;
        public List<String> tags;
    }

    @Test
    public void testReference() {
        Goods goods1 = new Goods();
        goods1.id = 10;
        goods1.tags = Arrays.asList("healthy", "cheap");

        ThreadLocal<Goods> threadLocal = new ThreadLocal<>();
        threadLocal.set(goods1);

        Goods goods2 = threadLocal.get();
        System.out.println(goods1); // cn.ganlixin.TestThreadLocal$Goods@1c655221
        System.out.println(goods2); // cn.ganlixin.TestThreadLocal$Goods@1c655221

        goods2.id = 100;
        System.out.println(goods1.id);  // 100
        System.out.println(goods2.id);  // 100

        threadLocal.remove();
        System.out.println(threadLocal.get()); // null
    }

    @Test
    public void test2() {
        // 一个线程中，可以创建多个ThreadLocal对象，多个ThreadLoca对象互不影响
        ThreadLocal<String> threadLocal1 = new ThreadLocal<>();
        ThreadLocal<String> threadLocal2 = new ThreadLocal<>();
        // ThreadLocal存的值默认为null

        System.out.println(threadLocal1.get()); // null

        threadLocal1.set("this is value1");
        threadLocal2.set("this is value2");
        System.out.println(threadLocal1.get()); // this is value1
        System.out.println(threadLocal2.get());  // this is value2

        // 可以重写initialValue进行设置初始值
        ThreadLocal<String> threadLocal3 = new ThreadLocal<String>() {
            @Override
            protected String initialValue() {
                return "this is initial value";
            }
        };
        System.out.println(threadLocal3.get()); // this is initial value
    }
}

// threadLocalHashCode用来表示当前ThreadLocal对象的hashCode，通过计算获得
private final int threadLocalHashCode = nextHashCode();

// 一个AtomicInteger类型的属性，功能就是计数，各种操作都是原子性的，在并发时不会出现问题
private static AtomicInteger nextHashCode = new AtomicInteger();

// hash值的增量，不是随便指定的，被称为“黄金分割数”，能让hash结果均衡分布
private static final int HASH_INCREMENT = 0x61c88647;

/**
 * 通过计算，为当前ThreadLocal对象生成一个HashCode
 */
private static int nextHashCode() {
    // 获取当前nextHashCode，然后递增HASH_INCREMENT
    return nextHashCode.getAndAdd(HASH_INCREMENT);
}

public ThreadLocal() {}

/**
 * 初始值默认为null，要设置初始值，只需要设置为方法返回值即可
 *
 * @return ThreadLocal的初始值
 */
protected T initialValue() {
    return null;
}

public void set(T value) {
    // 获取当前线程
    Thread t = Thread.currentThread();

    // 获取当前线程的ThreadLocalMap属性，ThreadLocal有一个threadLocals属性（ThreadLocalMap类型）
    ThreadLocalMap map = getMap(t);

    if (map != null) {
        // 如果当前线程有关联的ThreadLocalMap对象，则调用ThreadLocalMap的set方法进行设置
        map.set(this, value);
    } else {
        // 创建一个与当前线程关联的ThreadLocalMap对象，并设置对应的value
        createMap(t, value);
    }
}

/**
 * 获取线程关联的ThreadLocalMap对象
 */
ThreadLocalMap getMap(Thread t) {
    return t.threadLocals;
}

/**
 * 创建ThreadLocalMap
 * @param t          key为当前线程
 * @param firstValue value为ThreadLocal.set的值
 */
void createMap(Thread t, T firstValue) {
    t.threadLocals = new ThreadLocalMap(this, firstValue);
}

public T get() {
    // 获取当前线程
    Thread t = Thread.currentThread();

    // 获取当前线程对象的threadLocals属性
    ThreadLocalMap map = getMap(t);

    // 若当前线程对象的threadLocals属性不为空（map不为空）
    if (map != null) {
        // 当前ThreadLocal对象作为key，获取ThreadLocalMap中对应的Entry
        ThreadLocalMap.Entry e = map.getEntry(this);

        // 如果找到对应的Entry，则证明该线程的该ThreadLocal有值，返回值即可
        if (e != null) {
            @SuppressWarnings("unchecked")
            T result = (T) e.value;
            return result;
        }
    }

    // 1.当前线程对象的threadLocals属性为空（map为空）
    // 2.或者map不为空，但是未在map中查询到以该ThreadLocal对象为key对应的entry
    // 这两种情况，都会进行设置初始值，并将初始值返回
    return setInitialValue();
}

/**
 * 设置ThreadLocal初始值
 *
 * @return 初始值
 */
private T setInitialValue() {
    // 调用initialValue方法，该方法可以在创建ThreadLocal的时候重写
    T value = initialValue();
    Thread t = Thread.currentThread();

    // 获取当前线程的threadLocals属性（map）
    ThreadLocalMap map = getMap(t);
    if (map != null) {
        // threadLocals属性值不为空，则进行调用ThreadLocalMap的set方法
        map.set(this, value);
    } else {
        // 没有关联的threadLocals，则创建ThreadLocalMap，并在map中新增一个Entry
        createMap(t, value);
    }

    // 返回初始值
    return value;
}

/**
 * 初始值默认为null，要设置初始值，只需要设置为方法返回值即可
 * 创建ThreadLocal设置默认值，可以覆盖initialValue方法，initialValue方法不是在创建ThreadLocal时执行，而是这个时候执行
 *
 * @return ThreadLocal的初始值
 */
protected T initialValue() {
    return null;
}

/**
 * 删除当前线程中threadLocals属性（map）中的Entry（以当前ThreadLocal为key的）
 */
public void remove() {
    // 获取当前线程的threadLocals属性（ThreadLocalMap）
    ThreadLocalMap m = getMap(Thread.currentThread());

    if (m != null) {
        // 调用ThreadLocalMap的remove方法，删除map中以当前ThreadLocal为key的entry
        m.remove(this);
    }
}

/**
 * ThreadLocalMap中存放的元素类型，继承了弱引用类
 */
static class Entry extends WeakReference<ThreadLocal<?>> {
    // key对应的value，注意key是ThreadLocal类型
    Object value;

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

// 创建Reference对象，接受一个引用
Reference(T referent) {
    this(referent, null);
}

// 设置引用
Reference(T referent, ReferenceQueue<? super T> queue) {
    this.referent = referent;
    this.queue = (queue == null) ? ReferenceQueue.NULL : queue;
}

// ThreadLocalMap的初始容量
private static final int INITIAL_CAPACITY = 16;

// ThreadLocalMap底层存数据的数组
private Entry[] table;

// ThreadLocalMap中元素的个数
private int size = 0;

// 扩容阈值，当size达到阈值时会触发扩容（loadFactor=2/3;newCapacity=2*oldCapacity）
private int threshold; // Default to 0

/**
 * 初始化一个ThreadLocalMap对象（第一次调用ThreadLocal的set方法时创建），传入ThreadLocal对象和对应的value
 */
ThreadLocalMap(ThreadLocal<?> firstKey, Object firstValue) {
    // 创建一个Entry数组，容量为16（默认）
    table = new Entry[INITIAL_CAPACITY];

    // 计算新增的元素，应该放到数组的哪个位置，根据ThreadLocal的hash值与初始容量进行"与"操作
    int i = firstKey.threadLocalHashCode & (INITIAL_CAPACITY - 1);

    // 创建一个Entry，设置key和value，注意Entry中没有key属性，key属性是传给Entry的父类WeakReference
    table[i] = new Entry(firstKey, firstValue);

    // 初始容量为1
    size = 1;

    // 设置扩容阈值
    setThreshold(INITIAL_CAPACITY);
}

/**
 * 设置扩容阈值，接收容量值，负载因子固定为2/3
 */
private void setThreshold(int len) {
    threshold = len * 2 / 3;
}

/**
 * 为当前ThreadLocal对象设置value
 */
private void set(ThreadLocal<?> key, Object value) {
    Entry[] tab = table;
    int len = tab.length;

    // 计算新元素应该放到哪个位置（这个位置不一定是最终存放的位置，因为可能会出现hash冲突）
    int i = key.threadLocalHashCode & (len - 1);

    // 判断计算出来的位置是否被占用，如果被占用，则需要找出应该存放的位置
    for (Entry e = tab[i]; e != null; e = tab[i = nextIndex(i, len)]) {
        // 获取Entry中key，也就是弱引用的对象
        ThreadLocal<?> k = e.get();

        // 判断key是否相等（判断弱引用的是否为同一个ThreadLocal对象）如果是，则进行覆盖
        if (k == key) {
            e.value = value;
            return;
        }

        // k为null，也就是Entry的key已经被回收了，当前的Entry是一个陈旧的元素（stale entry）
        if (k == null) {
            // 用新元素替换掉陈旧元素，同时也会清理其他陈旧元素，防止内存泄露
            replaceStaleEntry(key, value, i);
            return;
        }
    }

    // map中没有ThreadLocal对应的key，或者说没有找到陈旧的Entry，则创建一个新的Entry，放入数组中
    tab[i] = new Entry(key, value);
    // ThreadLocalMap的元素数量加1
    int sz = ++size;

    // 先清理map中key为null的Entry元素，该Entry也应该被回收掉，防止内存泄露
    // 如果清理出陈旧的Entry，那么就判断是否需要扩容，如果需要的话，则进行rehash
    if (!cleanSomeSlots(i, sz) && sz >= threshold) {
        rehash();
    }
}

/**
 * 清理map中key为null的Entry元素，该Entry也应该被回收掉，防止内存泄露
 *
 * @param i 新Entry插入的位置
 * @param n 数组中元素的数量
 * @return 是否有陈旧的entry的清除
 */
private boolean cleanSomeSlots(int i, int n) {
    boolean removed = false;
    Entry[] tab = table;
    int len = tab.length;
    do {
        i = nextIndex(i, len);
        Entry e = tab[i];
        if (e != null && e.get() == null) {
            n = len;
            removed = true;
            i = expungeStaleEntry(i);
        }
    } while ((n >>>= 1) != 0);
    return removed;
}

private void rehash() {
    // 清除底层数组中所有陈旧的（stale）的Entry，也就是key为null的Entry
    // 同时每清除一个Entry，就对其后面的Entry重新计算hash，获取新位置，使用线性探测法，重新确定最终位置
    expungeStaleEntries();

    // 清理完陈旧Entry后，判断是否需要扩容
    if (size >= threshold - threshold / 4) {
        // 扩容时，容量变为旧容量的2倍，再进行rehash，并使用线性探测发确定Entry的新位置
        resize();
    }
}

/**
 * 移除当前线程的threadLocals属性中key为ThreadLocal的Entry
 *
 * @param key 要移除的Entry的key(ThreadLocal对象）
 */
private void remove(ThreadLocal<?> key) {
    Entry[] tab = table;
    int len = tab.length;

    // 计算出该ThreadLocal对应的key应该存放的位置
    int i = key.threadLocalHashCode & (len - 1);

    // 找到指定位置，开始按照线性探测算法进行查找到该Thread的Entry
    for (Entry e = tab[i]; e != null; e = tab[i = nextIndex(i, len)]) {

        // 如果Entry的key相同
        if (e.get() == key) {
            // 调用WeakReference的clear方法，Entry的key是弱引用，指向ThreadLocal，现在将key指向null
            // 则该ThreadLocal对象在会在下一次gc时，被垃圾收集器回收
            e.clear();

            // 将该位置的Entry中的value置为null，于是value引用的对象也会被垃圾收集器回收（不会造成内存泄漏）
            // 同时内部会调整Entry的顺序（开放探测算法的特点，删除元素后会重新调整顺序）
            expungeStaleEntry(i);

            return;
        }
    }
}