缓存抽象层Spring cache实战操作

1.前言

Spring从3.1开始定义了一系列抽象接口来统一不同的缓存技术；并支持使用JCache（JSR-107）注解简化我们进行缓存开发。Spring Cache 只负责维护抽象层，具体的实现由你的技术选型来决定。将缓存处理和缓存技术解除耦合。

2.主要依赖

Spring cache 抽象由spring-context相关组件实现。非Spring Boot 项目可通过引入该模块进行集成。

Spring Boot 项目可引入以下依赖：

<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-cache</artifactId>
</dependency>

同时可能需要引入你采用的缓存中间件客户端；比如 Ehcache、redis等。

3.重要抽象概念

• Cache 缓存抽象规范接口，定义缓存一些了操作。实现有：RedisCache、EhCacheCache、ConcurrentMapCache等
• CacheManager 缓存管理器，管理Cache的生命周期。

4.常用的一些注解

Spring cache 提供了一系列的注解，将我们从编程开发中解放出来。让我们更加关注于业务开发。

4.1 @EnableCaching

该注解是启用Spring cache 的开关。必须开启才能使用Spring cache相关功能。

4.2 @Cacheable

可以标记在一个方法或者类上。方法级只针对该方法。类上则针对类内所有的方法。对于一个支持缓存的方法，Spring会在其被调用后将其返回值缓存起来，以保证下次利用同样的参数来执行该方法时可以直接从缓存中获取结果，而不需要再次执行该方法。Spring在缓存方法的返回值时是以键值对进行缓存的，值就是方法的返回结果。

public @interface Cacheable {

@AliasFor("cacheNames")
String[] value() default {};
//和value注解差不多，二选一
String[] cacheNames() default {}; 
// 该次缓存的key 
String key() default "";
//key的生成器。key/keyGenerator二选一使用
String keyGenerator() default "";
//指定缓存管理器 一般使用默认
String cacheManager() default ""; 
//或者指定获取解析器  一般使用默认
String cacheResolver() default ""; 
//条件符合则缓存 使用的比较多 支持SpEL
String condition() default ""; 
//条件符合则不缓存 使用的比较多 支持SpEL
String unless() default ""; 
//是否使用异步模式
boolean sync() default false; 
}

后面有个别注解属性跟这个基本相同不进行重复介绍。

4.3 @CacheConfig

作用于缓存接口上，来对该接口下的一些重复配置（缓存名称、key生成器、缓存管理器、缓存处理器）进行归纳处理。其他属性可参考Cacheable。

4.4 @CachePut

该注解容易跟@Cacheable混淆。两者都可以执行缓存的“放入”操作，不同于@Cacheable，@CachePut每次都将执行方法并将返回值K-V放入缓存，如果该K存在则进行更新。其他属性可参考Cacheable。

4.5 @CacheEvict

@CachEvict主要针对方法配置，能够根据一定的条件对特定的缓存进行清空。该注解有两个特别的属性：

• allEntries 是否清空所有缓存内容，缺省为 false，如果指定为 true，则方法调用后将立即清空所有缓存。注意不能跟key参数同时使用。
• beforeInvocation 是否在方法执行前就清空，缺省为 false，如果指定为 true，则在方法还没有执行的时候就清空缓存，缺省情况下，如果方法执行抛出异常，则不会清空缓存。

4.6 @Caching

该注解是个组合注解。有时候我们需要在一个方法上同时使用多个相同注解但是java是不支持一个注解在同一个方法上多次使用。这时就可以使用该注解进行组合。

5. 使用要点

• 缓存注解所在的方法不能在类中进行内部调用。
• 缓存一定要有过期超时策略，避免系统不堪重负。
• 缓存的值如果是集合考虑对集合的大小的限制，避免序列化/反序列化性能。

6. 缓存实战

接下来我们通过Spring cache 集合redis 来实战一下，甚至有一些特别的玩法。假设redis环境已经搭建好了。Spring Boot 项目中引入：

<!--   redis  -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-data-redis</artifactId>
</dependency>
<!--    spring cache  -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-cache</artifactId>
</dependency>
<!--      lettuce 必备依赖  -->
<dependency>
<groupId>org.apache.commons</groupId>
<artifactId>commons-pool2</artifactId>
</dependency>

在yml配置中我们大多可使用默认配置。配置spring.cache.type=REDIS 。其他配置可通过前缀spring.cache、spring.redis进行配置。

6.1 redis高级客户端

Spring Boot 2.x中 默认使用lettuce作为默认redis客户端。当然你也可以引入redisson客户端。这两种是非阻塞反应式高级redis客户端。建议放弃阻塞客户端jedis。

6.2 自定义缓存配置

如果我们使用默认的配置那么所有的K-V都不会自动过期。很多情况下我们有这样的需求，验证码缓存5分钟自动过期，区域信息30分钟。那么我们就需要自定义 CacheManager。代码如下：

public CacheManager cacheManager(RedisConnectionFactory redisConnectionFactory) { 
return RedisCacheManager.RedisCacheManagerBuilder
 .fromCacheWriter(RedisCacheWriter.nonLockingRedisCacheWriter(redisConnectionFactory)) 
// 默认策略，未配置的 key 会使用这个 
 .cacheDefaults(redisConfig(60)) 
// 自定义 key 策略 
 .withInitialCacheConfigurations(redisCacheConfigurationMap()).build(); 
 }

cacheDefaults方法来指定默认配置。withInitialCacheConfigurations方法用来对各种缓存空间进行个性化配置。

redisCacheConfigurationMap方法是一个以缓存名称为key，其对应的redis配置类为值得键值映射。这个需要在开发中自己进行配置。参考`CacheNameEnum` 。

6.3 编写缓存处理类

经过上面的配置后，我们编写以下缓存类：

/**
 * The type Captcha cache.
 *
 * @author dax
 * @since 2019 /9/2 21:31
 * @see cn.felord.rediscache.config.CacheNameEnum
 */
@Slf4j
@Component
@CacheConfig(cacheNames = {"smsCode"})
public class CaptchaCache {

@CachePut(key = "#key")
public String put(String key,String code){
      log.info("执行 cachePut");
return code;
    }
    
@CacheEvict(key = "#key")
public void  expire(String key){
    }

@Cacheable(key = "#key")
public String get(String key){
return null;
    }
}

请注意 缓存名称 smsCode 在CacheNameEnum进行了个性化配置。