ThreadLocal源码分析

使用建议

1. ThreadLocal最好使用private static修饰
2. 如果你必须使用ThreadLocal,确保你在你在使用完之后和结束你的线程返回线程池之前尽快的清理value，最好的做法是使用remove()而不是set(null) ，因为他的value的弱关联随之一起立即被清理。

set方法

public void set(T value) {
    //获取当前线程
    Thread t = Thread.currentThread();
    //根据获取的线程，调方法获取存放数据的map
    ThreadLocalMap map = getMap(t);
    //判断是否是第一次set
    if (map != null)
        //不是第一次，覆盖，this表示threadlocal对象
        map.set(this, value);
    else
        //是第一次，给key为threadlocal对象的map赋值value
        createMap(t, value);
}

根据获取的线程，调方法获取存放数据的map对象的方法

//Thread类里面定义的
ThreadLocal.ThreadLocalMap threadLocals = null;

ThreadLocalMap getMap(Thread t) {
	//返回当前线程的ThreadLocalMap对象
    return t.threadLocals;
}

当map为空的时候，初始化map

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

我们看一下ThreadLocalMap构造函数做了什么

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

private Entry[] table;

//初始大小0
private int size = 0;

private static final int HASH_INCREMENT = 0x61c88647;

//当需要创建map的时候才会调用这个方法，是惰性的
ThreadLocalMap(ThreadLocal<?> firstKey, Object firstValue) {
	//初始化entry
    table = new Entry[INITIAL_CAPACITY];
    //求ThreadLocal的哈希值，使用魔数和2的n次幂减一进行取模
    //使其均匀分布在2的幂次方中
    //对于2的幂作为模数取模，可以用(2^n-1)来替代2^n，位运算比取模效率高很多
    int i = firstKey.threadLocalHashCode & (INITIAL_CAPACITY - 1);
    table[i] = new Entry(firstKey, firstValue);
    size = 1;
    //设置扩容阙值
    setThreshold(INITIAL_CAPACITY);
}

private final int threadLocalHashCode = nextHashCode();

private static int nextHashCode() {
    return nextHashCode.getAndAdd(HASH_INCREMENT);
}

//设置扩容阙值为长度的三分之二
private void setThreshold(int len) {
    threshold = len * 2 / 3;
}

get方法

public T get() {
	//获取当前线程
    Thread t = Thread.currentThread();
    //获取map
    ThreadLocalMap map = getMap(t);
    //map不为空时
    if (map != null) {
    	//获取map的当前ThreadLocal的Entry
        ThreadLocalMap.Entry e = map.getEntry(this);
        //判读entry是否为空
        if (e != null) {
            @SuppressWarnings("unchecked")
            //获取value
            T result = (T)e.value;
            return result;
        }
    }
    //map为空时，初始化map，赋值为null，并返回null
    return setInitialValue();
}

我们看一下get方法中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方法

protected T initialValue() {
    return null;
}

我们可以发现，setInitialValue方法和set方法很像，唯一的区别就是，setInitialValue方法的value值直接传的是null
可以知道，当一个threadLocal对象没有set的时候，直接调用get方法，程序内部会先set一个value值为null的map，然后再返回null

remove方法

public void remove() {
     ThreadLocalMap m = getMap(Thread.currentThread());
     if (m != null)
         m.remove(this);
}

private void remove(ThreadLocal<?> key) {
    Entry[] tab = table;
    int len = tab.length;
    //用tKey的threadLocalHashCode与初始大小16j减一取模得到哈希值
    int i = key.threadLocalHashCode & (len-1);
    for (Entry e = tab[i];
         e != null;
         e = tab[i = nextIndex(i, len)]) {
        if (e.get() == key) {
        	//显式的断开弱引用
            e.clear();
            expungeStaleEntry(i);
            return;
        }
    }
}