一.對ThreadLocal的理解 二.深入解析ThreadLocal類 三.ThreadLocal的應用場景

對ThreadLocal的理解

ThreadLocal是一個本地執行緒副本變數工具類。主要用於將私有執行緒和該執行緒存放的副本物件做一個對映，各個執行緒之間的變數互不幹擾，在高併發場景下，可以實現無狀態的呼叫，特別適用於各個執行緒依賴不同的變數值完成操作的場景。

我們先寫一個例子

class ConnectionManager {
     
    private static Connection connect = null;
     
    public static Connection openConnection
 
() {
        if(connect == null){
            connect = DriverManager.getConnection();
        }
        return connect;
    }
     
    public static void closeConnection() {
        if(connect!=null)
            connect.close();
    }
}
複製程式碼

假設有這樣一個資料庫連結管理類，這段程式碼在單執行緒中使用是沒有任何問題的，但是如果在多執行緒中使用呢？很顯然，在多執行緒中使用會存線上程安全問題：第一，這裡面的2個方法都沒有進行同步，很可能在openConnection方法中會多次建立connect；第二，由於connect是共享變數，那麼必然在呼叫connect的地方需要使用到同步來保障執行緒安全，因為很可能一個執行緒在使用connect進行資料庫操作，而另外一個執行緒呼叫closeConnection關閉連結。

所以出於執行緒安全的考慮，必須將這段程式碼的兩個方法進行同步處理，並且在呼叫connect的地方需要進行同步處理。

這樣將會大大影響程式執行效率，因為一個執行緒在使用connect進行資料庫操作的時候，其他執行緒只有等待。

那麼大家來仔細分析一下這個問題，這地方到底需不需要將connect變數進行共享？事實上，是不需要的。假如每個執行緒中都有一個connect變數，各個執行緒之間對connect變數的訪問實際上是沒有依賴關係的，即一個執行緒不需要關心其他執行緒是否對這個connect進行了修改的。

到這裡，可能會有朋友想到，既然不需要線上程之間共享這個變數，可以直接這樣處理，在每個需要使用資料庫連線的方法中具體使用時才建立資料庫連結，然後在方法呼叫完畢再釋放這個連線。比如下面這樣：

class ConnectionManager {
     
    private  Connection connect = null;
     
    public Connection openConnection() {
        if(connect == null){
            connect = DriverManager.getConnection();
        }
        return connect;
    }
     
    public void closeConnection() {
        if(connect!=null)
            connect.close();
    }
}
 
 
class Dao{
    public void insert() {
        ConnectionManager connectionManager = new ConnectionManager();
        Connection connection = connectionManager.openConnection();
         
        //使用connection進行操作
         
        connectionManager.closeConnection();
    }
}
複製程式碼

這樣處理確實也沒有任何問題，由於每次都是在方法內部建立的連線，那麼執行緒之間自然不存線上程安全問題。由於在方法中需要頻繁地開啟和關閉資料庫連線，這樣會導致伺服器壓力非常大，嚴重影響程式執行效能。

這種情況下我們可以使用ThreadLocal，因為ThreadLocal在每個執行緒中對該變數會建立一個副本，即每個執行緒內部都會有一個該變數，且線上程內部任何地方都可以使用，執行緒之間互不影響，這樣一來就不存線上程安全問題，也不會嚴重影響程式執行效能。

但是要注意，雖然ThreadLocal能夠解決上面說的問題，但是由於在每個執行緒中都建立了副本，所以要考慮它對資源的消耗，比如記憶體的佔用會比不使用ThreadLocal要大。

下圖為ThreadLocal的內部結構圖

從上面的結構圖，我們已經窺見ThreadLocal的核心機制：

• 每個Thread執行緒內部都有一個Map。
• Map裡面儲存執行緒本地物件（key）和執行緒的變數副本（value）
• 但是，Thread內部的Map是由ThreadLocal維護的，由ThreadLocal負責向map獲取和設定執行緒的變數值。

所以對於不同的執行緒，每次獲取副本值時，別的執行緒並不能獲取到當前執行緒的副本值，形成了副本的隔離，互不幹擾。

.深入解析ThreadLocal類

Thread執行緒內部的Map在類中描述如下：

public class Thread implements Runnable {
    /* ThreadLocal values pertaining to this thread. This map is maintained
     * by the ThreadLocal class. */
    ThreadLocal.ThreadLocalMap threadLocals = null;
}

複製程式碼

我們先了解一下ThreadLocal類提供如下幾個核心方法：

public T get() { }
public void set(T value) { }
public void remove() { }
protected T initialValue() { }
複製程式碼

• get()方法用於獲取當前執行緒的副本變數值。
• set()方法用於設定當前執行緒的副本變數值。
• initialValue()為當前執行緒初始副本變數值。
• remove()方法移除當前前程的副本變數值。

先看下get方法的實現：

/**
 * Returns the value in the current thread's copy of this
 * thread-local variable.  If the variable has no value for the
 * current thread,it is first initialized to the value returned
 * by an invocation of the {@link #initialValue} method.
 *
 * @return the current thread's value of this thread-local
 */
public T get() {
    Thread t = Thread.currentThread();
    ThreadLocalMap map = getMap(t);
    if (map != null) {
        ThreadLocalMap.Entry e = map.getEntry(this);
        if (e != null)
            return (T)e.value;
    }
    return setInitialValue();
}
複製程式碼

第一句是取得當前執行緒，然後通過getMap(t)方法獲取到一個map，map的型別為ThreadLocalMap。然後接著下面獲取到<key,value>鍵值對，注意這裡獲取鍵值對傳進去的是 this，而不是當前執行緒t。 如果獲取成功，則返回value值。 如果map為空，則呼叫setInitialValue方法返回value。 我們上面的每一句來仔細分析： 首先看一下getMap方法中做了什麼：

ThreadLocalMap getMap(Thread t) {
    return t.threadLocals;
}
複製程式碼

可能大家沒有想到的是，在getMap中，是呼叫當期執行緒t，返回當前執行緒t中的一個成員變數threadLocals。 那麼我們繼續取Thread類中取看一下成員變數threadLocals是什麼：

ThreadLocal.ThreadLocalMap threadLocals = null;
複製程式碼

實際上就是一個ThreadLocalMap，這個型別是ThreadLocal類的一個內部類，我們繼續取看ThreadLocalMap的實現：

 static class ThreadLocalMap {

        /**
         * The entries in this hash map extend WeakReference,using
         * its main ref field as the key (which is always a
         * ThreadLocal object).  Note that null keys (i.e. entry.get()
         * == null) mean that the key is no longer referenced,so the
         * entry can be expunged from table.  Such entries are referred to
         * as "stale entries" in the code that follows.
         */
        static class Entry extends WeakReference<ThreadLocal<?>> {
            /** The value associated with this ThreadLocal. */
            Object value;

            Entry(ThreadLocal<?> k,Object v) {
                super(k);
                value = v;
            }
        }
複製程式碼

可以看到ThreadLocalMap的Entry繼承了WeakReference，並且使用ThreadLocal作為鍵值。 然後再繼續看setInitialValue方法的具體實現：

private T setInitialValue() {
    T value = initialValue();
    Thread t = Thread.currentThread();
    ThreadLocalMap map = getMap(t);
    if (map != null)
        map.set(this,value);
    else
        createMap(t,value);
    return value;
}

protected T initialValue() {
    return null;
}

複製程式碼

 如果map不為空，設定鍵值對為空，再建立Map，看一下createMap的實現：

  /**
     * Create the map associated with a ThreadLocal. Overridden in
     * InheritableThreadLocal.
     *
     * @param t the current thread
     * @param firstValue value for the initial entry of the map
     */
    void createMap(Thread t,T firstValue) {
        t.threadLocals = new ThreadLocalMap(this,firstValue);
    }
複製程式碼

ThreadLocal為每個執行緒建立變數的副本的過程：

首先，在每個執行緒Thread內部有一個ThreadLocal.ThreadLocalMap型別的成員變數threadLocals，這個threadLocals就是用來儲存實際的變數副本的，鍵值為當前ThreadLocal變數，value為變數副本（即T型別的變數）。

初始時，在Thread裡面，threadLocals為空，當通過ThreadLocal變數呼叫get()方法或者set()方法，就會對Thread類中的threadLocals進行初始化，並且以當前ThreadLocal變數為鍵值，以ThreadLocal要儲存的副本變數為value，存到threadLocals。

然後在當前執行緒裡面，如果要使用副本變數，就可以通過get方法在threadLocals裡面查詢。

下面通過一個例子來證明通過ThreadLocal能達到在每個執行緒中建立變數副本的效果：

public class Test {
    ThreadLocal<Long> longLocal = new ThreadLocal<Long>();
    ThreadLocal<String> stringLocal = new ThreadLocal<String>();
     
    public void set() {
        longLocal.set(Thread.currentThread().getId());
        stringLocal.set(Thread.currentThread().getName());
    }
     
    public long getLong() {
        return longLocal.get();
    }
     
    public String getString() {
        return stringLocal.get();
    }
     
    public static void main(String[] args) throws InterruptedException {
        final Test test = new Test();
        test.set();
        System.out.println(test.getLong());
        System.out.println(test.getString());
   
        Thread thread1 = new Thread(){
            public void run() {
                test.set();
                System.out.println(test.getLong());
                System.out.println(test.getString());
            };
        };
        thread1.start();
        thread1.join();
         
        System.out.println(test.getLong());
        System.out.println(test.getString());
    }
}

複製程式碼

輸出結果如下圖

從這段程式碼的輸出結果可以看出，在main執行緒中和thread1執行緒中，longLocal儲存的副本值和stringLocal儲存的副本值都不一樣。最後一次在main執行緒再次列印副本值是為了證明在main執行緒中和thread1執行緒中的副本值確實是不同的。

總結一下：

1）實際的通過ThreadLocal建立的副本是儲存在每個執行緒自己的threadLocals中的； 2）為何threadLocals的型別ThreadLocalMap的鍵值為ThreadLocal物件，因為每個執行緒中可有多個threadLocal變數，就像上面程式碼中的longLocal和stringLocal； 3）在進行get之前，必須先set，否則會報空指標異常；

如果想在get之前不需要呼叫set就能正常訪問的話，必須重寫initialValue()方法。 因為在上面的程式碼分析過程中，我們發現如果沒有先set的話，即在map中查詢不到對應的儲存，則會通過呼叫setInitialValue方法返回i，而在setInitialValue方法中，有一個語句是T value = initialValue()， 而預設情況下，initialValue方法返回的是null。

看下面這個例子：

public class Test {
    ThreadLocal<Long> longLocal = new ThreadLocal<Long>();
    ThreadLocal<String> stringLocal = new ThreadLocal<String>();
 
    public void set() {
        longLocal.set(Thread.currentThread().getId());
        stringLocal.set(Thread.currentThread().getName());
    }
     
    public long getLong() {
        return longLocal.get();
    }
     
    public String getString() {
        return stringLocal.get();
    }
     
    public static void main(String[] args) throws InterruptedException {
        final Test test = new Test();
         
        System.out.println(test.getLong());
        System.out.println(test.getString());
 
        Thread thread1 = new Thread(){
            public void run() {
                test.set();
                System.out.println(test.getLong());
                System.out.println(test.getString());
            };
        };
        thread1.start();
        thread1.join();
         
        System.out.println(test.getLong());
        System.out.println(test.getString());
    }
}
複製程式碼

在main執行緒中，沒有先set，直接get的話，執行時會報空指標異常。 但是如果改成下面這段程式碼，即重寫了initialValue方法：

public class Test {
    ThreadLocal<Long> longLocal = new ThreadLocal<Long>(){
        protected Long initialValue() {
            return Thread.currentThread().getId();
        };
    };
    ThreadLocal<String> stringLocal = new ThreadLocal<String>(){;
        protected String initialValue() {
            return Thread.currentThread().getName();
        };
    };
     
    public void set() {
        longLocal.set(Thread.currentThread().getId());
        stringLocal.set(Thread.currentThread().getName());
    }
     
    public long getLong() {
        return longLocal.get();
    }
     
    public String getString() {
        return stringLocal.get();
    }
     
    public static void main(String[] args) throws InterruptedException {
        final Test test = new Test();
 
        test.set();
        System.out.println(test.getLong());
        System.out.println(test.getString());
     
         
        Thread thread1 = new Thread(){
            public void run() {
                test.set();
                System.out.println(test.getLong());
                System.out.println(test.getString());
            };
        };
        thread1.start();
        thread1.join();
         
        System.out.println(test.getLong());
        System.out.println(test.getString());
    }
}
複製程式碼

就可以直接不用先set而直接呼叫get了。

set()方法

/**
 * Sets the current thread's copy of this thread-local variable
 * to the specified value.  Most subclasses will have no need to
 * override this method,relying solely on the {@link #initialValue}
 * method to set the values of thread-locals.
 *
 * @param value the value to be stored in the current thread's copy of
 *        this thread-local.
 */
public void set(T value) {
    Thread t = Thread.currentThread();
    ThreadLocalMap map = getMap(t);
    if (map != null)
        map.set(this,value);
}

ThreadLocalMap getMap(Thread t) {
    return t.threadLocals;
}

void createMap(Thread t,T firstValue) {
    t.threadLocals = new ThreadLocalMap(this,firstValue);
}

複製程式碼

set方法過程： 1.獲取當前執行緒的成員變數map 2.map非空，則重新將ThreadLocal和新的value副本放入到map中。 3.map空，則對執行緒的成員變數ThreadLocalMap進行初始化建立，並將ThreadLocal和value副本放入map中。

remove()方法

/**
 * Removes the current thread's value for this thread-local
 * variable.  If this thread-local variable is subsequently
 * {@linkplain #get read} by the current thread,its value will be
 * reinitialized by invoking its {@link #initialValue} method,* unless its value is {@linkplain #set set} by the current thread
 * in the interim.  This may result in multiple invocations of the
 * <tt>initialValue</tt> method in the current thread.
 *
 * @since 1.5
 */
public void remove() {
 ThreadLocalMap m = getMap(Thread.currentThread());
 if (m != null)
     m.remove(this);
}

ThreadLocalMap getMap(Thread t) {
    return t.threadLocals;
}

複製程式碼

ThreadLocalMap

ThreadLocalMap是ThreadLocal的內部類，沒有實現Map介面，用獨立的方式實現了Map的功能，其內部的Entry也獨立實現。

在ThreadLocalMap中，也是用Entry來儲存K-V結構資料的。但是Entry中key只能是ThreadLocal物件，這點被Entry的構造方法已經限定死了。

static class Entry extends WeakReference<ThreadLocal> {
    /** The value associated with this ThreadLocal. */
    Object value;

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

複製程式碼

Entry繼承自WeakReference（弱引用，生命週期只能存活到下次GC前），但只有Key是弱引用型別的，Value並非弱引用。

ThreadLocalMap的成員變數：

static class ThreadLocalMap {
    /**
     * The initial capacity -- MUST be a power of two.
     */
    private static final int INITIAL_CAPACITY = 16;

    /**
     * The table,resized as necessary.
     * table.length MUST always be a power of two.
     */
    private Entry[] table;

    /**
     * The number of entries in the table.
     */
    private int size = 0;

    /**
     * The next size value at which to resize.
     */
    private int threshold; // Default to 0
}

複製程式碼

Hash衝突怎麼解決

和HashMap的最大的不同在於，ThreadLocalMap結構非常簡單，沒有next引用，也就是說ThreadLocalMap中解決Hash衝突的方式並非連結串列的方式，而是採用線性探測的方式，所謂線性探測，就是根據初始key的hashcode值確定元素在table陣列中的位置，如果發現這個位置上已經有其他key值的元素被佔用，則利用固定的演演算法尋找一定步長的下個位置，依次判斷，直至找到能夠存放的位置。

ThreadLocalMap解決Hash衝突的方式就是簡單的步長加1或減1，尋找下一個相鄰的位置。

/**
 * Increment i modulo len.
 */
private static int nextIndex(int i,int len) {
    return ((i + 1 < len) ? i + 1 : 0);
}

/**
 * Decrement i modulo len.
 */
private static int prevIndex(int i,int len) {
    return ((i - 1 >= 0) ? i - 1 : len - 1);
}

複製程式碼

顯然ThreadLocalMap採用線性探測的方式解決Hash衝突的效率很低，如果有大量不同的ThreadLocal物件放入map中時傳送衝突，或者發生二次衝突，則效率很低。

所以這裡引出的良好建議是：每個執行緒只存一個變數，這樣的話所有的執行緒存放到map中的Key都是相同的ThreadLocal，如果一個執行緒要儲存多個變數，就需要建立多個ThreadLocal，多個ThreadLocal放入Map中時會極大的增加Hash衝突的可能。

ThreadLocalMap的問題

由於ThreadLocalMap的key是弱引用，而Value是強引用。這就導致了一個問題，ThreadLocal在沒有外部物件強引用時，發生GC時弱引用Key會被回收，而Value不會回收，如果建立ThreadLocal的執行緒一直持續執行，那麼這個Entry物件中的value就有可能一直得不到回收，發生記憶體洩露。

如何避免洩漏 既然Key是弱引用，那麼我們要做的事，就是在呼叫ThreadLocal的get()、set()方法時完成後再呼叫remove方法，將Entry節點和Map的引用關係移除，這樣整個Entry物件在GC Roots分析後就變成不可達了，下次GC的時候就可以被回收。

如果使用ThreadLocal的set方法之後，沒有顯示的呼叫remove方法，就有可能發生記憶體洩露，所以養成良好的程式設計習慣十分重要，使用完ThreadLocal之後，記得呼叫remove方法。

ThreadLocal<Session> threadLocal = new ThreadLocal<Session>();
try {
    threadLocal.set(new Session(1,"Misout的部落格"));
    // 其它業務邏輯
} finally {
    threadLocal.remove();
}

複製程式碼

三.ThreadLocal的應用場景

最常見的ThreadLocal使用場景為 用來解決 資料庫連線、Session管理等。

private static ThreadLocal<Connection> connectionHolder
= new ThreadLocal<Connection>() {
public Connection initialValue() {
    return DriverManager.getConnection(DB_URL);
}
};
 
public static Connection getConnection() {
return connectionHolder.get();
}
複製程式碼

private static final ThreadLocal<Session> threadLocal = new ThreadLocal<Session>();

//獲取Session
public static Session getCurrentSession(){
    Session session =  threadLocal.get();
    //判斷Session是否為空，如果為空，將建立一個session，並設定到本地執行緒變數中
    try {
        if(session ==null&&!session.isOpen()){
            if(sessionFactory==null){
                rbuildSessionFactory();// 建立Hibernate的SessionFactory
            }else{
                session = sessionFactory.openSession();
            }
        }
        threadLocal.set(session);
    } catch (Exception e) {
        // TODO: handle exception
    }

    return session;
}

複製程式碼

private static final ThreadLocal threadSession = new ThreadLocal();
 
public static Session getSession() throws InfrastructureException {
    Session s = (Session) threadSession.get();
    try {
        if (s == null) {
            s = getSessionFactory().openSession();
            threadSession.set(s);
        }
    } catch (HibernateException ex) {
        throw new InfrastructureException(ex);
    }
    return s;
}
複製程式碼

每個執行緒訪問資料庫都應當是一個獨立的Session會話，如果多個執行緒共享同一個Session會話，有可能其他執行緒關閉連線了，當前執行緒再執行提交時就會出現會話已關閉的異常，導致系統異常。此方式能避免執行緒爭搶Session，提高併發下的安全性。

使用ThreadLocal的典型場景正如上面的資料庫連線管理，執行緒會話管理等場景，只適用於獨立變數副本的情況，如果變數為全域性共享的，則不適用在高併發下使用。

總結

• 每個ThreadLocal只能儲存一個變數副本，如果想要一個執行緒能夠儲存多個副本，就需要建立多個ThreadLocal。
• ThreadLocal內部的ThreadLocalMap鍵為弱引用，會有記憶體洩漏的風險。
• 適用於無狀態，副本變數獨立後不影響業務邏輯的高併發場景。如果如果業務邏輯強依賴於副本變數，則不適合用ThreadLocal解決，需要另尋解決方案。