Java線程本地變量導致的緩存問題解決方法

更新時間：2024年08月30日 10:53:28 作者：從零開始的-CodeNinja之路

使用緩存可以緩解大流量壓力,顯著提高程序的性能,我們在使用緩存系統(tǒng)時,尤其是大并發(fā)情況下,經(jīng)常會遇到一些疑難雜癥,這篇文章主要給大家介紹了關于Java線程本地變量導致的緩存問題的解決方法,需要的朋友可以參考下,

一、前言

前些時間看別人寫的一段關于鎖的（對象緩存+線程本地變量）的一段代碼，這段代碼大致描述了這么一個功能：

外部傳入一個key，需要根據(jù)這個key去全局變量里面找是否存在，如有有則表示有人對這個key加鎖了，往下就不執(zhí)行具體業(yè)務代碼，同時，同時哦還要判斷這個key是不是當前線程持有的，如果不是當前線程持有的也不能往下執(zhí)行業(yè)務代碼～

然后哦還要在業(yè)務代碼執(zhí)行完成后釋放這個key鎖，也就是要從 ThreadLocal 里面移除這個key。

當然需求不僅于此，就是業(yè)務的特殊性需要 ThreadLocal 同時持有多個不同的key，這就表明 ThreadLocal 的泛型肯定是個List或Set。

然后再說下代碼，為了演示問題代碼寫的比較簡略，以下我再一一說明可能存在的問題??

二、基本邏輯

功能大致包含兩個函數(shù):

lock : 主要是查找公共緩存還有線程本地變量是否包含傳入的指定key，若無則嘗試寫入全局變量及 ThreadLocal 并返回true以示獲取到鎖

release ：業(yè)務邏輯處理完成后調用此，此函數(shù)內主要是做全局緩存以及 ThreadLocal 內的key的移除并返回狀態(tài)(true/false)

contains : 公共方法，供以上兩個方法使用，邏輯：判斷全局變量或 ThreadLocal 里面有否有指定的key，此方法用 private 修飾
好了，準備看代碼 ??

代碼如下：

public class CacheObjectLock {
    // 全局對象緩存
    private static List<Object> GLOBAL_CACHE = new ArrayList<Object>(8);
    // 線程本地變量
    private static ThreadLocal<List<Object>> THREAD_CACHE = new ThreadLocal<List<Object>>();
 
    // 嘗試加鎖
    public synchronized boolean lock(Object obj){
        if(this.contains(obj)){
            return false;
        }
        List al = null;
        if((al=THREAD_CACHE.get())==null){
            al = new ArrayList(2);
            THREAD_CACHE.set(al);
        }
        al.add(obj);
        GLOBAL_CACHE.add(obj);
        return true;
 
    }
    // 判斷是否存在key
    public boolean contains(Object obj){
        List<Object> objs;
        return GLOBAL_CACHE.contains(obj)?true:(objs=THREAD_CACHE.get())==null?false:objs.contains(obj);
    }
 
    // 釋放key鎖，與上面的 lock 方法對應 
    public boolean release(Object obj){
        if( this.contains(obj) ){
            List<Object> objs = THREAD_CACHE.get();
            if(null!=objs){
                objs.remove(obj);
                GLOBAL_CACHE.remove(obj);
            }
            return true;
        }
        return false;
    }
}

三、測試代碼

因為是鎖，所以必須要使用多線程測試，這里我簡單使用 parallel stream +多輪循環(huán)去測試:

public class CacheObjectLockTest {
    private CacheObjectLock LOCK = new CacheObjectLock();
 
    public void test1(){
        IntStream.range(0,10000).parallel().forEach(i->{
            if(i%3==0){
                i-=2;
            }
            Boolean b = null;
            if((b=LOCK.lock(i))==false ){
                return ;
            }
            Boolean c = null;
            try {
                // do something ...
//                TimeUnit.MILLISECONDS.sleep(1);
            } catch (Exception e) {
                throw new RuntimeException(e);
            }finally {
                c = LOCK.release(i);
            }
            if(b!=c){
                System.out.println("b:"+b+" c:"+c+" => "+Thread.currentThread().getName());
            }
        });
//        LOCK.contains(9);
    }
 
    @Test
    public void test2(){
        for(int i=0;i<10;i++){
            this.test1();
        }
    }
}

測試結果

分析

顯而易見，這是沒有對 release 加鎖導致的，其實呢，這樣說是不準確的…
首先要明白 lock 上加的 synchronized 的同步鎖的范圍是對當前實例的，而 release 是沒有加 synchronized ，所以 release 是無視 lock 上加的 synchronized

再仔細看看 GLOBAL_CACHE 是什么？ArrayList ，明白了吧 ArrayList 不是線程安全的，因為 synchronized 的范圍只是 lock 函數(shù)這一函數(shù)內，從測試代碼可看到 LOCK.lock(i)

開始一直到 LOCK.release(i) 這中間是沒有加同步鎖的，所以到 LOCK.lock(i) 開始一直到 LOCK.release(i) 這中間是存在線程競爭的，恰好又碰到 ArrayList 這一不安全因素自然會拋錯的！

因為存在不安全類，所以我們有理由懷疑 THREAD_CACHE 的泛型變量也是存在多線程異常的，因為它這個泛型也是 ArrayList ！

四、解決鎖問題

好了，明白了問題之所在，自然解決辦法也十分easy：

在 release 方法上添加 synchronized 聲明，這樣簡單粗暴

分別對 objs.remove(obj); 以及 GLOBAL_CACHE.remove(obj); 加同步鎖，這樣顆粒度更細

因為 synchronized 是寫獨占的，所以無需在 contains 中單獨加鎖

代碼 (這里僅有 release 變更)

    public synchronized boolean release(Object obj){
        if( this.contains(obj) ){
            List<Object> objs = THREAD_CACHE.get();
            if(null!=objs){
//                synchronized (objs){
                    objs.remove(obj);
//                }
//                synchronized (GLOBAL_CACHE){
                    GLOBAL_CACHE.remove(obj);
//                }
            }
            return true;
        }
        return false;
    }

測試結果

分析??

測試了多輪都是成功的，沒有任何異常，難道就一定沒有異常了？？？

非也，非也~~~

為了讓問題體現(xiàn)的的更清晰，先修改下測試用例并把 contains 方法置為 public,然后測試用例:

public class CacheObjectLockTest {
    private CacheObjectLock2 LOCK = new CacheObjectLock2();
 
    public void test1(){
        IntStream.range(0,10000).parallel().forEach(i->{
//            String it = "K"+i;
            if(i%3==0){
                i-=2;
            }
            Boolean b = null;
            if((b=LOCK.lock(i))==false ){
                return ;
            }
            Boolean c = null;
            try {
                // do something ...
//                TimeUnit.MILLISECONDS.sleep(1);
            } catch (Exception e) {
                throw new RuntimeException(e);
            }finally {
                c = LOCK.release(i);
            }
            if(b!=c){
                System.out.println("b:"+b+" c:"+c+" => "+Thread.currentThread().getName());
            }
        });
        LOCK.contains(9);
    }
 
    @Test
    public void test2(){
        for(int i=0;i<10;i++){
            this.test1();
        }
    }
}

在這一行打上斷點 LOCK.contains(9); 然后逐步進入到 ThreadLocal 的 get() 方法中：

看到?jīng)]，雖然key已經(jīng)被移除的，但是 ThreadLocal 里面關聯(lián)的是 key外層的 ArrayList , 因為開發(fā)機配置都較好，一旦導致 ThreadLocal 膨脹,則 OOM 是必然的事兒！

我們知道 ThreadLocal 的基本特性，它會根據(jù)線程分開存放各自線程的所 set 進來的對象，若沒有調用其 remove 方法，變量會一直存在 ThreadLocal 這個 map 中，

若上述的測試代碼放在線程池里面被管理，線程池會根據(jù)負載會增減線程，如果每一次執(zhí)行上述代碼用的線程都不是固定的 ThreadLocal 必然會導致 jvm OOM ??

這就像 java 里面的文件讀寫，open 之后必須要要有 close 操作。

五、解決ThreadLocal問題

最后更改代碼如下：

public class CacheObjectLock3 {
    private static List<Object> GLOBAL_CACHE = new ArrayList<Object>(8);
    private static ThreadLocal<List<Object>> THREAD_CACHE = new ThreadLocal<List<Object>>();
    
    public synchronized boolean lock(Object obj){
        if(this.contains(obj)){
            return false;
        }
        List al = null;
        if((al=THREAD_CACHE.get())==null){
            al = new ArrayList(2);
            THREAD_CACHE.set(al);
        }
        al.add(obj);
        GLOBAL_CACHE.add(obj);
        return true;
 
    }
 
    public boolean contains(Object obj){
        List<Object> objs;
        return GLOBAL_CACHE.contains(obj)?true:(objs=THREAD_CACHE.get())==null?false:objs.contains(obj);
    }
 
    public synchronized boolean release(Object obj){
        if( this.contains(obj) ){
            List<Object> objs = THREAD_CACHE.get();
            if(null!=objs){
//                synchronized (objs){
                    objs.remove(obj);
                    if(objs.isEmpty()){
                        THREAD_CACHE.remove();
                    }
//                }
//                synchronized (GLOBAL_CACHE){
                    GLOBAL_CACHE.remove(obj);
//                }
            }
            return true;
        }
        return false;
    }
 
}

測試結果

測試 ok 通過 ~