hutool 验证码 redis-CFANZ编程社区

基于 Hutool 和 Redis 实现验证码的完整指南

1. 项目背景与目标

在现代web应用中，为了防止恶意注册以及其他形式的滥用，通常会引入验证码。结合 Hutool 工具包和 Redis 数据库，我们可以轻松地实现一个高效的验证码系统。

2. 项目流程概述

在这一部分，我们将详细描述整个实现验证码的流程，并以表格的形式列出每一步。

步骤	描述
1	引入相关依赖
2	实现验证码生成逻辑
3	将验证码存入 Redis
4	实现验证码校验逻辑
5	进行单元测试与整合

下面我们将详细介绍每一步的实现代码及其含义。

3. 步骤详解

步骤 1：引入相关依赖

在项目的 pom.xml 中添加 Hutool 和 jedis 的依赖：

<dependency>
    <groupId>cn.hutool</groupId>
    <artifactId>hutool-all</artifactId>
    <version>5.8.6</version>
</dependency>
<dependency>
    <groupId>redis.clients</groupId>
    <artifactId>jedis</artifactId>
    <version>4.2.3</version>
</dependency>

这里引入了 Hutool 提供的工具包以及 Jedis，Jedis 是 Java 对 Redis 的常用客户端。

步骤 2：实现验证码生成逻辑

使用 Hutool 来生成验证码：

import cn.hutool.captcha.CaptchaUtil;
import cn.hutool.captcha.ShearCaptcha;

// 创建验证码
public ShearCaptcha createCaptcha() {
    // 创建一个宽300像素、高200像素的验证码
    ShearCaptcha captcha = CaptchaUtil.createShearCaptcha(300, 200);
    // 返回验证码对象
    return captcha;
}

// 存储验证码
public String getCaptchaCode(ShearCaptcha captcha) {
    // 获取验证码内容，即用户所需输入的字符串
    return captcha.getCode();
}

使用 ShearCaptcha 创建了一张验证码图片，并获取了其对应的验证码值。

步骤 3：将验证码存入 Redis

下面的代码实现了将验证码存入 Redis 的逻辑：

import redis.clients.jedis.Jedis;

// 存入验证码到Redis
public void storeCaptcha(String key, String captchaCode) {
    try(Jedis jedis = new Jedis("localhost", 6379)) {
        // 将验证码存到 Redis, 并设置过期时间为五分钟
        jedis.setex(key, 300, captchaCode);
    }
}

使用 Jedis 连接 Redis，并将验证码内容与对应的键存入 Redis，设置过期时间为300秒（5分钟）。

步骤 4：实现验证码校验逻辑

在用户输入验证码时，我们需要验证其正确性：

import redis.clients.jedis.Jedis;

// 校验验证码
public boolean verifyCaptcha(String key, String inputCode) {
    try(Jedis jedis = new Jedis("localhost", 6379)) {
        // 从Redis中获取验证码
        String correctCode = jedis.get(key);
        // 校验用户输入的验证码是否正确
        return inputCode.equals(correctCode);
    }
}

这里从 Redis 中读取存储的验证码并与用户输入的进行比较，返回验证结果。

步骤 5：进行单元测试与整合

在这一阶段，我们需要进行步骤一到步骤四的整合与测试：

public class CaptchaService {
    
    public static void main(String[] args) {
        CaptchaService service = new CaptchaService();
        
        // 创建验证码
        ShearCaptcha captcha = service.createCaptcha();
        String captchaCode = service.getCaptchaCode(captcha);
        
        // 假设使用用户的key为user123
        String userKey = "captcha:user123";
        
        // 存储验证码
        service.storeCaptcha(userKey, captchaCode);
        
        // 输出验证码以方便测试
        System.out.println("Generated Captcha Code: " + captchaCode);
        
        // 假设用户输入的验证码为"1234"
        String userInput = "1234";  
        boolean isValid = service.verifyCaptcha(userKey, userInput);
        System.out.println("Is Captcha Valid? " + isValid);
    }
}

在主方法中，我们实现了创建、存储以及验证验证码的完整流程。

4. 旅行图与流程图

为了帮助更好地理解整个流程，下面是旅行图与流程图的展示。

旅行图

journey
    title 验证码生成与验证旅程
    section 用户操作
      生成验证码: 5: 用户生成验证码
      输入验证码: 3: 用户输入验证码
    section 系统动作
      存储验证码: 5: 系统将验证码存储到您的 Redis
      验证用户输入: 5: 系统验证用户输入的验证码

流程图

flowchart TD
    A[开始] --> B{生成验证码}
    B --> C[创建验证码对象]
    C --> D[获取验证码内容]
    D --> E{存储验证码}
    E --> F[连接Redis]
    F --> G[存储验证码到Redis]
    G --> H{用户输入验证码?}
    H --> I{验证验证码}
    I --> J[返回验证结果]
    J --> K[结束]