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

最新推荐文章于 2024-05-03 00:21:36 发布
最新推荐文章于 2024-05-03 00:21:36 发布
阅读量840 收藏 25
点赞数 17
分类专栏： java web springboot 文章标签： spring boot java web 验证码 登录
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/C_AJing/article/details/138232714
版权

一、前言

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

在一番寻觅以后，还真发现一个好用的第三方验证码组件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组件使用介绍就结束了。

代码探险家_cool
关注
  • 17
    点赞
  • 踩
  • 25
    收藏
    觉得还不错? 一键收藏
  • 1
    评论
专栏目录
easy-captcha是生成图形验证码的Java类库
12-12
easy-captcha-1.6.2.jar easy-captcha-1.6.2-javadoc.jar easy-captcha-1.6.2-sources.jar
github gitee go开发 热门开源项目
zhaoyang10的专栏
08-25 2224
该库通过高度兼容性支持复杂的组件，并提供流式API，以从具有大量数据的工作表中生成或读取数据。goauth2的后继者。go-sniffer 工具，可扩展的抓包工具，可以开发自定义协议的工具包. 现在只支持了 http，mysql，redis，mongodb.（5）如果只想获取切片中某项值，不需要值的索引，尽可能的使用for range去遍历切片，这比必须查询切片中的每个元素要快一些。是一个功能强大的命令行工具库，我们用它来实现内部的命令行工具，同时也推荐使用 我个人会更习惯用后者，要简洁一些。
华为被迫开源，从认知到落地SpringBoot企业级实战手册（完整版）
m0_71777195的博客
11-07 76
本手册重在引导读者进入真实的项目开发体验，围绕Spring Boot技术栈全面展开，兼顾相关技术的知识拓展，由浅入深，步步为营，使读者既能学习基础知识，又能掌握. 一定的开发技巧。本书的目标是让读者拥有一个完整且高质量的学习体验，远离"Hello World项目”，为技术深度的挖掘和薪水、职位的提升提供保障。工欲善其事，必先利其器。注重基础环境的搭建和开发工具的使用，以帮助朋友们少走弯路，快速掌握SpringBoot项目的开发技能。
Python Web框架比较，选择对的框架让开发更便捷
老K带你学Python
08-27 995
Python程序员有很多很好的选择来创建Web应用程序和API；Django，Weppy，Bottle和Flask引领潮流。 如果正在开发一个Web应用程序并且已经选择使用Python作为构建它的语言，那么这是一个明智的选择。Python的开发成熟度，强大的库以及广泛的实际应用使其成为Web开发的必需。 现在是困难的部分：从众多可用的Python web框架中选择一个。它们不仅数量在不断增长，而...
python web服务框架-13个Python Web框架比较，你想使用哪个呢？
weixin_37988176的博客
10-29 881
Python程序员有很多很好的选择来创建Web应用程序和API；Django，Weppy，Bottle和Flask引领潮流。如果正在开发一个Web应用程序并且已经选择使用Python作为构建它的语言，那么这是一个明智的选择。Python的开发成熟度，强大的库以及广泛的实际应用使其成为Web开发的必需。现在是困难的部分：从众多可用的Python web框架中选择一个。它们不仅数量在不断增长，而且很难...
华为被迫开源！从认知到落地SpringBoot企业级实战手册（完整版）
m0_69860228的博客
07-20 618
前言 本手册重在引导读者进入真实的项目开发体验，围绕Spring Boot技术栈全面展开，兼顾相关技术的知识拓展，由浅入深，步步为营，使读者既能学习基础知识，又能掌握. 一定的开发技巧。本书的目标是让读者拥有一个完整且高质量的学习体验，远离"Hello World项目”，为技术深度的挖掘和薪水、职位的提升提供保障。...
食品添加剂健康小助手系统的设计与实现 tp+mysql后台
shenchengyv的博客
10-10 328
Layui是一个基于jQuery的前端UI框架，由贤心于2016年创建，它致力于提供简洁、易用、扩展性强的前端UI解决方案，已成为国内领先的前端UI框架之一。以下是Layui的主要特点：简单易用：Layui的设计理念是简洁易用，文档详尽，功能模块化，易于上手。组件丰富：Layui提供了丰富的UI组件，包括表单、表格、导航、弹层、分页等，可以满足各种Web应用程序的需求。扩展性强：Layui提供了完善的插件机制和API接口，开发者可以自定义和扩展组件，以满足特定的需求。
go技术文章梳理（2017）
热门推荐
韩亚军的博客
06-22 3万+
gocn_news_2017-12-31 分布式系统下的Go channels https://medium.com/@matryer/introducing-vice-go-channels-across-many-machines-bcac1147d7e2 Go Socket编程之teleport框架是怎样炼成的 https://www.jianshu.com/p/7120...
2024年最全【2024最新】全网最全开源黑客工具合集（附地址）_quake(1)
2401_84240129的博客
05-03 592
受限于篇幅原因，无法全部展示，如果你需要的话，可以。
2024年最全【2024最新】全网最全开源黑客工具合集（附地址）_quake
最新发布
2401_84240129的博客
05-03 997
重点提醒：本项目工具来源于互联网，是否含带木马及后门请自行甄别！！请大家提高警惕！！！受限于篇幅原因，无法全部展示，如果你需要的话，可以。
dcat-login-captcha:Dcat-admin登陆验证码
03-15
admin登陆验证码预览环境PHP> = 7.2.5 Dcat管理员^ 2.0安装作曲家安装composer require lake/login-captcha安装扩展在开发工具->扩展安装本扩展开源协议本扩展共识Apache2开放协议发布，在保留本扩展版权的情况下...
java8源码-captcha-killer-java8:验证码杀手-java8
06-04
captcha-killer要解决的问题是让burp能用上各种验证码识别技术。 换到burp2020后，这款工具就用不了了，因为原工具Base64编码是使⽤JDK⾥sun.misc套件下的BASE64Encoder和BASE64Decoder这两个类，但是burp2020只能...
word源码java-Happy-Captcha-Java:快乐验证码-Java
06-05
Captcha是一款易于使用的Java验证码软件包，旨在花最短的时间，最少的代码量，实现Web站点的验证码功能。Happy Captcha完全遵循Apache 2.0开源许可协议，你可以自由使用该软件，如您在使用Happy Captcha时发现软件的...
基于Java的tianai-captcha行为验证码设计源码
04-15
基于Java的tianai-captcha行为验证码设计源码，该项目包含90个文件，主要文件类型有63个java...该项目是一个基于Java的tianai-captcha行为验证码设计源码，可能涉及用户界面设计、应用逻辑实现、数据存储等多个方面。
RequestContextHolder跨线程获取不到request对象，解决方法
C_AJing的博客
12-03 6074
一、前言 最近在做一个系统的全局日志拦截记录功能，有一个需要记录的IP地址的信息，我是从HttpServletRequest对象中获取的，但是我发现如果使用线程池以后，记录日志信息会报错，主要是获取不到HttpServletRequest对象。 下面使用代码简单演示一下问题和解决方法： 二、代码演示 创建一个spring boot项目，项目结构如下： 2. 导入maven依赖： <dependency> <groupId>org.spri
使用SM4国密加密算法对Spring Boot项目数据库连接信息以及yaml文件配置属性进行加密配置（读取时自动解密）
C_AJing的博客
02-07 2618
在业务系统开发过程中，我们必不可少的会使用数据库，在应用开发过程中，数据库连接信息往往都是以明文的方式配置到yaml配置文件中的，这样有密码泄露的风险，那么有没有什么方式可以避免呢？方案当然是有的，就是对数据库密码配置的时候进行加密，然后读取的时候再进行解密，这样就可以避免敏感信息泄露了。针对加密的数据库配置信息，需要自定义解密，所以需要自定义一个DataSource对象// 对用户名进行解密 return SM4Utils . decryptStr(super . getUsername());
SpringBoot项目集成消息中间件以后@JmsListener注解不能生效的问题
C_AJing的博客
03-28 2525
SpringBoot项目集成消息中间件以后@JmsListener注解不能生效的问题
spring boot2.x版本项目运行过程中，动态更新class文件，简单实践
C_AJing的博客
06-03 2361
在平时学习和开发过程中，如果java源文件发生了修改会重新编译成新的class文件，这时一般都需要重新启动项目，加载最新的class文件，改动才会生效。那么能不能在不重新启动项目的情况下，动态更新掉class文件，使最新的改动生效呢，下面我们简单实践一下： 首先创建一个简单的类文件： package learnbymaven.string; /** * @author jinghx * @date 2020/06/03 */ public class Hello { public Stri
在django中怎么运用django-simple-captcha自动生成验证码
02-28
在Django中使用django-simple-captcha生成验证码可以通过以下步骤现： 1. 安装django-simple-captcha库： 在终端中运行以下命令安装django-simple-captcha库： ``` pip install django-simple-captcha ``` 2. 在Django项目的`settings.py`文件中添加`captcha`应用： 打开`settings.py`文件，找到`INSTALLED_APPS`列表，将`'captcha'`添加到其中。 3. 运行数据库迁移： 在终端中运行以下命令，将`captcha`应用的数据库迁移到你的项目中： ``` python manage.py migrate captcha ``` 4. 在需要生成验证码的表单中添加验证码字段： 在你的表单类中导入`CaptchaField`，并将其作为一个字段添加到表单中。例如： ```python from captcha.fields import CaptchaField class MyForm(forms.Form): # 其他字段... captcha = CaptchaField() ``` 5. 在视图函数中验证验证码： 在你的视图函数中，可以通过调用`form.is_valid()`来验证验证码是否正确。例如： ```python def my_view(request): if request.method == 'POST': form = MyForm(request.POST) if form.is_valid(): # 验证码正确，执行相应的逻辑 # ... else: # 验证码错误，处理错误信息 # ... else: form = MyForm() return render(request, 'my_template.html', {'form': form}) ``` 6. 在模板中显示验证码输入框： 在你的模板文件中，可以通过`form.captcha`来渲染验证码输入框。例如： ```html <form method="post"> {% csrf_token %} {{ form.as_p }} <button type="submit">提交</button> </form> ``` 这样，你就可以在Django中使用django-simple-captcha生成验证码了。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 1
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值