CAPTCHA

查看 Github 倉庫 | 查看 Gitee 倉庫

簡介

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

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

代碼示例

導(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)驗(yàn)證碼

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

使用注解消費(fèi)驗(yàn)證碼（保護(hù)接口）

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

實(shí)現(xiàn)原理

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

@SendCode

1. 生成驗(yàn)證碼
2. 儲存驗(yàn)證碼
3. 發(fā)送驗(yàn)證碼

@VerifyCode

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

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

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

例子

隨機(jī)字符圖像驗(yàn)證碼的 AOP 實(shí)現(xiàn)

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

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

模塊劃分

業(yè)務(wù)邏輯

@SendCode

1. 通過 CodeGenerator生成 Code。
2. 通過 CodeStore儲存 Code。
3. 通過 CodeSender輸出 Code。
4. 執(zhí)行業(yè)務(wù)代碼。

@VerifyCode

1. 從請求參數(shù)獲取待驗(yàn)證的驗(yàn)證碼。
2. 通過 CodeStore取出 Code。
3. 通過 CodeVerify進(jìn)行驗(yàn)證。
4. 驗(yàn)證完成則執(zhí)行業(yè)務(wù)代碼，否則拋出異常。

拓展與組合

除了圖像驗(yàn)證碼（人機(jī)識別）以外，常見的驗(yàn)證碼業(yè)務(wù)或者人機(jī)識別業(yè)務(wù)例如：短信驗(yàn)證碼、郵箱驗(yàn)證碼、谷歌 reCAPTCHA 人機(jī)識別等都可以通過實(shí)現(xiàn)上述接口來完成業(yè)務(wù)。

例如，想要使用 Redis 儲存驗(yàn)證碼只需要通過 RedisTemplate實(shí)現(xiàn) CodeStore即可，再通過模塊的組合使用可以輕易地完成自定義的驗(yàn)證碼業(yè)務(wù)，同時又不影響業(yè)務(wù)代碼。

到此這篇關(guān)于Spring Boot 驗(yàn)證碼框架 - CAPTCHA的文章就介紹到這了,更多相關(guān)Spring Boot 驗(yàn)證碼框架內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

最新評論