EasyCaptcha 开源项目教程

EasyCaptcha 开源项目教程

EasyCaptcha Java图形验证码，支持gif、中文、算术等类型，可用于Java Web、JavaSE等项目。 项目地址: https://gitcode.com/gh_mirrors/eas/EasyCaptcha

1. 项目介绍

EasyCaptcha 是一个用于生成图形验证码的 Java 开源项目，支持 GIF、中文、算术等多种类型的验证码。它适用于 Java Web 和 JavaSE 项目，提供了丰富的功能和灵活的配置选项，帮助开发者快速集成验证码功能。

主要特性

• 支持 PNG 透明验证码
• 支持 GIF 动画验证码
• 支持 Base64 编码的验证码
• 支持中文验证码
• 支持算术验证码
• 支持多种字体和字符类型

2. 项目快速启动

2.1 环境准备

• JDK 1.8 或更高版本
• Maven 或 Gradle

2.2 添加依赖

Maven

在 pom.xml 文件中添加以下依赖：

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

Gradle

在 build.gradle 文件中添加以下依赖：

dependencies {
    compile 'com.github.whvcse:easy-captcha:1.6.2'
}

2.3 快速使用

2.3.1 在 SpringMVC 中使用

创建一个控制器类，用于生成验证码：

@Controller
public class CaptchaController {
    @RequestMapping("/captcha")
    public void captcha(HttpServletRequest request, HttpServletResponse response) throws Exception {
        CaptchaUtil.out(request, response);
    }
}

在前端页面中添加验证码图片：

<img src="/captcha" width="130px" height="48px" />

2.3.2 在 Servlet 中使用

在 web.xml 中配置 Servlet：

<web-app>
    <servlet>
        <servlet-name>CaptchaServlet</servlet-name>
        <servlet-class>com.wf.captcha.servlet.CaptchaServlet</servlet-class>
    </servlet>
    <servlet-mapping>
        <servlet-name>CaptchaServlet</servlet-name>
        <url-pattern>/captcha</url-pattern>
    </servlet-mapping>
</web-app>

在前端页面中添加验证码图片：

<img src="/captcha" width="130px" height="48px" />

3. 应用案例和最佳实践

3.1 验证码校验

在用户登录或提交表单时，通常需要校验用户输入的验证码是否正确。以下是一个简单的示例：

@Controller
public class LoginController {
    @PostMapping("/login")
    public JsonResult login(String username, String password, String verCode) {
        if (!CaptchaUtil.ver(verCode, request)) {
            CaptchaUtil.clear(request); // 清除session中的验证码
            return JsonResult.error("验证码不正确");
        }
        // 其他登录逻辑
    }
}

3.2 自定义验证码

EasyCaptcha 提供了丰富的配置选项，可以自定义验证码的宽度、高度、字符类型、字体等。以下是一个自定义验证码的示例：

@Controller
public class CaptchaController {
    @RequestMapping("/captcha")
    public void captcha(HttpServletRequest request, HttpServletResponse response) throws Exception {
        // 设置宽、高、位数
        CaptchaUtil.out(130, 48, 5, request, response);
    }
}

4. 典型生态项目

EasyCaptcha 作为一个轻量级的验证码生成工具，可以与多种 Java Web 框架和项目集成，例如：

• Spring Boot: 可以轻松集成到 Spring Boot 项目中，通过自动配置快速启用验证码功能。
• Shiro/Spring Security: 可以与这些安全框架结合，增强系统的安全性。
• 前后端分离项目: 可以生成 Base64 编码的验证码，方便前后端分离项目的集成。

通过这些生态项目的支持，EasyCaptcha 可以广泛应用于各种 Java Web 应用中，提升系统的安全性和用户体验。

EasyCaptcha Java图形验证码，支持gif、中文、算术等类型，可用于Java Web、JavaSE等项目。 项目地址: https://gitcode.com/gh_mirrors/eas/EasyCaptcha