Java ThreadLocal類使用詳解

前言

這幾天看《Java並發編程之美》的時候又遇到瞭ThradLocal這個類,不得不說,這個類在平時很多場景都遇得到,所以對其進行一個系統性的學習,然後再輸出成這篇博客。 那麼,什麼是ThreadLocal呢? 我們都知道,多線程訪問同一個共享變量很容易出現並發問題,特別是當多個線程對同一個共享變量進行寫入操作時。一般為瞭避免這種情況,我們會使用synchronized這個關鍵字對代碼塊加鎖。但是這種方式一是會讓沒獲取到鎖的線程進行阻塞等待,二是需要使用者對鎖有一定的瞭解,無疑提高瞭編程的難度。其實ThreadLocal 就可以做這件事情,雖然ThreadLocal 並不是為瞭解決這個問題而出現的。 ThreadLocal 是JDK 包提供的,它提供瞭線程本地變量,也就是如果你創建瞭一個ThreadLocal 變量,那麼訪問這個變量的每個線程都會有這個變量的一個本地副本。當多個線程操作這個變量時,實際操作的是自己本地內存裡面的變量,從而避免瞭線程安全問題。

如圖所示: 

快速開始

接下來我們就先用一個簡單的樣例給大傢展示一下ThreadLocal的基本用法

package cuit.pymjl.thradlocal;

/**
 * @author Pymjl
 * @version 1.0
 * @date 2022/7/1 10:56
 **/
public class MainTest {
    static ThreadLocal<String> threadLocal = new ThreadLocal<>();
​
    static void print(String str) {
        //打印當前線程中本地內存中本地變量的值
        System.out.println(str + " :" + threadLocal.get());
        //清除本地內存中的本地變量
        threadLocal.remove();
    }
​
    public static void main(String[] args) {
        Thread t1 = new Thread(new Runnable() {
            @Override
            public void run() {
                //設置線程1中本地變量的值
                threadLocal.set("thread1 local variable");
                //調用打印方法
                print("thread1");
                //打印本地變量
                System.out.println("after remove : " + threadLocal.get());
            }
        });
​
        Thread t2 = new Thread(new Runnable() {
            @Override
            public void run() {
                //設置線程1中本地變量的值
                threadLocal.set("thread2 local variable");
                //調用打印方法
                print("thread2");
                //打印本地變量
                System.out.println("after remove : " + threadLocal.get());
            }
        });
​
        t1.start();
        t2.start();
    }
}

運行結果如圖所示:

ThreadLocal的原理

ThreadLocal相關類圖

我們先來看一下ThreadLocal 相關類的類圖結構,如圖所示: 

 由該圖可知, Thread 類中有一個threadLocals 和一個inheritableThreadLocals , 它們都是ThreadLocalMap 類型的變量, 而ThreadLocalMap 是一個定制化的Hashmap 。在默認情況下, 每個線程中的這兩個變量都為null ,隻有當前線程第一次調用ThreadLocal 的set 或者get 方法時才會創建它們。其實每個線程的本地變量不是存放在ThreadLocal 實例裡面,而是存放在調用線程的threadLocals 變量裡面。也就是說, ThreadLocal 類型的本地變量存放在具體的線程內存空間中。ThreadLocal 就是一個工具殼,它通過set 方法把value 值放入調用線程的threadLocals 裡面並存放起來, 當調用線程調用它的get 方法時,再從當前線程的threadLocals 變量裡面將其拿出來使用。 如果調用線程一直不終止, 那麼這個本地變量會一直存放在調用線程的threadLocals 變量裡面,所以當不需要使用本地變量時可以通過調用ThreadLocal 變量的remove 方法,從當前線程的threadLocals 裡面刪除該本地變量。另外, Thread 裡面的threadLocals 為何被設計為map 結構?很明顯是因為每個線程可以關聯多個ThreadLocal 變量。 接下來我們來看看ThreadLocal的set、get、以及remove的源碼

set

    public void set(T value) {
        // 1.獲取當前線程(調用者線程)
        Thread t = Thread.currentThread();
        // 2.以當前線程作為key值,去查找對應的線程變量,找到對應的map
        ThreadLocalMap map = getMap(t);
        if (map != null) {
            // 3.如果map不為null,則直接添加元素
            map.set(this, value);
        } else {
            // 4.否則就先創建map,再添加元素
            createMap(t, value);
        }
    }
    void createMap(Thread t, T firstValue) {
        /**
         * 這裡是創建一個ThreadLocalMap,以當前調用線程的實例對象為key,初始值為value
         * 然後放入當前線程的Therad.threadLocals屬性裡面
         */
        t.threadLocals = new ThreadLocalMap(this, firstValue);
    }
    ThreadLocalMap getMap(Thread t) {
        //這裡就是直接獲取調用線程的成員屬性threadlocals
        return t.threadLocals;
    }

get

    public T get() {
        // 1.獲取當前線程
        Thread t = Thread.currentThread();
        // 2.獲取當前線程的threadlocals,即ThreadLocalMap
        ThreadLocalMap map = getMap(t);
        // 3.如果map不為null,則直接返回對應的值
        if (map != null) {
            ThreadLocalMap.Entry e = map.getEntry(this);
            if (e != null) {
                @SuppressWarnings("unchecked")
                T result = (T)e.value;
                return result;
            }
        }
        // 4.否則,則進行初始化
        return setInitialValue();
    }

下面是setInitialValue的代碼

private T setInitialValue() {
    //初始化屬性,其實就是null
    T value = initialValue();
    //獲取當前線程
    Thread t = Thread.currentThread();
    //通過當前線程獲取ThreadLocalMap
    ThreadLocalMap map = getMap(t);
    //如果map不為null,則直接添加元素
    if (map != null) {
        map.set(this, value);
    } else {
        //否則就創建,然後將創建好的map放入當前線程的屬性threadlocals
        createMap(t, value);
    }
        //將當前ThreadLocal實例註冊進TerminatingThreadLocal類裡面
    if (this instanceof TerminatingThreadLocal) {
        TerminatingThreadLocal.register((TerminatingThreadLocal<?>) this);
    }
    return value;
}

這裡我需要補充說明一下TerminatingThreadLocal。這個類是jdk11新出的,jdk8中並沒有這個類,所以在網上很多源碼分析中並未看見這個類的相關說明。 這個類我看瞭一下源碼,其作用應該是避免ThreadLocal內存泄露的問題(感興趣的可以去看看源碼,若有錯誤,還請指正)。 這是官方對其的解釋:

/**
 * A thread-local variable that is notified when a thread terminates and
 * it has been initialized in the terminating thread (even if it was
 * initialized with a null value).
 * 一個線程局部變量,
 * 當一個線程終止並且它已經在終止線程中被初始化時被通知(即使它被初始化為一個空值)。
 */

remove

     public void remove() {
         //如果當前線程的threadLocals 變量不為空, 則刪除當前線程中指定ThreadLocal 實例的本地變量。
         ThreadLocalMap m = getMap(Thread.currentThread());
         if (m != null) {
             m.remove(this);
         }
     }

小結

在每個線程內部都有一個名為threadLocals 的成員變量, 該變量的類型為Hash Map , 其中key 為我們定義的ThreadLocal 變量的this 引用, value 則為我們使用set 方法設置的值。每個線程的本地變量存放在線程自己的內存變量threadLocals 中,如果當前線程一直不消亡, 那麼這些本地變量會一直存在, 所以可能會造成內存溢出, 因此使用完畢後要記得調用ThreadLocal 的remove 方法刪除對應線程的threadLocals 中的本地變量。

ThreadLocal內存泄露

為什麼會出現內存泄漏?

ThreadLocalMap使用ThreadLocal的弱引用作為key,如果一個ThreadLocal沒有外部強引用來引用它,那麼系統 GC 的時候,這個ThreadLocal勢必會被回收,這樣一來,ThreadLocalMap中就會出現key為null的Entry,就沒有辦法訪問這些key為null的Entry的value,如果當前線程再遲遲不結束的話,這些key為null的Entry的value就會一直存在一條強引用鏈:Thread Ref -> Thread -> ThreaLocalMap -> Entry -> value永遠無法回收,造成內存泄漏。 其實,ThreadLocalMap的設計中已經考慮到這種情況,也加上瞭一些防護措施:在ThreadLocal的get(),set(),remove()的時候都會清除線程ThreadLocalMap裡所有key為null的value。 但是這些被動的預防措施並不能保證不會內存泄漏:

  • 使用static的ThreadLocal,延長瞭ThreadLocal的生命周期,可能導致的內存泄漏
  • 分配使用瞭ThreadLocal又不再調用get(),set(),remove()方法,那麼就會導致內存泄漏

為什麼使用弱引用?

既然我們都知道,使用瞭弱引用會造成ThreadLocalMap內存泄漏,那麼官方為什麼依然使用弱引用而不是強引用呢?這就要從使用弱引用和強引用的區別來說起瞭:

  • 如果使用強引用:我們知道,ThreadLocalMap的生命周期基本和Thread的生命周期一樣,當前線程如果沒有終止,那麼ThreadLocalMap始終不會被GC回收,而ThreadLocalMap持有對ThreadLocal的強引用,那麼ThreadLocal也不會被回收,當線程生命周期長,如果沒有手動刪除,則會造成kv累積,從而導致OOM
  • 如果使用弱引用:弱引用中的對象具有很短的聲明周期,因為在系統GC時,隻要發現弱引用,不管堆空間是否足夠,都會將對象進行回收。而當ThreadLocal的強引用被回收時,ThreadLocalMap所持有的弱引用也會被回收,如果沒有手動刪除kv,那麼會造成value累積,也會導致OOM

對比可知,使用弱引用至少可以保證不會因為map的key累積從而導致OOM,而對應的value可以通過remove,get,set方法在下一次調用時被清除。可見,內存泄露的根源不是弱引用,而是ThreadLocalMap的生命周期和Thread一樣長,造成累積導致的

解決方法

既然問題的根源是value的累積造成OOM,那麼我們對癥下藥,每次使用完ThreadLocal調用remove()方法清理掉就行瞭。

總結

到此這篇關於Java ThreadLocal類詳解的文章就介紹到這瞭,更多相關Java ThreadLocal 內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet!

推薦閱讀: