SpringBoot整合Redis缓存验证码

1、简介

Redis is an open source (BSD licensed), in-memory data structure store, used as a database, cache, and message broker.

翻译：Redis 是一个开源的内存中的数据结构存储系统，它可以用作：数据库、缓存和消息中间件。

官网链接：https://redis.io

Redis 是用 C 语言开发的一个开源的高性能键值对（key-value）数据库，官方提供的数据是可以达到 **100000+**的 QPS。

QPS（Queries-per-second），每秒内查询次数。（百度百科）

它存储的 value 类型比较丰富，也被称为结构化的 NoSQL 数据库。

NoSQL（Not only SQL），不仅仅是 SQL，泛指非关系型数据库。

NoSQL 数据库并不是要取代关系型数据库，而是关系型数据库的补充。

---

• 关系型数据库（RDBMS）
  • MySQL
  • Oracle
  • DB2
  • SQL Server

---

• 非关系型数据库（NoSQL）
  • Redis
  • Mongo db
  • MemCached

---

• Redis 应用场景
  • 缓存
  • 任务队列
  • 消息队列
  • 分布式锁

2、介绍

Redis 的 Java 客户端很多，官方推荐的有三种：Jedis、Lettuce、Redisson。

Spring 对 Redis 客户端进行了整合，提供了 Spring Data Redis。

在 Spring Boot 项目中还提供了对应的 Starter，即 spring-boot-starter-data-redis。

在这里直接使用的是Spring Data Redis，且不展示Redis的下载和安装过程啦。

3、前期配置

3.1、坐标导入

---

在创建完成Spring Boot项目之后，在pom.xml中加入spring-boot-start-data-redis的依赖坐标

<dependency>
    <groupId>org.springframework.bootgroupId>
    <artifactId>spring-boot-starter-data-redisartifactId>
dependency>

3.2、配置文件

---

这里忽略了其他的配置如MySQL这些，只突出Redis的配置信息

spring: 
  # Redis配置
  redis:
    host: localhost
    port: 6379
    # 根据自己设置的密码决定
    password: 123456
    # 操作0号数据库，默认有16个数据库
    database: 0
    jedis:
      pool:
        max-active: 8 # 最大连接数
        max-wait: 1ms # 连接池最大阻塞等待时间
        max-idle: 4   # 连接池中的最大空闲连接
        min-idle: 0   # 连接池中的最小空闲连接

3.3、配置类

---

使用 springboot 整合 redis 的专用客户端接口操作。此处使用的是 SpringBoot 框架提供的 RedisTemplate。

RedisTemplate 在处理 key 和 value 时，会对其进行序列化操作，这就会导致一些问题。

比如：输入的 key 值是 city，但 redis 获得到的 key 值却是 \xac]xed\x00\x05t\x00\x04city。

因此就需要一个专门的配置类，来专门处理 RedisTemplate 默认的序列化处理所导致的问题。

值得注意的是，这里是重新加载一个新的序列化器来取代原来的序列化器，这就证明着其原本是有着自己默认的序列化器JdkSerializationRedisSerializer。

/**
 * @classname RedisConfig
 * @description Redis配置类，更换key的默认序列化器
 * @author xBaozi
 * @date 19:04 2022/7/2
 **/
@Configuration
public class RedisConfig extends CachingConfigurerSupport {

    @Bean
    public RedisTemplate<Object, Object> redisTemplate(RedisConnectionFactory connectionFactory) {

        RedisTemplate<Object, Object> redisTemplate = new RedisTemplate<>();

        redisTemplate.setKeySerializer(new StringRedisSerializer());
        redisTemplate.setHashKeySerializer(new StringRedisSerializer());

        redisTemplate.setConnectionFactory(connectionFactory);
        return redisTemplate;
    }
}

4、Java操作Redis

在这里由于代码比较隐私（主要是懒得整理登录和生成验证码的接口放在这里），因此这里就直接使用测试类进行演示。

• 发送验证码

@PostMapping("/sendMsg")
public Result<String> sendMsg(@RequestBody User user, HttpSession session) {
    // 获取需要发送短信的手机号
    String userPhone = user.getPhone();
    if (StringUtils.isNotEmpty(userPhone)) {
        // 随机生成4位验证码
        String checkCode = ValidateCodeUtils.generateValidateCode4String(4);
        // 将生成的验证码保存到Redis中并设置有效期五分钟
        redisTemplate.opsForValue().set(userPhone, checkCode, 5, TimeUnit.MINUTES);

        return Result.success(checkCode);
    }
    return Result.error("短信发送错误");
}

• 输入验证码登录

@PostMapping("/login")
public Result<User> login(@RequestBody Map map, HttpSession session) {
    log.info("map: {}", map);
    // 获取用户输入信息
    String phone = (String)map.get("phone");
    String code = (String)map.get("code");

    // 从Redis中取出验证码
    String checkCode = redisTemplate.opsForValue().get(phone);

    // 比对验证码是否一致
    if (StringUtils.isNotEmpty(checkCode) && checkCode.equals(code.toLowerCase())) {
        // 将用户id存放到session中
        session.setAttribute("user", user.getId());

        // 登录成功，删除Redis中的验证码
        redisTemplate.delete(phone);

        // 将用户信息返回到前端
        return Result.success(user);
    }
    return Result.error("登录失败，请检查手机号或验证码是否正确");
}

到这里Redis的简单整合就完成啦，这里的Redis使用仍是比较简单的，验证码也只是Redis的一个最简单使用方式之一而已，在后续狗子我将会尝试Redis的其他用法，在没有偷懒的时候写好笔记记录下来！