亲宝软件园·资讯

展开

Spring Boot 验证码框架 Spring Boot 验证码框架 CAPTCHA详解

Hansin1997 人气:1
想了解Spring Boot 验证码框架 CAPTCHA详解的相关内容吗,Hansin1997在本文为您仔细讲解Spring Boot 验证码框架的相关知识和一些Code实例,欢迎阅读和指正,我们先划重点:Spring,Boot,验证码框架,Spring,Boot,验证码CAPTCHA,下面大家一起来学习吧。

CAPTCHA

查看 Github 仓库 | 查看 Gitee 仓库

简介

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

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

代码示例

导入 Maven 依赖

<dependency>
 <groupId>cn.dustlight.captcha</groupId>
 <artifactId>captcha-core</artifactId>
 <version>0.0.6</version>
</dependency>

添加注解启用 CAPTCHA

@SpringBootApplication
@EnableCaptcha // 启用 CAPTCHA
public class DemoApplication {
 public static void main(String[] args) {
  SpringApplication.run(DemoApplication.class, args);
 }
}

使用注解生产验证码

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

使用注解消费验证码(保护接口)

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

实现原理

CAPTCHA 基于面向切面编程(AOP)思想,将验证码业务划分为两个切面:

@SendCode

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

@VerifyCode

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

例子

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

业务分析

模块划分

接口 实现 功能/描述
Code Code<String> 字符串型 Code ,内有验证码名、验证码值。(验证码名用于区分不同业务的验证码)
CodeGenerator RandomStringCodeGenerator 随机字符串生成,通过参数配置字符池以及长度。
CodeSender ImageCodeSender 绘制图像(随机字符、干扰线),输出到 Response。
CodeStore HttpSessionCodeStore 基于 Session 对验证码进行储存与取出。
CodeVerifier StringEqualsCodeVerifier 字符串比较验证,通过参数配置是否大小写敏感以及是否 trim 。

业务逻辑

@SendCode

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

@VerifyCode

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

拓展与组合

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

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

加载全部内容

相关教程
猜你喜欢
用户评论