SpringBoot詳解如何整合Redis快取驗證碼

2022-07-04 14:01:02

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的依賴座標

<!--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
# 根據自己設定的密碼決定
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]xedx00x05tx00x04city。

因此就需要一個專門的設定類，來專門處理 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的其他用法，在沒有偷懶的時候寫好筆記記錄下來！

到此這篇關於SpringBoot詳解如何整合Redis快取驗證碼的文章就介紹到這了,更多相關SpringBoot Redis快取驗證碼內容請搜尋it145.com以前的文章或繼續瀏覽下面的相關文章希望大家以後多多支援it145.com！