Spring Boot 驗證碼框架 CAPTCHA詳解

更新時間：2021年03月22日 09:09:38 作者：Hansin1997

這篇文章主要介紹了Spring Boot 驗證碼框架 CAPTCHA詳解,本文給大家介紹的非常詳細(xì)，對大家的學(xué)習(xí)或工作具有一定的參考借鑒價值，需要的朋友可以參考下

CAPTCHA

查看 Github 倉庫 | 查看 Gitee 倉庫

簡介

人機識別與驗證碼是后端開發(fā)中保護(hù)接口最常見的方式之一，而此類代碼往往會與業(yè)務(wù)代碼耦合帶來項目可維護(hù)性變差。

CAPTCHA 是一個基于 Spring Boot 的驗證碼框架，它通過 AOP 的方式完成包含驗證碼生成、發(fā)送、存儲等驗證碼相關(guān)業(yè)務(wù)，以避免與業(yè)務(wù)代碼耦合。
開發(fā)者可以輕松地通過不同組件的組合來完成驗證業(yè)務(wù)，同時可以進(jìn)行自定義實現(xiàn)以應(yīng)對自身的業(yè)務(wù)需求（例如郵箱驗證碼、短信驗證碼）。

代碼示例

導(dǎo)入 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);
 }
}

使用注解生產(chǎn)驗證碼

 @RequestMapping("/captcha")
 @SendCode // 生成隨機字符圖像驗證碼并發(fā)送
 public void captcha(@CodeValue String code) {
  // 在此處進(jìn)行自定義的業(yè)務(wù)，驗證碼的生成、發(fā)送與儲存已由注解 '@SendCode' 完成。
  log.info(code);
 }

使用注解消費驗證碼（保護(hù)接口）

 @RequestMapping("/")
 @VerifyCode
 public String index(@CodeValue String code) {
  // 在此處進(jìn)行自定義的業(yè)務(wù)，驗證碼的驗證以及銷毀已由注解 '@VerifyCode' 完成。
  return String.format("Hello World! (%s)", code);
 }

實現(xiàn)原理

CAPTCHA 基于面向切面編程（AOP）思想，將驗證碼業(yè)務(wù)劃分為兩個切面：

@SendCode

生成驗證碼
儲存驗證碼
發(fā)送驗證碼

@VerifyCode

讀取驗證碼
進(jìn)行驗證

同時將驗證碼業(yè)務(wù)抽象為下面幾個接口：

Code—— 驗證碼
CodeGenerator—— 生成器
CodeSender—— 發(fā)送器
CodeStore—— 儲存器
CodeVerifier—— 驗證器

例子

隨機字符圖像驗證碼的 AOP 實現(xiàn)

業(yè)務(wù)分析

客戶端訪問驗證碼接口獲取到圖像，同時后端服務(wù)將生成的驗證碼儲存在 Session 或者 Redis。
客戶端訪問接口（登錄、注冊等），傳入?yún)?shù)以及驗證碼，后端服務(wù)取出驗證碼進(jìn)行校驗。

模塊劃分

接口	實現(xiàn)	功能/描述
Code	Code<String>	字符串型 Code ，內(nèi)有驗證碼名、驗證碼值。（驗證碼名用于區(qū)分不同業(yè)務(wù)的驗證碼）
CodeGenerator	RandomStringCodeGenerator	隨機字符串生成，通過參數(shù)配置字符池以及長度。
CodeSender	ImageCodeSender	繪制圖像（隨機字符、干擾線），輸出到 Response。
CodeStore	HttpSessionCodeStore	基于 Session 對驗證碼進(jìn)行儲存與取出。
CodeVerifier	StringEqualsCodeVerifier	字符串比較驗證，通過參數(shù)配置是否大小寫敏感以及是否 trim 。