如何实现验证码及校验

虽然说本人不太喜欢在项目中加入各种各样的验证，但在实际项目里，这确实是很重要的部分，不仅能阻挡一部分的人机注册，也能筛选用户 (bushi)

本文简单的探索一下 SpringBoot 如何简单的实现图片验证码功能

简单验证码

前置

easy-captcha
Redis

其实不用 Redis，使用 Session也能实现，但是现在一般都需要中间件

组件的基本使用

首先还是先在 maven 里引入

1
<dependencies>
2
   <dependency>
3
      <groupId>com.pig4cloud.plugin</groupId>
4
      <artifactId>captcha-spring-boot-starter</artifactId>
5
      <version>2.2.5</version>
6
   </dependency>
7
</dependencies>

后端代码

简单的实现接口

1
/**
2
 * 生成验证码
3
 */
4
@RequestMapping("/checkCode")
5
public ResponseVO checkcode() {
6
  // 定义验证码的长宽，以及算数类型
7
    ArithmeticCaptcha captcha = new ArithmeticCaptcha(100, 42);
8
    // 获取运算的结果
9
    String code = captcha.text();
10
    //存入Redis
11
    String checkCodeKey = redisComponent.saveCheckCode(code);
12
    //输出base64编码
13
    String checkCodeBase64 = captcha.toBase64();
14

15
    //将图片和Key都返回给前端
16
    Map<String, String> result = new HashMap<>();
17
    result.put("checkCode", checkCodeBase64);
18
    result.put("checkCodeKey", checkCodeKey);
19
    return getSuccessResponseVO(result);
20
}

Redis 方法

Redis 需要一些方法，为验证码设置缓存时间，验证结果等。

这里是简易示例，因为我 RedisUtils 里包装了一些额外的工具参数，篇幅很长，不方便展示。

1
```java
2
@Component
3
public class RedisComponent {
4

5
    @Autowired
6
    private StringRedisTemplate stringRedisTemplate;
7

8
    /**
9
     * 保存验证码到 Redis
10
     * @param code 验证码内容
11
     * @return 验证码对应的唯一 key
12
     */
13
    public String saveCheckCode(String code) {
14
        // 生成唯一 key
15
        String key = "checkCode:" + UUID.randomUUID().toString().replace("-", "");
16
        // 保存到 Redis，并设置过期时间（例如 5 分钟）
17
        stringRedisTemplate.opsForValue().set(key, code, 5, TimeUnit.MINUTES);
18
        return key;
19
    }
20

21
    /**
22
     * 根据 key 获取验证码
23
     * @param key 验证码 key
24
     * @return 验证码内容
25
     */
26
    public String getCheckCode(String key) {
27
        return stringRedisTemplate.opsForValue().get(key);
28
    }
29

30
    /**
31
     * 删除验证码（验证成功后清理）
32
     * @param key 验证码 key
33
     */
34
    public void deleteCheckCode(String key) {
35
        stringRedisTemplate.delete(key);
36
    }
37

38
    /**
39
     * 校验验证码是否正确
40
     * @param key 验证码 key
41
     * @param code 用户输入的验证码
42
     * @return true 正确，false 错误
43
     */
44
    public boolean validateCheckCode(String key, String code) {
45
        String storedCode = getCheckCode(key);
46
        if (storedCode == null) {
47
            return false; // 验证码不存在或已过期
48
        }
49
        boolean isValid = storedCode.equals(code);
50
        if (isValid) {
51
            deleteCheckCode(key); // 验证成功后立即删除
52
        }
53
        return isValid;
54
    }
55
}

然后我们在注册、登录等场景，便可以使用这些方法，进行获取和校验。