Spring Data Redis 最佳实践!
Spring Data Redis 是 Spring 框架提供的用于操作 Redis 的方式,最近整理了下它的用法,解决了使用过程中遇到的一些难点与坑点,希望对大家有所帮助。本文涵盖了 Redis 的安装、Spring Cache 结合 Redis 的使用、Redis 连接池的使用和 RedisTemplate 的使用等内容。
#Redis安装
这里提供Linux和Windows两种安装方式,由于Windows下的版本最高只有3.2版本,所以推荐使用Linux下的版本,目前最新稳定版本为5.0,也是本文中使用的版本。
#Linux
这里我们使用Docker环境下的安装方式。
- 下载Redis5.0的Docker镜像;
1 | docker pull redis:5.0 |
- 使用Docker命令启动Redis容器;
1 | docker run -p 6379:6379 --name redis \ |
#Windows
想使用Windows版本的朋友可以使用以下安装方式。
- 下载Windows版本的Redis,下载地址:https://github.com/MicrosoftArchive/redis/releases

- 下载完后解压到指定目录;

- 在当前地址栏输入cmd后,执行redis的启动命令:redis-server.exe redis.windows.conf
- 将Redis注册为服务的命令:
1 | # 注册服务 |
#Spring Cache 操作Redis
#Spring Cache 简介
当Spring Boot 结合Redis来作为缓存使用时,最简单的方式就是使用Spring Cache了,使用它我们无需知道Spring中对Redis的各种操作,仅仅通过它提供的@Cacheable 、@CachePut 、@CacheEvict 、@EnableCaching等注解就可以实现缓存功能。
#常用注解
#@EnableCaching
开启缓存功能,一般放在启动类上。
#@Cacheable
使用该注解的方法当缓存存在时,会从缓存中获取数据而不执行方法,当缓存不存在时,会执行方法并把返回结果存入缓存中。一般使用在查询方法上,可以设置如下属性:
- value:缓存名称(必填),指定缓存的命名空间;
- key:用于设置在命名空间中的缓存key值,可以使用SpEL表达式定义;
- unless:条件符合则不缓存;
- condition:条件符合则缓存。
#@CachePut
使用该注解的方法每次执行时都会把返回结果存入缓存中。一般使用在新增方法上,可以设置如下属性:
- value:缓存名称(必填),指定缓存的命名空间;
- key:用于设置在命名空间中的缓存key值,可以使用SpEL表达式定义;
- unless:条件符合则不缓存;
- condition:条件符合则缓存。
#@CacheEvict
使用该注解的方法执行时会清空指定的缓存。一般使用在更新或删除方法上,可以设置如下属性:
- value:缓存名称(必填),指定缓存的命名空间;
- key:用于设置在命名空间中的缓存key值,可以使用SpEL表达式定义;
- condition:条件符合则缓存。
#使用步骤
- 在pom.xml中添加项目依赖:
1 | <!--redis依赖配置--> |
- 修改配置文件application.yml,添加Redis的连接配置;
1 | spring: |
- 在启动类上添加@EnableCaching注解启动缓存功能;
1 | @EnableCaching |
- 接下来在PmsBrandServiceImpl类中使用相关注解来实现缓存功能,可以发现我们获取品牌详情的方法中使用了@Cacheable注解,在修改和删除品牌的方法上使用了@CacheEvict注解;
1 | /** |
- 我们可以调用获取品牌详情的接口测试下效果,此时发现Redis中存储的数据有点像乱码,并且没有设置过期时间;

#存储JSON格式数据
此时我们就会想到有没有什么办法让Redis中存储的数据变成标准的JSON格式,然后可以设置一定的过期时间,不设置过期时间容易产生很多不必要的缓存数据。
- 我们可以通过给RedisTemplate设置JSON格式的序列化器,并通过配置RedisCacheConfiguration设置超时时间来实现以上需求,此时别忘了去除启动类上的@EnableCaching注解,具体配置类RedisConfig代码如下;
1 | /** |
- 此时我们再次调用获取商品详情的接口进行测试,会发现Redis中已经缓存了标准的JSON格式数据,并且超时时间被设置为了1天。

#使用Redis连接池
SpringBoot 1.5.x版本Redis客户端默认是Jedis实现的,SpringBoot 2.x版本中默认客户端是用Lettuce实现的,我们先来了解下Jedis和Lettuce客户端。
#Jedis vs Lettuce
Jedis在实现上是直连Redis服务,多线程环境下非线程安全,除非使用连接池,为每个 RedisConnection 实例增加物理连接。
Lettuce是一种可伸缩,线程安全,完全非阻塞的Redis客户端,多个线程可以共享一个RedisConnection,它利用Netty NIO框架来高效地管理多个连接,从而提供了异步和同步数据访问方式,用于构建非阻塞的反应性应用程序。
#使用步骤
- 修改application.yml添加Lettuce连接池配置,用于配置线程数量和阻塞等待时间;
1 | spring: |
- 由于SpringBoot 2.x中默认并没有使用Redis连接池,所以需要在pom.xml中添加commons-pool2的依赖;
1 | <dependency> |
- 如果你没添加以上依赖的话,启动应用的时候就会产生如下错误;
1 | Caused by: java.lang.NoClassDefFoundError: org/apache/commons/pool2/impl/GenericObjectPoolConfig |
#自由操作Redis
Spring Cache 给我们提供了操作Redis缓存的便捷方法,但是也有很多局限性。比如说我们想单独设置一个缓存值的有效期怎么办?我们并不想缓存方法的返回值,我们想缓存方法中产生的中间值怎么办?此时我们就需要用到RedisTemplate这个类了,接下来我们来讲下如何通过RedisTemplate来自由操作Redis中的缓存。
#RedisService
定义Redis操作业务类,在Redis中有几种数据结构,比如普通结构(对象),Hash结构、Set结构、List结构,该接口中定义了大多数常用操作方法。
1 | /** |
#RedisServiceImpl
RedisService的实现类,使用RedisTemplate来自由操作Redis中的缓存数据。
1 | /** |
#RedisController
测试RedisService中缓存操作的Controller,大家可以调用测试下。
1 | /** |
#项目源码地址
https://github.com/macrozheng/mall-learning/tree/master/mall-tiny-redis
