Spring Cache缓存技术

## 前置知识

- 在 Spring Cache 缓存中有两大组件 CacheManager 和 Cache。在整个缓存中可以有多个 CacheManager，他们负责管理他们里边的 Cache。一个 CacheManager 中可以创建多个 Cache，每个 Cache 负责存储一个种类数据，例如 Salary Cache 负责存储 Salary 相关的数据。

![](/media/202311/2023-11-02_1716400.8269444662063147.png)

## 使用说明

### 一、开启基于注解的缓存功能

在启动类或者其他配置类中加入 `@EnabeleCaching` 注解

```java
@SpringBootApplication
@MapperScan("com.xj.springboot.mapper")
@EnableCaching
public class SpringbootCacheApplication {

public static void main(String[] args) {
        SpringApplication.run(SpringbootCacheApplication.class, args);
    }

}
```

### 二、在方法上标注缓存注解

#### 1.@Cacheable

此注解可以标注在方法上，当第一次调用被 @Cacheable 注解标注的方法时，该注解会将方法的返回值作为 value 存入缓存中，如果没有指定 key，则 key 默认值为方法的**实参**（注意不是形参）。然后再次调用此方法，传入的参数和上一次一样，则不会再执行方法体中的代码，而是直接从缓存中取出数据，然后返回。

cacheable 注解中有 9 个属性：value、cacheNames、key、keyGenerator、cacheManager、cacheResolver、condition、unless、sync。其中 value 和 cacheNames 互为别名，所以可以说只有 8 个属性。

- value / cacheNames：用于指定 Cache 的名字，此属性是数组类型，可以指定多个缓存的名字。此属性必须指定，不设置会报错。
- key：用于指定存放进缓存的数据的 key（因为要将当前方法的返回值以 key-value 的形式存储在缓存中），不设置的话默认就是传入方法的**实参的值（注意不是形参），如果要设置通常会使用 spEL 表达式（spEL 可**参考下图**）**。

注意：@Cacheable 注解的 key 属性中不能使用#result 取出方法执行后的返回值，因为 @Cacheable 注解是先到缓存中查找，在执行方法的，在没执行方法前，#result 是取不到值的。

![](/media/202311/2023-11-02_1716400.7539739913715032.png)

- keyGenerator：用于指定 key 的生成器。注意，keyGenerator 和 key 只能同时存在一个，如果设置了 key，则不能再设置 keyGenerator。
- cacheManager：指定使用哪个 CacheManager（缓存管理器）。springboot 的自动配置在容器中添加了一个 ConcurrentMapCacheManager 类型的 cacheManager，如果我们没有指定 cacheManager，则默认使用 springboot 提供的，即 ConcurrentMapCacheManager。
- cacheResolver：作用同 cacheManager。
- condition：用于指定一个表达式，当表达式成立时，才将方法的返回值放入缓存中。表达式通常同 spEL 表达式来编写。
- unless：作用与 condition 属性相反。指定一个表达式，当表达式成立时，方法的返回值将不被放入缓存中。有一点和 condition 不同，就是 unless 的表达式中，可以获取到方法的返回值进行判断。
- sync：是否使用异步模式。如果设置此注解为 true（即开启异步模式）unless 属性就不能使用了。多线程并发时可启用此属性。

**执行流程总结：**

**调用方法前，会先拿注解中 cacheNames 属性指定的名字到缓存中查找有没有该名字的 cache，如果有，则直接返回 key 为方法实参的数据。如果没有，那么就创建名字为 cacheNames 属性指定的名字的 cache，然后执行方法体，将方法的返回结果作为 value 放到缓存中。**

#### 2.@CachePut

此注解可以标注在方法上，当每次调用被 @Cacheput 注解标注的方法时，该注解会都会将方法的返回值作为 value 存入缓存中。一般标注在执行数据库更新操作的方法上。

**CachePut 与 Cacheable 注解的区别：****Cacheable 只有在第一次调用方法时才会将方法返回值放到缓存中，再次调用时缓存中有就不会再执行方法体了。而**CachePut 每次调用方法，都会将方法返回值放入缓存中。****

cachePut 注解中有 9 个属性，这 9 个属性同 Cacheable 注解的属性使用相同。

#### 3.@CacheEvict

cacheevict 中 evict 是驱逐，逐出的意思。所以此注解是用于删除缓存中指定 key 的数据的。此注解可以标注在方法上，当调用被 @CacheEvict 注解标注的方法时，该注解会根据 Cacheevict 注解中 key 属性所指定的 key 去缓存中找到这个 key 对应的 value，然后将它删掉。

Cacheevict 注解有 9 个属性：value、cacheNames、key、keyGenerator、cacheManager、cacheResolver、condition、allEntries、beforeInvocation。其中，前 7 个属性和 @Cacheable 中的属性作用是一样的，下边就不再赘述了，只介绍 allEntries 和 beforeInvocation

- allEntries：当 allEntries 设置为 true 时，表示调用当前注解标注的方法会将 cacheNames 指定的 cache 中所有的缓存数据**全部清除**。默认为 false
- beforeInvocation：当 beforeInvocation 设置为 true 时，清除缓存数据这个动作会在方法被调用之前执行。默认值为 false，即先调用方法，执行方法中的内容，最后执行清除缓存数据的动作。也许你还是疑惑 beforeInvocation 到底有什么用，清除缓存数据的动作在方法调用之前执行和在方法调用之后执行有什么区别。答案是肯定有区别的，区别就是清除缓存数据的动作在方法调用之后的话，会先执行方法，此时如果方法出现异常，就不会再执行清除缓存数据的动作。而清除缓存数据的动作在方法调用之前，那么不管方法会不会出现异常，清除缓存数据的动作都会执行。

#### 4.@Caching

此注解起始就是 Cacheable、CachePut、CacheEvict 这三个注解的组合体。此注解适用于缓存复杂的方法上。下边是 Caching 注解的源码。

![](/media/202311/2023-11-02_1716400.5582793696006147.png)

```java
@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Inherited
@Documented
public @interface Caching {
    Cacheable[] cacheable() default {};

CachePut[] put() default {};

CacheEvict[] evict() default {};
}
```

![](/media/202311/2023-11-02_1716400.04131972274179896.png)

#### 5.@CacheConfig

此注解可以标注在类上，用于抽取缓存的公共配置。

如果一个类中的所有方法上的 Cacheable、CachePut、CacheEvict 这三个注解，他们的都是 cacheNames 都是指向同一个或者同一批 cache 的，那么就可以用把 @CacheConfig 注解这些 cacheNames 都抽取出来，然后将此注解标注在类上。那么，这个类下边的方法上的缓存相关就都不用再指定 cacheNames 属性了，都会使用 CacheConfig 上指定的 cacheNames。