Google Guava之CacheBuilder

在什么场景下须要使用缓存呢？

缓存在不少场景下都是须要使用的。好比在须要一个值的过程和代价特别高的状况下，并且对这个值的须要不止一次的状况下，咱们可能就须要考虑使用缓存了。

在什么场景下须要使用本地缓存呢？

通常来讲要使用本地缓存，首先，是缓存中的数据总量不会超过内存的容量。而且你愿意消耗一些内存来提高速度。

那怎么实现本地缓存呢？

通常来讲咱们能够直接使用jdk里提供的数据结构来做为缓存，但这样有个问题就是缓存的一些机制，好比缓存过时的淘汰策略，缓存的初始化，缓存最大容量的设置，缓存的共享等等一些列的问题须要本身去考虑和实现。

第二种方法就是咱们可使用一些业界开源的，成熟的一些第三方的工具来帮助咱们实现缓存。这其中有：EHCache,cahce4j等等好多框架和工具。但从我使用的来看我认为google里guava包内的缓存工具是我使用过的最方便，简单的缓存框架。

下面就来介绍这个Guava包内的CacheBuilder。

加载（初始化）

使用Cacheloder自动加载

LoadingCache是附带CacheLoader构建而成的缓存实现。建立本身的CacheLoader一般只须要简单地实现V load(K key) throws Exception方法。（固然你也能够从新实现Cacheloder里的其余方法，来扩展你缓存的功能，好比loadAll,reload等。）

简单的一个例子：

LoadingCache<Key, String> graphs = CacheBuilder.newBuilder().maximumSize(2000).build( new CacheLoader<Key, String>() { public Graph load(Key key) throws AnyException { return createExpensiveGraph(key); } }); ... ... try { return graphs.get(key); } catch (ExecutionException e) { throw new OtherException(e.getCause()); } 

因为CacheLoader可能抛出异常，LoadingCache.get(K)也声明为抛出ExecutionException异常。若是你定义的CacheLoader没有声明任何检查型异常，则能够经过getUnchecked(K)查找缓存；但必须注意，一旦CacheLoader声明了检查型异常，就不能够调用getUnchecked(K)。

ImmutableMap<K, V> getAll(Iterable<? extends K> keys) throws ExecutionException;这个方法用来执行批量查询。默认状况下，对每一个不在缓存中的键，getAll方法会单独调用CacheLoader.load来加载缓存项。若是批量的加载比多个单独加载更高效，你能够重载CacheLoader.loadAll来利用这一点。getAll(Iterable)的性能也会相应提高。

获取缓存-若是没有-则计算（get-if-absent-compute）

get(K, Callable<V>)这个方法不论有没有实现自动加载均可以使用。代码用例以下：

Cache<Key, Graph> cache = CacheBuilder.newBuilder()
        .maximumSize(1000) .build(); // look Ma, no CacheLoader ... try { // If the key wasn't in the "easy to compute" group, we need to // do things the hard way. cache.get(key, () -> doThingsTheHardWay(key)); } catch (ExecutionException e) { throw new OtherException(e.getCause()); } 

tip：在整个加载方法完成前，缓存项相关的可观察状态都不会更改。这个方法简便地实现了模式"若是有缓存则返回；不然运算、缓存、而后返回"。

显示插入

使用cache.put(key, value)方法能够直接向缓存中插入值，这会直接覆盖掉给定键以前映射的值。使用Cache.asMap()视图提供的任何方法也能修改缓存。但请注意，asMap视图的任何方法都不能保证缓存项被原子地加载到缓存中。进一步说，asMap视图的原子运算在Guava Cache的原子加载范畴以外，因此相比于Cache.asMap().putIfAbsent(K,
V)，Cache.get(K, Callable<V>) 应该老是优先使用。

缓存的回收

Guava Cache提供了三种基本的缓存回收方式：基于容量回收、定时回收和基于引用回收。

基于容量的回收（size-based eviction）

若是要规定缓存项的数目不超过固定值，只需使用CacheBuilder.maximumSize(long)
缓存将尝试回收最近没有使用或整体上不多使用的缓存项。——警告：在缓存项的数目达到限定值以前，缓存就可能进行回收操做——一般来讲，这种状况发生在缓存项的数目逼近限定值时。

另外，不一样的缓存项有不一样的“权重”（weights）——例如，若是你的缓存值，占据彻底不一样的内存空间，你可使用CacheBuilder.weigher(Weigher)指定一个权重函数，而且用CacheBuilder.maximumWeight(long)指定最大总重。在权重限定场景中，除了要注意回收也是在重量逼近限定值时就进行了，还要知道重量是在缓存建立时计算的，所以要考虑重量计算的复杂度。。

当cache中全部的“weight”总和达到maxKeyWeight时，将会触发“剔除策略”。

定时回收（Timed Eviction）

CacheBuilder提供两种定时回收的方法：

• expireAfterAccess(long, TimeUnit)：缓存项在给定时间内没有被读/写访问，则回收。请注意这种缓存的回收顺序和基于大小回收同样。

• expireAfterWrite(long, TimeUnit)：缓存项在给定时间内没有被写访问（建立或覆盖），则回收。若是认为缓存数据老是在固定时候后变得陈旧不可用，这种回收方式是可取的。

基于引用的回收（Reference-based Eviction）

经过弱引用的键或者弱引用的值，或者软引用的值，guava Cache能够把缓存设置为容许垃圾回收

• CacheBuilder.weakKeys():使用过弱引用存储键值。当被垃圾回收的时候，当前键值没有其余引用的时候缓存项能够被垃圾回收。
• CacheBuilder.weakValues():使用弱引用存储值。
• CacheBuilder.softValues():使用软引用存储值。软引用就是在内存不够是才会按照顺序回收。

显示清除

任什么时候候，你均可以显式地清除缓存项，而不是等到它被回收：

• 个别清除：Cache.invalidate(key)
• 批量清除：Cache.invalidateAll(keys)
• 清除全部缓存项：Cache.invalidateAll()

移除监听器

经过CacheBuilder.removalListener(RemovalListener)，你能够声明一个监听器，以便缓存项被移除时作一些额外操做。缓存项被移除时，RemovalListener会获取移除通知[RemovalNotification]，其中包含移除缘由[RemovalCause]、键和值。

请注意，RemovalListener抛出的任何异常都会在记录到日志后被丢弃

警告：默认状况下，监听器方法是在移除缓存时同步调用的。由于缓存的维护和请求响应一般是同时进行的，代价高昂的监听器方法在同步模式下会拖慢正常的缓存请求。在这种状况下，你可使用RemovalListeners.asynchronous(RemovalListener, Executor)把监听器装饰为异步操做。

清理何时发生？

使用CacheBuilder构建的缓存不会"自动"执行清理和回收工做，也不会在某个缓存项过时后立刻清理，也没有诸如此类的清理机制。相反，它会在写操做时顺带作少许的维护工做，或者偶尔在读操做时作——若是写操做实在太少的话。

这样作的缘由在于：若是要自动地持续清理缓存，就必须有一个线程，这个线程会和用户操做竞争共享锁。此外，某些环境下线程建立可能受限制，这样CacheBuilder就不可用了。

相反，咱们把选择权交到你手里。若是你的缓存是高吞吐的，那就无需担忧缓存的维护和清理等工做。若是你的 缓存只会偶尔有写操做，而你又不想清理工做阻碍了读操做，那么能够建立本身的维护线程，以固定的时间间隔调用Cache.cleanUp()。ScheduledExecutorService能够帮助你很好地实现这样的定时调度。

刷新

刷新和回收不太同样。正如LoadingCache.refresh(K)所声明，刷新表示为键加载新值，这个过程能够是异步的。在刷新操做进行时，缓存仍然能够向其余线程返回旧值，而不像回收操做，读缓存的线程必须等待新值加载完成。

若是刷新过程抛出异常，缓存将保留旧值，而异常会在记录到日志后被丢弃[swallowed]。

重载CacheLoader.reload(K, V)能够扩展刷新时的行为，这个方法容许开发者在计算新值时使用旧的值。

//有些键不须要刷新，而且咱们但愿刷新是异步完成的 LoadingCache<Key, Graph> graphs = CacheBuilder.newBuilder() .maximumSize(1000) .refreshAfterWrite(1, TimeUnit.MINUTES) .build( new CacheLoader<Key, Graph>() { public Graph load(Key key) { // no checked exception return getGraphFromDatabase(key); } public ListenableFuture<Key, Graph> reload(final Key key, Graph prevGraph) { if (neverNeedsRefresh(key)) { return Futures.immediateFuture(prevGraph); }else{ // asynchronous! ListenableFutureTask<Key, Graph> task=ListenableFutureTask.create(new Callable<Key, Graph>() { public Graph call() { return getGraphFromDatabase(key); } }); executor.execute(task); return task; } } }); 

其余特性

统计

CacheBuilder.recordStats()用来开启Guava Cache的统计功能。统计打开后，Cache.stats()方法会返回CacheStats对象以提供以下统计信息：

• hitRate()：缓存命中率；
• averageLoadPenalty()：加载新值的平均时间，单位为纳秒；
• evictionCount()：缓存项被回收的总数，不包括显式清除。

此外，还有其余不少统计信息。这些统计信息对于调整缓存设置是相当重要的，在性能要求高的应用中咱们建议密切关注这些数据。

asMap视图

asMap视图提供了缓存的ConcurrentMap形式，但asMap视图与缓存的交互须要注意：

• cache.asMap()包含当前全部加载到缓存的项。所以相应地，cache.asMap().keySet()包含当前全部已加载键;
• asMap().get(key)实质上等同于cache.getIfPresent(key)，并且不会引发缓存项的加载。这和Map的语义约定一致。
• 全部读写操做都会重置相关缓存项的访问时间，包括Cache.asMap().get(Object)方法和Cache.asMap().put(K, V)方法，但不包括Cache.asMap().containsKey(Object)方法，也不包括在Cache.asMap()的集合视图上的操做。好比，遍历Cache.asMap().entrySet()不会重置缓存项的读取时间。