SpringBoot_缓存（JSR-107、Spring缓存抽象、整合Redis）（2.2.5 version）

JSR-107

Java Caching定义了5个核心接口，分别是CachingProvider, CacheManager, Cache, Entry 和 Expiry。

• CachingProvider定义了创建、配置、获取、管理和控制多个CacheManager。一个应用可以在运行期访问多个CachingProvider。
• CacheManager定义了创建、配置、获取、管理和控制多个唯一命名的Cache，这些Cache存在于CacheManager的上下文中。一个CacheManager仅被一个CachingProvider所拥有。
• Cache是一个类似Map的数据结构并临时存储以Key为索引的值。一个Cache仅被一个CacheManager所拥有。
• Entry是一个存储在Cache中的key-value对。
• Expiry 每一个存储在Cache中的条目有一个定义的有效期。一旦超过这个时间，条目为过期的状态。一旦过期，条目将不可访问、更新和删除。缓存有效期可以通过ExpiryPolicy设置。
  

Spring缓存抽象

概述

Spring从3.1开始定义了org.springframework.cache.Cache
和org.springframework.cache.CacheManager接口来统一不同的缓存技术；
并支持使用JCache（JSR-107）注解简化开发；

Cache接口为缓存的组件规范定义，包含缓存的各种操作集合；
Cache接口下Spring提供了各种xxxCache的实现；如RedisCache，EhCacheCache , ConcurrentMapCache等；

每次调用需要缓存功能的方法时，Spring会检查检查指定参数的指定的目标方法是否已经被调用过；如果有就直接从缓存中获取方法调用后的结果，如果没有就调用方法并缓存结果后返回给用户。下次调用直接从缓存中获取。
使用Spring缓存抽象时我们需要关注以下两点；

1. 确定方法需要被缓存以及对应的缓存策略
2. 从缓存中读取之前缓存存储的数据

重要概念&缓存注解

Cache SpEL available metadata

@Cacheable

将方法的运行结果进行缓存；以后再要相同的数据，直接从缓存中获取，不用调用方法。

属性

• cacheNames/value：指定缓存组件的名字;将方法的返回结果放在哪个缓存中，是数组的方式，可以指定多个缓存；
• key：缓存数据使用的key；可以用它来指定。默认是使用方法参数的值 param-Method's return
  编写SpEL： #id：参数id的值 #a0 \ #p0 \ #root.args[0]\ getEmp[2]
• keyGenerator：key的生成器；可以自己指定key的生成器的组件id
  key/keyGenerator：二选一使用;

@Configuration
public class MyCacheConfig {

    @Bean("myKeyGenerator")
    public KeyGenerator keyGenerator(){
        return new KeyGenerator(){

            @Override
            public Object generate(Object target, Method method, Object... params) {
                return method.getName()+"["+ Arrays.asList(params).toString()+"]";
            }
        };
    }
}

• cacheManager：指定缓存管理器；或者cacheResolver指定获取解析器
• condition：指定符合条件的情况下才缓存；
  • condition = "#id>0"
  • condition = "#a0>1"：第一个参数的值>1的时候才进行缓存
• unless:否定缓存；当unless指定的条件为true，方法的返回值就不会被缓存；可以获取到结果进行判断
  • unless = "#result == null"
  • unless = "#a0==2":如果第一个参数的值是2，结果不缓存；
• sync：是否使用同步模式,默认false

demo

@Cacheable(value = {"emp" },keyGenerator = "myKeyGenerator",
condition = "#a0>1",unless = "#a0==2")
public Employee getEmp(Integer id) {
	System.out.println("查询" + id + "号员工");
	Employee emp = employeeMapper.getEmpById(id);
	return emp;
}

原理

1. 自动配置类:CacheAutoConfiguration
2. 缓存的配置类
   
3. 默认SimpleCacheConfiguration生效；
4. 给容器中注册了一个CacheManager：ConcurrentMapCacheManager
5. 可以获取和创建ConcurrentMapCache类型的缓存组件；将数据保存在ConcurrentMap中；

运行流程

1. 方法运行之前，先去查询Cache（缓存组件），按照cacheNames指定的名字获取；（CacheManager先获取相应的缓存），第一次获取缓存如果没有Cache组件会自动创建。
2. 去Cache中查找缓存的内容，使用一个key，默认就是方法的参数；
   • key是按照某种策略生成的；默认是使用keyGenerator生成的，默认使用SimpleKeyGenerator生成key；
   • SimpleKeyGenerator生成key的默认策略；
     • 如果没有参数；key=new SimpleKey()；
     • 如果有一个参数：key=param
     • 如果有多个参数：key=new SimpleKey(params)；
3. 没有查到缓存就调用目标方法；
4. 将目标方法返回的结果，放进缓存中

@CachePut

既调用方法，又更新缓存数据；同步更新缓存；
修改了数据库的某个数据，同时更新缓存；

1. 先调用目标方法
2. 将目标方法的结果缓存起来

@CachePut(value = "emp",key = "#result.id")
public Employee updateEmp(Employee employee) {
	System.out.println("updateEmp:" + employee);
	employeeMapper.updateEmp(employee);
	return employee;
}

@CacheEvict

缓存清除

扫描二维码关注公众号，回复： 10740734 查看本文章

属性

• key：指定要清除的数据
• allEntries = true：指定清除这个缓存中所有的数据，不用指定key
• beforeInvocation = false：缓存的清除是否在方法之前执行，默认代表缓存清除操作是在方法执行之后执行;如果出现异常缓存就不会清除
• beforeInvocation = true：代表清除缓存操作是在方法运行之前执行，无论方法是否出现异常，缓存都清除

demo

@CacheEvict(value = "emp", beforeInvocation = true key = "#id")
public void deleteEmp(Integer id) {
	System.out.println("deleteEmp:" + id);
	//employeeMapper.deleteEmpById(id);
	int i = 10 / 0;
}

@Caching

定义复杂的缓存规则

@Caching(cacheable = {@Cacheable(/*value="emp",*/key = "#lastName") }, 
    	 put = {
             @CachePut(/*value="emp",*/key = "#result.id"),
             @CachePut(/*value="emp",*/key = "#result.email") 
 		}
)
public Employee getEmpByLastName(String lastName) {
	return employeeMapper.getEmpByLastName(lastName);
}

@CacheConfig

类注解，抽取缓存的公共配置

@CacheConfig(cacheNames = "emp",cacheManager = "employeeCacheManager") 
@Service
public class EmployeeService {

整合Redis

Docker安装运行Redis

docker pull redis
docker run -d -p 6379:6379 --name redis01 45c93dfa0e1f

SpringBoot配置Redis

spring:
	redis:
		host: 192.168.2.2

设置序列化方式

@Configuration
public class MyRedisConfig {

	/**
	 * 往容器中添加RedisCacheManager容器，并设置序列化方式
	 * @param redisConnectionFactory
	 * @return
	 */
	@Bean
	public RedisCacheManager redisCacheManager(
	        RedisConnectionFactory redisConnectionFactory) {
		RedisCacheWriter redisCacheWriter = RedisCacheWriter
		        .nonLockingRedisCacheWriter(redisConnectionFactory);
		RedisCacheConfiguration redisCacheConfiguration = RedisCacheConfiguration
		        .defaultCacheConfig()
		        .serializeValuesWith(RedisSerializationContext.SerializationPair
		                .fromSerializer(valueSerializer()))
		        .serializeKeysWith(RedisSerializationContext.SerializationPair
		                .fromSerializer(new StringRedisSerializer()))
		        .entryTtl(Duration.ofSeconds(300));
		return new RedisCacheManager(redisCacheWriter, redisCacheConfiguration);
	}
	
	/**
	  * 使用Jackson序列化器
	   * @return
	   */
	private RedisSerializer<Object> valueSerializer() {
		Jackson2JsonRedisSerializer<Object> serializer = new Jackson2JsonRedisSerializer<Object>(
		        Object.class);
		ObjectMapper objectMapper = new ObjectMapper();
		objectMapper.setVisibility(PropertyAccessor.ALL,
		        JsonAutoDetect.Visibility.ANY);
		//反序列化必需
		objectMapper.activateDefaultTyping(
		        LaissezFaireSubTypeValidator.instance,
		        ObjectMapper.DefaultTyping.NON_FINAL);
		serializer.setObjectMapper(objectMapper);
		return serializer;
	}

	/**
	 * 往容器中添加RedisTemplate对象，设置序列化方式
	 * 缓存并没有用到RedisTemplate，配置此bean只为了方便单独使用
	 * @param redisConnectionFactory
	 * @return
	 * @throws UnknownHostException
	 */
	@Bean
	public RedisTemplate<String, Object> redisTemplate(
	        RedisConnectionFactory redisConnectionFactory)
	        throws UnknownHostException {
		RedisTemplate<String, Object> template = new RedisTemplate<String, Object>();
		template.setConnectionFactory(redisConnectionFactory);
		template.setKeySerializer(new StringRedisSerializer());
		template.setValueSerializer(valueSerializer());
		template.setHashKeySerializer(new StringRedisSerializer());
		template.setHashValueSerializer(valueSerializer());
		template.afterPropertiesSet();
		return template;
	}
}