Spring Boot + Guava Cache缓存应用实战

Guava Cache缓存应用实战

问题背景

实际项目碰到一个上游服务商接口有10秒的查询限制（同个账号）。

项目中有一个需求是要实时统计一些数据，一个应用下可能有多个相同的账号。由于服务商接口的限制，当批量查询时，可能出现同一个账号第一次查询有数据，但第二次查询无数据的情况。

解决方案

基于以上问题，提出用缓存的过期时间来解决。

这时，可用Redis和Guava Cache来解决：

当批量查询时，同一个账号第一次查询有数据则缓存并设置过期时间10s, 后续查询时直接从缓存中取，没有再从服务商查询。

最终采用Guava Cache来解决，原因是：

• 应用是部署单台的，不会有分布式的问题
• Redis虽然可以实现，但会有通讯时间消耗
• Guava Cache使用本地缓存，支持并发

代码

由于使用Spring Boot框架，需要引入相关依赖：

<parent>
    <groupId>org.springframework.bootgroupId>
    <artifactId>spring-boot-starter-parentartifactId>
    <version>1.5.12.RELEASEversion>
parent>
<dependencies>
    <dependency>
        <groupId>org.springframework.bootgroupId>
        <artifactId>spring-boot-starter-webartifactId>
    dependency>
    <dependency>
        <groupId>org.springframework.bootgroupId>
        <artifactId>spring-boot-starter-cacheartifactId>
    dependency>
    <dependency>
        <groupId>com.google.guavagroupId>
        <artifactId>guavaartifactId>
        <version>24.1-jreversion>
    dependency>
dependencies>

Guava Cache与Spring Boot整合代码：

首先是Guava Cache属性：

@ConfigurationProperties(prefix = "guava.cache.config")
public class GuavaProperties {

    private long maximumSize;

    private long maximumWeight;

    private long expireAfterWriteDuration;

    private long expireAfterAccessDuration;

    private long refreshDuration;

    private int initialCapacity;

    private int concurrencyLevel;

    // 省略get/set方法
}

然后是Guava Cache配置类：

该类上的注解都是必须的

@EnableConfigurationProperties(GuavaProperties.class)
@EnableCaching
@Configuration
public class GuavaCacheConfig {

    @Autowired
    private GuavaProperties guavaProperties;

    @Bean
    public CacheBuilder cacheBuilder() {
        long duration = guavaProperties.getExpireAfterWriteDuration();
        if (duration <= 0) {
            duration = 10;
        }
        return CacheBuilder.newBuilder()
                .expireAfterWrite(duration, TimeUnit.SECONDS);
    }

    /**
     * expireAfterAccess: 当缓存项在指定的时间段内没有被读或写就会被回收。
     * expireAfterWrite：当缓存项在指定的时间段内没有更新就会被回收,如果我们认为缓存数据在一段时间后数据不再可用，那么可以使用该种策略。
     * refreshAfterWrite：当缓存项上一次更新操作之后的多久会被刷新。
     *
     * @return
     */
    @DependsOn({"cacheBuilder"})
    @Bean
    public CacheManager cacheManager(CacheBuilder cacheBuilder) {
        GuavaCacheManager cacheManager = new GuavaCacheManager();
        cacheManager.setCacheBuilder(cacheBuilder);
        return cacheManager;
    }
}

使用Spring的缓存接口CacheManager管理Guava Cache。

再然后，在application.yml应用配置文件中配置属性：

guava:
  cache:
    config:
      expire-after-write-duration: 10

最后在类中声明使用：

@Autowired
private CacheBuilder cacheBuilder;

private Cache surplusItemsCache;

@PostConstruct
public void init() {
    surplusItemsCache = cacheBuilder.build();
}

调用Cache的get(K, Callable)方法获取缓存内容

surplusItemsCache.get(key, () -> {
            // 从缓存取不到的后续操作，如从数据库或网络获取
            return value;
        }))

Callable的返回值会被缓存起来,且key和value都不能为null，否则将抛出异常，当然可以捕获该异常进行处理。

如果想了解GuavaCache的其它方法，推荐此文：

http://ifeve.com/google-guava-cachesexplained/