1 简介
Spring从3.1版本开始,提供Cache和CacheManager接口实现数据缓存功能,支持使用注解简化开发。Cache接口为缓存的组件规范定义,包含缓存的各种操作集合,CacheManager接口提供缓存配置管理。
本文将介绍Cache注解的使用方法和场景。我们可以为需要缓存功能的方法加上Cache注解,每次调用方法时,Spring会检查指定参数的指定目标方法是否已经被调用过,如果有就直接从缓存中获取结果,如果没有就调用方法并缓存结果后返回给用户,下次调用即可直接从缓存中获取。
2 注解定义
Cache的常用注解及定义如下:
名称 | 定义 |
---|---|
@EnableCaching | 用于启动类或配置类,开启使用基于注解的缓存。 |
@Cacheable | 能够根据方法的请求参数和返回结果,定义键值进行缓存。缓存存在时直接返回结果不调用方法,常用于查询。 |
@CachePut | 保证方法被调用,又希望结果被缓存。与@Cacheable区别在于每次都调用方法,常用于写入或更新。 |
@CacheEvict | 用于删除或清空缓存。 |
@Caching | 组合多个注解标签。 |
@CacheConfig | 用于使用缓存的类,统一配置缓存注解的属性。 |
注解的主要属性及定义如下:
名称 | 定义 |
---|---|
value | 缓存的名称,在spring配置文件中定义,必须指定至少一个。value指定了缓存存放的命名空间,所有写入和删除缓存的操作均针对指定命名空间的缓存。例如:@Cacheable(value = ”myCache”) ,或@Cacheable(value = {”myCache1”, ”myCache2”} |
key | 缓存的key,按照SpEL表达式编写,例如:@Cacheable(value = ”myCache”, key = ”#id”) 。如果不指定,则按照方法的参数进行组合。 |
condition | 缓存的条件,可以为空,使用SpEL编写,返回true或者false,只有为true才缓存数据或清除缓存。例如:@Cacheable(value = ”myCache”, condition = ”#id.length() > 0”) |
unless | 否定条件的缓存,返回结果为true时不缓存。例如:@Cacheable(value = ”myCache”, unless = ”#id == null || id.length() == 0”) |
allEntries | 是否清空所有缓存内容,@CacheEvict注解使用,缺省为false,如果指定为true,则方法调用后将立即清空所有缓存。例如:@CachEvict(value = ”myCache”, allEntries = true) |
beforeInvocation | 是否在方法执行前清空缓存,@CacheEvict注解使用,缺省为 false,如果指定为 true,则在执行方法前就清空缓存。缺省情况下,如果方法执行抛出异常,则不会清空缓存。例如:@CachEvict(value = ”myCache”,beforeInvocation = true) |
sync | 为true时,只有一个线程的请求会到达数据库,其他线程都会等待直到缓存可用。这个设置可减少对数据库的瞬间并发访问。 |
当一个类需要使用缓存的方法较多时,可在该类上使用@CacheConfig注解来统一指定value的值,之后可省略value配置。如果在方法依旧写上value,那么以方法的value值为准。示例如下:
@CacheConfig(cacheNames = {
"myCache"})
@Transactional(propagation = Propagation.REQUIRED, rollbackFor = Exception.class)
@Service
public class UserServiceImpl implements UserService {
}
多个Cache注解组合使用时,需要用@Caching组合多个注解标签,示例如下:
@Caching(cacheable =