1、介绍
Spring Cache是一个框架,实现了基于注解的缓存功能,只需要简单地加一个注解,就能实现缓存功能,大大简化我们在业务中操作缓存的代码。
如果我们不知道SpringCache 这个技术,那在项目开发中还需要我们自己去实现缓存的逻辑,比如 数据在缓存中是否存在,没有就去数据库查询再加到缓存中。
那我们学会了如何使用 SpringCache 就不需要我们自己去手动去实现这些操作,通过 SpringCache 提供的注解就能大大的简化我们的这个缓存操作的代码,然后提高我们的开发效率。
Spring Cache 提供了一层抽象,底层可以切换不同的cache实现。具体就是通过CacheManager接口来统一不同的缓存技术。CacheManager是Spring提供的各种缓存技术抽象接口。
CacheManager | 描述 |
---|---|
EhCacheCacheManager | 使用EhCache作为缓存技术 |
GuavaCacheManager | 使用Google的GuavaCache作为缓存技术 |
RedisCacheManager | 使用Redis作为缓存技术 |
2、注解
在SpringCache中提供了很多缓存操作的注解,常见的是以下的几个:
注解 | 说明 |
---|---|
@EnableCaching | 开启缓存注解功能 |
@Cacheable | 在方法执行前spring先查看缓存中是否有数据,如果有数据,则直接返回缓存数据;若没有数据,调用方法并将方法返回值放到缓存中 |
@CachePut | 将方法的返回值放到缓存中 |
@CacheEvict | 将一条或多条数据从缓存中删除 |
在spring boot项目中,使用缓存技术只需在项目中导入相关缓存技术的依赖包,并在启动类上使用@EnableCaching开启缓存支持即可。
例如,我想要使用Redis作为缓存技术,那我就只需要再项目导入Spring data Redis的maven坐标即可,它自己会帮我们进行整合。
3、 入门案例
接下来,我们通过一个入门案例来学习如何在项目开发中使用 SpringCache ,虽然使用起来比较简单,但是还是有一些细节问题值得我们来了解一下。
上面我们提到,SpringCache 可以集成不同的缓存技术,如Redis、Ehcache甚至我们可以使用Map来实现这个缓存数据, 接下来的案例,我们可以先使用最基础的 Map 方式演示一遍,然后再去使用 Redis。
SpringCache的基本功能是Spring核心(spring-context)中提供的,所以目前我们进行简单的SpringCache测试,是可以不用额外引入其他依赖的。
当然,我们后面需要用到 Redis 来进行 数据缓存 就要还需要导入下面两个坐标。
<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>
3.1 环境准备
1、我们可以在Controller注入一个CacheManager,在Debug时,我们可以通过CacheManager跟踪缓存中数据的变化。
2、 启动类上加@EnableCaching,代表当前项目开启缓存注解功能。
3.2 @CachePut注解
作用 | 将方法返回值,放入缓存。 |
---|---|
value | 缓存的名称, 每个缓存名称下面可以有很多key。 |
key | 缓存的key ----------> 支持Spring的表达式语言SPEL语法 |
既然我们知道 @CachePut 的作用了,那大家最觉得 它适合放在哪一类的方法上比较合适?
很明显,那就是新增方法上,因为我们 将一条数据插到我们数据库中的表中了,对应的也应该要插入到缓存中。
大家可以看到我们上面key 的 写法 有一点点不一样,我们每次增加一个用户,都会缓存一个数据,所以这个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的方法, 最后通过断点的形式跟踪缓存数据。
第一次访问时,缓存中的数据是空的,因为save方法执行完毕后才会缓存数据。
第二次访问时,我们通过debug可以看到已经有一条数据了,就是上次保存的数据,已经缓存了,缓存的key就是用户的id。
咳咳!注意,我们上面的演示,最终的数据是缓存在 ConcurrentHashMap ,当我们将项目重启后,缓存中的数据就会消失,我们后面使用了Redis来缓存就不存在这样的问题了。
3.3 @CacheEvict注解
作用 | 清理指定缓存。 |
---|---|
value | 缓存的名称,每个缓存名称下面可以有多个key。 |
key | 缓存的key ----------> 支持Spring的表达式语言SPEL语法。 |
既然我们知道 @CacheEvict 的作用了,那大家大概也知道它适合放在哪一类的方法上了。
那当然是删除方法和修改方法上,数据库的数据已经发生了变更,我们就需要将缓存中对应的数据删除掉,避免出现数据库数据与缓存数据不一致的情况。
key 的写法 :
#p0 | 代表第一个参数 |
---|---|
#root.args[0] | 代表第一个参数 |
#id | 代表变量名为id的参数 |
接下来我们再进入测试,要想测试删除,就必须要有数据,所以我们先执行几次增加方法,保存数据到数据库的同时,也保存到缓存中。 然后我们在通过postman访问delete方法, 如下:
删除数据时,通过debug我们可以看到已经缓存的数据:
当执行完delete操作之后,我们再次保存一条数据,在保存的时候debug查看一下删除的ID值是否已经被删除。
3.4 @Cacheable注解
|
作用 | 在方法执行前,spring先查看缓存中是否有数据,如果有数据,则直接返回缓存数据;
若没有数据,调用方法并将方法返回值放到缓存中。 | |
---|---|
value | 缓存的名称,每个缓存名称下面可以有多个key。 |
key | 缓存的key ----------> 支持Spring的表达式语言SPEL语法 |
了解了 @Cacheable 的作用,那大家应该都知道它适合放在 查询方法上了。
3.4.1 测试
我们可以重启服务,然后通过debug断点跟踪程序执行。
我们发现,第一次访问,会请求我们controller的方法,查询数据库。后面再查询相同的id,就直接获取到数据库,不用再查询数据库了,就说明缓存生效了。
我们在测试时,查询一个数据库不存在的id值,第一次查询缓存中没有,也会查询数据库。
而第二次再查询时,会发现,不再查询数据库了,而是直接返回,那也就是说如果根据ID没有查询到数据,那么会自动缓存一个null值。
3.4.2 缓存非null值
我们能不能做到,当查询到的值不为null时,再进行缓存,如果为null,则不缓存呢? 答案是可以的。
在@Cacheable注解中,提供了两个属性分别为: condition, unless 。
- condition : 表示满足什么条件, 再进行缓存 ;
- unless : 表示满足条件则不缓存 ; 与上述的condition是反向的 ;
我们在list方法中进行查询时,有两个查询条件,如果传递了id,根据id查询;
如果传递了name, 根据name查询,那么我们缓存的key在设计的时候,就需要既包含id,又包含name。 具体的代码实现如下:
测试结果就是 第一次查询时,需要查询数据库,在后续的查询中,就直接查询了缓存,不再查询数据库了。
4 、集成Redis
在使用上述默认的ConcurrentHashMap做缓存时,在我们服务重启之后,之前缓存的数据就全部丢失了,操作起来并不友好。在项目中使用,我们会选择使用redis来做缓存,主要需要操作以下几步:
1、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>
2、编写yml 文件。
3、 测试
重新启动项目,通过postman发送根据id查询数据的请求,然后通过redis的图形化界面工具,查看redis中是否可以正常的缓存数据。