第十六章：使用Redis作为SpringBoot项目数据缓存

我们平时在项目中设计数据访问的时候往往都是采用直接访问数据库，采用数据库连接池来实现，但是如果我们的项目访问量过大或者访问过于频繁，将会对我们的数据库带来很大的压力。为了解决这个问题从而redis数据库脱颖而出，redis数据库出现时是以非关系数据库的光环展示在广大程序猿的面前的，后来redis的迭代版本支持了缓存数据、登录session状态（分布式session共享）等。所以又被作为内存缓存的形式应用到大型企业级项目中。

本章目标

实现SpringBoot项目中整合Redis非关系数据库作为内存缓存框架，并测试数据读取源。

安装Redis

官网的redis仅支持Linux服务器的安装版本，由于开发人员都是在windows上工作，所以GitHub上的牛人基于linux平台下的Redis实现了windows版本。

下载Windows版本Redis

我们直接访问github网址：github.com/MSOpenTech/redis/releases，下载最新的windows X64版本的压缩包，如下图1所示：

图1

我们下载第二个就可以了，第一个是安装程序方式可以直接安装不过不太喜欢那种形式，第二个则是压缩包的形式解压完就可以用，第三、四个都是源码文件。下载完成后随便解压到我们的盘符内的文件即可，如下图2所示：

图2

开启Redis

解压完成后我们来开启Redis数据库，Redis数据库的默认端口是6379，如果已经被其他应用程序占用，请自行修改redis.windows.conf配置文件，修改位置如下图3所示：

图3

如果没有端口没有被占用，我们需要在cmd命令窗口执行运行Redis，我们首先使用cmd命令进入到Redis解压目录并且执行redis-server.exe redis.windows.conf命令即可，如下图4所示：

图4

可以看到上述图4，我们的redis数据库已经启动了，下面输出日志开启了服务链接在6379端口。好了我们的数据库已经配置完成了，接下来我们来构建SpringBoot整合Redis项目。

构建项目

我们使用IntelliJ IDEA工具构建一个SpringBoot项目，预先添加依赖Web、MySQL、JPA、Druid等。项目结构如下图5所示：

图5

接下来复制第十三章：SpringBoot实战SpringDataJPA文章项目源码（源码地址：git.oschina.net/jnyqy/lessons）的application.yml配置文件到本章节项目的resources目录下，如下图6所示：

图6

自行修改本地的数据库连接池的连接地址、用户名、密码就可以了。这个配置是我本地的！

配置支持Redis

构建完成后我们需要让我们的SpringBoot项目支持Redis数据库才能完成缓存的操作。

添加Redis依赖

我们打开pom.xml配置文件添加对应的redis缓存依赖maven配置，如下图7所示：

图7

我们添加缓存的支持需要两个依赖，一个是SpringBoot内部的缓存配置、另外则是我们的redis缓存。

配置Redis数据库

依赖添加完成后，需要配置我们本地的redis数据库连接到项目中，我们打开application.yml配置文件添加如下图8所示的配置内容：

图8

配置CacheManager

下面我们需要让SpringBoot内置的缓存框架使用我们的Redis作为新的缓存，我们来添加一个RedisConfiguration的配置类，并添加对应的配置如下图9所示：

图9

我们使用@EnableCaching注解来开启我们的项目支持缓存，我们在配置类内添加了方法cacheManager()，方法的返回值则是使用了我们的Redis缓存的管理器，SpringBoot项目启动时就会去找自定义配置的CacheManager对象并且自动应用到项目中。

上述就是有关Redis的所有配置，现在我们来编写一个测试的请求读取数据库内的单表数据，查看是否已经可以缓存数据。

使用Redis

我们现在我们本地的MySQL数据库内创建一张表结构，如下图10所示：

图10

表内就是几个简单的测试字段，下面我们根据对应的字段创建UserEntity，代码如下图11所示：

图11

截图省略了getter/setter，请自行添加上。下面我们根据UserEntity创建一个SpringDataJPA支持的JPA接口，（如需了解SpringDataJPA请访问：第十三章：SpringBoot实战SpringDataJPA）接口代码如下图12所示：

图12

创建JPA完成后，我们对应的创建一个业务逻辑服务类：UserService，我们在Service内添加redis的缓存支持，如下图13所示：

图13

在上图13内有两个新的注解，

@CacheConfig：该注解是用来开启声明的类参与缓存,如果方法内的@Cacheable注解没有添加key值，那么会自动使用cahceNames配置参数并且追加方法名。

@Cacheable：配置方法的缓存参数，可自定义缓存的key以及value。

再来添加一个名叫UserController的控制器，使用@RestController风格注解。如下图14所示：

图14

好了，下面我们来启动项目访问地址查看效果。

测试Redis

运行项目并查看控制台输出的日志是否存在异常，启动成功后访问地址：127.0.0.1:8080/list，界面输出内容如下图15所示：

图15

数据为测试数据，在启动项目之前需要手动添加到数据库。我们再来看下控制台输出的SQL，如下图16所示：

图16

可以看到是正常的访问数据库并且执行了JPA自动生成的SQL，那么为了验证Redis缓存，我们再来请求依次列表，界面输出内容如下图17所示：

图17

可以看到我们同样是可以访问到数据的，而且跟上次访问列表的数据一致，那么神奇的地方来了，我们去看下控制台的SQL输出，如下图18所示：

图18

可以看到只有一次输出，这个输出还是我们上次访问的时候执行的，证明我们配置的Redis缓存已经生效，下面我们使用Redis的客户端来查看下是否已经存在。

使用Redis-Cli客户端

我们使用Cmd命令进入我们的Redis解压目录，并执行redis-cli.exe应用程序，效果如下图19所示：

图19

可以看到Redis为我们自动生成的Key让我们很无奈，根本看不懂！那我们以后维护起来就很复杂了。下面我们来自定义Redis生成Key的规则！

自定义Key

我们打开RedisConfiguration配置类，添加继承CachingConfigurerSupport类，并重写方法keyGenerator()，代码如下图20所示：

图20

如上图20所述，我们根据类名、方法名、参数列表等完成自定义Redis缓存的Key定义，下面我们重启下项目，两次访问127.0.0.1:8080/list地址查看界面输出，如下图21所示：

图21

可以看到跟我们之前一样，第一次放了数据库，第二次查询了缓存数据，我们再来通过redis-cli客户端查看下数据库内保存的key是否已经按照我们自定义规则生成。如下图22所示：

图22

可以看到第二条，就是根据我们规则生成的key。

Redis命令

Redis数据库内有很多个命令下面我简单介绍几个大家在日常开发中常用到的。

flushdb：清空当前数据库。

select index：选择索引数据库，index为索引值名，如：select 1。

del key：删除一条指定key的值。

keys *：查看数据库内所有的key。

flushall：清空所有数据库。

quit：退出客户端连接。

总结

以上所述就是本章的全部讲解内容，本章主要讲解了SpringBoot项目中如何使用Redis非关系型数据库作为缓存框架，并完成自定义Redis生成的key值。

本章所用到的数据库已经放置到resources目录下，请访问码云下载。

本章代码已经上传到码云：

SpringBoot配套源码地址：https://gitee.com/hengboy/spring-boot-chapter

SpringCloud配套源码地址：https://gitee.com/hengboy/spring-cloud-chapter

SpringBoot相关系列文章请访问：目录：SpringBoot学习目录

QueryDSL相关系列文章请访问：QueryDSL通用查询框架学习目录

SpringDataJPA相关系列文章请访问：目录：SpringDataJPA学习目录

SpringBoot相关文章请访问：目录：SpringBoot学习目录，感谢阅读！

​