ThreadLocal分析二：set()方法解读

我们上一篇讲解了ThreadLocal的数据结构，这篇我们来看一下set()方法的源码

一.第一次set值的时候，也就是map等于空的时候

public void set(T value) {
//获取当前线程
        Thread t = Thread.currentThread();
//获取当前线程的ThreadLocalMap
        ThreadLocalMap map = getMap(t);
//如果map不等于空，直接set值
        if (map != null)
            map.set(this, value);
//否则创建一个新的ThreadMap
        else
            createMap(t, value);
    }
// 看一下createMap的方法
void createMap(Thread t, T firstValue) {
        t.threadLocals = new ThreadLocalMap(this, firstValue);
    }
// 看一下如何创建ThreadMap
protected ThreadLocalMap(ThreadLocal<?> firstKey, Object firstValue) {
        // 新建Entry数组，INITIAL_CAPACITY默认为16
        table = new Entry[INITIAL_CAPACITY];
        // hash出下标 通过魔数0x61c88647及其长度算得tab中的下脚标值
        int i = firstKey.threadLocalHashCode & (INITIAL_CAPACITY - 1);
        // 第一次set，肯定不会出现hash冲突
        table[i] = new Entry(firstKey, firstValue);
        size = 1;
        // 设置扩容的阈值，值为(INITIAL_CAPACITY * 2 / 3);
        setThreshold(INITIAL_CAPACITY);
    }
// 看一下创建Entry数组，注意它继承了一个弱引用对象
static class Entry extends WeakReference<ThreadLocal<?>> {
            //这个value就是threadLocal
            Object value;

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

这是我们第一次没有map的时候，会构建一个ThreadLocalMap,threadLocalMap的构建是懒加载的。当至少有一个entry实例需要放入到map中的时候，我们才创建一个map容器。

二.当再次set()值的时候，map不为空的时候

public void set(T value) {
        Thread t = Thread.currentThread();
        ThreadLocalMap map = getMap(t);
        if (map != null)
//调用了map.set方法
            map.set(this, value);
        else
            createMap(t, value);
    }

//map的set方法
        private void set(ThreadLocal<?> key, Object value) {
            //Entry数组
            Entry[] tab = table;
            //Entry数组的长度
            int len = tab.length;
            //获取数组的下标
            int i = key.threadLocalHashCode & (len-1);
            //进入循环
            for (Entry e = tab[i];
                 e != null;
                 e = tab[i = nextIndex(i, len)]) {
        //通过value值来找对应的key值
                ThreadLocal<?> k = e.get();
                 //如果k已经有了，则直接覆盖
                if (k == key) {
                    e.value = value;
                    return;
                }
                // 如果k为null，则说明被gc回收，这个Entry就是StaleEntry也就是脏Entry，需要先清除旧value再设置新value
        
                if (k == null) {
                    //清理过期对象
                    replaceStaleEntry(key, value, i);
                    return;
                }
            }
                //new一个Entry,赋给当前位置
            tab[i] = new Entry(key, value);
            //size初始为0,set一个就加1.
            int sz = ++size;
 //清理其余过期对象，若sz大于threshold(阈值就是长度的三分之二)，则需要扩容，重新hash
            if (!cleanSomeSlots(i, sz) && sz >= threshold)
                rehash();
        }

看一下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) { // entry不为null且entry中的key为null
            n = len;
            removed = true;
            i = expungeStaleEntry(i);   
        }
    } while ( (n >>>= 1) != 0); // 等价于n=n>>>1，>>>为无符号右移 n =n/2
    return removed;
}

可以看到 就是一个查询tab的方法，在全查和不检查中间的一种查法，时间复杂度是O（n） 关键代码在于expungeStaleEntry,我们看一下他的源码:

expungeStatleEntry源码

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

    // expunge entry at staleSlot
    tab[staleSlot].value = null;
    tab[staleSlot] = null;
    size--;     // 以上代码，将entry的value赋值为null，这样方便GC时将真正value占用的内存给释放出来；将entry赋值为null，size减1，这样这个slot就又可以重新存放新的entry了

    // Rehash until we encounter null
    Entry e;
    int i;
    for (i = nextIndex(staleSlot, len); // 从staleSlot后一个index开始向后遍历，直到遇到为null的entry
         (e = tab[i]) != null;
         i = nextIndex(i, len)) {
        ThreadLocal<?> k = e.get();
        if (k == null) {    // 如果entry的key为null，则清除掉该entry
            e.value = null;
            tab[i] = null;
            size--;
        } else {
            int h = k.threadLocalHashCode & (len - 1);
            if (h != i) {   // key的hash值不等于目前的index，说明该entry是因为有哈希冲突导致向后移动到当前index位置的
                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)      // 对该entry，重新进行hash并解决冲突
                    h = nextIndex(h, len);
                tab[h] = e;
            }
        }
    }
    return i;   // 返回经过整理后的，位于staleSlot位置后的第一个为null的entry的index值
}

这个类的作用就是清理了slot位置上的entry，还把slot之后key为null的entry也清空了，并且顺带将一些有哈希冲突的entry给填充回可用的index中。

这时候我们回头看一下rehash()的方法

private void rehash() {
    expungeStaleEntries();  

    // Use lower threshold for doubling to avoid hysteresis
    if (size >= threshold - threshold / 4)  // 进行resize的条件更苛刻了，只要大于等于3/4*threshold就进行resize
        resize();   
}

这里面注意调用的不是上面的expungeStaleEntry方法，而是expungeStaleEntries（）

看一下有什么不同

private void expungeStaleEntries() {
    Entry[] tab = table;
    int len = tab.length;
    for (int j = 0; j < len; j++) {
        Entry e = tab[j];
        if (e != null && e.get() == null)   // entry不为null且entry的key为null
            expungeStaleEntry(j);       // 
    }
}

结果是又调用了expungeStaleEntry方法 ，只不过这次是从头到尾的弄了一次。而expungeStaleEntry方法是从Staleslot开始的

然后我们看下resize方法

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 {
                int h = k.threadLocalHashCode & (newLen - 1);
                while (newTab[h] != null)
                    h = nextIndex(h, newLen);
                newTab[h] = e;
                count++;
            }
        }
    }

    setThreshold(newLen);
    size = count;
    table = newTab;
}

扩容机制嘛，直接将原来的长度*2,再重新hash位置。

我们最后来看一下在set()方法中if判断里面的replaceStaleEntry方法

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

    int slotToExpunge = staleSlot;
    for (int i = prevIndex(staleSlot, len); // 从staleSlot位置向前找，//向前找到第一个脏entry
         (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();

        if (k == key) { // 发生这种情况，说明在key本应存储的hash位置和key实际存储位置之间有出现了key为null的entry
//如果在向后环形查找过程中发现key相同的entry就覆盖并且和脏entry进行交换
            e.value = value;
            //如果在查找过程中还未发现脏entry，那么就以当前位置作为cleanSomeSlots
            //的起点
            tab[i] = tab[staleSlot];
            tab[staleSlot] = e;
// 这两句代码，将要清理的staleSlot位置的entry，和后面发现的因冲突而存储到i位置的两个entry进行对调

            if (slotToExpunge == staleSlot)
                slotToExpunge = i;
            cleanSomeSlots(expungeStaleEntry(slotToExpunge), len);
            return;
        }
        //如果向前未搜索到脏entry，则在查找过程遇到脏entry的话，后面就以此时这个位置
        //作为起点执行cleanSomeSlots
        if (k == null && slotToExpunge == staleSlot)
            slotToExpunge = i;
    }

    // If key not found, put new entry in stale slot
    tab[staleSlot].value = null;    // 先将原来entry的value引用断开，再讲新entry放到staleSlot位置中
    tab[staleSlot] = new Entry(key, value);

    // If there are any other stale entries in run, expunge them
    if (slotToExpunge != staleSlot) // 清理其他key为null的entry
        cleanSomeSlots(expungeStaleEntry(slotToExpunge), len);
}

主要的流程是

1.从staleSlot这个位置向前遍历，直到遇见entry为空停下来，如果遇见脏Entry(就是Entry不是空，但是key是null的)就把他标记起来。这个标记就是slotToExpunge。而这个slotToExpunge就是以后threadLocalmap从哪进行cleanSomeSlots() 清除和重新hash

2.从staleSlot向后遍历，知道遇见entry为空就停下来。如果找到和要插入的key相同的threadLocal时，两个entry就互换位置。我们就要判断第一步中在向前的操作中有没有找到脏entry，如果有，就从第一步中的slotToexpunge开始清除，重新hash。如果没有，就把这个slotToExpunge放到当前这个脏Entry的位置上。

3.如果没有找到相同的threadLocal,我们就把新的entry放到staleSlot这个地方,然后我们就要判断第一步中在向前的操作中有没有找到脏entry，如果有，就从第一步中的slotToexpunge开始清除，重新hash。

分析的有点不透彻，希望大家海涵

感谢JAVA并发系列十九：深入理解ThreadLocal（三）–详解ThreadLocal内存泄漏问题_tujisitan的专栏-CSDN博客 的作者。给我启发。万分感谢