ThreadLocal内部机制

96
慧明小和尚下山去化斋
0.2 2017.02.15 15:52* 字数 665

前言

下面是一个使用ThreadLocal的小demo

public class ThreadLocalDemo {
    public static void main(String[] args) {
        for (int i = 0; i < 5; i++) {
            Thread t = new Thread(new Task());
            t.start();
        }
        ThreadLocal<Integer> tl = new ThreadLocal<>();
        tl.set(2);
        System.out.println("ThreadLocal value: "+tl.get());
    }

    static class Task implements Runnable {

        private final ThreadLocal<Integer> tl = new ThreadLocal<>();

        @Override
        public void run() {
            for (int i = 0; i < 10; i++) {
                tl.set(i);
            }
            System.out.println("ThreadLocal value: "+tl.get());
        }
    }
}

为每个线程都创建一个ThreadLocal,最后输出每个线程中的ThreadLocal赋值。最后都是有序的值,没有一个是脏数据。

output:
ThreadLocal value: 9
ThreadLocal value: 9
ThreadLocal value: 9
ThreadLocal value: 2
ThreadLocal value: 9
ThreadLocal value: 9

细究

在Thread类中,有这样一个属性ThreadLocal.ThreadLocalMap threadLocals = null;ThreadLocal对数据的操作,都是对这样一个数据结构的操作进行的。

//ThreadLocal#set(T)
public void set(T value) {
        Thread t = Thread.currentThread();
        //拿到当前线程的ThreadLocalMap
        ThreadLocalMap map = getMap(t);
        //懒加载模式
        if (map != null)
        //map已经初始化了,直接调用set方法
        //这个set方法很特别,
        //它把ThreadLocal作为key,然后value就是我们要存储的值
            map.set(this, value);
        //如果Map是null,那么就创建一个ThreadLocalMap
        else
            createMap(t, value);
}

//ThreadLocal#getMap(Thread)
ThreadLocalMap getMap(Thread t) {
        return t.threadLocals;
}

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

关于ThreadLocalMap,它跟其他的map一样,都有一个Entry类被用来存放Map的数据,也有一个Entry[]数组。

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

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

private Entry[] table;
//table的初始大小是16
private static final int INITIAL_CAPACITY = 16;
private int threshold; // Default to 0

        /**
         * table增长的阀值是table长度的2/3;
         */
        private void setThreshold(int len) {
            threshold = len * 2 / 3;
        }

这个Entry对象继承了WeakReference了,也就是说,这些存在ThreadLocalMap里面的Entry对象在线程被销毁的时候更好的被GC。
ThreadLocalMap是通过set方法来把Entry放入table中去,下面是它的实现。

private void set(ThreadLocal<?> key, Object value) {
            Entry[] tab = table;
            int len = tab.length;
            // 首先拿到新的Entry的地址 i。
            int i = key.threadLocalHashCode & (len-1);
            //然后做循环,直到table桶对应位置中没有存放Entry,也就是null
            for (Entry e = tab[i];
                 e != null;
                 e = tab[i = nextIndex(i, len)]) {
                ThreadLocal<?> k = e.get();
                //key相同,也就是在这之前该线程曾经设置过该ThreadLocal,那么就直接赋予新的值,然后返回。
                if (k == key) {
                    e.value = value;
                    return;
                }
                //这里的key值就是ThreadLocal了,它有可能会出现null
                //这是因为Entry继承的是WeakReference,这是弱引用带来的坑
                if (k == null) {
                    //出现了null,就要置换过期(stale)了的Entry
                    replaceStaleEntry(key, value, i);
                    return;
                }
            }
            //执行到这里,说明找到了合适的位置,就把新的Entry放入table数组
            tab[i] = new Entry(key, value);
            int sz = ++size;
            //由于弱引用带来了这个问题,所以先要清除无用数据,才能判断现在的size有没有达到阀值threshhold
            //如果没有要清除的数据,并且达到阀值,那就要执行扩容:rehash()
            if (!cleanSomeSlots(i, sz) && sz >= threshold)
                rehash();
}

来看看计算哈希值的实现代码

private final int threadLocalHashCode = nextHashCode();
private static AtomicInteger nextHashCode = new AtomicInteger();
private static final int HASH_INCREMENT = 0x61c88647;

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

其实就是一个原子类不停地去加上0x61c88647,这是一个很特别的数,叫斐波那契散列(Fibonacci Hashing),斐波那契又有一个名称叫黄金分割,也就是说将这个数作为哈希值的考量将会使哈希表的分布更为均匀,因此我做了一个小实验。

//斐波那契散列小实验
final int delta = 0x61c88647;
int len = 16;
final AtomicInteger nextHashCode = new AtomicInteger();
int[] help = new int[len];
for (int k = 0; k < len; k++) {
    ++help[(nextHashCode.getAndAdd(delta) & (len - 1))];
}
for (int i = 0; i < help.length; i++) {
    System.out.println(i+": "+help[i]);
}

在这个实验中,我假定哈希表的长度len=16,也用一个原子类加上斐波那契散列值生成哈希值,最后用哈希值确定表的下标,然后用help数组记录下标生成的情况,在这里我忽略了阀值带来的影响。输出结果如下所示:

//斐波那契散列小实验输出结果
0: 1
1: 1
2: 1
3: 1
4: 1
5: 1
6: 1
7: 1
8: 1
9: 1
10: 1
11: 1
12: 1
13: 1
14: 1
15: 1

这就是说,哈希表中每个位置都均匀的放进了一个,很是均匀,这就减小了不同ThreadLocal的存放冲突。
ThreadLocalMap还要置换过期的Entry,过期的条件就是table数组中存放的Entry的key(ThreadLocal)没了,但是Entry的value却还是存在的,以下就是置换过期Entry的代码以及涉及到方法的代码。

        //根据发生的条件,传进来的key就是null了
        private void replaceStaleEntry(ThreadLocal<?> key, Object value, int staleSlot) {
            Entry[] tab = table;
            int len = tab.length;
            Entry e;

            //往前找,找到table中第一个脏了的数据的下标
            //清理整个table是为了避免因为垃圾回收带来的连续增长哈希的危险
            //也就是说,哈希表没有清理干净,当GC到来的时候,后果很严重。。。
            int slotToExpunge = staleSlot;
            for (int i = prevIndex(staleSlot, len);
                 (e = tab[i]) != null;
                 i = prevIndex(i, len))
                if (e.get() == null)
                    slotToExpunge = i;

            // 找到我们传进来的key或者是在传进来下标值后面的第一个过期Entry
            for (int i = nextIndex(staleSlot, len);
                 (e = tab[i]) != null;
                 i = nextIndex(i, len)) {
                ThreadLocal<?> k = e.get();

                // 如果我们找到了key,那么我们就需要把它跟新的过期数据交换来保持哈希表的顺序
                // 那么剩下的过期Entry呢,就可以交给expungeStaleEntry方法来擦除掉
                // 或者执行rehash方法。
                if (k == key) {
                    e.value = value;

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

                    // Start expunge at preceding stale entry if it exists
                    if (slotToExpunge == staleSlot)
                        slotToExpunge = i;
                    // 在这里开始清除过期数据
                    cleanSomeSlots(expungeStaleEntry(slotToExpunge), len);
                    return;
                }

                // 如果我们没有在后向查找中找见过期数据,那么slotToExpunge就是第一个过期Entry的下标了
                if (k == null && slotToExpunge == staleSlot)
                    slotToExpunge = i;
            }

            // 如果以上的查找都没有找见key的话,就放一个Entry<null, value>进tab[staleSlot]
            tab[staleSlot].value = null;
            tab[staleSlot] = new Entry(key, value);

            // 如果有其他的脏数据,依然要擦除
            if (slotToExpunge != staleSlot)
                cleanSomeSlots(expungeStaleEntry(slotToExpunge), len);
        }
        
        //这就是擦除(expunge)过期Entry的方法了,传进来的staleSlot就是有null 键值的table数组的下标。
        private int expungeStaleEntry(int staleSlot) {
            Entry[] tab = table;
            int len = tab.length;

            // 擦除掉这个脏数据
            tab[staleSlot].value = null;
            tab[staleSlot] = null;
            size--;

            // 这就是前面的rehash 操作了,停止条件是Entry e = null
            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 {
                    // 重新计算哈希值,并且移动Entry
                    int h = k.threadLocalHashCode & (len - 1);
                    if (h != i) {
                        tab[i] = null;

                        // Unlike Knuth 6.4 Algorithm R, we must scan until
                        // null because multiple entries could have been stale.
                        while (tab[h] != null)
                            h = nextIndex(h, len);
                        tab[h] = e;
                    }
                }
            }
            return i;
        }
        
        // 启发式的扫描过期数据并擦除,启发式是这样的:
        // 如果实在没有过期数据,那么这个算法的时间复杂度就是O(log n)
        // 如果有过期数据,那么这个算法的时间复杂度就是O(n)
        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
                    n = len;
                    removed = true;
                    i = expungeStaleEntry(i);
                }
            } while ( (n >>>= 1) != 0);
            return removed;
        }

清除过期数据真是一个很麻烦的事情,不见黄河心不死,再来看看扩容的rehash方法。

        /**
         * 扩容的思想跟HashMap很相似,都是把容量扩大两倍
         * 不同之处还是因为WeakReference带来的
         */
        private void resize() {
            Entry[] oldTab = table;
            int oldLen = oldTab.length;
            int newLen = oldLen * 2;
            Entry[] newTab = new Entry[newLen];
            int count = 0;

            for (int j = 0; j < oldLen; ++j) {
                Entry e = oldTab[j];
                if (e != null) {
                    ThreadLocal<?> k = e.get();
                    if (k == null) {
                        // 就算是扩容,也不能忘了为擦除过期数据做准备
                        e.value = null; // Help the GC
                    } else {
                        //重新计算哈希,并放到newTab原来没有被占用的桶中
                        int h = k.threadLocalHashCode & (newLen - 1);
                        while (newTab[h] != null)
                            h = nextIndex(h, newLen);
                        newTab[h] = e;
                        count++;
                    }
                }
            }
            //重新设置阀值,大小,table指针
            setThreshold(newLen);
            size = count;
            table = newTab;
        }

最后,再来看看remove操作,有了上面的基础,再看remove操作会觉得很容易。

        private void remove(ThreadLocal<?> key) {
            Entry[] tab = table;
            int len = tab.length;
            // 根据key的哈希值确定位置
            int i = key.threadLocalHashCode & (len-1);
            for (Entry e = tab[i];
                 e != null;
                 e = tab[i = nextIndex(i, len)]) {
                // 哈希值是相等了,还要循环比较key,这是由插入机制带来的
                if (e.get() == key) {
                    // 找到了,就调用WeakReference#clear方法
                    e.clear();
                    //再擦除掉这个Entry就OK了
                    expungeStaleEntry(i);
                    return;
                }
            }
        }

结语

要了解ThreadLocal,就要了解ThreadLocalMap,这是它的核心所在,感谢编写JDK的各位神级人物,是他们为Java做出了巨大的贡献。我说的不一定对,这都是我自己的理解,所以诸君还是要自己看一看源码的!

JDK源码系列
Web note ad 1