Spring Boot Cache使用与整合

Spring 提供了对缓存功能的抽象：即允许绑定不同的缓存解决方案（如Caffeine、Ehcache等），但本身不直接提供缓存功能的实现。它支持注解方式使用缓存，非常方便。

SpringBoot在annotation的层面实现了数据缓存的功能，基于Spring的AOP技术。所有的缓存配置只是在annotation层面配置，像声明式事务一样。

Spring定义了CacheManager和Cache接口统一不同的缓存技术。其中CacheManager是Spring提供的各种缓存技术的抽象接口。而Cache接口包含缓存的各种操作。

Cache接口下Spring提供了各种xxxCache的实现，如RedisCache，EhCacheCache ,ConcurrentMapCache等；

一，缓存技术类型与CacheManger

针对不同的缓存技术，需要实现不同的cacheManager，Spring定义了如下的cacheManger实现。

CacheManger描述 SimpleCacheManager 使用简单的Collection来存储缓存，主要用于测试 ConcurrentMapCacheManager 使用ConcurrentMap作为缓存技术

，需要显式的删除缓存，无过期机制 NoOpCacheManager 仅测试用途，不会实际存储缓存 EhCacheCacheManager 使用EhCache作为缓存技术，以前在hibernate的时候经常用 GuavaCacheManager 使用google guava的GuavaCache作为缓存技术

CaffeineCacheManager 是使用Java8对Guava缓存的重写，spring5（springboot2）开始用Caffeine取代guava HazelcastCacheManager 使用Hazelcast作为缓存技术 JCacheCacheManager 使用JCache标准的实现作为缓存技术，如Apache Commons JCS RedisCacheManager 使用Redis作为缓存技术

常规的SpringBoot已经为我们自动配置了EhCache、Collection、Guava、ConcurrentMap等缓存，默认使用 ConcurrentMapCacheManager。SpringBoot的application.properties配置文件，使用spring.cache前缀的属性进行配置。

二，缓存依赖

开始使用前需要导入依赖

spring-boot-starter-cache 为基础依赖，其他依赖根据使用不同的缓存技术选择加入，默认情况下使用 ConcurrentMapCache不需要引用任何依赖

三、application配置

四、缓存注解

下面是缓存公用接口注释，使用与任何缓存技术

1，@EnableCaching：在启动类注解@EnableCaching开启缓存

2，@Cacheable：配置了findByName函数的返回值将被加入缓存。同时在查询时，会先从缓存中获取，若不存在才再发起对数据库的访问。

该注解主要有下面几个参数：

• value、cacheNames：两个等同的参数（cacheNames为Spring 4新增，作为value的别名），用于指定缓存存储的集合名。由于Spring 4中新增了@CacheConfig，因此在Spring 3中原本必须有的value属性，也成为非必需项了
• key：缓存对象存储在Map集合中的key值，非必需，缺省按照函数的所有参数组合作为key值，若自己配置需使用SpEL表达式，比如：@Cacheable(key = “#p0”)：使用函数第一个参数作为缓存的key值
• condition：缓存对象的条件，非必需，也需使用SpEL表达式，只有满足表达式条件的内容才会被缓存，比如：@Cacheable(key = “#p0”, condition = “#p0.length() < 3”)，表示只有当第一个参数的长度小于3的时候才会被缓存
• unless：另外一个缓存条件参数，非必需，需使用SpEL表达式。它不同于condition参数的地方在于它的判断时机，该条件是在函数被调用之后才做判断的，所以它可以通过对result进行判断。
• keyGenerator：用于指定key生成器，非必需。若需要指定一个自定义的key生成器，我们需要去实现org.springframework.cache.interceptor.KeyGenerator接口，并使用该参数来指定。需要注意的是：该参数与key是互斥的
• cacheManager：用于指定使用哪个缓存管理器，非必需。只有当有多个时才需要使用
• cacheResolver：用于指定使用那个缓存解析器，非必需。需通过org.springframework.cache.interceptor.CacheResolver接口来实现自己的缓存解析器，并用该参数指定。

3，@CachePut：主要针对方法配置，能够根据方法的请求参数对其结果进行缓存，和 @Cacheable 不同的是，它每次都会触发真实方法的调用 。简单来说就是用户更新缓存数据。但需要注意的是该注解的value 和 key 必须与要更新的缓存相同，也就是与@Cacheable 相同。示例：

4，@CacheEvict：配置于函数上，通常用在删除方法上，用来从缓存中移除相应数据。除了同@Cacheable一样的参数之外，它还有下面两个参数：

• allEntries：非必需，默认为false。当为true时，会移除所有数据。如：@CachEvict(value=”testcache”,allEntries=true)
• beforeInvocation：非必需，默认为false，会在调用方法之后移除数据。当为true时，会在调用方法之前移除数据。 如：@CachEvict(value=”testcache”，beforeInvocation=true)

5，@CacheConfig： 统一配置本类的缓存注解的属性，在类上面统一定义缓存的名字，方法上面就不用标注了，当标记在一个类上时则表示该类所有的方法都是支持缓存的

五：SpEL上下文数据

Spring Cache提供了一些供我们使用的SpEL上下文数据，下表直接摘自Spring官方文档：

名称位置描述示例 methodName root对象 当前被调用的方法名

method root对象 当前被调用的方法

target root对象 当前被调用的目标对象实例

targetClass root对象 当前被调用的目标对象的类

args root对象 当前被调用的方法的参数列表

caches root对象 当前方法调用使用的缓存列表

Argument Name 执行上下文 当前被调用的方法的参数，如findArtisan(Artisan artisan),可以通过#artsian.id获得参数

result 执行上下文 方法执行后的返回值（仅当方法执行后的判断有效，如 unless cacheEvict的beforeInvocation=false）

注意：

1.当我们要使用root对象的属性作为key时我们也可以将”#root”省略，因为Spring默认使用的就是root对象的属性。 如

@Cacheable(key = "targetClass + methodName +#p0")

2.使用方法参数时我们可以直接使用”#参数名”或者”#p参数index”。 如：

@Cacheable(value="users", key="#id")

@Cacheable(value="users", key="#p0")

SpEL提供了多种运算符

关系

以上的知识点适合你遗忘的时候来查阅，下面正式进入学习！

六：ConcurrentMap Cache

Spring boot默认使用的是SimpleCacheConfiguration，即使用ConcurrentMapCacheManager来实现缓存，ConcurrentMapCache实质是一个ConcurrentHashMap集合对象java内置，所以无需引入其他依赖，也没有额外的配置

ConcurrentMapCache的自动装配声明在SimpleCacheConfiguration中，如果需要也可对它进行额外的装配

七：Caffeine Cache

1，Caffeine参数说明：

• initialCapacity=[integer]: 初始的缓存空间大小
• maximumSize=[long]: 缓存的最大条数
• maximumWeight=[long]: 缓存的最大权重
• expireAfterAccess=[duration]: 最后一次写入或访问后经过固定时间过期
• expireAfterWrite=[duration]: 最后一次写入后经过固定时间过期
• refreshAfterWrite=[duration]: 创建缓存或者最近一次更新缓存后经过固定的时间间隔，刷新缓存refreshAfterWrite requires a LoadingCache
• weakKeys: 打开key的弱引用
• weakValues：打开value的弱引用
• softValues：打开value的软引用

• recordStats：开发统计功能

• refreshAfterWrite必须实现LoadingCache，跟expire的区别是，指定时间过后，expire是remove该key，下次访问是同步去获取返回新值，而refresh则是指定时间后，不会remove该key，下次访问会触发刷新，新值没有回来时返回旧值

• expireAfterWrite和expireAfterAccess同事存在时，以expireAfterWrite为准。
• maximumSize和maximumWeight不可以同时使用
• weakValues和softValues不可以同时使用

2,导入依赖

3、Caffeine配置

（1）通过配置文件来设置Caffeine

（2）通过bean装配

（3）配置文件结合Bean装配

4，实现cacheLoader

CacheLoader是cache的一种加载策略，key不存在或者key过期之类的都可以通过CacheLoader来自定义获得/重新获得数据。使用refreshAfterWrite必须要设置cacheLoader

八：EHCache

EhCache 是一个纯Java的进程内缓存框架，具有快速、精干等特点，是Hibernate中默认CacheProvider。Ehcache是一种广泛使用的开源Java分布式缓存。主要面向通用缓存,Java EE和轻量级容器。它具有 内存和磁盘存储，缓存加载器,缓存扩展,缓存异常处理程序,一个gzip缓存servlet过滤器,支持REST和SOAP api等特点。

1，导入依赖

引入 springboot-cache和 ehcache。需要注意， EhCache 不需要配置 version，SpringBoot的根pom已经集成了。

2，加入配置：

3，ehcache配置文件

EhCache的配置文件ehcache.xml只需要放到类路径下面，SpringBoot会自动扫描

4，装配

SpringBoot会为我们自动配置 <span class="pln"><span class="typ">EhCacheCacheManager</span></span>这个Bean，如果想自定义设置一些个性化参数时，通过Java Config形式配置。

九：Redis

1，Redis 优势

• 分布式
• 性能极高 – Redis能读的速度是110000次/s,写的速度是81000次/s 。
• 丰富的数据类型 – Redis支持二进制案例的 Strings, Lists, Hashes, Sets 及 Ordered Sets 数据类型操作。
• 原子 – Redis的所有操作都是原子性的，意思就是要么成功执行要么失败完全不执行。单个操作是原子性的。多个操作也支持事务，即原子性，通过MULTI和EXEC指令包起来。
• 丰富的特性 – Redis还支持 publish/subscribe, 通知, key 过期等等特性

2， 导入依赖

就只需要这一个依赖！不需要 spring-boot-starter-cache

当你导入这一个依赖时，SpringBoot的CacheManager就会使用RedisCache。

Redis使用模式使用pool2连接池，在需要时引用下面的依赖

4，配置Redis

如果你的Redis这时候已经可以启动程序了。

5，装配

如果需要自定义缓存配置可以通过，继承CachingConfigurerSupport类，手动装配，如果一切使用默认配置可不必

(1) 装配序列化类型

(2) 装配过期时间

(3) 一个比较完整的装配类 demo

6，模板编程

除了使用注解，Spring boot集成 Redis 客户端jedis。封装Redis 连接池，以及操作模板，可以方便的显示的在方法的代码中处理缓存对象

Original: https://www.cnblogs.com/ejiyuan/p/11014765.html
Author: ejiyuan
Title: Spring Boot Cache使用与整合