SpringBoot詳解如何整合Redis緩存驗證碼

更新時間：2022年07月04日 11:23:27 作者：陳寶子

本文主要介紹了SpringBoot集成Redis實現(xiàn)驗證碼的緩存簡單案例，文中通過示例代碼介紹的非常詳細，具有一定的參考價值，感興趣的小伙伴們可以參考一下

1、簡介

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

翻譯：Redis 是一個開源的內(nèi)存中的數(shù)據(jù)結(jié)構(gòu)存儲系統(tǒng)，它可以用作：數(shù)據(jù)庫、緩存和消息中間件。

官網(wǎng)鏈接：https://redis.io

Redis 是用 C 語言開發(fā)的一個開源的高性能鍵值對（key-value）數(shù)據(jù)庫，官方提供的數(shù)據(jù)是可以達到 **100000+**的 QPS。

QPS（Queries-per-second），每秒內(nèi)查詢次數(shù)。（百度百科）

它存儲的 value 類型比較豐富，也被稱為結(jié)構(gòu)化的 NoSQL 數(shù)據(jù)庫。

NoSQL（Not only SQL），不僅僅是 SQL，泛指非關(guān)系型數(shù)據(jù)庫。

NoSQL 數(shù)據(jù)庫并不是要取代關(guān)系型數(shù)據(jù)庫，而是關(guān)系型數(shù)據(jù)庫的補充。

關(guān)系型數(shù)據(jù)庫（RDBMS）

MySQL
Oracle
DB2
SQL Server

非關(guān)系型數(shù)據(jù)庫（NoSQL）

Redis
Mongo db
MemCached

Redis 應(yīng)用場景

緩存
任務(wù)隊列
消息隊列
分布式鎖

2、介紹

Redis 的 Java 客戶端很多，官方推薦的有三種：Jedis、Lettuce、Redisson。

Spring 對 Redis 客戶端進行了整合，提供了 Spring Data Redis。

在 Spring Boot 項目中還提供了對應(yīng)的 Starter，即 spring-boot-starter-data-redis。

在這里直接使用的是Spring Data Redis，且不展示Redis的下載和安裝過程啦。

3、前期配置

3.1、坐標導(dǎo)入

在創(chuàng)建完成Spring Boot項目之后，在pom.xml中加入spring-boot-start-data-redis的依賴坐標

<!--Spring Data Redis-->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-data-redis</artifactId>
</dependency>

3.2、配置文件

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

spring:
# Redis配置
redis:
host: localhost
port: 6379
# 根據(jù)自己設(shè)置的密碼決定
password: 123456
# 操作0號數(shù)據(jù)庫，默認有16個數(shù)據(jù)庫
database: 0
jedis:
pool:
max-active: 8 # 最大連接數(shù)
max-wait: 1ms # 連接池最大阻塞等待時間
max-idle: 4 # 連接池中的最大空閑連接
min-idle: 0 # 連接池中的最小空閑連接

3.3、配置類

使用 springboot 整合 redis 的專用客戶端接口操作。此處使用的是 SpringBoot 框架提供的 RedisTemplate。

RedisTemplate 在處理 key 和 value 時，會對其進行序列化操作，這就會導(dǎo)致一些問題。

比如：輸入的 key 值是 city，但 redis 獲得到的 key 值卻是 \xac]xed\x00\x05t\x00\x04city。

因此就需要一個專門的配置類，來專門處理 RedisTemplate 默認的序列化處理所導(dǎo)致的問題。

值得注意的是，這里是重新加載一個新的序列化器來取代原來的序列化器，這就證明著其原本是有著自己默認的序列化器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

在這里由于代碼比較隱私（~~主要是懶得整理登錄和生成驗證碼的接口放在這里~~），因此這里就直接使用測試類進行演示。

發(fā)送驗證碼

@PostMapping("/sendMsg")
public Result<String> sendMsg(@RequestBody User user, HttpSession session) {
    // 獲取需要發(fā)送短信的手機號
    String userPhone = user.getPhone();
    if (StringUtils.isNotEmpty(userPhone)) {
        // 隨機生成4位驗證碼
        String checkCode = ValidateCodeUtils.generateValidateCode4String(4);
        // 將生成的驗證碼保存到Redis中并設(shè)置有效期五分鐘
        redisTemplate.opsForValue().set(userPhone, checkCode, 5, TimeUnit.MINUTES);
        return Result.success(checkCode);
    }
    return Result.error("短信發(fā)送錯誤");
}

輸入驗證碼登錄

@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("登錄失敗，請檢查手機號或驗證碼是否正確");
}