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

  • 读取验证码
  • 进行验证

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

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

例子

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

业务分析

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

模块划分

接口 实现 功能/描述
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即可，再通过模块的组合使用可以轻易地完成自定义的验证码业务，同时又不影响业务代码。

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

赞 (0)

相关推荐

  • SpringBoot + SpringSecurity 短信验证码登录功能实现

    实现原理 在之前的文章中,我们介绍了普通的帐号密码登录的方式: SpringBoot + Spring Security 基本使用及个性化登录配置. 但是现在还有一种常见的方式,就是直接通过手机短信验证码登录,这里就需要自己来做一些额外的工作了. 对SpringSecurity认证流程详解有一定了解的都知道,在帐号密码认证的过程中,涉及到了以下几个类:UsernamePasswordAuthenticationFilter(用于请求参数获取),UsernamePasswordAuthentica

  • SpringBoot结合SpringSecurity实现图形验证码功能

    本文介绍了SpringBoot结合SpringSecurity实现图形验证码功能,分享给大家,具体如下: 生成图形验证码 根据随机数生成图片 将随机数存到Session中 将生成的图片写到接口的响应中 生成图形验证码的过程比较简单,和SpringSecurity也没有什么关系.所以就直接贴出代码了 根据随机数生成图片 /** * 生成图形验证码 * @param request * @return */ private ImageCode generate(ServletWebRequest r

  • Springboot实现验证码登录

    Springboot实现验证码登录

    本文实例为大家分享了Springboot实现验证码登录的具体代码,供大家参考,具体内容如下 因为在项目中需要使用到验证码,我总结一下在项目中如何快速解决项目需求~验证码,下面推荐给大家速上手验证码的例子. 一.编写验证码工具类 import java.awt.Color; import java.awt.Font; import java.awt.Graphics; import java.awt.image.BufferedImage; import java.io.FileOutputStr

  • SpringBoot实现前端验证码图片生成和校验

    SpringBoot下实现前端验证码图片的生成和校验,供大家参考,具体内容如下 1.效果 点击验证码可以获取新的验证码 2.原理 后台生成验证码图片,将图片传到前台. 后台在session中保存验证码内容. 前台输入验证码后传到后台在后台取出session中保存的验证码进行校验. 注意,验证码的明文是不能传送到前端的.前端内容都是透明的,不安全.验证码是用来防机器人并不是单单防人.如果把验证码明文传到前端很容易就会被破解. 3.图片生成 验证码生成工具类RandomValidateCodeUti

  • Spring Boot 验证码框架 CAPTCHA详解

    CAPTCHA 查看 Github 仓库 | 查看 Gitee 仓库 简介 人机识别与验证码是后端开发中保护接口最常见的方式之一,而此类代码往往会与业务代码耦合带来项目可维护性变差. CAPTCHA是一个基于 Spring Boot 的验证码框架,它通过 AOP 的方式完成包含验证码生成.发送.存储等验证码相关业务,以避免与业务代码耦合. 开发者可以轻松地通过不同组件的组合来完成验证业务,同时可以进行自定义实现以应对自身的业务需求(例如邮箱验证码.短信验证码). 代码示例 导入 Maven 依赖

  • Spring Boot 集成MyBatis 教程详解

    Spring Boot 集成MyBatis 教程详解

    Spring Boot是由Pivotal团队提供的全新框架,其设计目的是用来简化新Spring应用的初始搭建以及开发过程.该框架使用了特定的方式来进行配置,从而使开发人员不再需要定义样板化的配置.通过这种方式,Spring Boot致力于在蓬勃发展的快速应用开发领域(rapid application development)成为领导者. 在集成MyBatis前,我们先配置一个druid数据源. Spring Boot 系列 1.Spring Boot 入门 2.Spring Boot 属性配置

  • Spring Security 在 Spring Boot 中的使用详解【集中式】

    Spring Security 在 Spring Boot 中的使用详解【集中式】

    1.1 准备 1.1.1 创建 Spring Boot 项目   创建好一个空的 Spring Boot 项目之后,写一个 controller 验证此时是可以直接访问到该控制器的. 1.1.2 引入 Spring Security   在 Spring Boot 中引入 Spring Security 是相当简单的,可以在用脚手架创建项目的时候勾选,也可以创建完毕后在 pom 文件中加入相关依赖. <dependency> <groupId>org.springframework

  • Spring Boot Admin的使用详解(Actuator监控接口)

    Spring Boot Admin的使用详解(Actuator监控接口)

    第一部分 Spring Boot Admin 简介 Spring Boot Admin用来管理和监控Spring Boot应用程序. 应用程序向我们的Spring Boot Admin Client注册(通过HTTP)或使用SpringCloud®(例如Eureka,Consul)发现. UI是Spring Boot Actuator端点上的Vue.js应用程序. Spring Boot Admin 是一个管理和监控Spring Boot 应用程序的开源软件.每个应用都认为是一个客户端,通过HT

  • Java Spring Boot消息服务万字详解分析

    Java Spring Boot消息服务万字详解分析

    目录 消息服务概述 为什么要使用消息服务 异步处理 应用解耦 流量削峰 分布式事务管理 常用消息中间件介绍 ActiveMQ RabbitMQ RocketMQ RabbitMQ消息中间件 RabbitMQ简介 RabbitMQ工作模式介绍 Work queues(工作队列模式) Public/Subscribe(发布订阅模式) Routing(路由模式) Topics(通配符模式) RPC Headers RabbitMQ安装以及整合环境搭建 安装RabbitMQ 下载RabbitMQ 安装R

  • Spring Boot 整合 Reactor实例详解

    目录 引言 1 创建项目 2 集成 H2 数据库 3 创建测试类 3.1 user 实体 3.2 UserRepository 3.3 UserService 3.4 UserController 3.5 SpringReactorApplication 添加注解支持 测试 总结 引言 Reactor 是一个完全非阻塞的 JVM 响应式编程基础,有着高效的需求管理(背压的形式).它直接整合 Java8 的函数式 API,尤其是 CompletableFuture, Stream,还有 Durat

  • Spring boot 使用mysql实例详解

    Spring boot 使用mysql实例详解 开发阶段用 H2即可,上线时,通过以下配置切换到mysql,spring boot将使用这个配置覆盖默认的H2. 1.建立数据库: mysql -u root CREATE DATABASE springbootdb 2.pom.xml: <dependency> <groupId>mysql</groupId> <artifactId>mysql-connector-java</artifactId&g

  • Dubbo在Spring和Spring Boot中的使用详解

    一.在Spring中使用Dubbo 1.Maven依赖 <dependency> <groupId>com.alibaba</groupId> <artifactId>dubbo</artifactId> <version>2.5.3.6</version> <exclusions> <exclusion> <groupId>log4j</groupId> <artif

  • spring boot linux启动方式详解

    spring boot linux启动方式详解

    前台启动 java -jar XXX.jar 后台启动 java -jar xxx.jar & 区别:前台启动ctrl+c就会关闭程序,后台启动ctrl+c不会关闭程序 制定控制台的标准输出 java -jar xxx.jar > catalina.out 2>&1 & catalina.out将标准输出指向制定文件catalina.out 2>&1 输出所有的日志文件 & 后台启动  脚本启动 #!/bin/sh #功能简介:启动上层目录下的ja

  • 在Linux系统上安装Spring boot应用的教程详解

    Unix/Linux 服务 systemd 服务 操作过程 1. 安装了JDK的centOS7虚拟机 注意下载linux版本JDK的时候不能直接通过wget这种直接链接下载,否则会解压不成功,应该打开原官网,点击同意许可后点击下载(这种方式下载很慢),比较好的方式是复制下载页的地址到迅雷,通过迅雷打开该下载页,同意许可后点击下载. 下载后解压.配置环境变量 tar -zxvf jdk1.8.0_211.jar.gz 环境变量配置:/etc/profile 文件最后添加如下 export JAVA

随机推荐