Java并发编程之ThreadLocal使用及源码解析

Java ThreadLocal类允许你创建只能由同一线程读写的变量。因此，即使两个线程执行相同的代码，并且代码引用相同的ThreadLocal变量，两个线程也不能看到彼此的ThreadLocal变量。

创建ThreadLocal及其操作

创建ThreadLocal

ThreadLocal<String> threadLocal = new ThreadLocal<>();

上面代码是创建一个ThreadLocal对象

进行ThreadLocal的相应操作

设置ThreadLocal的值，使用set方法（获取当前线程，进行map中查找）：

threadlocal.set("Hello World");

获取ThreadLocal的值，使用get方法（获取当前线程，进行map中查找）：

threadlocal.get();

删除ThreadLocal的值，使用remove方法（获取当前线程，进行map中查找）：

threadlocal.remove();

ThreadLocal初始值设置

ThreadLocal可以设置初始化的值，可以通过两种方式进行设置：
1.使用子类重写initialValue()进行设置

ThreadLocal<String> threadLocalInit = new ThreadLocal<String>(){
        @Override
        protected String initialValue() {
            return String.valueOf(System.currentTimeMillis());
        }
    };

2.使用ThreadLocal实现Supplier 接口进行设置

ThreadLocal<String> threadLocalInit2 = ThreadLocal.withInitial(new Supplier<String>() {
        @Override
        public String get() {
            return String.valueOf(System.currentTimeMillis());
        }
    });

使用Lambda表达式进行设置

ThreadLocal<String> threadLocalInit3 = ThreadLocal.withInitial(
        ()->{return String.valueOf(System.currentTimeMillis());});

	//简化版本
    ThreadLocal<String> threadLocalInit4 = ThreadLocal.withInitial(() -> String.valueOf(System.currentTimeMillis()));

ThreadLocal 延迟设置值

在某些情况下，您不能使用设置初始值的标准方法。例如，您可能需要一些在创建ThreadLocal变量时不可用的配置信息。在这种情况下，可以延迟设置初始值。

public class DateFormatter {
    private ThreadLocal<SimpleDateFormat> threadLocal = new ThreadLocal<>();

    public String format(Date date){
        SimpleDateFormat simpleDateFormat = getSimpleDateFormat();
        return simpleDateFormat.format(date);
    }

    private SimpleDateFormat getSimpleDateFormat() {
        SimpleDateFormat simpleDateFormat = threadLocal.get();
        if(Objects.isNull(simpleDateFormat)){
            simpleDateFormat = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
            threadLocal.set(simpleDateFormat);
        }
        return simpleDateFormat;
    }
}
如果使用过hibernate的时候，应该会有影响，我们进行sessionFactory创建的时候，就会使用上面的这种方式。
将sessionFactory使用ThreadLocal中进行延迟创建。

ThreadLocal子类InheritableThreadLocal

InheritableThreadLocal类是ThreadLocal的子类。 而不是Threadable内部的每个线程都具有自己的值，而是InheritableThreadLocal授予对线程以及该线程创建的所有子线程的值的访问权限。

ThreadLocal源码

public class ThreadLocal<T> {
	
	private final int threadLocalHashCode = nextHashCode();
	//线程安全的Integer类AtomicInteger
	private static AtomicInteger nextHashCode = new AtomicInteger();
	//连续生成的哈希码之间的区别——将隐式顺序线程本地id
	//转换为接近最优扩散乘法哈希值，用于两个幂次大小的表。
	private static final int HASH_INCREMENT = 0x61c88647;
	//生成nextHashCode
	private static int nextHashCode() {
    	return nextHashCode.getAndAdd(HASH_INCREMENT);
	}
	//初始化设置，如果子类不重写这个方法，将不能进行初始化值的设定
	protected T initialValue() {
        return null;
    }
    //实现接口进行初始化值的设置
    public static <S> ThreadLocal<S> withInitial(Supplier<? extends S> supplier) {
        return new SuppliedThreadLocal<>(supplier);
    }
    //默认构造函数
    public ThreadLocal() {
    }
    //获取ThreadLocal中的值
    public T get() {
        Thread t = Thread.currentThread();
        //这个是ThreadLocal的一个内部类，进行ThreadLocal数据的管理
        ThreadLocalMap map = getMap(t);
        if (map != null) {
            ThreadLocalMap.Entry e = map.getEntry(this);
            if (e != null) {
                @SuppressWarnings("unchecked")
                T result = (T)e.value;
                return result;
            }
        }
        return setInitialValue();
    }
	//设置初始值
	private T setInitialValue() {
        T value = initialValue();
        Thread t = Thread.currentThread();
        ThreadLocalMap map = getMap(t);
        if (map != null)
        	//设置如果存在的时候，如果不存在就创建createMap
            map.set(this, value);
        else
            createMap(t, value);
        return value;
    }
    //设置值
    public void set(T value) {
        Thread t = Thread.currentThread();
        ThreadLocalMap map = getMap(t);
        if (map != null)
            map.set(this, value);
        else
            createMap(t, value);
    }
    //移除值
    public void remove() {
         ThreadLocalMap m = getMap(Thread.currentThread());
         if (m != null)
             m.remove(this);
     }
	//获取内部类ThreadLocalMap 
	ThreadLocalMap getMap(Thread t) {
        return t.threadLocals;
    }
    //创建一个ThreadLocalMap，这里会传入一个线程和相关的值
    void createMap(Thread t, T firstValue) {
        t.threadLocals = new ThreadLocalMap(this, firstValue);
    }
    //创建一个map在InheritableThreadLocal
    static ThreadLocalMap createInheritedMap(ThreadLocalMap parentMap) {
        return new ThreadLocalMap(parentMap);
    }
    //获取子值
    T childValue(T parentValue) {
        throw new UnsupportedOperationException();
    }
    //实现Supplier进行初始化值的设置
    static final class SuppliedThreadLocal<T> extends ThreadLocal<T> {
        private final Supplier<? extends T> supplier;
        SuppliedThreadLocal(Supplier<? extends T> supplier) {
            this.supplier = Objects.requireNonNull(supplier);
        }
        //通过supplier进行初始化设置
        @Override
        protected T initialValue() {
            return supplier.get();
        }
    }
    //内部类ThreadLocalMap 
    static class ThreadLocalMap {
    	//这个哈希映射中的条目扩展了WeakReference，使用它的主ref字段作为
    	//键(始终是ThreadLocal对象)。注意，空键(即entry.get()  == null)意味
    	//着不再引用该键，因此可以从表中删除条目。这样的条目在下面的代码
    	//中被称为“陈旧条目”。
    	static class Entry extends WeakReference<ThreadLocal<?>> {
            /** The value associated with this ThreadLocal. */
            Object value;
            Entry(ThreadLocal<?> k, Object v) {
                super(k);
                value = v;
            }
        }
        //初始化容量
        private static final int INITIAL_CAPACITY = 16;
        //重置必须使用的table
         private Entry[] table;
         //map中的条目
         private int size = 0;
         //要调整大小的下一个大小值
         private int threshold
         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);
        }
        //构造一个最初包含(firstKey, firstValue)的新映射。
        //ThreadLocalMaps是惰性构造的，所以我们只在至少有一个条目要放入其中时才创建一个
        ThreadLocalMap(ThreadLocal<?> firstKey, Object firstValue) {
            table = new Entry[INITIAL_CAPACITY]; //设置容量
            int i = firstKey.threadLocalHashCode & (INITIAL_CAPACITY - 1);
            table[i] = new Entry(firstKey, firstValue);
            size = 1;
            setThreshold(INITIAL_CAPACITY);
        }
        //构造一个新的映射，包括来自给定父映射的所有可继承线程局部变量。仅由createInheritedMap调用。
        private ThreadLocalMap(ThreadLocalMap parentMap) {
            Entry[] parentTable = parentMap.table;
            int len = parentTable.length;
            setThreshold(len);
            table = new Entry[len];

            for (int j = 0; j < len; j++) {
                Entry e = parentTable[j];
                if (e != null) {
                    @SuppressWarnings("unchecked")
                    ThreadLocal<Object> key = (ThreadLocal<Object>) e.get();
                    if (key != null) {
                        Object value = key.childValue(e.value);
                        Entry c = new Entry(key, value);
                        int h = key.threadLocalHashCode & (len - 1);
                        while (table[h] != null)
                            h = nextIndex(h, len);
                        table[h] = c;
                        size++;
                    }
                }
            }
        }
        //获取与key关联的条目。这个方法本身只处理快速路径:直接命中现有的
        //键。否则，它getEntryAfterMiss得到错过。这样做的目的是使直接命中的性能最大
        //化，部分是通过使这种方法容易地不可分割。
        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);
        }

        /**
         * 当键在其直接哈希槽中找不到时使用的getEntry方法的版本
         */
        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;
        }

        /**
         设置与key关联的值
         */
        private void set(ThreadLocal<?> key, Object value) {
           //我们不像get（）那样使用快速路径，因为它位于至少与使用set（）创建
           //新条目一样常见替换现有的，在这种情况下，路径失败的机会多于失败。
            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)]) {
                ThreadLocal<?> k = e.get();
                if (k == key) {
                    e.value = value;
                    return;
                }
                if (k == null) {
                    replaceStaleEntry(key, value, i);
                    return;
                }
            }
            tab[i] = new Entry(key, value);
            int sz = ++size;
            if (!cleanSomeSlots(i, sz) && sz >= threshold)
                rehash();
        }

        /**
         * 移除条目中的key
         */
        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;
                }
            }
        }

        /**
         使用指定键值的条目替换在set操作期间遇到的陈旧条目。传入的值 
         value参数存储在条目中，无论是否指定键的条目已经存在
        作为一个副作用，此方法会删除"run"中包含该陈旧条目的所有陈旧条目。(运行是两个空槽之间的条目序列。)
         */
        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);
                 (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();

              //如果找到密钥，则需要交换密钥
			//使用陈旧的条目来维护哈希表的顺序。
			//新失效的插槽，或任何其他失效的插槽
			//在它上面遇到的，然后可以发送到expungeStaleEntry
			//删除或重新哈希运行中的所有其他条目。
                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;
                }

               //如果在向后扫描中未找到过时的条目，则
				//扫描密钥时看到的第一个陈旧条目是
				//首先仍在运行中。
                if (k == null && slotToExpunge == staleSlot)
                    slotToExpunge = i;
            }

            // If key not found, put new entry in stale slot
            tab[staleSlot].value = null;
            tab[staleSlot] = new Entry(key, value);

            // If there are any other stale entries in run, expunge them
            if (slotToExpunge != staleSlot)
                cleanSomeSlots(expungeStaleEntry(slotToExpunge), len);
        }

        /**
        通过重新哈希任何可能冲突的条目来清除陈旧的条目
        位于staleSlot和下一个空插槽之间。 这也消失了
        在结尾的null之前遇到的任何其他过时的条目
         */
        private int expungeStaleEntry(int staleSlot) {
            Entry[] tab = table;
            int len = tab.length;

            // expunge entry at staleSlot
            tab[staleSlot].value = null;
            tab[staleSlot] = null;
            size--;

            // Rehash until we encounter 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 {
                    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(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;
                    removed = true;
                    i = expungeStaleEntry(i);
                }
            } while ( (n >>>= 1) != 0);
            return removed;
        }

    /**
    重新包装和/或调整桌子大小。 首先扫描整个
	删除陈旧条目的表。 如果这还不够
	缩小表的大小，将表的大小增加一倍
     */
    private void rehash() {
        expungeStaleEntries();
        // Use lower threshold for doubling to avoid hysteresis
        if (size >= threshold - threshold / 4)
            resize();
    }

    /**
     * 重置大小 到以前大小的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; // 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;
    }

    /**
     * 删除表中所有过时的条目。.
     */
    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)
                expungeStaleEntry(j);
        }
    }
    }
}