Spring系列之Spring Cache
@Bean
public CacheManagerCustomizer<ConcurrentMapCacheManager> cacheManagerCustomizer() {
return new CacheManagerCustomizer<ConcurrentMapCacheManager>() {
@Override
public void customize(ConcurrentMapCacheManager cacheManager) {
cacheManager.setCacheNames(Arrays.asList("one", "two"));
}
};
}
如果上下文定义至少一个 org.springframework.cache.Cache bean,则使用Generic缓存,配置CacheManager包装。
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.xml的根目录下找到一个名为的文件,则使用EhCache 2.x。如果EhCache 2.x EhCacheCacheManager由spring-boot-starter-cache“Starter” 提供, 并且此类文件存在,则用于引导缓存管理器。还可以使用以下方式提供备用配置文件:
spring.cache.ehcache.config=classpath:config/another-config.xml
Spring Boot 对Hazelcast有一般的支持。如果HazelcastInstance已经自动配置,它会自动包装在一个 CacheManager。如果由于某种原因,您需要一个不同HazelcastInstance的缓存,您可以请求Spring Boot创建一个单独的,只能用于 CacheManager。
spring.cache.hazelcast.config = classpath:config / my-cache-hazelcast.xml
如果以HazelcastInstance这种方式创建一个单独的,则它不会在应用程序上下文中注册。
如果Redis可用和配置,RedisCacheManager则自动配置。也可以使用该spring.cache.cache-names 属性在启动时创建其他高速缓存。
默认情况下,添加一个键前缀以防止如果两个单独的缓存使用相同的键,则Redis将具有重叠的键,并可能返回无效值。如果您创建自己的,我们强烈建议您启用此设置RedisCacheManager。
已弃用,如果存在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")
| 表达式 | 描述 |
| — | — |
| #root.args
| 传递给缓存方法的参数,形式为数组 |
| #root.caches
| 该方法执行时所对应的缓存,形式为数组 |
| #root.target
| 目标对象 |
| #root.targetClass
| 目标对象的类 |
| #root.method
| 缓存方法 |
| #root.methodName
| 缓存方法的名字,即#root.method.name
|
| #result
| 方法调用的返回值,不能用于@Cacheable |
| #Argument
| 任意方法参数名(如#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() {