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