@Cacheable
@Cacheable 是 Spring 框架中的一个注解,用于实现方法级别的缓存。
当一个方法被标记为 @Cacheable 时,Spring 会首先检查缓存,如果缓存中已经存在与该方法调用相关的数据,则直接从缓存中获取数据返回,而不执行方法体;如果缓存中不存在相关数据,则执行方法体,并将方法的返回值缓存起来,以便下次相同的方法调用时可以直接从缓存中获取。
这个注解通常与其他缓存相关的注解一起使用,比如 @CacheEvict 和 @CachePut。
例如:
@Service
public class MyService {
@Cacheable(value = "myCache", key = "#id")
public MyObject getObjectById(Long id) {
// 这个方法返回值会被缓存
return myRepository.findById(id);
}
@CacheEvict(value = "myCache", key = "#id")
public void evictCacheById(Long id) {
// 此方法将从缓存中删除与给定 id 关联的条目
}
@CacheEvict(value = "myCache", allEntries = true)
public void evictCacheAll(Long id) {
// 此方法将从缓存中删除 "myCache" 所有缓存项
}
@CachePut(value = "myCache", key = "#result.id")
public MyObject updateObject(MyObject updatedObject) {
// 该方法会更新对应id的缓存值
return myRepository.save(updatedObject);
}
}
在上面的例子中,@Cacheable 注解用于缓存 getObjectById 方法的返回值,@CacheEvict 注解用于从缓存中删除特定条目,@CachePut 注解用于更新缓存中的值。
-
@Cacheable 属性
value 或 cacheNames
:指定缓存的名称。这可以是缓存管理器的缓存名称之一,或者是默认的缓存名称。
key
:缓存的键,用于唯一标识缓存的条目。默认情况下,它会使用方法的参数来生成键。
keyGenerator
:指定一个自定义的键生成器。
cacheManager
:指定一个缓存管理器来管理缓存。
cacheResolver
:用于解析缓存的解析器。
condition
:指定一个 SpEL 表达式,只有在该表达式为 true 时才会缓存方法的返回值。
unless
:指定一个 SpEL 表达式,用于决定何时不缓存方法的返回值。
sync
:是否使用同步模式来更新缓存。 -
key属性设置
-
使用 Spring Expression Language(SpEL)来定义多个键。以下是一个示例:
@Cacheable(value = "myCache", key = "#param1 + '-' + #param2")
public MyObject getObject(String param1, String param2) {
// Method logic
}
在这个例子中,param1 和 param2 是方法的参数,通过连接它们来生成一个复合键。
- 使用方法的返回值作为键:
@Cacheable(value = "myCache", key = "#result.id")
public MyObject getObjectById(Long id) {
// Method logic
}
这样,在每次调用 getObjectById 方法时,返回对象的 id 将作为缓存的键。
- 结合多种表达式来创建更复杂的键。例如:
@Cacheable(value = "myCache", key = "'prefix-' + #param1 + '-' + #param2")
public MyObject getObject(String param1, String param2) {
// Method logic
}
在这个例子中,将 “prefix-” 作为固定的前缀,加上两个参数的组合作为键。
@CacheEvict
@CacheEvict 是 Spring 框架中用于从缓存中删除数据的注解。它的一些常见属性包括:
value
: 这是一个必需的属性,用于指定要清除的缓存名称。你可以指定一个或多个缓存名称,多个缓存名称之间用逗号分隔。
key
: 这是一个SpEL 表达式,用于指定要清除的缓存条目的键。如果不指定,则默认使用方法的参数作为键。
keyGenerator
: 用于自定义缓存键生成器的 Bean 名称。如果指定了该属性,将使用指定的键生成器来生成缓存键,而不使用 key 属性中定义的 SpEL 表达式。
condition
:类似于@Cacheable中的condition属性,它是一个SpEL表达式,用于决定是否执行缓存清除操作。只有当表达式的计算结果为true时,才会执行清除操作。
allEntries
:默认值为false。如果设置为true,则表示清除指定缓存中的所有条目,而不是仅清除与指定键相关的条目。当你想要清除整个缓存时,通常会将此属性设置为 true。
beforeInvocation
:默认值为false。如果设置为true,则表示在方法执行之前清除缓存;如果设置为false,则表示在方法执行之后清除缓存。默认情况下,@CacheEvict 在方法执行之后清除缓存。
cacheManager
: 用于指定要使用的缓存管理器的 Bean 名称。如果应用中有多个缓存管理器,则可以使用此属性指定要使用的特定缓存管理器。
cacheResolver
: 类似于 @Cacheable 中的 cacheResolver 属性,用于指定解析缓存的策略的 Bean 名称。