SpringCache
介绍
Spring Cache是一个框架,实现了基于注解的缓存功能,只需要简单地加一个注解,就能实现缓存功能,大大简化我们在业务中操作缓存的代码
Spring Cache只是提供了一层抽象,底层可以切换不同的cache实现。具体就是通过CacheManager接口来统一不同的缓存技术CacheManager是Spring提供的各种缓存技术抽象接口
针对不同的缓存技术需要实现不同的CacheManager
CacheManager | 描述 |
---|---|
EhCacheCacheManager | 使用EhCache作为缓存技术 |
GuavaCacheManager | 使用Google的GuavaCache作为缓存技术 |
RedisCacheManager | 使用Redis作为缓存技术 |
注解
在SpringCache中提供了很多缓存操作的注解,常见的是以下的几个:
注解 | 说明 |
---|---|
@EnableCaching | 开启缓存注解功能(写在启动类上) |
@Cacheable(if) | 在方法执行前spring先查看缓存中是否有数据,如果有数据,则直接返回缓存数据;若没有数据,调用方法并将方法返回值放到缓存中(1. exists key-> get key/(set key value) |
@CachePut | 将方法的返回值放到缓存中(set key value) |
@CacheEvict | 将一条或多条数据从缓存中删除(适用于增删改方法)(del key) |
在spring boot项目中,使用缓存技术只需在项目中导入相关缓存技术的依赖包,并在启动类上使用@EnableCaching开启缓存支持即可
例如
使用Redis作为缓存技术,只需要导入Spring data Redis的maven坐标即可
入门程序
SpringCache可以集成不同的缓存技术,如Redis、Ehcache甚至我们可以使用Map来缓存数据
环境准备
-
数据库准备
自备
-
导入基础工程
由于SpringCache的基本功能是Spring核心(spring-context)中提供的,所以进行简单的SpringCache测试,是可以不用额外引入其他依赖的
-
注入CacheManager
注入一个CacheManager,在Debug时,我们可以通过CacheManager跟踪缓存中数据的变化
CacheManager是一个接口,默认的实现有以下几种
在这几个实现中,默认使用的是 ConcurrentMapCacheManager
-
引导类上加@EnableCaching
在引导类上加该注解,就代表当前项目开启缓存注解功能
@EnableCaching //开启缓存注解功能
@CachePut注解
说明
作用
将方法返回值,放入缓存
value
缓存的名称, 每个缓存名称下面可以有很多key
key
缓存的key 支持Spring的表达式语言SPEL语法
在save方法上加注解@CachePut
当前UserController的save方法是用来保存用户信息的,在该用户信息保存到数据库的同时,也往缓存中缓存一份数据,我们可以在save方法上加上注解 @CachePut
/**
* CachePut:将方法返回值放入缓存
* value:缓存的名称,每个缓存名称下面可以有多个key
* key:缓存的key
*/
@CachePut(value = "userCache", key = "#result.id")
//vlaue: 是外层hashmap 的key (map1 的key)
//key: 是内层hashmap 的key (map2 的key)
//思考: 为啥要设置两个key
// 分类存储, 有利于提升查询效率
@PostMapping
public User save(User user){
userService.save(user);
return user;
}
key的写法
- #user.id
#user指的是方法形参的名称, id指的是user的id属性 , 也就是使用user的id属性作为key
- #user.name
#user指的是方法形参的名称, name指的是user的name属性 ,也就是使用user的name属性作为key
- #result.id
#result代表方法返回值,该表达式 代表以返回对象的id属性作为key
- #result.name
#result代表方法返回值,该表达式 代表以返回对象的name属性作为key
测试
启动服务,通过postman请求访问UserController的方法, 然后通过断点的形式跟踪缓存数据
@Autowired
private CacheManager cacheManager;
//http://localhost:8080/user/test
@GetMapping("/test")
public String test() {
System.out.println(cacheManager);
return "成功";
}
第一次访问时,缓存中的数据是空的,因为save方法执行完毕后才会缓存数据
第二次访问时,我们通过debug可以看到已经有一条数据了,就是上次保存的数据,已经缓存了,缓存的key就是用户的id
注意
最终的数据,实际上是缓存在ConcurrentHashMap中,那么当我们的服务器重启之后,缓存中的数据就会丢失
#注意
#方法的返回值需要序列化,否则会报以下错误
java.lang.IllegalArgumentException: DefaultSerializer requires a
Serializable payload but received an object of type
[com.itheima.entity.User]
@Data
public class User implements Serializable {
}
@CacheEvict注解
说明
evict
驱逐,逐出
作用
清理指定缓存
value
缓存的名称,每个缓存名称下面可以有多个key
key
缓存的key ----------> 支持Spring的表达式语言SPEL语法
在 delete 方法上加注解@CacheEvict
当我们在删除数据库user表的数据的时候,我们需要删除缓存中对应的数据,此时就可以使用@CacheEvict注解,
/**
* CacheEvict:清理指定缓存
* value:缓存的名称,每个缓存名称下面可以有多个key
* key:缓存的key
*/
//@CacheEvict(value = "userCache",key = "#p0") //#p0 代表第一个参数: parameter
//@CacheEvict(value = "userCache",key = "#root.args[0]") //#root.args[0] 代表第一个参数
@CacheEvict(value = "userCache",key = "#id") //#id 代表变量名为id的参数
@DeleteMapping("/{id}")
public void delete(@PathVariable Long id){
userService.removeById(id);
}
测试
要测试缓存的删除,我们先访问save方法,保存数据到数据库的同时,也保存到缓存中,最终我们可以通过debug看到缓存中的数据信息。 然后我们在通过postman访问delete方法
删除数据时,通过debug我们可以看到已经缓存的数据
当执行完delete操作之后,我们再次保存一条数据,在保存的时候debug查看一下删除的ID值是否已经被删除
在 update 方法上加注解@CacheEvict
在更新数据之后,数据库的数据已经发生了变更,我们需要将缓存中对应的数据删除掉,避免出现数据库数据与缓存数据不一致的情况
//@CacheEvict(value = "userCache",key = "#p0.id") //第一个参数的id属性
//@CacheEvict(value = "userCache",key = "#root.args[0].id") //第一个参数的id属性
@CacheEvict(value = "userCache",key = "#user.id") //参数名为user参数的id属性
@PutMapping
public User update(User user){
userService.updateById(user);
return user;
}
加上注解之后,我们可以重启服务,然后测试方式,基本和上述相同,先缓存数据,然后再更新某一条数据,通过debug的形式查询缓存数据的情况
@Cacheable注解
说明
作用
在方法执行前,spring先查看缓存中是否有数据,如果有数据,则直接返回缓存数据;若没有数据,调用方法并将方法返回值放到缓存中
value
缓存的名称,每个缓存名称下面可以有多个key
key
缓存的key 支持Spring的表达式语言SPEL语法
//1、判断缓存中是否存在数据
if (cache != null) {
return cache; //方法就不再执行了
} else {
//2、查询数据库,获取数据
//3、获取到数据添加到缓存中
}
在getById上加注解@Cacheable
/**
* Cacheable:在方法执行前spring先查看缓存中是否有数据,如果有数据,则直接返回缓存数据;若没有数据,调用方法并将方法返回值放到缓存中
* value:缓存的名称,每个缓存名称下面可以有多个key
* key:缓存的key
*/
@Cacheable(value = "userCache",key = "#id")
//1.先判断缓存中是否存在此id的数据
//1.1 -> 不存在,就查询数据库-》放到缓存中
//1.2 -> 存在,直接返回缓存中的用户信息
@GetMapping("/{id}")
public User getById(@PathVariable Long id){
User user = userService.getById(id);
return user;
}
测试
我们可以重启服务,然后通过debug断点跟踪程序执行。我们发现,第一次访问,会请求我们controller的方法,查询数据库。后面再查询相同的id,就直接获取到数据库,不用再查询数据库了,就说明缓存生效了
当我们在测试时,查询一个数据库不存在的id值,第一次查询缓存中没有,也会查询数据库。而第二次再查询时,会发现,不再查询数据库了,而是直接返回,那也就是说如果根据ID没有查询到数据,那么会自动缓存一个null值。 我们可以通过debug,验证一下
当查询到的值不为null时,再进行缓存,如果为null,则不缓存
缓存非null值
在@Cacheable注解中,提供了两个属性
condition
表示满足条件, 再进行缓存
unless
表示满足条件则不缓存 ; 与上述的condition是反向的
实例
/**
* Cacheable:在方法执行前spring先查看缓存中是否有数据,如果有数据,则直接返回缓存数据;若没有数据,调用方法并将方法返回值放到缓存中
* value:缓存的名称,每个缓存名称下面可以有多个key
* key:缓存的key
* condition:条件,满足条件时才缓存数据
* unless:满足条件则不缓存
*/
@Cacheable(value = "userCache",key = "#id", unless = "#result == null")
@GetMapping("/{id}")
public User getById(@PathVariable Long id){
User user = userService.getById(id);
return user;
}
注意
此处,我们使用的时候只能使用 unless(什么时候不存储)
- condition中只能使用方法参数中数据
- unless才能使用方法返回值中的数据
在list方法上加注解@Cacheable
在list方法中进行查询时,有两个查询条件,如果传递了id,根据id查询; 如果传递了name, 根据name查询,那么我们缓存的key在设计的时候,就需要既包含id,又包含name
@Cacheable(value = "userCache",key = "#user.id + '_' + #user.name")
@GetMapping("/list")
public List<User> list(User user){
LambdaQueryWrapper<User> queryWrapper = new LambdaQueryWrapper<>();
queryWrapper.eq(user.getId() != null,User::getId,user.getId());
queryWrapper.eq(user.getName() != null,User::getName,user.getName());
List<User> list = userService.list(queryWrapper);
return list;
}
重启服务,进行测试
第一次查询时,需要查询数据库,在后续的查询中,就直接查询了缓存,不再查询数据库了
key 的规则
如果想从参数列表中读取数据
格式: #变量名.属性名
#user.id : #user指的是方法形参的名称, id指的是user的id属性 , 也就是使用user的id属性作为key ;
#user.name: #user指的是方法形参的名称, name指的是user的name属性 ,也就是使用user的name属性作为key ;
#id 代表变量名为id的参数
#不常用
格式:#p0 代表第一个参数
格式:#root.args[0] 代表第一个参数
如果想从返回值中读取数据
格式: #result.属性名
#result.id : #result代表方法返回值,该表达式 代表以返回对象的id属性作为key ;
#result.name : #result代表方法返回值,该表达式 代表以返回对象的name属性作为key ;
集成Redis
使用默认的ConcurrentHashMap做缓存时,服务重启之后,之前缓存的数据就全部丢失了,操作起来并不友好。
在项目中使用,会选择使用redis来做缓存,主要需要操作以下几步
pom.xml
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-cache</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-data-redis</artifactId>
</dependency>
application.yml
spring:
redis:
host: 192.168.200.200 #改成自己的
port: 6379
#password: 123456
database: 0
cache: #spring cache的配置
redis:
time-to-live: 1800000 #设置缓存过期时间,可选,单位默认毫秒
测试
重新启动项目,通过postman发送根据id查询数据的请求,然后通过redis的图形化界面工具,查看redis中是否可以正常的缓存数据