SpringBoot集成图片验证码框架easy-captcha的详细过程

 更新时间:2025年03月04日 11:23:39   作者:shy好好学习  
本文介绍了如何将Easy-Captcha框架集成到SpringBoot项目中,实现图片验证码功能,Easy-Captcha是一款轻量级的开源验证码框架,通过简洁的API和高度可定制性,可以快速实现验证码功能,文章详细介绍了如何配置、生成和展示验证码,并提供了Easy-Captcha的GitHub地址

SpringBoot集成图片验证码框架easy-captcha

此项目已经很久未维护,如有更好的选择,建议使用更好的选择!!!

一、引言

验证码(CAPTCHA)是现代应用中防止机器人攻击、保护接口安全的核心手段之一。然而,从零开发验证码模块需要处理图形渲染、算法设计、安全防护等诸多复杂问题。Easy-Captcha 作为一款轻量级开源验证码框架,以简洁的API和高度可定制性成为开发者的优选方案。下面我们将介绍如何将Easy-Captcha框架整合到SpringBoot项目中。

二、依赖

<dependency>
    <groupId>com.github.whvcse</groupId>
    <artifactId>easy-captcha</artifactId>
    <version>1.6.2</version>
</dependency>

三、代码

1. EasyCaptcha配置类

我们可以修改EasyCaptchaTypeEnum的枚举值来使用不同的验证码类型

@Configuration
@Data
public class EasyCaptchaConfig {
    /**
     * 验证码类型
     */
    private EasyCaptchaTypeEnum type = EasyCaptchaTypeEnum.GIF;
    /**
     * 验证码缓存过期时间(单位:秒)
     */
    private long ttl = 120L;
    /**
     * 验证码内容长度
     */
    private int length = 4;
    /**
     * 验证码宽度
     */
    private int width = 120;
    /**
     * 验证码高度
     */
    private int height = 36;
    /**
     * 验证码字体
     */
    private String fontName = "Verdana";
    /**
     * 字体风格
     */
    private Integer fontStyle = Font.PLAIN;
    /**
     * 字体大小
     */
    private int fontSize = 20;
}

2. EasyCaptchaTypeEnum枚举类

/**
 * @desc: EasyCaptcha 验证码类型枚举
 * @author: shy
 * @date: 2025/02/27 16:55
 */
public enum EasyCaptchaTypeEnum {
    /**
     * 算数
     */
    ARITHMETIC,
    /**
     * 中文
     */
    CHINESE,
    /**
     * 中文闪图
     */
    CHINESE_GIF,
    /**
     * 闪图
     */
    GIF,
    /**
     * png格式验证码
     */
    SPEC
}

3. 验证码生成器

/**
 * @desc: 验证码生成器
 * @author: shy
 * @date: 2025/02/27 16:59
 */
@Component
@RequiredArgsConstructor
public class EasyCaptchaProducer {
    private final EasyCaptchaConfig captchaConfig;
    public Captcha getCaptcha() {
        Captcha captcha;
        int width = captchaConfig.getWidth();
        int height = captchaConfig.getHeight();
        int length = captchaConfig.getLength();
        String fontName = captchaConfig.getFontName();
        switch (captchaConfig.getType()) {
            case ARITHMETIC:
                captcha = new ArithmeticCaptcha(width, height);
                //固定设置为两位,图片为算数运算表达式
                captcha.setLen(2);
                break;
            case CHINESE:
                captcha = new ChineseCaptcha(width, height);
                captcha.setLen(length);
                break;
            case CHINESE_GIF:
                captcha = new ChineseGifCaptcha(width, height);
                captcha.setLen(length);
                break;
            case GIF:
                captcha = new GifCaptcha(width, height);//最后一位是位数
                captcha.setLen(length);
                break;
            case SPEC:
                captcha = new SpecCaptcha(width, height);
                captcha.setLen(length);
                break;
            default:
                throw new RuntimeException("验证码配置信息错误!正确配置查看 CaptchaTypeEnum ");
        }
        // 使用默认字体即可解决中文乱码问题
        captcha.setFont(new Font(fontName, captchaConfig.getFontStyle(), captchaConfig.getFontSize()));
        return captcha;
    }
}

4. 验证码生成Service

/**
 * @desc: EasyCaptcha 业务类
 * @author: shy
 * @date: 2025/02/27 17:02
 */
@Component
@RequiredArgsConstructor
public class EasyCaptchaService {
    private final EasyCaptchaProducer easyCaptchaProducer;
    private final EasyCaptchaConfig captchaConfig;
    /**
     * 获取EasyCaptcha图片验证码
     *
     * @param
     * @return Captcha
     * @throws
     * @author shy
     * @date 2025/02/27 22:18
     */
    public Captcha getCaptcha() {
        // 获取验证码
        Captcha captcha = easyCaptchaProducer.getCaptcha();
        // 验证码文本
        String captchaText = captcha.text();
        // todo 验证码文本存储Redis比对
        System.out.println("验证码文本:" + captchaText);
        return captcha;
    }
}

5. 对外接口

@GetMapping("/getEasyCaptcha")
@ApiOperation(value = "获取EasyCaptcha图片验证码", notes = "获取EasyCaptcha图片验证码", httpMethod = "GET")
public void getEasyCaptcha() {
    Captcha captcha = captchaService.getCaptcha();
    try {
        captcha.out(response.getOutputStream());
        // 以上两种方式都可以输出图片验证码
        //CaptchaUtil.out(captcha, request, response);
    } catch (IOException e) {
        throw new RuntimeException();
    }
    super.getEasyCaptcha();
}

四、验证码展示

SHY QR Code

动态验证码

SHY QR Code

中文验证码

SHY QR Code

png格式验证码

五、总结

Easy-Captcha 通过模块化设计平衡了安全性与开发效率,其源码结构清晰(仅核心类约15个),适合二次开发。无论是快速实现基础验证功能,还是构建企业级人机验证系统,该框架都能提供可靠支持。建议结合具体业务需求,在验证码样式、验证流程上做深度定制。

GitHub 地址:https://github.com/whvcse/EasyCaptcha

到此这篇关于SpringBoot集成图片验证码框架easy-captcha的文章就介绍到这了,更多相关SpringBoot验证码easy-captcha内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • Java实现简单的贪吃蛇游戏

    Java实现简单的贪吃蛇游戏

    这篇文章主要介绍了Java实现简单的贪吃蛇游戏,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2021-07-07
  • Java JDBC API介绍与实现数据库连接池流程

    Java JDBC API介绍与实现数据库连接池流程

    JDBC是指Java数据库连接,是一种标准Java应用编程接口( JAVA API),用来连接 Java 编程语言和广泛的数据库。从根本上来说,JDBC 是一种规范,它提供了一套完整的接口,允许便携式访问到底层数据库,本篇文章我们来了解JDBC API及数据库连接池
    2022-12-12
  • Java获取接口的所有实现类方法总结示例

    Java获取接口的所有实现类方法总结示例

    这篇文章主要给大家介绍了关于Java获取接口的所有实现类方法的相关资料,文中通过代码介绍的非常详细,对大家的学习或者工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2024-06-06
  • Java实用工具库commons-lang3的使用

    Java实用工具库commons-lang3的使用

    Apache Commons Lang 3是一个流行的Java实用工具库,提供了对java.lang包的扩展,包括字符串操作、正则表达式处理、数字操作、日期和时间操作、随机字符串生成和对象操作等功能
    2025-03-03
  • Java 精炼解读类和对象原理

    Java 精炼解读类和对象原理

    面向对象乃是Java语言的核心,是程序设计的思想。Java语言的面向对象技术包括了面向对象和面向过程的基本概念,面向对象的特征,Java语言的类,对象,修饰符,抽象类等一系列的知识点
    2022-03-03
  • 在自定义线程池中捕获和处理异常实现过程

    在自定义线程池中捕获和处理异常实现过程

    这篇文章主要介绍了在自定义线程池中捕获和处理异常实现过程,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2026-05-05
  • Spring Cloud Eureka 注册与发现操作步骤详解

    Spring Cloud Eureka 注册与发现操作步骤详解

    这篇文章主要介绍了Spring Cloud Eureka 注册与发现操作步骤详解,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2021-03-03
  • HttpMessageConverter报文信息转换器的深入讲解

    HttpMessageConverter报文信息转换器的深入讲解

    在Spring中内置了大量的HttpMessageConverter,通过请求头信息中的MIME类型,选择相应的HttpMessageConverter,这篇文章主要给大家介绍了关于HttpMessageConverter报文信息转换器的相关资料,需要的朋友可以参考下
    2022-01-01
  • 如何解决Mybatis-plus中@TableLogic注解失效问题

    如何解决Mybatis-plus中@TableLogic注解失效问题

    这篇文章主要介绍了如何解决Mybatis-plus中@TableLogic注解失效问题,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2024-05-05
  • Java设计模式中的原型模式讲解

    Java设计模式中的原型模式讲解

    原型模式是用于创建重复的对象,同时又能保证性能。这种类型的设计模式属于创建型模式,它提供了一种创建对象的最佳方式,今天通过本文给大家介绍下Java 原型设计模式,感兴趣的朋友一起看看吧
    2023-04-04

最新评论