@Cacheable 注解

news2024/5/19 23:32:27

1. 功能说明

　　@Cacheable 注解在方法上，表示该方法的返回结果是可以缓存的。也就是说，该方法的返回结果会放在缓存中，以便于以后使用相同的参数调用该方法时，会返回缓存中的值，而不会实际执行该方法。

　　注意，这里强调了一点：参数相同。这一点应该是很容易理解的，因为缓存不关心方法的执行逻辑，它能确定的是：对于同一个方法，如果参数相同，那么返回结果也是相同的。但是如果参数不同，缓存只能假设结果是不同的，所以对于同一个方法，你的程序运行过程中，使用了多少种参数组合调用过该方法，理论上就会生成多少个缓存的 key（当然，这些组合的参数指的是与生成 key 相关的）。下面来了解一下 @Cacheable 的一些参数：

2. cacheNames & value

　　@Cacheable 提供两个参数来指定缓存名：value、cacheNames，二者选其一即可。这是 @Cacheable 最简单的用法示例：

@Override

@Cacheable("menu")

public Menu findById(String id) {

Menu menu = this.getById(id);

if (menu != null){

System.out.println("menu.name = " + menu.getName());

}

return menu;

}

　　在这个例子中，findById 方法与一个名为 menu 的缓存关联起来了。调用该方法时，会检查 menu 缓存，如果缓存中有结果，就不会去执行方法了。

3. 关联多个缓存名

　　其实，按照官方文档，@Cacheable 支持同一个方法关联多个缓存。这种情况下，当执行方法之前，这些关联的每一个缓存都会被检查，而且只要至少其中一个缓存命中了，那么这个缓存中的值就会被返回。示例：

@Override

@Cacheable({"menu", "menuById"})

public Menu findById(String id) {

Menu menu = this.getById(id);

if (menu != null){

System.out.println("menu.name = " + menu.getName());

}

return menu;

}


---------

@GetMapping("/findById/{id}")

public Menu findById(@PathVariable("id")String id){

Menu menu0 = menuService.findById("fe278df654adf23cf6687f64d1549c0a");

Menu menu2 = menuService.findById("fb6106721f289ebf0969565fa8361c75");

return menu0;

}

4. key & keyGenerator

　　一个缓存名对应一个被注解的方法，但是一个方法可能传入不同的参数，那么结果也就会不同，这应该如何区分呢？这就需要用到 key 。在 spring 中，key 的生成有两种方式：显式指定和使用 keyGenerator 自动生成。

　　4.1. KeyGenerator 自动生成

　　　　当我们在声明 @Cacheable 时不指定 key 参数，则该缓存名下的所有 key 会使用 KeyGenerator 根据参数自动生成。spring 有一个默认的 SimpleKeyGenerator ，在 spring boot 自动化配置中，这个会被默认注入。生成规则如下：

　　　　　　a. 如果该缓存方法没有参数，返回 SimpleKey.EMPTY ；

　　　　　　b. 如果该缓存方法有一个参数，返回该参数的实例；

　　　　　　c. 如果该缓存方法有多个参数，返回一个包含所有参数的 SimpleKey ；

　　　　默认的 key 生成器要求参数具有有效的 hashCode() 和 equals() 方法实现。另外，keyGenerator 也支持自定义，并通过 keyGenerator 来指定。关于 KeyGenerator 这里不做详细介绍，有兴趣的话可以去看看源码，其实就是使用 hashCode 进行加乘运算。跟 String 和 ArrayList 的 hash 计算类似。

　　4.2. 显式指定 key

　　　　相较于使用 KeyGenerator 生成，spring 官方更推荐显式指定 key 的方式，即指定 @Cacheable 的 key 参数。

　　　　即便是显式指定，但是 key 的值还是需要根据参数的不同来生成，那么如何实现动态拼接呢？SpEL（Spring Expression Language，Spring 表达式语言）能做到这一点。下面是一些使用 SpEL 生成 key 的例子。

@Override

@Cacheable(value = {"menuById"}, key = "#id")

public Menu findById(String id) {

Menu menu = this.getById(id);

if (menu != null){

System.out.println("menu.name = " + menu.getName());

}

return menu;

}


@Override

@Cacheable(value = {"menuById"}, key = "'id-' + #menu.id")

public Menu findById(Menu menu) {

return menu;

}


@Override

@Cacheable(value = {"menuById"}, key = "'hash' + #menu.hashCode()")

public Menu findByHash(Menu menu) {

return menu;

}

注意：官方说 key 和 keyGenerator 参数是互斥的，同时指定两个会导致异常。

5. cacheManager & cacheResolver

　　CacheManager，缓存管理器是用来管理（检索）一类缓存的。通常来讲，缓存管理器是与缓存组件类型相关联的。我们知道，spring 缓存抽象的目的是为使用不同缓存组件类型提供统一的访问接口，以向开发者屏蔽各种缓存组件的差异性。那么 CacheManager 就是承担了这种屏蔽的功能。spring 为其支持的每一种缓存的组件类型提供了一个默认的 manager，如：RedisCacheManager 管理 redis 相关的缓存的检索、EhCacheManager 管理 ehCache 相关的缓等。

　　CacheResolver，缓存解析器是用来管理缓存管理器的，CacheResolver 保持一个 cacheManager 的引用，并通过它来检索缓存。CacheResolver 与 CacheManager 的关系有点类似于 KeyGenerator 跟 key。spring 默认提供了一个 SimpleCacheResolver，开发者可以自定义并通过 @Bean 来注入自定义的解析器，以实现更灵活的检索。

　　大多数情况下，我们的系统只会配置一种缓存，所以我们并不需要显式指定 cacheManager 或者 cacheResolver。但是 spring 允许我们的系统同时配置多种缓存组件，这种情况下，我们需要指定。指定的方式是使用 @Cacheable 的 cacheManager 或者 cacheResolver 参数。

　　注意：按照官方文档，cacheManager 和 cacheResolver 是互斥参数，同时指定两个可能会导致异常。

6. sync

　　是否同步，true/false。在一个多线程的环境中，某些操作可能被相同的参数并发地调用，这样同一个 value 值可能被多次计算（或多次访问 db），这样就达不到缓存的目的。针对这些可能高并发的操作，我们可以使用 sync 参数来告诉底层的缓存提供者将缓存的入口锁住，这样就只能有一个线程计算操作的结果值，而其它线程需要等待，这样就避免了 n-1 次数据库访问。

　　sync = true 可以有效的避免缓存击穿的问题。

7. condition

　　调用前判断，缓存的条件。有时候，我们可能并不想对一个方法的所有调用情况进行缓存，我们可能想要根据调用方法时候的某些参数值，来确定是否需要将结果进行缓存或者从缓存中取结果。比如当我根据年龄查询用户的时候，我只想要缓存年龄大于 35 的查询结果。那么 condition 能实现这种效果。

　　condition 接收一个结果为 true 或 false 的表达式，表达式同样支持 SpEL 。如果表达式结果为 true，则调用方法时会执行正常的缓存逻辑（查缓存-有就返回-没有就执行方法-方法返回不空就添加缓存）；否则，调用方法时就好像该方法没有声明缓存一样（即无论传入了什么参数或者缓存中有些什么值，都会执行方法，并且结果不放入缓存）