Java应用开发必备：使用 easy-captcha 组件生成验证码的详细介绍

2024-04-27 15:20
文章标签 java 使用 应用 组件 介绍 开发 生成 详细 必备 验证码 easy captcha

本文主要是介绍Java应用开发必备：使用 easy-captcha 组件生成验证码的详细介绍，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

一、前言

最近系统开发在优化验证码的相关功能，第一反应就是有没有开源的第三方组件可以使用呢。

在一番寻觅以后，还真发现一个好用的第三方验证码组件Easy-captcha。Easy-captcha是一个开源的Java库，用于生成和验证验证码，它的API上手难度低，可以生成包含数字、字母、中文和数字运算验证码，还有会动的GIF格式验证码哦，此外还允许开发者针对长度、字符集、字体、颜色、样式等方面进行自定义，可以满足大部分复杂场景。

二、快速入门

说了这么多Easy-captcha的好处，我们入门实际体验一下吧。

  1. 新建一个Spring Boot项目，导入如下依赖：

    <dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-web</artifactId>
</dependency><!--easy-captcha组件的依赖-->
<dependency><groupId>com.github.whvcse</groupId><artifactId>easy-captcha</artifactId><version>1.6.2</version>
</dependency>

  2. 新建一个Controller，用于生成验证码

    import com.wf.captcha.utils.CaptchaUtil;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;@RestController
public class CaptchaController {/*** 生成验证码** @param request* @param response* @throws IOException*/@RequestMapping("/captcha")public void captcha(HttpServletRequest request, HttpServletResponse response) throws IOException {// 使用这一行代码就可以生成验证码了CaptchaUtil.out(request, response);}}

  3. 准备一个登陆接口，用于验证验证码的正确性

    import com.wf.captcha.utils.CaptchaUtil;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RestController;import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;@RestController
public class LoginController {/*** 登录** @param request* @param response*/@PostMapping("/login")public void login(HttpServletRequest request, HttpServletResponse response) throws IOException {// 获取验证码参数String captcha = request.getParameter("captcha");// 校验验证码是否正确if (CaptchaUtil.ver(captcha, request)) {response.getOutputStream().print("captcha correct!");} else {response.getOutputStream().print("captcha error!");}}
}

  4. 准备一个静态文件index.html，用于显示验证码和输入验证码验证

    <!DOCTYPE html>
<html lang="en">
<form action="/login" method="post"><img src="/captcha" width="160px" height="50px"><input type="text" name="captcha"><input type="submit" value="login">
</form>
</html>

  5. 在项目resource目录下新建static目录，将index.html文件拷贝到该目录下

    在这里插入图片描述

由于我本地有Nginx，出于个人习惯考虑，我将静态文件index.html交由nginx代理服务器进行代理访问，nginx参考配置如下：

    server {listen       80;server_name  localhost;location / {root   captcha; # 存放index.html文件的目录index  index.html;}location /captcha {proxy_pass http://localhost:8080/captcha;}location /login {proxy_pass http://localhost:8080/login;}}

  1. 启动项目进行测试

    正常Spring Boot项目启动以后访问：http://localhost:8080/index.html页面，我本地通过Nginx服务代理，直接访问http://localhost就行了（后面不再提示），会出现页面：

    在这里插入图片描述

  • 输入错误验证码，提示验证码错误

    在这里插入图片描述

  • 输入正确验证码，提示验证码正确

    在这里插入图片描述

到此我们快速入门就结束了。

三、技术浅析

为了我们更好的使用Easy-captcha，我们还是了解一下源码，并针对一些疑问进行探究。

  1. Easy-captcha生成验证码的方式只能通过CaptchaUtil.out(request, response)吗？

    这个问题的答案显然是否定的，查看CaptchaUtil.out方法可以发现，它其实还有很多重载方法：

    在这里插入图片描述

    在重载方法中，我们可以指定生成验证码的宽度、高度、验证码个数，甚至指定不同的验证码类型。

  2. Easy-captcha验证码组件可以生成不同类型的验证码，要怎么指定，并且可以支持哪些呢？

    这个问题其实通过上面也可以看到：

在这里插入图片描述

​

​ 可以支持的类型：

在这里插入图片描述

而且通过源码可以发现，默认就是SpecCaptcha格式验证码：

在这里插入图片描述

  1. Easy-captcha组件生成验证码和校验验证码原理是什么？

    针对这个问题，直接跟踪源码就行了：

    输出验证码核心逻辑是通过response.getOutputStream()输出流，同时，会将生成的验证码文字信息保存到session中，（这里针对前后端分离，或者禁用session的系统会有问题，可以参考后面的解决方法）

在这里插入图片描述

​ 验证验证码的逻辑也很简单，就是从session中获取验证码与传入进来的值进行比较，看看是否相等。

在这里插入图片描述

四、 验证码使用介绍大全

1. 自定义验证码属性

我们可以自定义验证码长度、宽度、高度等属性，代码如下：

@RequestMapping("/captcha")public void captcha(HttpServletRequest request, HttpServletResponse response) throws IOException {// 指定宽度为200，高度为100，验证码字符为5个CaptchaUtil.out(200, 100, 5, request, response);}

重启应用，刷新页面：

在这里插入图片描述

2. 使用GifCaptcha形式验证码

示例代码：

@RequestMapping("/captcha")
public void captcha(HttpServletRequest request, HttpServletResponse response) throws IOException {// 创建GifCaptcha对象，设置宽度为160，高度为40，长度为5GifCaptcha gifCaptcha = new GifCaptcha(160, 40, 5);// 获取生成的验证码内容final String captcha = gifCaptcha.text().toLowerCase();System.out.println(captcha);// 获取生成验证码的base64字符串// String base64 = gifCaptcha.toBase64();// System.out.println(base64);// 输出到前端页面显示CaptchaUtil.out(gifCaptcha, request, response);
}

重启应用，刷新页面（验证码会动）：

在这里插入图片描述

3. 使用ChineseGifCaptcha形式验证码

示例代码：

    @RequestMapping("/captcha")public void captcha(HttpServletRequest request, HttpServletResponse response) throws IOException {// 创建ChineseGifCaptcha对象，设置宽度为160，高度为40，长度为5ChineseGifCaptcha chineseGifCaptcha = new ChineseGifCaptcha(160, 40, 5);// 获取生成的验证码内容final String captcha = chineseGifCaptcha.text().toLowerCase();System.out.println(captcha);// 获取生成验证码的base64字符串//String base64 = chineseGifCaptcha.toBase64();//System.out.println(base64);// 输出到前端页面显示CaptchaUtil.out(chineseGifCaptcha, request, response);}

重启应用，刷新页面：

在这里插入图片描述

4. 使用ChineseCaptcha形式验证码

示例代码：

@RequestMapping("/captcha")public void captcha(HttpServletRequest request, HttpServletResponse response) throws IOException {// 创建ChineseCaptcha对象，设置宽度为160，高度为40，长度为5ChineseCaptcha chineseCaptcha = new ChineseCaptcha(160, 40, 5);// 获取生成的验证码内容final String captcha = chineseCaptcha.text().toLowerCase();System.out.println(captcha);// 获取生成验证码的base64字符串//String base64 = chineseCaptcha.toBase64();//System.out.println(base64);// 输出到前端页面显示CaptchaUtil.out(chineseCaptcha, request, response);}

重启应用，刷新页面：

在这里插入图片描述

5. 使用ArithmeticCaptcha形式验证码

示例代码：

@RequestMapping("/captcha")
public void captcha(HttpServletRequest request, HttpServletResponse response) throws IOException {// 创建ArithmeticCaptcha对象，设置宽度为160，高度为40，长度为5ArithmeticCaptcha arithmeticCaptcha = new ArithmeticCaptcha(160, 40, 5);// 获取生成的验证码内容final String captcha = arithmeticCaptcha.text().toLowerCase();System.out.println(captcha);// 获取生成验证码的base64字符串String base64 = arithmeticCaptcha.toBase64();System.out.println(base64);// 输出到前端页面显示CaptchaUtil.out(arithmeticCaptcha, request, response);
}

重启应用，刷新页面：

在这里插入图片描述

五、前后端分离架构怎么使用

上面我们介绍了各种验证码方式的使用，不过回到之前的问题，目前前后端架构的应用特别多，针对前后端分离架构下此时通过session去保存和获取验证码显然是不合适的，那么我们可以这么解决呢？

1. 技术方案

其实Easy-captcha组件也支持这个问题的解决，简单说一下解决思路。

  1. 创建需要的验证码对象；

  2. 获取验证码对象生成的验证码放到redis或其他缓存组件中，存储形式为key-value，key可以设置随机字符串，并可以设置过期时间，进行验证码有效期控制；

  3. 获取验证码对象生成的Base64字符串，和步骤2生成的key，一起返回给前端，前端通过返回的Base64字符串生成验证码图片；

  4. 验证码验证时，前端回传步骤3响应给前端key和输入的验证码，后端拿到key以后从redis或其他缓存组件中获取验证码对输入的验证码进行字符串对比，如果符合则通过，否则失败。

2. 技术实现

下面我们简单实现一下这个逻辑，使用ArithmeticCaptcha形式验证码为例，示例代码如下：

import com.wf.captcha.ArithmeticCaptcha;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
import java.io.PrintWriter;
import java.util.HashMap;
import java.util.Map;
import java.util.UUID;
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.ConcurrentMap;@RestController
public class CaptchaController {/*** 缓存，模拟redis缓存，不过没设置过期时间*/public static final ConcurrentMap<String, String> REDIS = new ConcurrentHashMap<>();/*** 生成验证码** @param request* @param response* @throws IOException*/@RequestMapping("/captcha")public /*Map<String, Object>*/ void captcha(HttpServletResponse response) throws IOException {Map<String, Object> map = new HashMap<>();// 创建ArithmeticCaptcha对象，设置宽度为160，高度为40，长度为5ArithmeticCaptcha arithmeticCaptcha = new ArithmeticCaptcha(160, 40, 5);// 获取生成的验证码内容final String captcha = arithmeticCaptcha.text().toLowerCase();// 生成一个随机keyString key = UUID.randomUUID().toString();// 模拟放入到redis中，真实业务需要设置验证码过期时间REDIS.put(key, captcha);// 获取生成验证码的base64字符串String base64 = arithmeticCaptcha.toBase64();map.put("captchaKey", key);map.put("captchaBase64", base64);// 为了演示简单，我使用response对象生成在前端显示response.setContentType("text/html;charset=utf-8");PrintWriter printWriter = response.getWriter();printWriter.println("<form action='/login' method='post'>");printWriter.println("<input type='hidden' name='captchaKey' value='" + key + "'>");printWriter.println("<img src='" + base64 + "' width='160px' height='50px'>");printWriter.println("<input type='text' name='captcha'>");printWriter.println("<input type='submit' value='login'>");printWriter.println("</from>");// 实际业务，将信息构建成一个MAP，返回给前端，前端生成验证码// return map;}}

输入验证码点击登录时，前端会携带返回key信息和验证码信息，后端根据这些信息进行判断，示例代码如下：

import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RestController;import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
import java.util.Objects;@RestController
public class LoginController {/*** 登录** @param request* @param response*/@PostMapping("/login")public void login(HttpServletRequest request, HttpServletResponse response) throws IOException {// 获取验证码参数String captcha = request.getParameter("captcha");// 获取验证码KeyString captchaKey = request.getParameter("captchaKey");// 从redis或者其他缓存组件中获取缓存的验证码信息，注意是否过期final String cacheCaptcha = CaptchaController.REDIS.get(captchaKey);// 校验验证码是否正确if (Objects.nonNull(cacheCaptcha) && cacheCaptcha.equalsIgnoreCase(cacheCaptcha)) { // 验证码一般对大小写不敏感response.getOutputStream().print("captcha correct!");} else {response.getOutputStream().print("captcha error!");}}
}

3. 测试

启动工程，访问http://localhost:8080/captcha地址，查看是否正常显示：

在这里插入图片描述

  • 输入错误验证码测试：

    在这里插入图片描述

  • 输入正确验证码测试：

在这里插入图片描述

到此，Easy-captcha组件使用介绍就结束了。

这篇关于Java应用开发必备：使用 easy-captcha 组件生成验证码的详细介绍的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！


http://www.chinasem.cn/article/940849。

相关文章

使用Python实现IP地址和端口状态检测与监控

使用Python实现IP地址和端口状态检测与监控

《使用Python实现IP地址和端口状态检测与监控》在网络运维和服务器管理中,IP地址和端口的可用性监控是保障业务连续性的基础需求,本文将带你用Python从零打造一个高可用IP监控系统,感兴趣的小伙... 目录概述：为什么需要IP监控系统使用步骤说明1. 环境准备2. 系统部署3. 核心功能配置系统效果展
阅读更多...
Java 实用工具类Spring 的 AnnotationUtils详解

Java 实用工具类Spring 的 AnnotationUtils详解

《Java实用工具类Spring的AnnotationUtils详解》Spring框架提供了一个强大的注解工具类org.springframework.core.annotation.Annot... 目录前言一、AnnotationUtils 的常用方法二、常见应用场景三、与 JDK 原生注解 API 的
阅读更多...
Java controller接口出入参时间序列化转换操作方法(两种)

Java controller接口出入参时间序列化转换操作方法(两种)

《Javacontroller接口出入参时间序列化转换操作方法(两种)》：本文主要介绍Javacontroller接口出入参时间序列化转换操作方法,本文给大家列举两种简单方法,感兴趣的朋友一起看... 目录方式一、使用注解方式二、统一配置场景：在controller编写的接口，在前后端交互过程中一般都会涉及
阅读更多...
Java中的StringBuilder之如何高效构建字符串

Java中的StringBuilder之如何高效构建字符串

《Java中的StringBuilder之如何高效构建字符串》本文将深入浅出地介绍StringBuilder的使用方法、性能优势以及相关字符串处理技术,结合代码示例帮助读者更好地理解和应用,希望对大家... 目录关键点什么是 StringBuilder？为什么需要 StringBuilder？如何使用 St
阅读更多...
使用Java将各种数据写入Excel表格的操作示例

使用Java将各种数据写入Excel表格的操作示例

《使用Java将各种数据写入Excel表格的操作示例》在数据处理与管理领域,Excel凭借其强大的功能和广泛的应用,成为了数据存储与展示的重要工具,在Java开发过程中,常常需要将不同类型的数据,本文... 目录前言安装免费Java库1. 写入文本、或数值到 Excel单元格2. 写入数组到 Excel表格
阅读更多...
redis中使用lua脚本的原理与基本使用详解

redis中使用lua脚本的原理与基本使用详解

《redis中使用lua脚本的原理与基本使用详解》在Redis中使用Lua脚本可以实现原子性操作、减少网络开销以及提高执行效率,下面小编就来和大家详细介绍一下在redis中使用lua脚本的原理... 目录Redis 执行 Lua 脚本的原理基本使用方法使用EVAL命令执行 Lua 脚本使用EVALSHA命令
阅读更多...
Java并发编程之如何优雅关闭钩子Shutdown Hook

Java并发编程之如何优雅关闭钩子Shutdown Hook

《Java并发编程之如何优雅关闭钩子ShutdownHook》这篇文章主要为大家详细介绍了Java如何实现优雅关闭钩子ShutdownHook,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起... 目录关闭钩子简介关闭钩子应用场景数据库连接实战演示使用关闭钩子的注意事项开源框架中的关闭钩子机制1.
阅读更多...
Maven中引入 springboot 相关依赖的方式(最新推荐)

Maven中引入 springboot 相关依赖的方式(最新推荐)

《Maven中引入springboot相关依赖的方式(最新推荐)》：本文主要介绍Maven中引入springboot相关依赖的方式(最新推荐),本文给大家介绍的非常详细,对大家的学习或工作具有... 目录Maven中引入 springboot 相关依赖的方式1. 不使用版本管理（不推荐）2、使用版本管理（推
阅读更多...
Java 中的 @SneakyThrows 注解使用方法(简化异常处理的利与弊)

Java 中的 @SneakyThrows 注解使用方法(简化异常处理的利与弊)

《Java中的@SneakyThrows注解使用方法(简化异常处理的利与弊)》为了简化异常处理,Lombok提供了一个强大的注解@SneakyThrows,本文将详细介绍@SneakyThro... 目录1. @SneakyThrows 简介 1.1 什么是 Lombok？2. @SneakyThrows
阅读更多...
在 Spring Boot 中实现异常处理最佳实践

在 Spring Boot 中实现异常处理最佳实践

《在SpringBoot中实现异常处理最佳实践》本文介绍如何在SpringBoot中实现异常处理,涵盖核心概念、实现方法、与先前查询的集成、性能分析、常见问题和最佳实践,感兴趣的朋友一起看看吧... 目录一、Spring Boot 异常处理的背景与核心概念1.1 为什么需要异常处理？1.2 Spring B
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2