EasyCaptcha 使用教程

项目介绍

EasyCaptcha 是一个用于生成图形验证码的 Java 库，支持 GIF、中文、算术等多种类型。它适用于 Java Web 和 JavaSE 项目，提供了丰富的配置选项和内置字体，不依赖系统字体。EasyCaptcha 旨在简化验证码的生成和使用过程，提高开发效率。

项目快速启动

引入依赖

首先，你需要在你的项目中引入 EasyCaptcha 库。以下是通过 Maven 和 Gradle 引入的示例：

Maven

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

Gradle

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

生成验证码

以下是一个简单的示例，展示如何生成一个 PNG 验证码并输出到文件：

import com.wf.captcha.SpecCaptcha;
import java.awt.Font;
import java.io.File;
import java.io.FileOutputStream;
import java.io.OutputStream;

public class Test {
    public static void main(String[] args) throws Exception {
        OutputStream outputStream = new FileOutputStream(new File("D:/a/aa.png"));
        SpecCaptcha specCaptcha = new SpecCaptcha(130, 48, 5);
        specCaptcha.setFont(new Font("Verdana", Font.PLAIN, 32));
        specCaptcha.setCharType(SpecCaptcha.TYPE_ONLY_NUMBER);
        String code = specCaptcha.text();
        specCaptcha.out(outputStream);
    }
}

应用案例和最佳实践

Web 应用中的使用

在 Web 项目中，你可以通过以下方式生成验证码并输出到 HTTP 响应中：

import com.wf.captcha.SpecCaptcha;
import com.wf.captcha.utils.CaptchaUtil;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;

@RequestMapping("/getcode")
public void captcha(HttpServletRequest request, HttpServletResponse response) throws IOException {
    CaptchaUtil.setHeader(response);
    SpecCaptcha specCaptcha = new SpecCaptcha(85, 45, 4);
    specCaptcha.setCharType(SpecCaptcha.TYPE_ONLY_NUMBER);
    specCaptcha.out(response.getOutputStream());
}

最佳实践

1. 字体设置：使用内置字体，避免依赖系统字体。
2. 验证码类型：根据需求选择合适的验证码类型，如纯数字、纯字母或混合类型。
3. 干扰线：增加贝塞尔曲线作为干扰线，提高安全性。

典型生态项目

EasyCaptcha 可以与以下项目结合使用，以增强验证码功能：

1. Spring Boot：集成 Spring Boot 快速开发验证码服务。
2. Shiro/Spring Security：结合安全框架，实现验证码的验证和校验。
3. Redis：使用 Redis 存储验证码，提高性能和可扩展性。

通过这些生态项目的结合，可以构建出更加健壮和高效的验证码系统。