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

news2025/1/18 9:55:36

一、前言

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

在一番寻觅以后，还真发现一个好用的第三方验证码组件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，长度为5
    GifCaptcha 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，长度为5
        ChineseGifCaptcha 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，长度为5
        ChineseCaptcha 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，长度为5
    ArithmeticCaptcha 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，长度为5
        ArithmeticCaptcha arithmeticCaptcha = new ArithmeticCaptcha(160, 40, 5);
        // 获取生成的验证码内容
        final String captcha = arithmeticCaptcha.text().toLowerCase();
        // 生成一个随机key
        String 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");
        // 获取验证码Key
        String 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组件使用介绍就结束了。

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.coloradmin.cn/o/1628081.html

如若内容造成侵权/违法违规/事实不符，请联系多彩编程网进行投诉反馈，一经查实，立即删除！

相关文章

RGB灯珠的控制-单片机通用模板

RGB灯珠的控制-单片机通用模板

RGB灯珠的控制-单片机通用模板 一、RGB控制的原理二、RGB.c的实现三、RGB.h的实现四、color色彩空间变换以及控制渐变一、RGB控制的原理 ①通过IO发送脉冲识别0/1编码，组合24Bit的RGB数据，从而控制RGB；②每个RGB灯珠通过DIN、DOU进行级联起来；③通过HSV色彩转换成RGB从而控…
阅读更多...
Tomcat架构设计精髓分析-Connector高内聚低耦合设计

Tomcat架构设计精髓分析-Connector高内聚低耦合设计

优秀的模块化设计通常都会采用高内聚、低耦合 高内聚是指相关度比较高的功能要尽可能集中&#xff0c;不要分散。低耦合是指两个相关的模块要尽可能减少依赖的部分和降低依赖的程序&#xff0c;不要让两个模块产中强依赖。 Tomca连接器需要实现的功能: 监听网络端口 接受网络…
阅读更多...
手撕netty源码（一）- NioEventLoopGroup

手撕netty源码（一）- NioEventLoopGroup

文章目录 前言一、NIO 与 netty二、NioEventLoopGroup 对象的创建过程2.1 创建流程图2.2 EventExecutorChooser 的创建 前言 processOn文档跳转 本文是手撕netty源码系列的开篇文章&#xff0c;会先介绍一下netty对NIO关键代码的封装位置&#xff0c;主要介绍 NioEventLoopGro…
阅读更多...
使用PyCharm开发工具创建工程

使用PyCharm开发工具创建工程

一. 简介 前面文章实现了开发 python程序使用的 开发工具PyCharm&#xff0c;本文来学习使用 PyCharm开发工具创建一个 python工程。 二. 使用PyCharm开发工具创建工程 1. 首先&#xff0c;打开 PyCharm开发工具&#xff0c;打开 "New project" 选项&#xff1a; …
阅读更多...
hive启动beeline报错

hive启动beeline报错

问题一在zpark启动集群报错 出现上面的问题执行以下代码 chmod 777 /opt/apps/hadoop-3.2.1/logs 问题二启动beeline报错 执行 cd /opt/apps/hadoop-3.2.1 bin/hadoop dfsadmin -safemode leave 问题三执行查询语句报错 执行 set hive.exec.mode.local.autotrue;
阅读更多...
java接口加密解密

java接口加密解密

这里写目录标题 controller加解密工具类加密&#xff08;本质是对ResponseBody加密&#xff09;解密&#xff08;本质是对RequestBody传参解密&#xff09;注解 controller Controller public class PathVariableController {GetMapping(value "/test")ResponseBod…
阅读更多...
Redis缓存问题:穿透,击穿,雪崩等

Redis缓存问题:穿透,击穿,雪崩等

Redis缓存问题:穿透,击穿,雪崩等 在高并发场景下,数据库往往是最薄弱的环节,我们通常选择使用redis来进行缓存,以起到缓冲作用,来降低数据库的压力,但是一旦缓存出现问题,也会导致数据库瞬间压力过大甚至崩溃,从而导致整个系统崩溃.今天就聊聊常见的redis缓存问题. 缓存击穿 …
阅读更多...
相关分析方法

相关分析方法

目录 1.什么是相关分析方法 2.相关系数 3.常见的相关分析方法 3.1.皮尔逊相关系数 3.2.斯皮尔曼等级相关 ​​​​​​​3.3.肯德尔等级相关 ​​​​​​​3.4.其它 4.应用 5.注意事项 6.结语 1.什么是相关分析方法 相关分析是数据分析中的一种统计方法&#xff0c…
阅读更多...
[C++基础学习]----02-C++运算符详解

[C++基础学习]----02-C++运算符详解

前言 C中的运算符用于执行各种数学或逻辑运算。下面是一些常见的C运算符及其详细说明&#xff1a;下面详细解释一些常见的C运算符类型&#xff0c;包括其原理和使用方法。 正文 01-运算符简介 算术运算符&#xff1a; a、加法运算符&#xff08;&#xff09;&#xff1a;对两个…
阅读更多...
RabbitMQ（高级）笔记

RabbitMQ（高级）笔记

一、生产者可靠性 &#xff08;1&#xff09;生产者重连&#xff08;不建议使用&#xff09; logging:pattern:dateformat: MM-dd HH:mm:ss:SSSspring:rabbitmq:virtual-host: /hamllport: 5672host: 192.168.92.136username: hmallpassword: 123listener:simple:prefetch: 1c…
阅读更多...
AWTK 开源串口屏开发(17) - 通过 MODBUS 访问数组数据

AWTK 开源串口屏开发(17) - 通过 MODBUS 访问数组数据

在 AWTK 串口屏中&#xff0c;内置了 MODBUS Client Channel 的模型&#xff0c;不用编写代码即可实现在 ListView 中显示数组数据。 MODBUS 协议一次只能读取 125 个 WORD&#xff0c;AWTK-MODBUS Client Channel 支持长数据&#xff0c;自动分成多个请求访问。 1. 功能 不用…
阅读更多...
浏览器的同源策略与解决跨域

浏览器的同源策略与解决跨域

同源策略&#xff08;协议、域名、端口&#xff09; 同源策略&#xff08;Same-Origin Policy&#xff09;是一个在浏览器安全模型中被实施的重要安全机制。它是基于域名、协议和端口号的限制&#xff0c;用于防止不同源的网页间的恶意行为和信息泄露。 根据同源策略&#xf…
阅读更多...
【Diffusion实战】训练一个diffusion模型生成蝴蝶图像（Pytorch代码详解）

【Diffusion实战】训练一个diffusion模型生成蝴蝶图像（Pytorch代码详解）

上一篇Diffusion实战是确确实实一步一步走的公式&#xff0c;这回采用一个更方便的库&#xff1a;diffusers&#xff0c;来实现Diffusion模型训练。 Diffusion实战篇&#xff1a;   【Diffusion实战】训练一个diffusion模型生成S曲线&#xff08;Pytorch代码详解&#xff09;…
阅读更多...
Adaboost集成学习 | Matlab实现基于RVM-Adaboost相关向量机结合Adaboost集成学习多变量时间序列预测（负荷预测）

Adaboost集成学习 | Matlab实现基于RVM-Adaboost相关向量机结合Adaboost集成学习多变量时间序列预测（负荷预测）

目录 效果一览基本介绍模型设计程序设计参考资料效果一览 基本介绍
阅读更多...
【Linux学习】​​学习Linux的准备工作和Linux的基本指令

【Linux学习】​​学习Linux的准备工作和Linux的基本指令

˃͈꒵˂͈꒱ write in front ꒰˃͈꒵˂͈꒱ ʕ̯•͡˔•̯᷅ʔ大家好&#xff0c;我是xiaoxie.希望你看完之后,有不足之处请多多谅解&#xff0c;让我们一起共同进步૮₍❀ᴗ͈ . ᴗ͈ აxiaoxieʕ̯•͡˔•̯᷅ʔ—CSDN博客 本文由xiaoxieʕ̯•͡˔•̯᷅ʔ 原创 CSDN 如…
阅读更多...
并并并并·病查坤

并并并并·病查坤

P1、什么是并查集 引用自百度百科&#xff1a; 并查集&#xff0c;在一些有N个元素的集合应用问题中&#xff0c;我们通常是在开始时让每个元素构成一个单元素的集合&#xff0c;然后按一定顺序将属于同一组的元素所在的集合合并&#xff0c;其间要反复查找一个元素在哪个集合…
阅读更多...
【数据标注】使用LabelImg标注YOLO格式的数据（案例演示）

【数据标注】使用LabelImg标注YOLO格式的数据（案例演示）

文章目录 LabelImg介绍LabelImg安装LabelImg界面标注常用的快捷键标注前的一些设置案例演示检查YOLO标签中的标注信息是否正确参考文章 LabelImg介绍 LabelImg是目标检测数据标注工具&#xff0c;可以标注两种格式&#xff1a; VOC标签格式&#xff0c;标注的标签存储在xml文…
阅读更多...
insightface 环境配置

insightface 环境配置

首先创建续集环境&#xff1a; conda create -n insightface3 python3.8 然后打开此虚拟环境&#xff1a;conda activate insightface3 然后安装&#xff1a; pip install insightface 再安装&#xff1a;pip install onnxruntime-gpu 就可以了
阅读更多...
零基础俄语培训哪家好,柯桥俄语培训

零基础俄语培训哪家好,柯桥俄语培训

1、Мощный дух спасает расслабленное тело. 强大的精神可以拯救孱弱的肉体。 2、Единственное правило в жизни, по которому нужно жить — оставаться человеком в лю…
阅读更多...
物联网的基本功能及五大核心技术——青创智通

物联网的基本功能及五大核心技术——青创智通

工业物联网解决方案-工业IOT-青创智通 物联网基本功能 物联网的最基本功能特征是提供“无处不在的连接和在线服务”&#xff0c;其具备十大基本功能。 &#xff08;1&#xff09;在线监测&#xff1a;这是物联网最基本的功能&#xff0c;物联网业务一般以集中监测为主、控制为…
阅读更多...
推荐文章
最新文章

Copyright @ 2022~2023