ThreadLocal就是這麼簡單

Java3y發表於2018-04-03

前言

今天要研究的是ThreadLocal,這個我在一年前學習JavaWeb基礎的時候接觸過一次,當時在baidu搜出來的第一篇博文ThreadLocal,在評論下很多開發者認為那博主理解錯誤,給出了很多有關的連結來指正(可原博主可能沒上部落格了,一直沒做修改)。我也去學習了一番,可惜的是當時還沒有記錄的習慣,直到現在僅僅記住了一些當時學過的皮毛。

因此,做一些技術的記錄是很重要的~同時,ThreadLocal也是面試非常常見的面試題,對Java開發者而言也是一個必要掌握的知識點~

當然了,如果我有寫錯的地方請大家多多包涵,歡迎在評論下留言指正~

一、什麼是ThreadLocal

宣告:本文使用的是JDK 1.8

首先我們來看一下JDK的文件介紹:


/**
 * This class provides thread-local variables.  These variables differ from
 * their normal counterparts in that each thread that accesses one (via its
 * {@code get} or {@code set} method) has its own, independently initialized
 * copy of the variable.  {@code ThreadLocal} instances are typically private
 * static fields in classes that wish to associate state with a thread (e.g.,
 * a user ID or Transaction ID).
 * 
 * <p>For example, the class below generates unique identifiers local to each
 * thread.
 * A thread's id is assigned the first time it invokes {@code ThreadId.get()}
 * and remains unchanged on subsequent calls.
 */  	
	
複製程式碼

結合我的總結可以這樣理解:ThreadLocal提供了執行緒的區域性變數,每個執行緒都可以通過set()get()來對這個區域性變數進行操作,但不會和其他執行緒的區域性變數進行衝突,實現了執行緒的資料隔離~。

簡要言之:往ThreadLocal中填充的變數屬於當前執行緒,該變數對其他執行緒而言是隔離的。

二、為什麼要學習ThreadLocal?

從上面可以得出:ThreadLocal可以讓我們擁有當前執行緒的變數,那這個作用有什麼用呢???

2.1管理Connection

**最典型的是管理資料庫的Connection:**當時在學JDBC的時候,為了方便操作寫了一個簡單資料庫連線池,需要資料庫連線池的理由也很簡單,頻繁建立和關閉Connection是一件非常耗費資源的操作,因此需要建立資料庫連線池~

那麼,資料庫連線池的連線怎麼管理呢??我們交由ThreadLocal來進行管理。為什麼交給它來管理呢??ThreadLocal能夠實現當前執行緒的操作都是用同一個Connection,保證了事務!

當時候寫的程式碼:


public class DBUtil {
    //資料庫連線池
    private static BasicDataSource source;

    //為不同的執行緒管理連線
    private static ThreadLocal<Connection> local;


    static {
        try {
            //載入配置檔案
            Properties properties = new Properties();

            //獲取讀取流
            InputStream stream = DBUtil.class.getClassLoader().getResourceAsStream("連線池/config.properties");

            //從配置檔案中讀取資料
            properties.load(stream);

            //關閉流
            stream.close();

            //初始化連線池
            source = new BasicDataSource();

            //設定驅動
            source.setDriverClassName(properties.getProperty("driver"));

            //設定url
            source.setUrl(properties.getProperty("url"));

            //設定使用者名稱
            source.setUsername(properties.getProperty("user"));

            //設定密碼
            source.setPassword(properties.getProperty("pwd"));

            //設定初始連線數量
            source.setInitialSize(Integer.parseInt(properties.getProperty("initsize")));

            //設定最大的連線數量
            source.setMaxActive(Integer.parseInt(properties.getProperty("maxactive")));

            //設定最長的等待時間
            source.setMaxWait(Integer.parseInt(properties.getProperty("maxwait")));

            //設定最小空閒數
            source.setMinIdle(Integer.parseInt(properties.getProperty("minidle")));

            //初始化執行緒本地
            local = new ThreadLocal<>();


        } catch (IOException e) {
            e.printStackTrace();
        }
    }

    public static Connection getConnection() throws SQLException {
        
        if(local.get()!=null){
            return local.get();
        }else{
        
            //獲取Connection物件
            Connection connection = source.getConnection();
    
            //把Connection放進ThreadLocal裡面
            local.set(connection);
    
            //返回Connection物件
            return connection;
        }

    }

    //關閉資料庫連線
    public static void closeConnection() {
        //從執行緒中拿到Connection物件
        Connection connection = local.get();

        try {
            if (connection != null) {
                //恢復連線為自動提交
                connection.setAutoCommit(true);

                //這裡不是真的把連線關了,只是將該連線歸還給連線池
                connection.close();

                //既然連線已經歸還給連線池了,ThreadLocal儲存的Connction物件也已經沒用了
                local.remove();

            }
        } catch (SQLException e) {
            e.printStackTrace();
        }
    }


}
複製程式碼

同樣的,Hibernate對Connection的管理也是採用了相同的手法(使用ThreadLocal,當然了Hibernate的實現是更強大的)~

2.2避免一些引數傳遞

避免一些引數的傳遞的理解可以參考一下Cookie和Session:

  • 每當我訪問一個頁面的時候,瀏覽器都會幫我們從硬碟中找到對應的Cookie傳送過去。
  • 瀏覽器是十分聰明的,不會傳送別的網站的Cookie過去,只帶當前網站釋出過來的Cookie過去

瀏覽器就相當於我們的ThreadLocal,它僅僅會傳送我們當前瀏覽器存在的Cookie(ThreadLocal的區域性變數),不同的瀏覽器對Cookie是隔離的(Chrome,Opera,IE的Cookie是隔離的【在Chrome登陸了,在IE你也得重新登陸】),同樣地:執行緒之間ThreadLocal變數也是隔離的....

那上面避免了引數的傳遞了嗎??其實是避免了。Cookie並不是我們手動傳遞過去的,並不需要寫<input name= cookie/>來進行傳遞引數...

在編寫程式中也是一樣的:日常中我們要去辦理業務可能會有很多地方用到身份證,各類證件,每次我們都要掏出來很麻煩


    // 諮詢時要用身份證,學生證,房產證等等....
    public void consult(IdCard idCard,StudentCard studentCard,HourseCard hourseCard){

    }

    // 辦理時還要用身份證,學生證,房產證等等....
    public void manage(IdCard idCard,StudentCard studentCard,HourseCard hourseCard) {

    }

    //......

複製程式碼

而如果用了ThreadLocal的話,ThreadLocal就相當於一個機構,ThreadLocal機構做了記錄你有那麼多張證件。用到的時候就不用自己掏了,問機構拿就可以了。

在諮詢時的時候就告訴機構:來,把我的身份證、房產證、學生證通通給他。在辦理時又告訴機構:來,把我的身份證、房產證、學生證通通給他。...


    // 諮詢時要用身份證,學生證,房產證等等....
    public void consult(){

        threadLocal.get();
    }

    // 辦理時還要用身份證,學生證,房產證等等....
    public void takePlane() {
        threadLocal.get();
    }

複製程式碼

這樣是不是比自己掏方便多了。

當然了,ThreadLocal可能還會有其他更好的作用,如果知道的同學可在評論留言哦~~~

三、ThreadLocal實現的原理

想要更好地去理解ThreadLocal,那就得翻翻它是怎麼實現的了~~~

宣告:本文使用的是JDK 1.8

首先,我們來看一下ThreadLocal的set()方法,因為我們一般使用都是new完物件,就往裡邊set物件了


    public void set(T value) {

		// 得到當前執行緒物件
        Thread t = Thread.currentThread();
		
		// 這裡獲取ThreadLocalMap
        ThreadLocalMap map = getMap(t);

		// 如果map存在,則將當前執行緒物件t作為key,要儲存的物件作為value存到map裡面去
        if (map != null)
            map.set(this, value);
        else
            createMap(t, value);
    }

複製程式碼

上面有個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是ThreadLocal的一個內部類。用Entry類來進行儲存

我們的值都是儲存到這個Map上的,key是當前ThreadLocal物件

如果該Map不存在,則初始化一個:


    void createMap(Thread t, T firstValue) {
        t.threadLocals = new ThreadLocalMap(this, firstValue);
    }
複製程式碼

如果該Map存在,則從Thread中獲取


    /**
     * Get the map associated with a ThreadLocal. Overridden in
     * InheritableThreadLocal.
     *
     * @param  t the current thread
     * @return the map
     */
    ThreadLocalMap getMap(Thread t) {
        return t.threadLocals;
    }

複製程式碼

Thread維護了ThreadLocalMap變數


    /* ThreadLocal values pertaining to this thread. This map is maintained
     * by the ThreadLocal class. */
    ThreadLocal.ThreadLocalMap threadLocals = null
複製程式碼

從上面又可以看出,ThreadLocalMap是在ThreadLocal中使用內部類來編寫的,但物件的引用是在Thread中

於是我們可以總結出:Thread為每個執行緒維護了ThreadLocalMap這麼一個Map,而ThreadLocalMap的key是LocalThread物件本身,value則是要儲存的物件

有了上面的基礎,我們看get()方法就一點都不難理解了:


    public T get() {
        Thread t = Thread.currentThread();
        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();
    }
複製程式碼

3.1ThreadLocal原理總結

  1. 每個Thread維護著一個ThreadLocalMap的引用
  2. ThreadLocalMap是ThreadLocal的內部類,用Entry來進行儲存
  3. 呼叫ThreadLocal的set()方法時,實際上就是往ThreadLocalMap設定值,key是ThreadLocal物件,值是傳遞進來的物件
  4. 呼叫ThreadLocal的get()方法時,實際上就是往ThreadLocalMap獲取值,key是ThreadLocal物件
  5. ThreadLocal本身並不儲存值,它只是作為一個key來讓執行緒從ThreadLocalMap獲取value

正因為這個原理,所以ThreadLocal能夠實現“資料隔離”,獲取當前執行緒的區域性變數值,不受其他執行緒影響~

四、避免記憶體洩露

我們來看一下ThreadLocal的物件關係引用圖:

ThreadLocal就是這麼簡單

ThreadLocal記憶體洩漏的根源是:由於ThreadLocalMap的生命週期跟Thread一樣長,如果沒有手動刪除對應key就會導致記憶體洩漏,而不是因為弱引用

想要避免記憶體洩露就要手動remove()掉

五、總結

ThreadLocal這方面的博文真的是數不勝數,隨便一搜就很多很多~站在前人的肩膀上總結了這篇博文~

最後要記住的是:ThreadLocal設計的目的就是為了能夠在當前執行緒中有屬於自己的變數,並不是為了解決併發或者共享變數的問題

如果看得不夠過癮,覺得不夠深入的同學可參考下面的連結,很多的博主還開展了一些擴充套件知識,我就不一一展開了~

參考博文:

ThreadLocal就是這麼簡單

如果文章有錯的地方歡迎指正,大家互相交流。習慣在微信看技術文章,想要獲取更多的Java資源的同學,可以關注微信公眾號:Java3y

相關文章