ThreadLocal 你需要了解的七大姑八大姨

一、ThreadLocal是什么 ？

ThreadLocal：线程本地变量，每一个线程都存有一份独立的变量副本，每个线程在运行过程中都可以通过Thread.currentThread()获得当前thread对象，每个线程内部都维护着ThreadLocalMap，内部的Entry继承自WeakReference，它以ThreadLocal作为key，这里的key是一个弱引用对象，要存储的变量作为value

二、ThreadLocal怎么使用？

接下来瞅一瞅标准使用示例：

import java.util.concurrent.atomic.AtomicInteger;
 public class ThreadId {
     // 使用Atomic原子类，CAS实现线程安全
     private static final AtomicInteger nextId = new AtomicInteger(0);
     // 初始化，通过CAS递增nextId的值，静态ThreadLocal，保持在内存中只存在一份
     private static final ThreadLocal<Integer> threadId =
         new ThreadLocal<Integer>() {
             @Override 
             protected Integer initialValue() {
                 return nextId.getAndIncrement();
             }
     };
     // 获取ID值
     public static int get() {
         return threadId.get();
     }
 }

三、ThreadLocal 成员变量

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

1、ThreadLocal中存在一个成员变量 threadLocalHashCode，表示该ThreadLocal在ThreadLocalMap中的hash值（即map集合中Entry的索引值）

2、第一次构造ThreadLocal时，threadLocalHashCode初始值为0，之后每次增加一个魔数 HASH_INCREMENT=0x61c88647

3、该魔数增加的方式为 Atomic原子类，CAS保证了线程安全，该魔数能够保证在2的幂次方容量的数组上均匀散列

四、ThreadLocalMap

1、成员变量

	// ThreadLocalMap初始容量大小
	private static final int INITIAL_CAPACITY = 16;
	// 内部的Entry数组
	private Entry[] table;
	// 数组容量大小
	private int size = 0;
	// 重新分配表的阈值大小
	private int threshold; 

2、主要方法

	// 设置阈值，为总容量的2/3
	private void setThreshold(int len) {
  	  threshold = len * 2 / 3;
	}
	// 获取下一个索引值，最后一个元素的下一个索引为第一个元素的索引，形成环形数组
	private static int nextIndex(int i, int len) {
	    return ((i + 1 < len) ? i + 1 : 0);
	}
	// 获取上一个索引值，最第一个元素的上一个索引为最后一个元素的索引，形成环形数组
	private static int prevIndex(int i, int len) {
	    return ((i - 1 >= 0) ? i - 1 : len - 1);
	}

ThreadLocalMap 散列冲突通过开放地址法解决—线性探测（nextIndex()、prevIndex()）

3、内部Entry结构

static class Entry extends WeakReference<java.lang.ThreadLocal<?>> {
    // 往ThreadLocal里实际填入的泛型值
    Object value;
    // 以ThreadLocal弱引用作为Key
    Entry(java.lang.ThreadLocal<?> k, Object v) {
        super(k);
        value = v;
    }
}

使用ThreadLocal弱引用作为key的原因？

1、如果使用强引用普通形式的 key-value，将会造成节点与线程的绑定，只要线程没有销毁，那么节点在GC过程中就一直处于可达状态，程序无法判断是否可以回收这些节点

2、使用弱引用，在程序发生GC的时候，会回收这些弱引用对象，那么ThreadLocalMap对应的Entry的key将会失效

4、构造函数

/**
 * 构造一个包含firstKey和firstValue的map。
 * ThreadLocalMap是惰性构造的，所以只有当至少要往里面放一个元素的时候才会构建它。
 */
ThreadLocalMap(java.lang.ThreadLocal<?> firstKey, Object firstValue) {
    // 初始化table数组
    table = new Entry[INITIAL_CAPACITY];
    // 用firstKey的threadLocalHashCode与初始大小16取模得到哈希值
    int i = firstKey.threadLocalHashCode & (INITIAL_CAPACITY - 1);
    // 初始化该节点
    table[i] = new Entry(firstKey, firstValue);
    // 设置节点表大小为1
    size = 1;
    // 设定扩容阈值
    setThreshold(INITIAL_CAPACITY);
}

五、ThreadLocal常用方法

1、initialValue()

• 当线程第一次调用get()方法时，initialValue()将会被间接调用，当先调用set()方法时，再调用get()方法，initialVaule()将不会被调用
• 主要是用于初始化值
• 当调用remove()方法时，initialValue()将会被二次调用
• 该方法默认返回null，需要子类具体实现

    protected T initialValue() {
        return null;
    }

2、withInitial与静态内部类SuppliedThreadLocal

• SuppliedThreadLocal是ThreadLocal的子类，可以在withInitial()内传递一个Supplier接口的子类构造一个SuppliedThreadLocal对象
• 与initialValue()方法相比，其实是将initialValue()方法写到了Supplier内部，通过Supplier的get()方法返回

    public static <S> ThreadLocal<S> withInitial(Supplier<? extends S> supplier) {
        return new SuppliedThreadLocal<>(supplier);
    }
	//ThreadLocal的静态内部类
    static final class SuppliedThreadLocal<T> extends ThreadLocal<T> {
        //由于是? extends，只能使用supplier的泛型出口代码
        private final Supplier<? extends T> supplier;  

        SuppliedThreadLocal(Supplier<? extends T> supplier) {
            this.supplier = Objects.requireNonNull(supplier);
        }

        @Override
        protected T initialValue() {
            return supplier.get();  //调用supplier的泛型出口代码
        }
    }

• Supplier的实际泛型类型，是赋值过去的泛型类型的子类

ThreadLocal<Number> localNumber = ThreadLocal.withInitial(new Supplier<Integer>() {
    @Override
    public Integer get() {
        return  null;
    };
});

3、get()方法解析

    public T get() {
    	// 1、获取当前线程对象
        Thread t = Thread.currentThread();
        // 2、通过线程获取到该线程内部的ThreadLocalMap对象
        ThreadLocalMap map = getMap(t);
        if (map != null) {
        	// 3、通过传入this对象，也就是ThreadLocal对象获取Entry对象，ThreadLocalMap内部类
            ThreadLocalMap.Entry e = map.getEntry(this);
            if (e != null) {
            	// 4、Entry不为空就获取value值返回
                T result = (T)e.value;
                return result;
            }
        }
        // 5、如果getMap()返回空，则调用setInitialValue()方法
        return setInitialValue();
    }

4、getMap(Thread thread)方法解析

    ThreadLocalMap getMap(Thread t) {
    	// 获取Thread内部成员变量，threadLocals
        return t.threadLocals;
    }

5、setInitialValue()方法解析

    private T setInitialValue() {
    	// 1、首先调用initialValue()方法，初始化值
        T value = initialValue();
        // 2、获取当前线程对象
        Thread t = Thread.currentThread();
        // 3、通过线程对象获取到ThreadLocalMap对象，也就是Thread内部成员变量threadLocals
        ThreadLocalMap map = getMap(t);
        if (map != null)
        	// 4、如果threadLocalMap不为空，则调用set()方法设置值
            map.set(this, value);
        else
        	// 5、如果此时threadLocalMap对象为空，则先要创建threadLocalMap对象
            createMap(t, value);
        return value;
    }

6、createMap(Thread thread,Object object)方法解析

    void createMap(Thread t, T firstValue) {
    	// 创建一个ThreadLocalMap对象
        t.threadLocals = new ThreadLocalMap(this, firstValue);
    }

7、ThreadLocalMap.getEntry()方法解析

	private Entry getEntry(ThreadLocal<?> key) {
		// 根据ThreadLocal的ID来获取索引，即哈希值，与2的幂次方取模也即是求余
		int i = key.threadLocalHashCode & (table.length - 1);
		Entry e = table[i];
		// 若entry存在且未失效且弱引用指向的ThreadLocal就是key
		if (e != null && e.get() == key) {
			return e;
		} else {
			// 线性探测，所以往后找有可能能够找到目标Entry
			return getEntryAfterMiss(key, i, e);
		}
	}

8、ThreadLocalMap.getEntryAfterMiss()方法解析：主要是线性探测，寻找下一个可能命中的key，并且回收掉无用的Entry，因为key为弱引用的ThreadLocal，触发GC时，将会回收掉key，key=null

	private Entry getEntryAfterMiss(ThreadLocal<?> key, int i, Entry e) {
		// 赋值table数组
		Entry[] tab = table;
		// 获取Entry数组的长度
		int len = tab.length;
		// 基于线性探测法（nextIndex()）不断向后探测直到遇到空entry
		while (e != null) {
			// 获取到key对象
			ThreadLocal<?> k = e.get();
			// 找到目标
			if (k == key) {
				return e;
			}
			if (k == null) {
				// 该entry对应的ThreadLocal已经被回收，调用expungeStaleEntry来清理无效的entry
				expungeStaleEntry(i);
			} else {
				// 获取下一个Entry的索引
				i = nextIndex(i, len);
			}
			e = tab[i];
		}
		return null;
	}

9、ThreadLocalMap.expungeStaleEntry()方法解析：清理无效的Entry

private int expungeStaleEntry(int staleSlot) {
    Entry[] tab = table;
    int len = tab.length;
    // 因为Entry对应的ThreadLocal已经被回收，value设为null，显式断开强引用
    tab[staleSlot].value = null;
    // 设置Entry为null，以便垃圾回收，GC
    tab[staleSlot] = null;
    // 容量减一
    size--;
    Entry e;
    int i;
    // 循环获取下一个Entry，一次检测key是否为空，为空就将value置为null
    for (i = nextIndex(staleSlot, len); (e = tab[i]) != null; i = nextIndex(i, len)) {
        ThreadLocal<?> k = e.get();
        // 清理对应ThreadLocal已经被回收的entry
        if (k == null) {
            e.value = null;
            tab[i] = null;
            size--;
        } else {
            /*
             * 对于还没有被回收的情况，需要做一次rehash。
             * 
             * 如果对应的ThreadLocal的ID对len取模出来的索引h不为当前位置i，
             * 则从h向后线性探测到第一个空的slot，把当前的entry给挪过去。
             */
            int h = k.threadLocalHashCode & (len - 1);
            if (h != i) {
                tab[i] = null;
                /*
                 * 中的R算法。R算法描述了如何从使用线性探测的散列表中删除一个元素。
                 * R算法维护了一个上次删除元素的index，当在非空连续段中扫到某个entry的哈希值取模后的索引
                 * 还没有遍历到时，会将该entry挪到index那个位置，并更新当前位置为新的index，
                 * 继续向后扫描直到遇到空的entry。
                 *
                 * ThreadLocalMap因为使用了弱引用，所以其实每个slot的状态有三种也即
                 * 有效（value未回收），无效（value已回收），空（entry==null）。
                 * 正是因为ThreadLocalMap的entry有三种状态，所以不能完全套高德纳原书的R算法。
                 *
                 * 因为expungeStaleEntry函数在扫描过程中还会对无效slot清理将之转为空slot，
                 * 如果直接套用R算法，可能会出现具有相同哈希值的entry之间断开（中间有空entry）。
                 */
                while (tab[h] != null) {
                    h = nextIndex(h, len);
                }
                tab[h] = e;
            }
        }
    }
    // 返回staleSlot之后第一个空的slot索引
    return i;
}

10、set()方法解析

    public void set(T value) {
    	//获取当前线程对象
        Thread t = Thread.currentThread();
        //获取当前线程对应的ThreadLocalMap对象
        ThreadLocalMap map = getMap(t);
        if (map != null)
     	   //如果map对象存在，直接set值
            map.set(this, value);
        else
        	//如果map对象不存在，创建map
            createMap(t, value);
    }

11、ThreadLocalMap set()源码解析

private void set(ThreadLocal<?> key, Object value) {
    Entry[] tab = table;
    int len = tab.length;
    //获取元素hash索引
    int i = key.threadLocalHashCode & (len - 1);
    // 线性探测
    for (Entry e = tab[i]; e != null; e = tab[i = nextIndex(i, len)]) {
        ThreadLocal<?> k = e.get();
        // 找到对应的entry
        if (k == key) {
            e.value = value;
            return;
        }
        // 寻找到失效的entry
        if (k == null) {
        	//
            replaceStaleEntry(key, value, i);
            return;
        }
    }

    tab[i] = new Entry(key, value);
    int sz = ++size;
    if (!cleanSomeSlots(i, sz) && sz >= threshold) {
        rehash();
    }
}

private void replaceStaleEntry(ThreadLocal<?> key, Object value,int staleSlot) {
    Entry[] tab = table;
    int len = tab.length;
    Entry e;
    // 向前扫描，查找最前的一个无效slot
    int slotToExpunge = staleSlot;
    for (int i = prevIndex(staleSlot, len);(e = tab[i]) != null;i = prevIndex(i, len)）{
        if (e.get() == null) {
            slotToExpunge = i;
        }
    }

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

        // 找到了key，将其与无效的slot交换
        if (k == key) {
            // 更新对应slot的value值
            e.value = value;

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

            /*
             * 如果在整个扫描过程中（包括函数一开始的向前扫描与i之前的向后扫描）
             * 找到了之前的无效slot则以那个位置作为清理的起点，
             * 否则则以当前的i作为清理起点
             */
            if (slotToExpunge == staleSlot) {
                slotToExpunge = i;
            }
            // 从slotToExpunge开始做一次连续段的清理，再做一次启发式清理
            cleanSomeSlots(expungeStaleEntry(slotToExpunge), len);
            return;
        }

        // 如果当前的slot已经无效，并且向前扫描过程中没有无效slot，则更新slotToExpunge为当前位置
        if (k == null && slotToExpunge == staleSlot) {
            slotToExpunge = i;
        }
    }

    // 如果key在table中不存在，则在原地放一个即可
    tab[staleSlot].value = null;
    tab[staleSlot] = new Entry(key, value);

    // 在探测过程中如果发现任何无效slot，则做一次清理（连续段清理+启发式清理）
    if (slotToExpunge != staleSlot) {
        cleanSomeSlots(expungeStaleEntry(slotToExpunge), len);
    }
}

/**
 * 启发式地清理slot,
 * i对应entry是非无效（指向的ThreadLocal没被回收，或者entry本身为空）
 * n是用于控制控制扫描次数的
 * 正常情况下如果log n次扫描没有发现无效slot，函数就结束了
 * 但是如果发现了无效的slot，将n置为table的长度len，做一次连续段的清理
 * 再从下一个空的slot开始继续扫描
 * 
 * 这个函数有两处地方会被调用，一处是插入的时候可能会被调用，另外个是在替换无效slot的时候可能会被调用，
 * 区别是前者传入的n为元素个数，后者为table的容量
 */
private boolean cleanSomeSlots(int i, int n) {
    boolean removed = false;
    Entry[] tab = table;
    int len = tab.length;
    do {
        // i在任何情况下自己都不会是一个无效slot，所以从下一个开始判断
        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;
}


private void rehash() {
    // 做一次全量清理
    expungeStaleEntries();

    /*
     * 因为做了一次清理，所以size很可能会变小。
     * ThreadLocalMap这里的实现是调低阈值来判断是否需要扩容，
     * threshold默认为len*2/3，所以这里的threshold - threshold / 4相当于len/2
     */
    if (size >= threshold - threshold / 4) {
        resize();
    }
}

/*
 * 做一次全量清理
 */
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) {
            /*
             * 个人觉得这里可以取返回值，如果大于j的话取了用，这样也是可行的。
             * 因为expungeStaleEntry执行过程中是把连续段内所有无效slot都清理了一遍了。
             */
            expungeStaleEntry(j);
        }
    }
}

/**
 * 扩容，因为需要保证table的容量len为2的幂，所以扩容即扩大2倍
 */
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; 
            } else {
                // 线性探测来存放Entry
                int h = k.threadLocalHashCode & (newLen - 1);
                while (newTab[h] != null) {
                    h = nextIndex(h, newLen);
                }
                newTab[h] = e;
                count++;
            }
        }
    }

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

小结！！！

1、从createMap()方法可以看出，每个线程对应与不同的ThreadLocaMap对象，它以ThreadLocal作为key，所以ThreadLocal对于不同的线程存储不同的变量副本，当不同的线程需要对同一个key来进行set()或者get()时，需要复用ThrealLocal，也就是全局只有一个，设置为静态变量只会初始化一次