Spring系列之Spring Cache

概述

缓存作用：

1. 操作系统磁盘缓存：减少磁盘机械操作
2. 数据库缓存：减少文件系统IO
3. 应用程序缓存：减少对数据库的查询
4. Web服务器缓存：减少应用服务器请求
5. 客户端浏览器缓存：减少对网站的访问

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

引入依赖：

<dependency>
	<groupId>org.springframework.boot</groupId>
	<artifactId>spring-boot-starter-cache</artifactId>
</dependency>

如果您尚未定义类型CacheManager或CacheResolver命名的bean cacheResolver（请参阅CachingConfigurer），在SB中通过@EnableCaching注解自动化配置合适的缓存管理器（CacheManager），SB根据下面的顺序去侦测缓存提供者：

1. Generic
2. JCache (JSR-107) (EhCache 3, Hazelcast, Infinispan, etc)
3. EhCache 2.x
4. Hazelcast
5. Infinispan
6. Couchbase
7. Redis
8. Caffeine
9. Guava：废弃
10. Simple：基于ConcurrentMap存储缓存

@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属性创建缓存，并通过以下方式（按此顺序）定制缓存：
一个缓存规范定义

1. spring.cache.guava.spec
2. com.google.common.cache.CacheBuilderSpec定义一个bean
3. 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。

SimpleCacheConfiguration

如果没有添加任何额外的依赖或配置，SimpleCacheConfiguration将生效，即使用ConcurrentHashMap，

注解

@EnableCaching：用于Spring Boot启动类，开启缓存功能，源码如下：

@Import(CachingConfigurationSelector.class)
public @interface EnableCaching {
	// 设置为true将影响所有需要代理的Spring Bean，而不仅仅是那些标记有@Cacheable的Bean。如其他@Transactional注解的Bean将同时升级为子类代理
	boolean proxyTargetClass() default false;
	// 默认使用代理，同一类中的本地调用不能以这种方式被拦截；本地调用中此类方法的缓存注释将被忽略，Spring拦截器甚至不会针对此类运行时场景启动
	AdviceMode mode() default AdviceMode.PROXY;
	int order() default Ordered.LOWEST_PRECEDENCE;
}

AdviceMode是一个枚举类，PROXY表示JDK代理，ASPECTJ织入。

@CacheConfig：只能用于类，指定缓存的公共配置

@Cacheable：可用于类和方法，主要用于方法，能够根据方法的请求参数对其结果进行缓存。先检查是否存在缓存，存在则直接返回，不执行目标方法，不存在则执行目标方法，然后对执行结果加以缓存。

注解的参数：

• value：缓存的名字
• cacheNames：同上
• key：缓存Key
• keyGenerator：和Key二选一
• cacheManager：可指定自定义CacheManager，和cacheResolver互斥
• cacheResolver：可指定自定义CacheResolver，和cacheManager互斥
• condition：指定符合条件时才缓存，可使用SpEL表达式
• unless：和condition相反，不满足条件才缓存，可使用SpEL表达式
• sync：是否使用异步模式

注解的使用：

• 如果没有指定请求参数，则缓存生成的key name，是默认值SimpleKey[];如果指定请求参数，则缓存的key name就是请求参数
• 缓存中key对应的value默认使用JDK序列化
• value表示过期时间，设置为-1，表示永不过期
• key支持SpEL表达式，如@Cacheable(value = {"hot"}, key = "#root.method.name")

@CachePut：用于方法，更新缓存。和@Cacheable不同的是，它每次都会触发真实方法的调用，返回值也会放到缓存中。即，先调用目标方法，然后将数据缓存下来。参数和@Cacheable非常相似。

@CacheEvict：用于方法，能够根据一定的条件对缓存进行清空，重复执行也不会报错，和@Cacheable、@CachePut不同，能够应用在返回值为void的方法上。注解的属性（参数）和@Cacheable非常相似：

• allEntries：用于指定是否删除缓存内的所有条目。默认为false，仅删除关联键下的值。设置为true并指定Key是不允许的
• beforeInvocation：缓存的清除是否在方法之前执行。默认false表示方法（正确无误不抛异常）执行后清除缓存。如果设置为true，表示在方法执行之前清除缓存，此时如果方法执行出现异常也会删除缓存，不建议这样使用。

@Caching
源码如下：

@Reflective
public @interface Caching {
	Cacheable[] cacheable() default {};
	CachePut[] put() default {};
	CacheEvict[] evict() default {};
}

可知@Caching是一个组合注解，看应用复杂缓存规则场景下。如下场景，根据id查询用户Person，一并缓存3条数据，3个Key分别是id、name和phone：

@Caching(cacheable = {@Cacheable(value = "demo")},
        put = {@CachePut(value = "demo", key = "#result.name"),
                @CachePut(value = "demo", key = "#result.phone")})
public Person findById(Long id) {
    return personRepository.findById(id).orElseThrow();
}

SpEL

表达式	描述
#root.args	传递给缓存方法的参数，形式为数组
#root.caches	该方法执行时所对应的缓存，形式为数组
#root.target	目标对象
#root.targetClass	目标对象的类
#root.method	缓存方法
#root.methodName	缓存方法的名字，即#root.method.name
#result	方法调用的返回值，不能用于@Cacheable，常用于@CachePut
#Argument	任意方法参数名（如#argName）或参数索引（如#a0或p0）

进阶

KeyGenerator

是一个接口，只要一个generate方法：

@FunctionalInterface
public interface KeyGenerator {
	Object generate(Object target, Method method, Object... params);
}

默认使用的实现类是SimpleKeyGenerator。

自定义Key生成策略，并配置为Bean：

@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();
	};
}

CacheManager

public interface CacheManager {
	// 根据名字查找因延迟加载而可能为空的缓存
	@Nullable
	Cache getCache(String name);
	// 返回所有缓存名字
	Collection<String> getCacheNames();
}

实现类：

• JCacheCacheManager
• CaffeineCacheManager
• ConcurrentMapCacheManager
• SimpleCacheManager

自定义CacheManager：

@Bean
public CacheManager cacheManager(LettuceConnectionFactory lettuceConnectionFactory) {
	RedisCacheConfiguration conf = RedisCacheConfiguration.defaultCacheConfig()
			.disableCachingNullValues()
			.entryTtl(Duration.ofHours(1))
			.serializeValuesWith(RedisSerializationContext.SerializationPair.fromSerializer(RedisSerializer.json()));
    conf.usePrefix();
	return RedisCacheManager.RedisCacheManagerBuilder.fromConnectionFactory(lettuceConnectionFactory)
            .cacheDefaults(conf).build();
}

自动配置

CacheAutoConfiguration

Cacheable原理

默认情况下，使用SimpleCacheConfiguration，对应的CacheManager是ConcurrentMapCacheManager

参考