乐趣区

关于java:Caffeine缓存的简单介绍

jiezi

1、简介

在本文中，咱们将理解 Caffeine，一个用于 Java 的高性能缓存库。

缓存和 Map 之间的一个基本区别是缓存会清理存储的我的项目。

一个清理策略会决定在某个给定工夫哪些对象应该被删除，这个策略间接影响缓存的命中率——缓存库的一个要害个性。

Caffeine 应用 Window TinyLfu 清理策略，它提供了靠近最佳的命中率。
<!–more–>

2、依赖

咱们须要将 Caffeine 依赖增加到咱们的 pom.xml 中：

<dependency>
    <groupId>com.github.ben-manes.caffeine</groupId>
    <artifactId>caffeine</artifactId>
    <version>2.5.5</version>
</dependency>

您能够在 Maven Central 上找到最新版本的 Caffeine。

3、写入缓存

让咱们关注 Caffeine 的三种缓存写入策略：手动、同步加载和异步加载。

首先，让咱们编写一个类，作为要存储在缓存中的值的类型：

class DataObject {
    private final String data;

    private static int objectCounter = 0;
    // standard constructors/getters
    
    public static DataObject get(String data) {
        objectCounter++;
        return new DataObject(data);
    }
}

3.1、手动写入

在此策略中，咱们手动将值写入缓存并稍后读取它们。

咱们先初始化缓存：

Cache<String, DataObject> cache = Caffeine.newBuilder()
  .expireAfterWrite(1, TimeUnit.MINUTES)
  .maximumSize(100)
  .build();

当初，咱们能够应用 getIfPresent 办法从缓存中获取一些值。如果缓存中不存在该值，则此办法将返回null：

String key = "A";
DataObject dataObject = cache.getIfPresent(key);

assertNull(dataObject);

咱们能够应用 put 办法手动写入缓存：

cache.put(key, dataObject);
dataObject = cache.getIfPresent(key);

assertNotNull(dataObject);

咱们还能够应用 get 办法获取值，该办法承受一个函数和一个键作为参数。如果缓存中不存在该键，则此函数将用于提供兜底值，该值将在执行后写入缓存：

dataObject = cache
  .get(key, k -> DataObject.get("Data for A"));

assertNotNull(dataObject);
assertEquals("Data for A", dataObject.getData());

这个 GET 办法执行是原子性的。这意味着即便多个线程同时申请该值，执行只会进行一次。这就是为什么应用 get 比getIfPresent更好。

有时咱们须要手动使一些缓存的值生效：

cache.invalidate(key);
dataObject = cache.getIfPresent(key);

assertNull(dataObject);

3.2、同步加载

这种加载缓存的办法须要一个Function，用于初始化写入值，相似于手动写入策略的 get 办法，让咱们看看如何应用它。

首先，咱们须要初始化咱们的缓存：

LoadingCache<String, DataObject> cache = Caffeine.newBuilder()
  .maximumSize(100)
  .expireAfterWrite(1, TimeUnit.MINUTES)
  .build(k -> DataObject.get("Data for" + k));

当初咱们能够应用 get 办法读取值：

DataObject dataObject = cache.get(key);

assertNotNull(dataObject);
assertEquals("Data for" + key, dataObject.getData());

咱们还能够应用 getAll 办法获取一组值：

Map<String, DataObject> dataObjectMap 
  = cache.getAll(Arrays.asList("A", "B", "C"));

assertEquals(3, dataObjectMap.size());

值从传递给 build 办法的底层后端初始化 Function 中读取到，这样就能够应用缓存作为拜访值的次要入口了。

3.3、异步加载

此策略的工作原理与前一个雷同，然而会异步执行操作并返回一个 CompletableFuture 来保留理论的值：

AsyncLoadingCache<String, DataObject> cache = Caffeine.newBuilder()
  .maximumSize(100)
  .expireAfterWrite(1, TimeUnit.MINUTES)
  .buildAsync(k -> DataObject.get("Data for" + k));

咱们能够以雷同的形式应用 get 和getAll办法，思考到它们的返回是CompletableFuture：

String key = "A";

cache.get(key).thenAccept(dataObject -> {assertNotNull(dataObject);
    assertEquals("Data for" + key, dataObject.getData());
});

cache.getAll(Arrays.asList("A", "B", "C"))
  .thenAccept(dataObjectMap -> assertEquals(3, dataObjectMap.size()));

CompletableFuture 具备很多有用的 API，您能够在本文中浏览更多相干信息。

4、缓存值的清理

Caffeine 有三种缓存值的清理策略：基于大小、基于工夫和基于援用。

4.1、基于大小的清理

这种类型的清理设计为在超出缓存配置的大小限度时产生清理。有两种获取大小的办法——计算缓存中的对象数，或者获取它们的权重。

让咱们看看如何计算缓存中的对象数。缓存初始化时，其大小为零：

LoadingCache<String, DataObject> cache = Caffeine.newBuilder()
  .maximumSize(1)
  .build(k -> DataObject.get("Data for" + k));

assertEquals(0, cache.estimatedSize());

当咱们增加一个值时，大小明显增加：

cache.get("A");

assertEquals(1, cache.estimatedSize());

咱们能够将第二个值增加到缓存中，这会导致删除第一个值：

cache.get("B");
cache.cleanUp();

assertEquals(1, cache.estimatedSize());

值得一提的是，咱们在获取缓存大小之前调用了 cleanUp 办法。这是因为缓存清理是异步执行的，该办法有助于期待清理实现。

咱们还能够传入一个 weigher 的 Function 来定义缓存大小的获取：

LoadingCache<String, DataObject> cache = Caffeine.newBuilder()
  .maximumWeight(10)
  .weigher((k,v) -> 5)
  .build(k -> DataObject.get("Data for" + k));

assertEquals(0, cache.estimatedSize());

cache.get("A");
assertEquals(1, cache.estimatedSize());

cache.get("B");
assertEquals(2, cache.estimatedSize());

当权重超过 10 时，这些值将从缓存中删除：

cache.get("C");
cache.cleanUp();

assertEquals(2, cache.estimatedSize());

4.2、基于工夫的清理

这种清理策略基于条目标过期工夫，分为三种：

  • 拜访后过期——自上次读取或写入以来，条目在通过某段时间后过期
  • 写入后过期——自上次写入以来，条目在通过某段时间后过期
  • 自定义策略——由 Expiry 的实现来为每个条目独自计算到期工夫

让咱们应用 expireAfterAccess 办法配置拜访后过期策略：

LoadingCache<String, DataObject> cache = Caffeine.newBuilder()
  .expireAfterAccess(5, TimeUnit.MINUTES)
  .build(k -> DataObject.get("Data for" + k));

要配置写入后过期策略，咱们应用 expireAfterWrite 办法：

cache = Caffeine.newBuilder()
  .expireAfterWrite(10, TimeUnit.SECONDS)
  .weakKeys()
  .weakValues()
  .build(k -> DataObject.get("Data for" + k));

要初始化自定义策略，咱们须要实现 Expiry 接口：

cache = Caffeine.newBuilder().expireAfter(new Expiry<String, DataObject>() {
    @Override
    public long expireAfterCreate(String key, DataObject value, long currentTime) {return value.getData().length() * 1000;}
    @Override
    public long expireAfterUpdate(String key, DataObject value, long currentTime, long currentDuration) {return currentDuration;}
    @Override
    public long expireAfterRead(String key, DataObject value, long currentTime, long currentDuration) {return currentDuration;}
}).build(k -> DataObject.get("Data for" + k));

4.3、基于援用的清理

咱们能够配置咱们的缓存，容许缓存的键或值或二者一起的垃圾收集。为此，咱们须要为键和值配置 WeakReference 的应用，并且咱们能够配置 SoftReference 仅用于值的垃圾收集。

WeakReference的应用容许在没有对对象的任何强援用时对对象进行垃圾回收。SoftReference容许基于 JVM 的全局 LRU（最近起码应用）策略对对象进行垃圾回收。能够在此处找到无关 Java 中援用的更多详细信息。

咱们应用 Caffeine.weakKeys()、Caffeine.weakValues()和 Caffeine.softValues()来启用每个选项：

LoadingCache<String, DataObject> cache = Caffeine.newBuilder()
  .expireAfterWrite(10, TimeUnit.SECONDS)
  .weakKeys()
  .weakValues()
  .build(k -> DataObject.get("Data for" + k));

cache = Caffeine.newBuilder()
  .expireAfterWrite(10, TimeUnit.SECONDS)
  .softValues()
  .build(k -> DataObject.get("Data for" + k));

5、缓存刷新

能够将缓存配置为在定义的时间段后主动刷新条目。让咱们看看如何应用 refreshAfterWrite 办法做到这一点：

Caffeine.newBuilder()
  .refreshAfterWrite(1, TimeUnit.MINUTES)
  .build(k -> DataObject.get("Data for" + k));

在这里，咱们应该明确 expireAfter 和 refreshAfter 的一个区别：当申请过期条目时，执行会阻塞，直到 build 函数计算出新值。然而如果该条目合乎刷新条件，则缓存将返回一个旧值并异步从新加载该值。

6、统计

Caffeine 提供了一种记录缓存应用统计信息的办法：

LoadingCache<String, DataObject> cache = Caffeine.newBuilder()
  .maximumSize(100)
  .recordStats()
  .build(k -> DataObject.get("Data for" + k));
cache.get("A");
cache.get("A");

assertEquals(1, cache.stats().hitCount());
assertEquals(1, cache.stats().missCount());

咱们还能够创立一个 StatsCounter 的实现作为参数来传入recordStats。每次与统计相干的更改，这个实现对象都将被调用。

7、论断

在本文中，咱们相熟了 Java 的 Caffeine 缓存库。咱们看到了如何配置和存入缓存，以及如何依据须要抉择适合的过期或刷新策略。

原文：https://www.baeldung.com/java…

翻译：码农熊猫

更多技术干货，请拜访我的集体网站 https://pinmost.com，或关注公众号【码农熊猫】

退出移动版