概述
缓存作用:
- 操作系统磁盘缓存:减少磁盘机械操作
- 数据库缓存:减少文件系统IO
- 应用程序缓存:减少对数据库的查询
- Web服务器缓存:减少应用服务器请求
- 客户端浏览器缓存:减少对网站的访问
Spring 3.1引入基于注解的缓存技术,本质上不是一个具体的缓存实现方案,而是一个缓存抽象,通过在既有代码中添加少量定义的各种 annotation,即能够达到缓存方法的返回对象的效果。
缓存是依赖于org.springframework.cache.Cache和 org.springframework.cache.CacheManager接口实现的抽象。CacheManager只要通过@EnableCaching注释启用缓存支持,Spring Boot将根据实现自动配置适当的配置。如果您使用的缓存基础结构与不是基于接口的bean,请确保启用该proxyTargetClass属性@EnableCaching。
Spring缓存技术还具备相当的灵活性,不仅能够使用 SpEL来定义缓存的 key 和各种 condition,还提供开箱即用的缓存临时存储方案,支持主流的缓存中间件集成:
- caffeine:一种高性能的缓存库,基于Guava
- couchbase:CouchBase是一款非关系型JSON文档数据库
- ehcache:
- generic:由泛型机制和 static 组合实现的泛型缓存机制
- hazelcast:一个高度可扩展的数据分发和集群平台,可用于实现分布式数据存储、数据缓存
- infinispan:分布式的集群缓存系统
- jcache:JSR107缓存规范
- none:没有缓存
- redis:用 Redis 作为缓存
- simple:用内存作为缓存
也可以强制缓存提供者通过spring.cache.type 属性使用。如果您需要在某些环境中完全禁用缓存,请使用此属性。如果CacheManager由Spring Boot自动配置,则可以通过暴露实现接口的bean来完全初始化之前进一步调整其CacheManagerCustomizer配置。以下设置要使用的缓存名称。
基于Spring AOP的动态代理技术,Spring Cache注解会帮忙在调用方法之后,去缓存方法调用的最终结果,或者在方法调用之前拿缓存中的结果,或者删除缓存中的结果
特点:
- 通过少量的配置 annotation 注释即可使得既有代码支持缓存
- 支持开箱即用,Out-Of-The-Box,即不用安装和部署额外第三方组件即可使用缓存
- 支持SpEL,能使用对象的任何属性或者方法来定义缓存的 key 和 condition
- 支持 AspectJ,并通过其实现任何方法的缓存支持
- 支持自定义 key 和自定义缓存管理者,具有相当的灵活性和扩展性
Spring Boot
如果是SB应用,引入依赖:
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-cache</artifactId>
</dependency>
如果您尚未定义类型CacheManager或CacheResolver命名的bean cacheResolver(请参阅CachingConfigurer),在SB中通过@EnableCaching注解自动化配置合适的缓存管理器(CacheManager),SB根据下面的顺序去侦测缓存提供者:
- Generic
- JCache (JSR-107) (EhCache 3, Hazelcast, Infinispan, etc)
- EhCache 2.x
- Hazelcast
- Infinispan
- Couchbase
- Redis
- Caffeine
- Guava (deprecated)
- Simple
@Bean
public CacheManagerCustomizer<ConcurrentMapCacheManager> cacheManagerCustomizer() {
return new CacheManagerCustomizer<ConcurrentMapCacheManager>() {
@Override
public void customize(ConcurrentMapCacheManager cacheManager) {
cacheManager.setCacheNames(Arrays.asList("one", "two"));
}
};
}
Generic
如果上下文定义至少一个 org.springframework.cache.Cache bean,则使用Generic缓存,配置CacheManager包装。
JCache
JCache通过类javax.cache.spi.CachingProvider路径(即一个符合JSR-107的缓存库)和“Starter” JCacheCacheManager 提供的引导spring-boot-starter-cache。在那里有各种兼容的库,Spring Boot为Ehcache 3,Hazelcast和Infinispan提供依赖管理。也可以添加任何其他兼容的库。
可能会出现多个提供程序存在,在这种情况下必须明确指定提供程序。即使JSR-107标准没有强制执行一种标准化的方式来定义配置文件的位置,Spring Boot也可以适应实现细节。
spring.cache.jcache.provider=com.acme.MyCachingProvider
spring.cache.jcache.config = classpath:acme.xml
EhCache 2.x
如果在类路径ehcache.xml的根目录下找到一个名为的文件,则使用EhCache 2.x。如果EhCache 2.x EhCacheCacheManager由spring-boot-starter-cache“Starter” 提供, 并且此类文件存在,则用于引导缓存管理器。还可以使用以下方式提供备用配置文件:
spring.cache.ehcache.config=classpath:config/another-config.xml
Hazelcast
Spring Boot 对Hazelcast有一般的支持。如果HazelcastInstance已经自动配置,它会自动包装在一个 CacheManager。如果由于某种原因,您需要一个不同HazelcastInstance的缓存,您可以请求Spring Boot创建一个单独的,只能用于 CacheManager。
spring.cache.hazelcast.config = classpath:config / my-cache-hazelcast.xml
如果以HazelcastInstance这种方式创建一个单独的,则它不会在应用程序上下文中注册。
Redis
如果Redis可用和配置,RedisCacheManager则自动配置。也可以使用该spring.cache.cache-names 属性在启动时创建其他高速缓存。
默认情况下,添加一个键前缀以防止如果两个单独的缓存使用相同的键,则Redis将具有重叠的键,并可能返回无效值。如果您创建自己的,我们强烈建议您启用此设置RedisCacheManager。
Guava
已弃用,如果存在Guava,GuavaCacheManager则自动配置。可以在启动时使用spring.cache.cache-names属性创建缓存,并通过以下方式(按此顺序)定制缓存:
一个缓存规范定义
- spring.cache.guava.spec
- com.google.common.cache.CacheBuilderSpec定义一个bean
- com.google.common.cache.CacheBuilder定义一个bean
下面的配置创建foo和bar高速缓存按照500的最大尺寸和存活时间为10分钟
spring.cache.cache-names=foo,bar
spring.cache.guava.spec=maximumSize=500,expireAfterAccess=600s
此外,如果com.google.common.cache.CacheLoader定义一个bean,它将自动关联到GuavaCacheManager。由于CacheLoader将被关联到所有由高速缓存管理器管理的缓存,它必须定义为 CacheLoader。
简单
如果这些选项都没有实现,则配置使用ConcurrentHashMap 缓存存储的简单实现。如果您的应用程序中没有缓存库,则这是默认值。
注解
@EnableCaching:用于类,开启缓存功能
@Cacheable:主要针对方法配置,能够根据方法的请求参数对其结果进行缓存
- 如果没有指定请求参数,则缓存生成的 key name,是默认值
SimpleKey[]
- 如果指定请求参数,则缓存的 key name 就是请求参数
- 缓存中 key 对应的 value 默认使用 JDK 序列化
- value过期时间为-1,表示永不过期。
自定义 key支持SpEL表达式
@Cacheable(value = {"hot"}, key = "#root.method.name")
表达式 |
描述 |
|
传递给缓存方法的参数,形式为数组 |
|
该方法执行时所对应的缓存,形式为数组 |
|
目标对象 |
|
目标对象的类 |
|
缓存方法 |
|
缓存方法的名字,即 |
|
方法调用的返回值,不能用于@Cacheable |
|
任意方法参数名(如#argName)或参数索引(如#a0或p0) |
- @Caching
- @CacheConfig
@CachePut:用于方法,更新缓存,和@Cacheable不同的是,它每次都会触发真实方法的调用,返回值也会也会放到缓存中:
属性 |
描述 |
value |
缓存名称,必须至少指定一个 |
key |
缓存key,可以为空,缺省按照方法的所有参数进行组合,不为空则必须按照SpEL表达式写 |
condition |
缓存条件,可以为空,不为空可使用SpEL表达式,返回值为true才缓存 |
@CacheEvict:用于方法,能够根据一定的条件对缓存进行清空,重复执行也不会报错,和 @Cacheable、@CachePut 不同,能够应用在返回值为 void 的方法上。
属性 |
描述 |
value |
缓存名称 |
key |
SpEL表达式,用于计算自定义缓存key |
condition |
SpEL表达式,值为false时缓存不会应用到方法调用上 |
allEntries |
为true时,特定缓存的所有条目都会被移除掉 |
beforeInvocation |
为true时,方法调用之前移除条目,否则,方法成功调用之后再移除条目 |
进阶
配置key生成策略:
/**
* spring uses keygenerator to generate cache keys
*/
@Bean
public KeyGenerator boxKeyGenerator() {
return (target, method, params) -> {
StringBuilder sb = new StringBuilder();
sb.append(target.getClass().getName()).append("-");
sb.append(method.getName()).append("-");
for (Object obj : params) {
sb.append(obj.toString());
}
return sb.toString();
};
}