Spring Boot + Mybatis + Redis二级缓存开发指南

朴灿烈づ我的快乐病毒、 2022-06-08 22:25 94阅读 0赞

背景

Spring-Boot因其提供了各种开箱即用的插件，使得它成为了当今最为主流的Java Web开发框架之一。Mybatis是一个十分轻量好用的ORM框架。Redis是当今十分主流的分布式key-value型数据库，在web开发中，我们常用它来缓存数据库的查询结果。

本篇博客将介绍如何使用Spring-Boot快速搭建一个Web应用，并且采用Mybatis作为我们的ORM框架。为了提升性能，我们将Redis作为Mybatis的二级缓存。为了测试我们的代码，我们编写了单元测试，并且用H2内存数据库来生成我们的测试数据。通过该项目，我们希望读者可以快速掌握现代化Java Web开发的技巧以及最佳实践。

本文的示例代码可在Github中下载：https://github.com/Lovelcp/spring-boot-mybatis-with-redis/tree/master

环境

开发环境：mac 10.11

ide：Intellij 2017.1

jdk：1.8

Spring-Boot：1.5.3.RELEASE

Redis：3.2.9

Mysql：5.7

首先，我们需要初始化我们的Spring-Boot工程。通过Intellij的Spring Initializer，新建一个Spring-Boot工程变得十分简单。首先我们在Intellij中选择New一个Project：

![01a74ec181094cef95b9a6349800a599.webp][]

然后在选择依赖的界面，勾选Web、Mybatis、Redis、Mysql、H2：

![620a7c5a166b4c8a9dfbb5bb9734120b.webp][]

新建工程成功之后，我们可以看到项目的初始结构如下图所示：

![89f02814b2d4457780a9695fd4966a53.webp][]

Spring Initializer已经帮我们自动生成了一个启动类——SpringBootMybatisWithRedisApplication。该类的代码十分简单：

![84849f197ed943a383202178c2e69695.webp][]

@SpringBootApplication注解表示启用Spring Boot的自动配置特性。好了，至此我们的项目骨架已经搭建成功，感兴趣的读者可以通过Intellij启动看看效果。

新建API接口

接下来，我们要编写Web API。假设我们的Web工程负责处理商家的产品（Product）。我们需要提供根据product id返回product信息的get接口和更新product信息的put接口。首先我们定义Product类，该类包括产品id，产品名称name以及价格price：

![8ede7984ba4e447ca051fcbf59f318f8.webp][]

然后我们需要定义Controller类。由于Spring Boot内部使用Spring MVC作为它的Web组件，所以我们可以通过注解的方式快速开发我们的接口类：

![23706391216b4a9f8ae51e7ea7900949.webp][]

我们简单介绍一下上述代码中所用到的注解的作用：

@RestController：表示该类为Controller，并且提供Rest接口，即所有接口的值以Json格式返回。该注解其实是@Controller和@ResponseBody的组合注解，便于我们开发REST API。

@RequestMapping、@GetMapping、@PutMapping：表示接口的URL地址。标注在类上的@RequestMapping注解表示该类下的所有接口的URL都以/product开头。@GetMapping表示这是一个Get HTTP接口，@PutMapping表示这是一个Put HTTP接口。

@PathVariable、@RequestBody：表示参数的映射关系。假设有个Get请求访问的是/product/123，那么该请求会由getProductInfo方法处理，其中URL里的123会被映射到productId中。同理，如果是Put请求的话，请求的body会被映射到newProduct对象中。

这里我们只定义了接口，实际的处理逻辑还未完成，因为product的信息都存在数据库中。接下来我们将在项目中集成mybatis，并且与数据库做交互。

集成Mybatis 配置数据源

首先我们需要在配置文件中配置我们的数据源。我们采用mysql作为我们的数据库。这里我们采用yaml作为我们配置文件的格式。我们在resources目录下新建application.yml文件：

![23f76d572a524bdc819f16bb2def76b2.webp][]

由于Spring Boot拥有自动配置的特性，我们不用新建一个DataSource的配置类，Sping Boot会自动加载配置文件并且根据配置文件的信息建立数据库的连接池，十分便捷。

笔者推荐大家采用yaml作为配置文件的格式。xml显得冗长，properties没有层级结构，yaml刚好弥补了这两者的缺点。这也是Spring Boot默认就支持yaml格式的原因。

我们已经通过Spring Initializer在pom.xml中引入了mybatis-spring-boot-starte库，该库会自动帮我们初始化mybatis。首先我们在application.yml中指定mybatis的配置文件：

然后我们在resources目录下新建mybatis-config.xml文件。在配置文件中，我们需要指定Product类以及mapper文件的路径：

![c432e8600f564ef1b990a0414b11b0cc.webp][]

接下来，我们再在resourses目录下新建mappers目录，并且新建ProductMapper.xml文件，编写操作products表的SQL语句（该文件的内容请参考笔者在前文贴的Github仓库地址）。最后，再在代码中定义ProductMapper类：

![438d7cd4d5c34c89868beea492bf2855.webp][]

Spring Boot之所以这么流行，最大的原因是它自动配置的特性。开发者只需要关注组件的配置（比如数据库的连接信息），而无需关心如何初始化各个组件，这使得我们可以集中精力专注于业务的实现，简化开发流程。

完成了Mybatis的配置之后，我们就可以在我们的接口中访问数据库了。我们在ProductController下通过@Autowired引入mapper类，并且调用对应的方法实现对product的查询和更新操作，这里我们以查询接口为例：

![23a6dc40800f4a67a7aed1b60ce8112e.webp][]

然后在你的mysql中插入几条product的信息，就可以运行该项目看看是否能够查询成功了。

至此，我们已经成功地在项目中集成了Mybatis，增添了与数据库交互的能力。但是这还不够，一个现代化的Web项目，肯定会上缓存加速我们的数据库查询。接下来，将介绍如何科学地将Redis集成到Mybatis的二级缓存中，实现数据库查询的自动缓存。

集成Redis 配置Redis

同访问数据库一样，我们需要配置Redis的连接信息。在application.yml文件中增加如下配置：

![6580df56c2474341a9887018df738f68.webp][]

上述列出的都为常用配置，读者可以通过注释信息了解每个配置项的具体作用。由于我们在pom.xml中已经引入了spring-boot-starter-data-redis库，所以Spring Boot会帮我们自动加载Redis的连接，具体的配置类org.springframework.boot.autoconfigure.data.redis.RedisAutoConfiguration。通过该配置类，我们可以发现底层默认使用Jedis库，并且提供了开箱即用的redisTemplate和stringTemplate。

将Redis作为二级缓存

Mybatis的二级缓存原理本文不再赘述，读者只要知道，Mybatis的二级缓存可以自动地对数据库的查询做缓存，并且可以在更新数据时同时自动地更新缓存。

实现Mybatis的二级缓存很简单，只需要新建一个类实现org.apache.ibatis.cache.Cache接口即可。

该接口共有以下五个方法：

String getId()：mybatis缓存操作对象的标识符。一个mapper对应一个mybatis的缓存操作对象。

void putObject(Object key, Object value)：将查询结果塞入缓存。

Object getObject(Object key)：从缓存中获取被缓存的查询结果。

Object removeObject(Object key)：从缓存中删除对应的key、value。只有在回滚时触发。一般我们也可以不用实现，具体使用方式请参考：org.apache.ibatis.cache.decorators.TransactionalCache。

void clear()：发生更新时，清除缓存。

int getSize()：可选实现。返回缓存的数量。

ReadWriteLock getReadWriteLock()：可选实现。用于实现原子性的缓存操作。

接下来，我们新建RedisCache类，实现Cache接口：

![12a2c69a93854a84a84bb44de4c52fb1.webp][]

![5bfac7e5dae340d090917ca720e7a783.webp][]

![44c271c72ff7473a855a3d54999fb500.webp][]

讲解一下上述代码中一些关键点：

自己实现的二级缓存，必须要有一个带id的构造函数，否则会报错。

我们使用Spring封装的redisTemplate来操作Redis。网上所有介绍redis做二级缓存的文章都是直接用jedis库，但是笔者认为这样不够Spring Style，而且，redisTemplate封装了底层的实现，未来如果我们不用jedis了，我们可以直接更换底层的库，而不用修改上层的代码。更方便的是，使用redisTemplate，我们不用关心redis连接的释放问题，否则新手很容易忘记释放连接而导致应用卡死。

需要注意的是，这里不能通过autowire的方式引用redisTemplate，因为RedisCache并不是Spring容器里的bean。所以我们需要手动地去调用容器的getBean方法来拿到这个bean，具体的实现方式请参考Github中的代码。

我们采用的redis序列化方式是默认的jdk序列化。所以数据库的查询对象（比如Product类）需要实现Serializable接口。

这样，我们就实现了一个优雅的、科学的并且具有Spring Style的Redis缓存类。

开启二级缓存

接下来，我们需要在ProductMapper.xml中开启二级缓存：

![5a5e337c4dcd4ffaab7c7e26e13902aa.webp][]

<cache type="com.wooyoo.learning.util.RedisCache"/>表示开启基于redis的二级缓存，并且在update语句中，我们设置flushCache为true，这样在更新product信息时，能够自动失效缓存（本质上调用的是clear方法）。

测试 配置H2内存数据库

至此我们已经完成了所有代码的开发，接下来我们需要书写单元测试代码来测试我们代码的质量。我们刚才开发的过程中采用的是mysql数据库，而一般我们在测试时经常采用的是内存数据库。这里我们使用H2作为我们测试场景中使用的数据库。

要使用H2也很简单，只需要跟使用mysql时配置一下即可。在application.yml文件中：

![77ba7875285444bbaacf0df1345405ee.webp][]

为了避免和默认的配置冲突，我们用---另起一段，并且用profiles: test表明这是test环境下的配置。然后只要在我们的测试类中加上@ActiveProfiles(profiles = "test")注解来启用test环境下的配置，这样就能一键从mysql数据库切换到h2数据库。

在上述配置中，schema.sql用于存放我们的建表语句，data.sql用于存放insert的数据。这样当我们测试时，h2就会读取这两个文件，初始化我们所需要的表结构以及数据，然后在测试结束时销毁，不会对我们的mysql数据库产生任何影响。这就是内存数据库的好处。另外，别忘了在pom.xml中将h2的依赖的scope设置为test。

使用Spring Boot就是这么简单，无需修改任何代码，轻松完成数据库在不同环境下的切换。

因为我们是通过Spring Initializer初始化的项目，所以已经有了一个测试类——SpringBootMybatisWithRedisApplicationTests。

Spring Boot提供了一些方便我们进行Web接口测试的工具类，比如TestRestTemplate。然后在配置文件中我们将log等级调成DEBUG，方便观察调试日志。具体的测试代码如下：

![d477522130c14e108ac247231b9f31bd.webp][]

在上述测试代码中：

我们首先调用get接口，通过assert语句判断是否得到了预期的对象。此时该product对象会存入redis中。

然后我们调用put接口更新该product对象，此时redis缓存会失效。

最后我们再次调用get接口，判断是否获取到了新的product对象。如果获取到老的对象，说明缓存失效的代码执行失败，代码存在错误，反之则说明我们代码是OK的。

书写单元测试是一个良好的编程习惯。虽然会占用你一定的时间，但是当你日后需要做一些重构工作时，你就会感激过去写过单元测试的自己。

我们在Intellij中点击执行测试用例，测试结果如下：

![e64fd33481d744f99e312f35f041a2f0_th.webp][]

真棒，显示的是绿色，说明测试用例执行成功了。

总结

本篇文章介绍了如何通过Spring Boot、Mybatis以及Redis快速搭建一个现代化的Web项目，并且同时介绍了如何在Spring Boot下优雅地书写单元测试来保证我们的代码质量。当然这个项目还存在一个问题，那就是mybatis的二级缓存只能通过flush整个DB来实现缓存失效，这个时候可能会把一些不需要失效的缓存也给失效了，所以具有一定的局限性。

希望通过本篇文章，能够给读者带来一些收获和启发。有任何的意见或者建议请在本文下方评论。

参考资料

http://www.baeldung.com/spring-data-redis-tutorial

http://chrisbaileydeveloper.com/projects/spring-boot-redis-heroku-demo/

http://docs.spring.io/spring-data/redis/docs/1.6.2.RELEASE/reference/html/

http://blog.didispace.com/springbootredis/

[01a74ec181094cef95b9a6349800a599.webp]: /images/20220609/41538c314d324c988398713566cf6a45.png
[620a7c5a166b4c8a9dfbb5bb9734120b.webp]: /images/20220609/9f179d0ea02b42b89f83da9aa054e676.png
[89f02814b2d4457780a9695fd4966a53.webp]: /images/20220609/c8f2acda93294a43b5b31c895dcb44c0.png
[84849f197ed943a383202178c2e69695.webp]: /images/20220609/5c9dfe56df37458b8a70a2d58a722aef.png
[8ede7984ba4e447ca051fcbf59f318f8.webp]: /images/20220609/1bd600248b644c21adaaff432da1a20a.png
[23706391216b4a9f8ae51e7ea7900949.webp]: /images/20220609/de59b084592746d48c96563f54dfb27a.png
[23f76d572a524bdc819f16bb2def76b2.webp]: /images/20220609/31db1e30ab954804b26eeeace89f891a.png
[c432e8600f564ef1b990a0414b11b0cc.webp]: /images/20220609/bf5152e27fe14e56b1bbd6a7266bb815.png
[438d7cd4d5c34c89868beea492bf2855.webp]: /images/20220609/00e3a4ca14934421987ccee2e6940b44.png
[23a6dc40800f4a67a7aed1b60ce8112e.webp]: /images/20220609/74c780f35130450487768b1d4a4a2160.png
[6580df56c2474341a9887018df738f68.webp]: /images/20220609/7c208374fd7744f5942d2ca67b926f7e.png
[12a2c69a93854a84a84bb44de4c52fb1.webp]: /images/20220609/25a02c9ebfbf4298bfb0069954235dad.png
[5bfac7e5dae340d090917ca720e7a783.webp]: /images/20220609/fe02e47678694c2bac5ae46589920a93.png
[44c271c72ff7473a855a3d54999fb500.webp]: /images/20220609/42c9f9ee033d42e488b2a61cb9878212.png
[5a5e337c4dcd4ffaab7c7e26e13902aa.webp]: /images/20220609/a68841cff31f4acab327069d9c8a437e.png
[77ba7875285444bbaacf0df1345405ee.webp]: /images/20220609/5d3ed5d362ba4c22b0c3ca76a667dd3d.png
[d477522130c14e108ac247231b9f31bd.webp]: /images/20220609/662e379735f34b08a40652ce1ac32dbb.png
[e64fd33481d744f99e312f35f041a2f0_th.webp]: /images/20220609/accb2d95b52c44c69fa28262c616f341.png