20191116_ThreadLocal源码解析

ThreadLocal是用来存储线程的本地数据的。
ThreadLocal的设计算是十分巧妙的。
每一个线程Thread持有ThreadLocalMap， ThreadLocalMap是ThreadLocal下的一个内部静态类。ThreadLocalMap并没有继承Map, 而是持有了一个Entry[]的table。Entry的key是ThreadLocal (弱引用）, value是存储的值。

源码

set()方法

来看一下ThreadLocal的set方法：

public void set(T value) {
    //获取当前线程
    Thread t = Thread.currentThread();
    //获取当前线程的ThreadLocalMap，之前说过了，每个线程Thread会持有一个ThreadLocalMap
    ThreadLocalMap map = getMap(t);
    if (map != null)
        map.set(this, value);
    else
    //没有的话给当前线程重新创建一个ThreadLocalMap
        createMap(t, value);
}

跟进，看一下ThreadLocalMap的set方法：

private void set(ThreadLocal<?> key, Object value) {

    Entry[] tab = table;
    int len = tab.length;
    // 决定放在table的哪个位置
    int i = key.threadLocalHashCode & (len-1);

    for (Entry e = tab[i];
         e != null;
         e = tab[i = nextIndex(i, len)]) {
        ThreadLocal<?> k = e.get();

        //如果已经设值，覆盖它
        if (k == key) {
            e.value = value;
            return;
        }
        //如果当前这个的 Entry 是一个陈旧Entry（有对象但是k == null），
        //那就调用 replaceStaleEntry(key, value, i);将数据存储进去，并结束
        if (k == null) {
            replaceStaleEntry(key, value, i);
            return;
        }
    }

    tab[i] = new Entry(key, value);
    int sz = ++size;
    // 清除部分的陈旧Entry，如果清除不成功，
    //并且大于等于负载阈值 threshold （当前size的2/3）的时候就会 rehash
    if (!cleanSomeSlots(i, sz) && sz >= threshold)
        rehash();
}

replaceStaleEntry

先来看下replaceStaleEntry这个方法:

private void replaceStaleEntry(ThreadLocal<?> key, Object value,
                               int staleSlot) {
    Entry[] tab = table;
    int len = tab.length;
    Entry e;

    int slotToExpunge = staleSlot;
    // 往前找key为null的位置
    for (int i = prevIndex(staleSlot, len);
         (e = tab[i]) != null;
         i = prevIndex(i, len))
        if (e.get() == null)
            slotToExpunge = i;

    // 往后遍历
    for (int i = nextIndex(staleSlot, len);
         (e = tab[i]) != null;
         i = nextIndex(i, len)) {
        ThreadLocal<?> k = e.get();

        //如果在向后环形查找过程中发现key相同的entry就覆盖并且和脏entry进行交换
        if (k == key) {
            e.value = value;

            tab[i] = tab[staleSlot];
            tab[staleSlot] = e;

            //如果在查找过程中还未发现脏entry，那么就以当前位置作为cleanSomeSlots的起点
            if (slotToExpunge == staleSlot)
                slotToExpunge = i;
            cleanSomeSlots(expungeStaleEntry(slotToExpunge), len);
            return;
        }

        //如果在查找过程中还未发现脏entry，那么就以当前位置作为cleanSomeSlots的起点
        if (k == null && slotToExpunge == staleSlot)
            slotToExpunge = i;
    }

    // 如果在查找过程中没有找到可以覆盖的entry，则将新的entry插入在脏entry
    tab[staleSlot].value = null;
    tab[staleSlot] = new Entry(key, value);

    // 如果找到了，清理
    if (slotToExpunge != staleSlot)
        cleanSomeSlots(expungeStaleEntry(slotToExpunge), len);
}

作者认为在脏key的附近脏key是聚集的，那么在当前key是存在key为null，value不为null的情况下，向前寻找到key不为null的节点，然后向后遍历进行局部清理脏key。
这样不用进行遍历全部数据，同时也可以进行一部分的脏key的清理，但终究出现内存泄露时，节点越来越多，慢慢就清理不过来了。

cleanSomeSlots

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;
}

可以看到, cleanSomeSlots这个看上去是Log(n)的时间复杂度。但需要主要的是：一旦检查到脏Entry（key为null)，n又会重新赋值为table的长度。

expungeStaleEntry

private int expungeStaleEntry(int staleSlot) {
    Entry[] tab = table;
    int len = tab.length;

    // 清理value
    tab[staleSlot].value = null;
    tab[staleSlot] = null;
    size--;

    Entry e;
    int i;
    // 继续往后清理
    for (i = nextIndex(staleSlot, len);
         (e = tab[i]) != null;
         i = nextIndex(i, len)) {
        ThreadLocal<?> k = e.get();
        if (k == null) {
            e.value = null;
            tab[i] = null;
            size--;
        } else {
            int h = k.threadLocalHashCode & (len - 1);
            // 处理rehash的情况
            if (h != i) {
                tab[i] = null;

                while (tab[h] != null)
                    h = nextIndex(h, len);
                tab[h] = e;
            }
        }
    }
    return i;
}

get()

相比于set()方法，get()方法就简单很多了。
当我们调用threadLocal的get方法时，当table[i]不是和所要找的key相同的话，会继续通过threadLocalMap的
getEntryAfterMiss方法向后环形去找：

public T get() {
    Thread t = Thread.currentThread();
    ThreadLocalMap map = getMap(t);
    if (map != null) {
        // 获取Entry
        ThreadLocalMap.Entry e = map.getEntry(this);
        if (e != null) {
            @SuppressWarnings("unchecked")
            T result = (T)e.value;
            return result;
        }
    }
    return setInitialValue();
}

private Entry getEntry(ThreadLocal<?> key) {
    int i = key.threadLocalHashCode & (table.length - 1);
    Entry e = table[i];
    if (e != null && e.get() == key)
        return e;
    else
        return getEntryAfterMiss(key, i, e);
}

private Entry getEntryAfterMiss(ThreadLocal<?> key, int i, Entry e) {
    Entry[] tab = table;
    int len = tab.length;

    while (e != null) {
        ThreadLocal<?> k = e.get();
        if (k == key)
            return e;
        // 清理脏数据
        if (k == null)
            expungeStaleEntry(i);
        else
            i = nextIndex(i, len);
        e = tab[i];
    }
    return null;
}

remove()

private void remove(ThreadLocal<?> key) {
    Entry[] tab = table;
    int len = tab.length;
    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;
        }
    }
}

弱引用

我们知道ThreadLocalMap.Entry<ThreadLocal, Object>的key是一个弱引用。这就存在内存泄漏的问题，当key被回收掉的时候，value一直得不到清除。
那为什么仍要采用弱引用呢？
如果采用强引用，将ThreadLocal置为null的时候，因为ThreadLocalMap还强引用着ThreadLocal，造成ThreadLocal无法被回收。
相比之下，采用弱引用，配合着上面get(), remove(), set()方法的回收，是可以有效的解决内存泄漏的问题的。但前提是要使用这些方法！