threadLocal详解

1. threadLocal概念

ThreadLocal是线程本地变量的意思,可以做到线程间数据隔离，各个线程之间的变量互不干扰，在高并发场景下，可以实现无状态的调用，特别适用于各个线程依赖不同的变量值完成操作的场景。

2. 源码分析

• 初始化threadLocal

ThreadLocal.ThreadLocalMap threadLocals = null;
ThreadLocal<？> localName = new ThreadLocal();

• ThreadLocal set方法:

public void set(T value) {
    Thread t = Thread.currentThread(); //获取当前线程
    ThreadLocalMap map = getMap(t);    //根据线程名称获取到threadLocalMap, thread里面有一个名为threadLocals的threadLocalMap类型变量，【return t.threadLocals】


    if (map != null)
        map.set(this, value);
    else
        createMap(t, value);          //若是当前线程没有threadLocalMap则创建一个localMap  【t.threadLocals = new ThreadLocalMap(this, firstValue);】
}

• ThreadLocal get方法：

Thread t = Thread.currentThread();        //获取当前线程
ThreadLocalMap map = getMap(t);           //根据线程名称获取到threadLocalMap, thread里面有一个threadLocals变量，【return t.threadLocals】
if (map != null) {
  ThreadLocalMap.Entry e = map.getEntry(this);   //当线程中有map获取entry对象，当里面有值得时候就获取值
    if (e != null) {
        @SuppressWarnings("unchecked")
        T result = (T)e.value;
        return result;
    }
}
return setInitialValue();                 // 如果没有设置值就获取值的话就给个空，并创建一个threadLocalMap
//获取getEntry
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);
}


//set初始化值
private T setInitialValue() {
    T value = initialValue();          //value为空
    Thread t = Thread.currentThread();
    ThreadLocalMap map = getMap(t);
    if (map != null)
        map.set(this, value);
    else
        createMap(t, value);
    return value;
}

• ThreadLocalMap的set Entry方法：

  Entry存放方式：
  

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

    Entry[] tab = table;   //得到整个数组的数据
    int len = tab.length;   //计算数组的长度
    int i = key.threadLocalHashCode & (len-1);  //根据threadLocal的key【HashCode】算出所在数组下标


    for (Entry e = tab[i]; e != null;  e = tab[i = nextIndex(i, len)]) {
        ThreadLocal<?> k = e.get();    //根据entry得到threadLocal

         //【如果得到threadLocal与传进来的参数一样，则重新设置值，并覆盖以前的值】
        if (k == key) {
            e.value = value;
            return;
        }

         //【如果根据传来的threadLocal计算出数组下标i的entry的threadLocal为空，则用现在key与value直接覆盖】
        if (k == null) {
            replaceStaleEntry(key, value, i);
            return;
        }
    }

    【如如果得到threadLocal与传进来的参数一样，则在数组上添加一个entry，并将数组数量加1】
    tab[i] = new Entry(key, value);
    int sz = ++size;
    if (!cleanSomeSlots(i, sz) && sz >= threshold)
        rehash();
}

1、如果当前位置是空的，那么正好，就初始化一个Entry对象放在位置i上；
2、不巧，位置i已经有Entry对象了，如果这个Entry对象的key正好是即将设置的key，那么重新设置Entry中的value；
3、很不巧，位置i的Entry对象，和即将设置的key没关系，那么只能找下一个空位置；
这样的话，在get的时候，也会根据ThreadLocal对象的hash值，定位到table中的位置，然后判断该位置Entry对象中的key是否和get的key一致，如果不一致，就判断下一个位置

• ThreadLocalMap 数组的扩容：

private void resize() {
    Entry[] oldTab = table;      //整个旧的数组
    int oldLen = oldTab.length;  
    int newLen = oldLen * 2;           
    Entry[] newTab = new Entry[newLen];  //新的数组扩容两倍
    int count = 0;

   【遍历旧的数组，如果k为null则删除value，否则就将新entry放入新的数组中】
    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;
}

• ThreadLocal内存泄漏以及处理：

既然已经发现有内存泄露的隐患，自然有应对的策略，在调用ThreadLocal的get()、set()可能会清除ThreadLocalMap中key为null的Entry对象，这样对应的value就没有GC Roots可达了，下次GC的时候就可以被回收，当然如果调用remove方法，肯定会删除对应的Entry对象。
如果使用ThreadLocal的set方法之后，没有显示的调用remove方法，就有可能发生内存泄露，所以养成良好的编程习惯十分重要，使用完ThreadLocal之后，记得调用remove方法。


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);  //清除 key(ThreadLocalMap)与 value
        return;
    }
}