Guava Cache用法介紹

背景

緩存的主要作用是暫時在內存中保存業務系統的數據處理結果，並且等待下次訪問使用。在日長開發有很多場合，有一些數據量不是很大，不會經常改動，並且訪問非常頻繁。但是由於受限於硬盤IO的性能或者遠程網絡等原因獲取可能非常的費時。會導致我們的程序非常緩慢，這在某些業務上是不能忍的！而緩存正是解決這類問題的神器！

 

當然也並不是說你用了緩存你的系統就一定會變快，建議在用之前看一下使用緩存的9大誤區(上) 使用緩存的9大誤區(下)

緩存在很多系統和架構中都用廣泛的應用,例如：

• CPU緩存
• 操作系統緩存
• HTTP緩存
• 數據庫緩存
• 靜態文件緩存
• 本地緩存
• 分布式緩存

可以說在計算機和網絡領域，緩存是無處不在的。可以這么說，只要有硬件性能不對等，涉及到網絡傳輸的地方都會有緩存的身影。

緩存總體可分為兩種 集中式緩存 和 分布式緩存

“集中式緩存"與"分布式緩存"的區別其實就在於“集中”與"非集中"的概念，其對象可能是服務器、內存條、硬盤等。比如：

1.服務器版本：

• 緩存集中在一台服務器上，為集中式緩存。
• 緩存分散在不同的服務器上，為分布式緩存。

2.內存條版本：

• 緩存集中在一台服務器的一條內存條上，為集中式緩存。
• 緩存分散在一台服務器的不同內存條上，為分布式緩存。

3.硬盤版本：

• 緩存集中在一台服務器的一個硬盤上，為集中式緩存。
• 緩存分散在一台服務器的不同硬盤上，為分布式緩存。

想了解分布式緩存可以看一下淺談分布式緩存那些事兒。

這是幾個當前比較流行的java 分布式緩存框架5個強大的Java分布式緩存框架推薦。

而我們今天要講的是集中式內存緩存guava cache,這是當前我們項目正在用的緩存工具，研究一下感覺還蠻好用的。當然也有很多其他工具，還是看個人喜歡。oschina上面也有很多類似開源的java緩存框架

正文

Guava Cache與ConcurrentMap很相似，但也不完全一樣。最基本的區別是ConcurrentMap會一直保存所有添加的元素，直到顯式地移除。相對地，Guava Cache為了限制內存占用，通常都設定為自動回收元素。在某些場景下，盡管LoadingCache 不回收元素，它也是很有用的，因為它會自動加載緩存。

Guava Cache是在內存中緩存數據，相比較於數據庫或redis存儲，訪問內存中的數據會更加高效。Guava官網介紹，下面的這幾種情況可以考慮使用Guava Cache：

1. 願意消耗一些內存空間來提升速度。

2. 預料到某些鍵會被多次查詢。

3. 緩存中存放的數據總量不會超出內存容量。

所以，可以將程序頻繁用到的少量數據存儲到Guava Cache中，以改善程序性能。下面對Guava Cache的用法進行詳細的介紹。

構建緩存對象

接口Cache代表一塊緩存，它有如下方法：

public interface Cache<K, V> {
    V get(K key, Callable<? extends V> valueLoader) throws ExecutionException;

    ImmutableMap<K, V> getAllPresent(Iterable<?> keys);

    void put(K key, V value);

    void putAll(Map<? extends K, ? extends V> m);

    void invalidate(Object key);

    void invalidateAll(Iterable<?> keys);

    void invalidateAll();

    long size();

    CacheStats stats();

    ConcurrentMap<K, V> asMap();

    void cleanUp();
}

可以通過CacheBuilder類構建一個緩存對象，CacheBuilder類采用builder設計模式，它的每個方法都返回CacheBuilder本身，直到build方法被調用。構建一個緩存對象代碼如下。

public class StudyGuavaCache {
    public static void main(String[] args) {
        Cache<String,String> cache = CacheBuilder.newBuilder().build();
        cache.put("word","Hello Guava Cache");
        System.out.println(cache.getIfPresent("word"));
    }
}

上面的代碼通過CacheBuilder.newBuilder().build()這句代碼創建了一個Cache緩存對象，並在緩存對象中存儲了key為word，value為Hello Guava Cache的一條記錄。可以看到Cache非常類似於JDK中的Map，但是相比於Map，Guava Cache提供了很多更強大的功能。

從LoadingCache查詢的正規方式是使用 get(K)方法。這個方法要么返回已經緩存的值，要么使用CacheLoader向緩存原子地加載新值（通過 load(String key) 方法加載）。由於CacheLoader可能拋出異常， LoadingCache.get(K)也聲明拋出ExecutionException異常。如果你定義的CacheLoader沒有聲明任何檢查型異常，則可以通過 getUnchecked(K)查找緩存；但必須注意，一旦CacheLoader聲明了檢查型異常，就不可以調用 getUnchecked(K)。

LoadingCache<Key, Value> cache = CacheBuilder.newBuilder()
       .build(
           new CacheLoader<Key, Value>() {
             public Value load(Key key) throws AnyException {
               return createValue(key);
             }
           });
...
try {
  return cache.get(key);
} catch (ExecutionException e) {
  throw new OtherException(e.getCause());
} 

設置最大存儲

Guava Cache可以在構建緩存對象時指定緩存所能夠存儲的最大記錄數量。當Cache中的記錄數量達到最大值后再調用put方法向其中添加對象，Guava會先從當前緩存的對象記錄中選擇一條刪除掉，騰出空間后再將新的對象存儲到Cache中。

public class StudyGuavaCache {
    public static void main(String[] args) {
        Cache<String,String> cache = CacheBuilder.newBuilder()
                .maximumSize(2)
                .build();
        cache.put("key1","value1");
        cache.put("key2","value2");
        cache.put("key3","value3");
        System.out.println("第一個值：" + cache.getIfPresent("key1"));
        System.out.println("第二個值：" + cache.getIfPresent("key2"));
        System.out.println("第三個值：" + cache.getIfPresent("key3"));
    }
}

上面代碼在構造緩存對象時，通過CacheBuilder類的maximumSize方法指定Cache最多可以存儲兩個對象，然后調用Cache的put方法向其中添加了三個對象。程序執行結果如下圖所示，可以看到第三條對象記錄的插入，導致了第一條對象記錄被刪除。

設置過期時間

在構建Cache對象時，可以通過CacheBuilder類的expireAfterAccess和expireAfterWrite兩個方法為緩存中的對象指定過期時間，使用`CacheBuilder`構建的緩存不會“自動”執行清理和逐出值，也不會在值到期后立即執行或逐出任何類型。相反，它在寫入操作期間執行少量維護，或者在寫入很少的情況下偶爾執行讀取操作。其中，expireAfterWrite方法指定對象被寫入到緩存后多久過期，expireAfterAccess指定對象多久沒有被訪問后過期。

public class StudyGuavaCache {
    public static void main(String[] args) throws InterruptedException {
        Cache<String,String> cache = CacheBuilder.newBuilder()
                .maximumSize(2)
                .expireAfterWrite(3,TimeUnit.SECONDS)
                .build();
        cache.put("key1","value1");
        int time = 1;
        while(true) {
            System.out.println("第" + time++ + "次取到key1的值為：" + cache.getIfPresent("key1"));
            Thread.sleep(1000);
        }
    }
}

上面的代碼在構造Cache對象時，通過CacheBuilder的expireAfterWrite方法指定put到Cache中的對象在3秒后會過期。在Cache對象中存儲一條對象記錄后，每隔1秒讀取一次這條記錄。程序運行結果如下圖所示，可以看到，前三秒可以從Cache中獲取到對象，超過三秒后，對象從Cache中被自動刪除。

下面代碼是expireAfterAccess的例子。

public class StudyGuavaCache {
    public static void main(String[] args) throws InterruptedException {
        Cache<String,String> cache = CacheBuilder.newBuilder()
                .maximumSize(2)
                .expireAfterAccess(3,TimeUnit.SECONDS)
                .build();
        cache.put("key1","value1");
        int time = 1;
        while(true) {
            Thread.sleep(time*1000);
            System.out.println("睡眠" + time++ + "秒后取到key1的值為：" + cache.getIfPresent("key1"));
        }
    }
}

通過CacheBuilder的expireAfterAccess方法指定Cache中存儲的對象如果超過3秒沒有被訪問就會過期。while中的代碼每sleep一段時間就會訪問一次Cache中存儲的對象key1，每次訪問key1之后下次sleep的時間會加長一秒。程序運行結果如下圖所示，從結果中可以看出，當超過3秒沒有讀取key1對象之后，該對象會自動被Cache刪除。

也可以同時用expireAfterAccess和expireAfterWrite方法指定過期時間，這時只要對象滿足兩者中的一個條件就會被自動過期刪除。

Guava Cache緩存過期后不一定會立馬被清理，一般會在Cache整體被讀取一定次數后清理。這中策略對性能是有好處的，如果想強制清理可以手動調用`Cache.cleanup()`或者使用`ScheduledExecutorService`來完成定期清理

弱引用

可以通過weakKeys和weakValues方法指定Cache只保存對緩存記錄key和value的弱引用。這樣當沒有其他強引用指向key和value時，key和value對象就會被垃圾回收器回收。

public class StudyGuavaCache {
    public static void main(String[] args) throws InterruptedException {
        Cache<String,Object> cache = CacheBuilder.newBuilder()
                .maximumSize(2)
                .weakValues()
                .build();
        Object value = new Object();
        cache.put("key1",value);

        value = new Object();//原對象不再有強引用
        System.gc();
        System.out.println(cache.getIfPresent("key1"));
    }
}

上面代碼的打印結果是null。構建Cache時通過weakValues方法指定Cache只保存記錄值的一個弱引用。當給value引用賦值一個新的對象之后，就不再有任何一個強引用指向原對象。System.gc()觸發垃圾回收后，原對象就被清除了。

顯示清除

可以調用Cache的invalidateAll或invalidate方法顯示刪除Cache中的記錄。invalidate方法一次只能刪除Cache中一個記錄，接收的參數是要刪除記錄的key。invalidateAll方法可以批量刪除Cache中的記錄，當沒有傳任何參數時，invalidateAll方法將清除Cache中的全部記錄。invalidateAll也可以接收一個Iterable類型的參數，參數中包含要刪除記錄的所有key值。下面代碼對此做了示例。

public class StudyGuavaCache {
    public static void main(String[] args) throws InterruptedException {
        Cache<String,String> cache = CacheBuilder.newBuilder().build();
        Object value = new Object();
        cache.put("key1","value1");
        cache.put("key2","value2");
        cache.put("key3","value3");

        List<String> list = new ArrayList<String>();
        list.add("key1");
        list.add("key2");

        cache.invalidateAll(list);//批量清除list中全部key對應的記錄
        System.out.println(cache.getIfPresent("key1"));
        System.out.println(cache.getIfPresent("key2"));
        System.out.println(cache.getIfPresent("key3"));
    }
}

代碼中構造了一個集合list用於保存要刪除記錄的key值，然后調用invalidateAll方法批量刪除key1和key2對應的記錄，只剩下key3對應的記錄沒有被刪除。

移除監聽器

可以為Cache對象添加一個移除監聽器，這樣當有記錄被刪除時可以感知到這個事件。

public class StudyGuavaCache {
    public static void main(String[] args) throws InterruptedException {
        RemovalListener<String, String> listener = new RemovalListener<String, String>() {
            public void onRemoval(RemovalNotification<String, String> notification) {
                System.out.println("[" + notification.getKey() + ":" + notification.getValue() + "] is removed!");
            }
        };
        Cache<String,String> cache = CacheBuilder.newBuilder()
                .maximumSize(3)
                .removalListener(listener)
                .build();
        Object value = new Object();
        cache.put("key1","value1");
        cache.put("key2","value2");
        cache.put("key3","value3");
        cache.put("key4","value3");
        cache.put("key5","value3");
        cache.put("key6","value3");
        cache.put("key7","value3");
        cache.put("key8","value3");
    }
}

removalListener方法為Cache指定了一個移除監聽器，這樣當有記錄從Cache中被刪除時，監聽器listener就會感知到這個事件。程序運行結果如下圖所示。

自動加載

Cache的get方法有兩個參數，第一個參數是要從Cache中獲取記錄的key，第二個記錄是一個Callable對象。當緩存中已經存在key對應的記錄時，get方法直接返回key對應的記錄。如果緩存中不包含key對應的記錄，Guava會啟動一個線程執行Callable對象中的call方法，call方法的返回值會作為key對應的值被存儲到緩存中，並且被get方法返回。下面是一個多線程的例子：

public class StudyGuavaCache {

    private static Cache<String,String> cache = CacheBuilder.newBuilder()
            .maximumSize(3)
            .build();

    public static void main(String[] args) throws InterruptedException {

        new Thread(new Runnable() {
            public void run() {
                System.out.println("thread1");
                try {
                    String value = cache.get("key", new Callable<String>() {
                        public String call() throws Exception {
                            System.out.println("load1"); //加載數據線程執行標志
                            Thread.sleep(1000); //模擬加載時間
                            return "auto load by Callable";
                        }
                    });
                    System.out.println("thread1 " + value);
                } catch (ExecutionException e) {
                    e.printStackTrace();
                }
            }
        }).start();

        new Thread(new Runnable() {
            public void run() {
                System.out.println("thread2");
                try {
                    String value = cache.get("key", new Callable<String>() {
                        public String call() throws Exception {
                            System.out.println("load2"); //加載數據線程執行標志
                            Thread.sleep(1000); //模擬加載時間
                            return "auto load by Callable";
                        }
                    });
                    System.out.println("thread2 " + value);
                } catch (ExecutionException e) {
                    e.printStackTrace();
                }
            }
        }).start();
    }
}

這段代碼中有兩個線程共享同一個Cache對象，兩個線程同時調用get方法獲取同一個key對應的記錄。由於key對應的記錄不存在，所以兩個線程都在get方法處阻塞。此處在call方法中調用Thread.sleep(1000)模擬程序從外存加載數據的時間消耗。代碼的執行結果如下圖：

從結果中可以看出，雖然是兩個線程同時調用get方法，但只有一個get方法中的Callable會被執行(沒有打印出load2)。Guava可以保證當有多個線程同時訪問Cache中的一個key時，如果key對應的記錄不存在，Guava只會啟動一個線程執行get方法中Callable參數對應的任務加載數據存到緩存。當加載完數據后，任何線程中的get方法都會獲取到key對應的值。

統計信息

可以對Cache的命中率、加載數據時間等信息進行統計。在構建Cache對象時，可以通過CacheBuilder的recordStats方法開啟統計信息的開關。開關開啟后Cache會自動對緩存的各種操作進行統計，調用Cache的stats方法可以查看統計后的信息。

public class StudyGuavaCache {
    public static void main(String[] args) throws InterruptedException {
        Cache<String,String> cache = CacheBuilder.newBuilder()
                .maximumSize(3)
                .recordStats() //開啟統計信息開關
                .build();
        cache.put("key1","value1");
        cache.put("key2","value2");
        cache.put("key3","value3");
        cache.put("key4","value4");

        cache.getIfPresent("key1");
        cache.getIfPresent("key2");
        cache.getIfPresent("key3");
        cache.getIfPresent("key4");
        cache.getIfPresent("key5");
        cache.getIfPresent("key6");

        System.out.println(cache.stats()); //獲取統計信息
    }
}

程序執行結果如下圖所示：

這些統計信息對於調整緩存設置是至關重要的，在性能要求高的應用中應該密切關注這些數據

LoadingCache

LoadingCache是Cache的子接口，相比較於Cache，當從LoadingCache中讀取一個指定key的記錄時，如果該記錄不存在，則LoadingCache可以自動執行加載數據到緩存的操作。LoadingCache接口的定義如下：

public interface LoadingCache<K, V> extends Cache<K, V>, Function<K, V> {

    V get(K key) throws ExecutionException;

    V getUnchecked(K key);

    ImmutableMap<K, V> getAll(Iterable<? extends K> keys) throws ExecutionException;

    V apply(K key);

    void refresh(K key);

    @Override
    ConcurrentMap<K, V> asMap();
}

與構建Cache類型的對象類似，LoadingCache類型的對象也是通過CacheBuilder進行構建，不同的是，在調用CacheBuilder的build方法時，必須傳遞一個CacheLoader類型的參數，CacheLoader的load方法需要我們提供實現。當調用LoadingCache的get方法時，如果緩存不存在對應key的記錄，則CacheLoader中的load方法會被自動調用從外存加載數據，load方法的返回值會作為key對應的value存儲到LoadingCache中，並從get方法返回。

public class StudyGuavaCache {
    public static void main(String[] args) throws ExecutionException {
        CacheLoader<String, String> loader = new CacheLoader<String, String> () {
            public String load(String key) throws Exception {
                Thread.sleep(1000); //休眠1s，模擬加載數據
                System.out.println(key + " is loaded from a cacheLoader!");
                return key + "'s value";
            }
        };

        LoadingCache<String,String> loadingCache = CacheBuilder.newBuilder()
                .maximumSize(3)
                .build(loader);//在構建時指定自動加載器

        loadingCache.get("key1");
        loadingCache.get("key2");
        loadingCache.get("key3");
    }
}

程序執行結果如下圖所示：

轉自：

https://segmentfault.com/a/1190000011105644

https://www.jianshu.com/p/64b0df87e51b