SpringBoot教程(十四)
一、Redis集成简介
Redis是我们Java开发中,使用频次非常高的一个nosql数据库,数据以key-value键值对的形式存储在内存中。redis的常用使用场景,可以做缓存,分布式锁,自增序列等,使用redis的方式和我们使用数据库的方式差不多,首先我们要在自己的本机电脑或者服务器上安装一个redis的服务器,通过我们的java客户端在程序中进行集成,然后通过客户端完成对redis的增删改查操作。redis的Java客户端类型还是很多的,常见的有jedis, redission,lettuce等,所以我们在集成的时候,我们可以选择直接集成这些原生客户端。但是在springBoot中更常见的方式是集成spring-data-redis,这是spring提供的一个专门用来操作redis的项目,封装了对redis的常用操作,里边主要封装了jedis和lettuce两个客户端。相当于是在他们的基础上加了一层门面。
本篇文章我们就来重点介绍,springBoot通过集成spring-data-redis使用对于redis的常用操作。
由于不涉及到兼容问题,我们就直接在feature/MybatisPlus分支上开发。二、集成步骤2.1 添加依赖
添加redis所需依赖: org.springframework.boot spring-boot-starter-data-redis 复制代码
完整pom.xml<?xml version="1.0" encoding="UTF-8"?> 4.0.0 com.lsqingfeng.springboot springboot-learning 1.0.0 8 8 org.springframework.boot spring-boot-dependencies 2.6.2 pom import org.springframework.boot spring-boot-starter-web org.projectlombok lombok 1.18.22 provided com.baomidou mybatis-plus-boot-starter 3.5.1 com.baomidou mybatis-plus-generator 3.5.1 org.freemarker freemarker 2.3.31 org.springframework.boot spring-boot-devtools true mysql mysql-connector-java runtime org.springframework.boot spring-boot-starter-data-redis 复制代码
这里我们直接引入了spring-boot-starter-data-redis这个springBoot本身就已经提供好了的starter, 我们可以点击去看一下这个starter中包含了哪些依赖:
可以发现,里面包含了spring-data-redis和 lettuce-core两个核心包,这就是为什么说我们的spring-boot-starter-data-redis默认使用的就是lettuce这个客户端了。
如果我们想要使用jedis客户端怎么办呢?就需要排除lettuce这个依赖,再引入jedis的相关依赖就可以了。
那么为什么我们只需要通过引入不同的依赖就能让spring-data-redis可以自由切换客户端呢,这其实就涉及到了springBoot的自动化配置原理。我们可以给大家简单讲解一下。
springBoot这个框架之所以可以通过各种starter无缝融合其他技术的一大主要原因就是springBoot本身的自动化配置功能。所谓自动化配置就是springBoot本身已经预先设置好了一些常用框架的整合类。然后通过类似于ConditionOn这样的条件判断注解,去辨别你的项目中是否有相关的类(或配置)了,进而进行相关配置的初始化。
springBoot预设的自动化配置类都位于spring-boot-autoconfigure这个包中,只要我们搭建了springBoot的项目,这个包就会被引入进来。
而这个包下就有一个RedisAutoConfiguration这个类,顾名思义就是Redis的自动化配置。在这个类中,会引入LettuceConnectionConfiguration 和 JedisConnectionConfiguration 两个配置类,分别对应lettuce和jedis两个客户端。
而这个两个类上都是用了ConditionOn注解来进行判断是否加载。
jedis如下;
而由于我们的项目自动引入了lettuce-core,而没有引入jedis相关依赖,所以LettuceConnectionConfiguration这个类的判断成立会被加载,而Jedis的判断不成立,所以不会加载。进而lettuce的配置生效,所以我们在使用的使用, 默认就是lettuce的客户端。2.2 添加配置
然后我们需要配置连接redis所需的账号密码等信息,这里大家要提前安装好redis,保证我们的本机程序可以连接到我们的redis, 如果不知道redis如何安装,可以参考文章: [Linux系统安装redis6.0.5] blog.csdn.net/lsqingfeng/…
常规配置如下: 在application.yml配置文件中配置 redis的连接信息spring: redis: host: localhost port: 6379 password: 123456 database: 0 复制代码
如果有其他配置放到一起:server: port: 19191 spring: datasource: driver-class-name: com.mysql.cj.jdbc.Driver url: jdbc:mysql://localhost:3306/springboot_learning?serverTimezone=Asia/Shanghai&characterEncoding=utf-8 username: root password: root redis: host: localhost port: 6379 password: 123456 database: 0 lettuce: pool: max-idle: 16 max-active: 32 min-idle: 8 devtools: restart: enable: true third: weather: url: http://www.baidu.com port: 8080 username: test cities: - 北京 - 上海 - 广州 list[0]: aaa list[1]: bbb list[2]: ccc 复制代码
这样我们就可以直接在项目当中操作redis了。如果使用的是集群,那么使用如下配置方式:spring: redis: password: 123456 cluster: nodes: 10.255.144.115:7001,10.255.144.115:7002,10.255.144.115:7003,10.255.144.115:7004,10.255.144.115:7005,10.255.144.115:7006 max-redirects: 3 复制代码
但是有的时候我们想要给我们的redis客户端配置上连接池。就像我们连接mysql的时候,也会配置连接池一样,目的就是增加对于数据连接的管理,提升访问的效率,也保证了对资源的合理利用。那么我们如何配置连接池呢,这里大家一定要注意了,很多网上的文章中,介绍的方法可能由于版本太低,都不是特别的准确。 比如很多人使用spring.redis.pool来配置,这个是不对的(不清楚是不是老版本是这样的配置的,但是在springboot-starter-data-redis中这种写法不对)。首先是配置文件,由于我们使用的lettuce客户端,所以配置的时候,在spring.redis下加上lettuce再加上pool来配置,具体如下;spring: redis: host: 10.255.144.111 port: 6379 password: 123456 database: 0 lettuce: pool: max-idle: 16 max-active: 32 min-idle: 8 复制代码
如果使用的是jedis,就把lettuce换成jedis(同时要注意依赖也是要换的)。
但是仅仅这在配置文件中加入,其实连接池是不会生效的。这里大家一定要注意,很多同学在配置文件上加上了这段就以为连接池已经配置好了,其实并没有,还少了最关键的一步,就是要导入一个依赖,不导入的话,这么配置也没有用。 org.apache.commons commons-pool2 复制代码
之后,连接池才会生效。我们可以做一个对比。 在导包前后,观察RedisTemplate对象的值就可以看出来。
导入之前:
导入之后:
导入之后,我们的连接池信息才有值,这也印证了我们上面的结论。
具体的配置信息我们可以看一下源代码,源码中使用RedisProperties 这个类来接收redis的配置参数。
2.3 项目中使用
我们的配置工作准备就绪以后,我们就可以在项目中操作redis了,操作的话,使用spring-data-redis中为我们提供的 RedisTemplate 这个类,就可以操作了。我们先举个简单的例子,插入一个键值对(值为string)。package com.lsqingfeng.springboot.controller; import com.lsqingfeng.springboot.base.Result; import org.springframework.data.redis.core.RedisTemplate; import org.springframework.web.bind.annotation.GetMapping; import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.RestController; /** * @className: RedisController * @description: * @author: sh.Liu * @date: 2022-03-08 14:28 */ @RestController @RequestMapping("redis") public class RedisController { private final RedisTemplate redisTemplate; public RedisController(RedisTemplate redisTemplate) { this.redisTemplate = redisTemplate; } @GetMapping("save") public Result save(String key, String value){ redisTemplate.opsForValue().set(key, value); return Result.success(); } } 复制代码三、工具类封装
我们在前面的代码中已经通过RedisTemplate成功操作了redis服务器,比如set一个字符串,我们可以使用:redisTemplate.opsForValue().set(key, value); 复制代码
来put一个String类型的键值对。而redis中可以支持 string, list, hash,set, zset五种数据格式,这五种数据格式的常用操作,都在RedisTemplate这个类中进行了封装。 操作string类型就是用opsForValue,操作list类型是用listOps, 操作set类型是用setOps等等。我们可以通过查看RedisTemplate这个类中的源码来了解大致有哪些功能。
而这些功能都在这一个类中,使用起来其实并不是很方便,所有一般情况下,我们都是单独封装一个工具类,来把常用的一些方法进行抽象。操作的时候,直接通过工具类来操作。 package com.lsqingfeng.springboot.utils; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.data.redis.core.RedisTemplate; import org.springframework.stereotype.Component; import java.util.List; import java.util.Map; import java.util.Set; import java.util.concurrent.TimeUnit; /** * @className: RedisUtil * @description: * @author: sh.Liu * @date: 2022-03-09 14:07 */ @Component public class RedisUtil { @Autowired private RedisTemplate redisTemplate; /** * 给一个指定的 key 值附加过期时间 * * @param key * @param time * @return */ public boolean expire(String key, long time) { return redisTemplate.expire(key, time, TimeUnit.SECONDS); } /** * 根据key 获取过期时间 * * @param key * @return */ public long getTime(String key) { return redisTemplate.getExpire(key, TimeUnit.SECONDS); } /** * 根据key 获取过期时间 * * @param key * @return */ public boolean hasKey(String key) { return redisTemplate.hasKey(key); } /** * 移除指定key 的过期时间 * * @param key * @return */ public boolean persist(String key) { return redisTemplate.boundValueOps(key).persist(); } //- - - - - - - - - - - - - - - - - - - - - String类型 - - - - - - - - - - - - - - - - - - - - /** * 根据key获取值 * * @param key 键 * @return 值 */ public Object get(String key) { return key == null ? null : redisTemplate.opsForValue().get(key); } /** * 将值放入缓存 * * @param key 键 * @param value 值 * @return true成功 false 失败 */ public void set(String key, String value) { redisTemplate.opsForValue().set(key, value); } /** * 将值放入缓存并设置时间 * * @param key 键 * @param value 值 * @param time 时间(秒) -1为无期限 * @return true成功 false 失败 */ public void set(String key, String value, long time) { if (time > 0) { redisTemplate.opsForValue().set(key, value, time, TimeUnit.SECONDS); } else { redisTemplate.opsForValue().set(key, value); } } /** * 批量添加 key (重复的键会覆盖) * * @param keyAndValue */ public void batchSet(Map keyAndValue) { redisTemplate.opsForValue().multiSet(keyAndValue); } /** * 批量添加 key-value 只有在键不存在时,才添加 * map 中只要有一个key存在,则全部不添加 * * @param keyAndValue */ public void batchSetIfAbsent(Map keyAndValue) { redisTemplate.opsForValue().multiSetIfAbsent(keyAndValue); } /** * 对一个 key-value 的值进行加减操作, * 如果该 key 不存在 将创建一个key 并赋值该 number * 如果 key 存在,但 value 不是长整型 ,将报错 * * @param key * @param number */ public Long increment(String key, long number) { return redisTemplate.opsForValue().increment(key, number); } /** * 对一个 key-value 的值进行加减操作, * 如果该 key 不存在 将创建一个key 并赋值该 number * 如果 key 存在,但 value 不是 纯数字 ,将报错 * * @param key * @param number */ public Double increment(String key, double number) { return redisTemplate.opsForValue().increment(key, number); } //- - - - - - - - - - - - - - - - - - - - - set类型 - - - - - - - - - - - - - - - - - - - - /** * 将数据放入set缓存 * * @param key 键 * @return */ public void sSet(String key, String value) { redisTemplate.opsForSet().add(key, value); } /** * 获取变量中的值 * * @param key 键 * @return */ public Set