Spring Boot与缓存：使用JCache（JSR-107）注解简化开发

缓存是个好东西，如果你想让前台用户操作流畅的话。经典的倒装句。现在都在追求服务的无状态化，所以这里使用redis作为缓存工具。我也感觉没有必要写，可是简单的你不写，复杂的你又写不好，最后，就是啥也没有。

springboot版本：2.6.7

引入依赖

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

配置

默认生效的是配置类：SimpleCacheConfiguration，其他的配置类比如RedisCacheConfiguration如果要生效必须添加相关的Redis配置信息，否则默认不生效。

spring:
  cache:
  # 可以为理解指定存储缓存的东西
    type: redis
  redis:
    database: 0
    host: localhost
    # 如果你有密码的话
    password: redis213

启动类加个启用缓存的注解，开启缓存

@SpringBootApplication
@EnableCaching
public class ServerApplication {
    public static void main(String[] args) {
        SpringApplication.run(ServerApplication.class, args);
    }

}

开始使用

推荐注解使用啊，手写的话应该不需要介绍，自己手搓着就行，手搓没啥可说的，注解，也只是说一说注解里的各种属性。英文好点，可以随便使用啊。英文不好，那咱也不是一点也不能看，根据变量名猜，加上机器翻译，日子到也过的下去。

我只是一个喜欢写随笔的人啊，每次写这种介绍博客时，总时控制不住去写书，可能和我的初中老师有关系，一股脑的全部到给你，也不管你听不听得懂。还是简略点，写的太详细写的也累，看的也累。最主要感觉还是要起到的一个类似领头的效果吧。很多细节，自己去看源码也是可以解决的。

几个重要的概念和注解

@Cacheable

@Cacheable标注的方法在执行之前会先检查缓存中有没有这个数据，默认按照参数的值作为缓存的key去查询缓存，如果没有就运行该方法并将结果放入缓存；以后再来调用就可以直接使用缓存中的数据；

1. 方法运行之前，先去查询Cache（缓存组件），按照cacheNames指定的名字获取；（CacheManager先获取相应的缓存），第一次获取缓存如果没有Cache组件会自动创建。
2. 去Cache中查找缓存的内容，使用一个key，默认就是方法的参数；key是按照某种策略生成的；默认是使用keyGenerator生成的，默认使用SimpleKeyGenerator生成key；
3. 看源码得知SimpleKeyGenerator生成key的默认策略；
   • 如果没有参数；key=new SimpleKey()；
   • 如果有一个参数：key=参数的值
   • 如果有多个参数：key=new SimpleKey(params)；
4. 没有查到缓存就调用目标方法；
5. 将目标方法返回的结果，放进缓存中

将方法的运行结果进行缓存；以后再要相同的数据，直接从缓存中获取，不用调用方法；
CacheManager管理多个Cache组件的，对缓存的真正CRUD操作在Cache组件中，每一个缓存组件有自己唯一一个名字；

Cacheable注解的可配置项

1. cacheNames/value：指定缓存组件的名字;将方法的返回结果放在哪个缓存中，是数组的方式，可以指定多个缓存；
2. key：缓存数据使用的key；可以用它来指定。默认是使用方法参数的值 1-方法的返回值编写SpEL； #id;参数id的值 #a0 #p0 #root.args[0]getEmp[2]
3. keyGenerator：key的生成器；可以自己指定key的生成器的组件id,key/keyGenerator：二选一使用
4. cacheManager：指定缓存管理器；或者cacheResolver指定获取解析器
5. condition：指定符合条件的情况下才缓存；condition = “#id>0”；condition = “#a0>1”：第一个参数的值大于1的时候才进行缓存
6. unless: 否定缓存；当unless指定的条件为true，方法的返回值就不会被缓存；可以获取到结果进行判unless = “#result == null”unless = “#a0==2”:如果第一个参数的值是2，结果不缓存；
7. sync：是否使用异步模式

@Cacheable(value = {"emp"},keyGenerator = "myKeyGenerator",condition = "#a0>1",unless = "#a0==2")
public Employee getEmp(Integer id){
    System.out.println("查询"+id+"号员工");
    Employee emp = employeeMapper.getEmpById(id);
    return emp;
}

@CachePut

• 既调用方法，又更新缓存数据；同步更新缓存

• 应用场景：修改了数据库的某个数据，同时更新缓存；

• 流程：

  1. 先调用目标方法
  2. 将目标方法的结果缓存起来

@CachePut(value = "emp",key = "#result.id")
public Employee updateEmp(Employee employee){
    System.out.println("updateEmp:"+employee);
    employeeMapper.updateEmp(employee);
    return employee;
}

@CacheEvict

• @CacheEvict：缓存清除
• key：指定要清除的数据
• allEntries = true：指定清除这个缓存中所有的数据
• beforeInvocation = false：缓存的清除是否在方法之前执行。默认代表缓存清除操作是在方法执行之后执行;如果出现异常缓存就不会清除。
• beforeInvocation = true：代表清除缓存操作是在方法运行之前执行，无论方法是否出现异常，缓存都清除

@CacheEvict(value="emp",beforeInvocation = true，key = "#id")
public void deleteEmp(Integer id){
    System.out.println("deleteEmp:"+id);
    employeeMapper.deleteEmpById(id);
}

@Caching

• @Caching 综合上面介绍的几个注解，用来定义较为复杂的缓存规则

@Caching(
     cacheable = {
         @Cacheable(/*value="emp",*/key = "#lastName")
     },
     put = {
         @CachePut(/*value="emp",*/key = "#result.id"),
         @CachePut(/*value="emp",*/key = "#result.email")
     }
)
public Employee getEmpByLastName(String lastName){
    return employeeMapper.getEmpByLastName(lastName);
}

@CacheConfig

• 在类上使用，提供公共属性。
• cacheNames: 缓存名称，同一个类中，不指定缓存名称则使用这个名称，类似于一个以类为单位的全局配置。
• 下面和上面类似，而且属性前面也有介绍，就不多说了。

源码：

@Target(ElementType.TYPE) // 这个表示只能在类上使用
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface CacheConfig {
 String[] cacheNames() default {};

 String keyGenerator() default "";
 String cacheManager() default "";

 String cacheResolver() default "";

}

封面