为了减轻数据库压力和提高访问速度,从spring3.1开始映入了基于注解的缓存机制。
1.Java Caching定义了5个核心接口,分别是CachingProvider, CacheManager, Cache, Entry 和 Expiry。
(1)CachingProvider定义了创建、配置、获取、管理和控制多个CacheManager。一个应用可以在运行期访问多个CachingProvider。
(2)CacheManager定义了创建、配置、获取、管理和控制多个唯一命名的Cache,这些Cache存在于CacheManager的上下文中。一个CacheManager仅被一个CachingProvider所拥有。
(3)Cache是一个类似Map的数据结构并临时存储以Key为索引的值。一个Cache仅被一个CacheManager所拥有。
(4)Entry是一个存储在Cache中的key-value对。
(5)Expiry 每一个存储在Cache中的条目有一个定义的有效期。一旦超过这个时间,条目为过期的状态。一旦过期,条目将不可访问、更新和删除。缓存有效期可以通过ExpiryPolicy设置。
2.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)从缓存中读取之前缓存存储的数据
(3)重要概念和注解
Cache |
缓存接口,定义缓存操作。实现有:RedisCache、EhCacheCache、ConcurrentMapCache等 |
CacheManager |
缓存管理器,管理各种缓存(Cache)组件 |
@Cacheable |
主要针对方法配置,能够根据方法的请求参数对其结果进行缓存 |
@CacheEvict |
清空缓存 |
@CachePut |
保证方法被调用,又希望结果被缓存。 |
@EnableCaching |
开启基于注解的缓存 |
keyGenerator |
缓存数据时key生成策略 |
serialize |
缓存数据时value序列化策略 |
3.spring boot 的对于缓存的配置在org.springframework.boot.autoconfigure.cache.CacheAutoConfiguration中,spring boot 配置提供不同的类型cacheManager的配置,如SimpleCacheConfigure,RedisCacheConfigure,EnCacheCacheConfigure,默认情况下啊生效的是SimpleCacheConfigure,它会给容器中注入一个ConcurrentMapCache组件,将缓存数据保存保存在ConcurrentMap 中。
缓存的运行流程
(1)先去查询缓存组件(cache),如果没有则自动创建一个。
(2)使用key去cacahe中查找
(3)如果没有查到就去目标方法查找
(4)将查询结果返回(如果缓存中没有则将结果存入缓存)
4.使用方法
(1)添加缓存依赖
<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-cache</artifactId> </dependency>
(2)在主程序使用@EnableCaching注解,开启缓存服务
package com.springboot; import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.SpringBootApplication; import org.springframework.cache.annotation.EnableCaching; @SpringBootApplication @EnableCaching public class SpringbootWebCacheApplication { public static void main(String[] args) { SpringApplication.run(SpringbootWebCacheApplication.class, args); } }
(3)在目标方法上使用@Cacheable注解
package com.springboot.service; import org.slf4j.Logger; import org.slf4j.LoggerFactory; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.cache.annotation.Cacheable; import org.springframework.stereotype.Service; import com.springboot.entity.Employee; import com.springboot.mapper.EmployeeMapper; @Service public class EmployeeService { private static final Logger log = LoggerFactory.getLogger(EmployeeService.class); @Autowired EmployeeMapper employeeMapper; @Cacheable(cacheNames= {"emp"}) public Employee getEmpByID(Integer id) { log.info("查询"+id+"号员工"); Employee emp = employeeMapper.selectByPrimaryKey(id); return emp; } }
5.关于缓存有以下几个参数
(1)@CacheConfig:主要用于配置该类中会用到的一些共用的缓存配置。在这里@CacheConfig(cacheNames = "users"):配置了该数据访问对象中返回的内容将存储于名为users的缓存对象中,我们也可以不使用该注解,直接通过@Cacheable自己配置缓存集的名字来定义。
(2)@Cacheable:配置了findByName函数的返回值将被加入缓存。同时在查询时,会先从缓存中获取,若不存在才再发起对数据库的访问。该注解主要有下面几个参数:
【1】value、cacheNames:两个等同的参数(cacheNames为Spring 4新增,作为value的别名),用于指定缓存存储的集合名。由于Spring 4中新增了@CacheConfig,因此在Spring 3中原本必须有的value属性,也成为非必需项了
【2】key:缓存对象存储在Map集合中的key值,非必需,缺省按照函数的所有参数组合作为key值,若自己配置需使用SpEL表达式,比如:@Cacheable(key = "#p0"):使用函数第一个参数作为缓存的key值,更多关于SpEL表达式的详细内容可参考官方文档
【3】condition:缓存对象的条件,非必需,也需使用SpEL表达式,只有满足表达式条件的内容才会被缓存,比如:@Cacheable(key = "#p0", condition = "#p0.length() < 3"),表示只有当第一个参数的长度小于3的时候才会被缓存,若做此配置上面的AAA用户就不会被缓存,读者可自行实验尝试。
【4】unless:另外一个缓存条件参数,非必需,需使用SpEL表达式。它不同于condition参数的地方在于它的判断时机,该条件是在函数被调用之后才做判断的,所以它可以通过对result进行判断。
【5】keyGenerator:用于指定key生成器,非必需。若需要指定一个自定义的key生成器,我们需要去实现org.springframework.cache.interceptor.KeyGenerator接口,并使用该参数来指定。需要注意的是:该参数与key是互斥的
【6】cacheManager:用于指定使用哪个缓存管理器,非必需。只有当有多个时才需要使用
【7】cacheResolver:用于指定使用那个缓存解析器,非必需。需通过org.springframework.cache.interceptor.CacheResolver接口来实现自己的缓存解析器,并用该参数指定。
【8】sync:是否异步,默认为同步,即方法执行完将结果缓存,异步情况下不支持unless。
除了这里用到的两个注解之外,还有下面几个核心注解:
(3)@CachePut:配置于函数上,能够根据参数定义条件来进行缓存或更新缓存,它与@Cacheable不同的是,它每次都会真是调用函数,所以主要用于数据新增和修改操作上。它的参数与@Cacheable类似,具体功能可参考上面对@Cacheable参数的解析。需要注意的是如果要对同一笔数据进行更新操作,那@CachePut和@Cacheable 使用的key必须是一致的。
(4)@CacheEvict:配置于函数上,通常用在删除方法上,用来从缓存中移除相应数据。除了同@Cacheable一样的参数之外,它还有下面两个参数:
【1】allEntries:非必需,默认为false。当为true时,会移除所有数据
【2】beforeInvocation:非必需,默认为false,会在调用方法之后移除数据。当为true时,会在调用方法之前移除数据。