Spring Boot 验证码框架 CAPTCHA详解

也想出现在这里？点击联系我~

CAPTCHA

查看 Github 仓库 | 查看 Gitee 仓库

简介

人机识别与验证码是后端开发中保护接口最常见的方式之一，而此类代码往往会与业务代码耦合带来项目可维护性变差。

CAPTCHA是一个基于 Spring Boot 的验证码框架，它通过 AOP 的方式完成包含验证码生成、发送、存储等验证码相关业务，以避免与业务代码耦合。
开发者可以轻松地通过不同组件的组合来完成验证业务，同时可以进行自定义实现以应对自身的业务需求（例如邮箱验证码、短信验证码）。

代码示例

导入 Maven 依赖

1. <dependency>
2. <groupId>cn.dustlight.captcha</groupId>
3. <artifactId>captcha-core</artifactId>
4. <version>0.0.6</version>
5. </dependency>

添加注解启用 CAPTCHA

1. @SpringBootApplication
2. @EnableCaptcha // 启用 CAPTCHA
3. public class DemoApplication {
4. public static void main(String[] args) {
5. SpringApplication.run(DemoApplication.class, args);
6. }
7. }

使用注解生产验证码

1. @RequestMapping("/captcha")
2. @SendCode // 生成随机字符图像验证码并发送
3. public void captcha(@CodeValue String code) {
4. // 在此处进行自定义的业务，验证码的生成、发送与储存已由注解 '@SendCode' 完成。
5. log.info(code);
6. }

使用注解消费验证码（保护接口）

1. @RequestMapping("/")
2. @VerifyCode
3. public String index(@CodeValue String code) {
4. // 在此处进行自定义的业务，验证码的验证以及销毁已由注解 '@VerifyCode' 完成。
5. return String.format("Hello World! (%s)", code);
6. }

实现原理

CAPTCHA 基于面向切面编程（AOP）思想，将验证码业务划分为两个切面：

@SendCode

1. 生成验证码
2. 储存验证码
3. 发送验证码

@VerifyCode

• 读取验证码
• 进行验证

同时将验证码业务抽象为下面几个接口：

• Code—— 验证码
• CodeGenerator—— 生成器
• CodeSender—— 发送器
• CodeStore—— 储存器
• CodeVerifier—— 验证器

例子

随机字符图像验证码的 AOP 实现

业务分析

• 客户端访问验证码接口获取到图像，同时后端服务将生成的验证码储存在 Session 或者 Redis。
• 客户端访问接口（登录、注册等），传入参数以及验证码，后端服务取出验证码进行校验。

模块划分

业务逻辑

@SendCode

1. 通过 CodeGenerator生成 Code。
2. 通过 CodeStore储存 Code。
3. 通过 CodeSender输出 Code。
4. 执行业务代码。

@VerifyCode

1. 从请求参数获取待验证的验证码。
2. 通过 CodeStore取出 Code。
3. 通过 CodeVerify进行验证。
4. 验证完成则执行业务代码，否则抛出异常。

拓展与组合

除了图像验证码（人机识别）以外，常见的验证码业务或者人机识别业务例如：短信验证码、邮箱验证码、谷歌 reCAPTCHA 人机识别等都可以通过实现上述接口来完成业务。

例如，想要使用 Redis 储存验证码只需要通过 RedisTemplate实现 CodeStore即可，再通过模块的组合使用可以轻易地完成自定义的验证码业务，同时又不影响业务代码。

到此这篇关于Spring Boot 验证码框架 – CAPTCHA的文章就介绍到这了,更多相关Spring Boot 验证码框架内容请搜索快网idc以前的文章或继续浏览下面的相关文章希望大家以后多多支持快网idc！

原文链接：https://blog.csdn.net/weixin_48803392/article/details/114890427