guava是google的一個開源java框架，其github地址是 https://github.com/google/guava。guava工程包含了若干被Google的 Java項目廣泛依賴的核心庫，例如：集合 [collections] 、緩存 [caching] 、原生類型支持 [primitives support] 、並發庫 [concurrency libraries] 、通用注解 [common annotations] 、字符串處理 [string processing] 、I/O 等等。 所有這些工具每天都在被Google的工程師應用在產品服務中。 其中caching這一塊是我常用的模塊的之一，今天就來分享一下我對guava cache的一些見解。
guava cache使用簡介
guava cache 是利用CacheBuilder類用builder模式構造出兩種不同的cache加載方式CacheLoader,Callable，共同邏輯都是根據key是加載value。不同的地方在於CacheLoader的定義比較寬泛，是針對整個cache定義的，可以認為是統一的根據key值load value的方法，而Callable的方式較為靈活，允許你在get的時候指定load方法。看以下代碼
Cache<String,Object> cache = CacheBuilder.newBuilder()
.expireAfterWrite(10, TimeUnit.SECONDS).maximumSize(500).build();
cache.get("key", new Callable<Object>() { //Callable 加載
@Override
public Object call() throws Exception {
return "value";
}
});
LoadingCache<String, Object> loadingCache = CacheBuilder.newBuilder()
.expireAfterAccess(30, TimeUnit.SECONDS).maximumSize(5)
.build(new CacheLoader<String, Object>() {
@Override
public Object load(String key) throws Exception {
return "value";
}
});
這里面有幾個參數expireAfterWrite、expireAfterAccess、maximumSize其實這幾個定義的都是過期策略。expireAfterWrite適用於一段時間cache可能會發先變化場景。expireAfterAccess是包括expireAfterWrite在內的，因為read和write操作都被定義的access操作。另外expireAfterAccess，expireAfterAccess都是受到maximumSize的限制。當緩存的數量超過了maximumSize時,guava cache會要據LRU算法淘汰掉最近沒有寫入或訪問的數據。這里的maximumSize指的是緩存的個數並不是緩存占據內存的大小。 如果想限制緩存占據內存的大小可以配置maximumWeight參數。
看代碼：
CacheBuilder.newBuilder().weigher(new Weigher<String, Object>() {
@Override
public int weigh(String key, Object value) {
return 0; //the value.size()
}
}).expireAfterWrite(10, TimeUnit.SECONDS).maximumWeight(500).build();
weigher返回每個cache value占據內存的大小，這個大小是由使用者自身定義的，並且put進內存時就已經確定后面就再不會發生變動。maximumWeight定義了所有cache value加起的weigher的總和不能超過的上限。
注意一點就是maximumWeight與maximumSize兩者只能生效一個是不能同時使用的！
guava cache的設計
guava cache作為一個被廣泛使用的緩存組件，設計上它有哪些過人之處？
先看下cache的類實現定義
class LocalCache<K, V> extends AbstractMap<K, V> implements ConcurrentMap<K, V> {....}
我們看到了ConcurrentMap,所以我們知道了一點guava cache基於ConcurrentHashMap的基礎上設計。所以ConcurrentHashMap的優點它也具備。既然實現了 ConcurrentMap那再看下guava cache中的Segment的實現是怎樣？
我們看到guava cache 中的Segment本質是一個ReentrantLock。內部定義了table,wirteQueue,accessQueue定義屬性。其中table是一個ReferenceEntry原子類數組，里面就存放了cache的內容。wirteQueue存放的是對table的寫記錄，accessQueue是訪問記錄。guava cache的expireAfterWrite,expireAfterAccess就是借助這個兩個queue來實現的。
了解了guava cache的大概存儲結構，下面看通過對cache的操作來進行更深入的了解。
put(key,val)操作。
public V put(K key, V value) {
checkNotNull(key);
checkNotNull(value);
int hash = hash(key);
return segmentFor(hash).put(key, hash, value, false);
}
設置緩存大概的過程：根據key 哈希到對應的segment,然后對segment加鎖lock(),然后獲取segment.table對應的結點
int index = hash & (table.length() - 1); ReferenceEntry<K, V> first = table.get(index);
之后入隊的過程和hashMap的入隊過程類似。入隊完之后還會進行相關操作比如更新accessQueue和wiriteQueue，累加totalWeight
void recordWrite(ReferenceEntry<K, V> entry, int weight, long now) {
// we are already under lock, so drain the recency queue immediately
drainRecencyQueue();
totalWeight += weight;
if (map.recordsAccess()) {
entry.setAccessTime(now);
}
if (map.recordsWrite()) {
entry.setWriteTime(now);
}
accessQueue.add(entry);
writeQueue.add(entry);
}
get(key)操作 。
第一步也是先定位到所在segment
V get(K key, CacheLoader<? super K, V> loader) throws ExecutionException {
int hash = hash(checkNotNull(key));
return segmentFor(hash).get(key, hash, loader);
}
判斷key對應的ReferenceEntry存在
ReferenceEntry<K, V> e = getEntry(key, hash);
if (e != null) {
long now = map.ticker.read();
V value = getLiveValue(e, now);
if (value != null) {
recordRead(e, now);
statsCounter.recordHits(1);
return scheduleRefresh(e, key, hash, value, now, loader);
}
ValueReference<K, V> valueReference = e.getValueReference();
if (valueReference.isLoading()) {
return waitForLoadingValue(e, key, valueReference);
}
getLiveValue(e, now)如果返回了null就表示當前cache已經過期了，不為null時recordRead(e, now)記錄最新訪問時間為now，然后統計命中率。scheduleRefresh(e, key, hash, value, now, loader)相當於一個雙重檢查，再次檢查cache需不需要刷新，如果需要刷新看不看不能馬上拿到新值。
如果可以返回新值，否直接拿原值返回。
這時注意valueReference.isLoading()為true的時候就表示有其它線程正在更新該cache,其它所有線程都要wait到這個線程loading完
才能返回。
key對應的ReferenceEntry不存在：緩存沒有加載進來或者已經被remove掉。
return lockedGetOrLoad(key, hash, loader);
lockedGetOrLoad執行邏輯是先加鎖lock(),判斷當前是否有其它線程在loading該cache，如果有等待其加載完畢然后返回。否自己執行loader把值設進cache中然后返回。
try {
// Synchronizes on the entry to allow failing fast when a recursive load is
// detected. This may be circumvented when an entry is copied, but will fail fast most
// of the time.
synchronized (e) {
return loadSync(key, hash, loadingValueReference, loader);
}
} finally {
statsCounter.recordMisses(1);
}
guava cache的淘汰策略
guava cache總體來說有四種淘汰策略。
1、size-based 基本於使用量。
當緩存個數超過CacheBuilder.maximumSize(long)設置的值時，優先淘汰最近沒有使用或者不常用的元素。同理CacheBuilder.maximumWeight(long)也是一樣邏輯。
2、timed eviction 基於時間驅逐。
expireAfterAccess(long, TimeUnit)僅在指定上一次讀/更新操作過了指定持續時間之后才考慮淘汰，淘汰邏輯與size-based是類似的。優先淘汰最近沒有使用或者不常用的元素
expireAfterWrite(long, TimeUnit) 僅在指定上一次寫/更新操作過了指定持續時間之后才考慮淘汰，淘汰邏輯與size-based是類似的。優先淘汰最近沒有使用或者不常用的元素
3、Reference-based Eviction 基本於引用驅逐
在JDK1.2之后,Java對引用的概念進行了擴充，將引用分為強引用(Strong Reference)、軟引用(Soft Reference)、弱引用(Weak Refernce)、虛引用(Phantom Reference)。四種引用強度依次減弱。這四種引用除了強引用(Strong Reference)之外，其它的引用所對應的對象來JVM進行GC時都是可以確保被回收的。所以通過使用弱引用的鍵、或弱引用的值、或軟引用的值，Guava Cache可以把緩存設置為允許垃圾回收：
- CacheBuilder.weakKeys()：使用弱引用存儲鍵。當鍵沒有其它（強或軟）引用時，緩存項可以被垃圾回收。因為垃圾回收僅依賴恆等式（==），使用弱引用鍵的緩存用==而不是equals比較鍵。
- CacheBuilder.weakValues()：使用弱引用存儲值。當值沒有其它（強或軟）引用時，緩存項可以被垃圾回收。因為垃圾回收僅依賴恆等式（==），使用弱引用值的緩存用==而不是equals比較值。
- CacheBuilder.softValues()：使用軟引用存儲值。軟引用只有在響應內存需要時，才按照全局最近最少使用的順序回收。考慮到使用軟引用的性能影響，我們通常建議使用更有性能預測性的緩存大小限定（使用軟引用值的緩存同樣用==而不是equals比較值）
這樣的好處就是當內存資源緊張時可以釋放掉到緩存的內存。注意！CacheBuilder如果沒有指明默認是強引用的，GC時如果沒有元素到達指定的過期時間，內存是不能被回收的。
4、顯示刪除
任何時候，你都可以顯式地清除緩存項，而不是等到它被回收：
- 個別清除：Cache.invalidate(key)
- 批量清除：Cache.invalidateAll(keys)
- 清除所有緩存項：Cache.invalidateAll()
提一下guava cache 是怎么觸發元素回收的。guava的元素回收與其它的一些框架不一樣比如redis，redis是起額外的線程去回收元素。而guava是進行get,put操作的時候順便把元素回收的。這樣比一般的緩存另起線程監控清理相比，可以減少開銷，但如果長時間沒有調用方法的話，會導致不能及時的清理釋放內存空間的問題。回收時主要處理四個Queue：1. keyReferenceQueue；2. valueReferenceQueue；3. writeQueue；4. accessQueue。前兩個queue是因為WeakReference、SoftReference被垃圾回收時加入的，清理時只需要遍歷整個queue，將對應的項從LocalCache中移除即可，這里keyReferenceQueue存放ReferenceEntry，而valueReferenceQueue存放的是ValueReference。而對后面兩個Queue，只需要檢查是否配置了相應的expire時間，然后從頭開始查找已經expire的Entry，將它們移除即可。
總的來說，guava cache基於ConcurrentHashMap的優秀設計借鑒，在高並發場景支持線程安全，使用Reference引用命令，保證了GC的可回收到相應的數據，有效節省空間；同時write鏈和access鏈的設計，能更靈活、高效的實現多種類型的緩存清理策略，包括基於容量的清理、基於時間的清理、基於引用的清理等；