Java 实现的图形验证码工具类

1. 工具类代码

package com.example.demo.util;

import lombok.extern.slf4j.Slf4j;

import javax.imageio.ImageIO;
import java.awt.*;
import java.awt.image.BufferedImage;
import java.io.File;
import java.io.IOException;
import java.security.SecureRandom;

/**
 * 验证码工具类
 *
 * @author wangbo
 * @since 2024/10/29
 */
@Slf4j
public class CaptchaGeneratorUtil {

    private CaptchaGeneratorUtil() {
        // ...
    }

    public static void main(String[] args) throws IOException {
        // 生成4位随机数字验证码
        String text = generateRandomCode();
        // 创建验证码图片
        BufferedImage image = createImage(text);
        // 保存图片到文件
        ImageIO.write(image, "png", new File("captcha.png"));
    }

    private static final SecureRandom RANDOM = new SecureRandom();

    /**
     * 生成4位随机数字字母验证码
     */
    public static String generateRandomCode() {
        StringBuilder code = new StringBuilder();
        for (int i = 0; i < 4; i++) {
            int i1 = RANDOM.nextInt(3);
            if (i1 == 0) {
                code.append((char) (RANDOM.nextInt(26) + 65));
            } else if (i1 == 1) {
                code.append((char) (RANDOM.nextInt(26) + 97));
            } else {
                code.append(RANDOM.nextInt(10));
            }
        }
        log.info("生成的验证码文本 text = {}", code);
        return code.toString();
    }

    /**
     * 创建验证码图片
     */
    public static BufferedImage createImage(String text) {
        log.info("待生成验证码图片的文本 text = {}", text);
        int width = 75;
        int height = 25;
        BufferedImage image = new BufferedImage(width, height, BufferedImage.TYPE_INT_RGB);
        // 使用Graphics2D以获得更好的图形控制
        Graphics2D g2d = image.createGraphics();

        try {
            // 设置背景颜色
            g2d.setColor(new Color(0xDCDCDC));
            g2d.fillRect(0, 0, width, height);

            // 设置字体和颜色
            g2d.setFont(new Font("Arial", Font.BOLD, 20));
            g2d.setColor(new Color(0x004000));

            // 确保文本不会超出图像边界
            FontMetrics fm = g2d.getFontMetrics();
            int textWidth = fm.stringWidth(text);
            // 居中文本
            int x = (width - textWidth) / 2;
            // 居中文本（基线对齐）
            int y = (height - fm.getHeight()) / 2 + fm.getAscent();

            g2d.drawString(text, x, y);

            // 添加噪声线
            for (int i = 0; i < 5; i++) {
                g2d.setColor(new Color(RANDOM.nextInt(255), RANDOM.nextInt(255), RANDOM.nextInt(255)));
                g2d.drawLine(RANDOM.nextInt(width), RANDOM.nextInt(height), RANDOM.nextInt(width), RANDOM.nextInt(height));
            }

            // 设置渲染提示以提高图像质量（可选）
            g2d.setRenderingHint(RenderingHints.KEY_ANTIALIASING, RenderingHints.VALUE_ANTIALIAS_ON);
        } finally {
            // 确保在try块之后释放Graphics2D资源
            g2d.dispose();
        }

        return image;
    }

    private static final String CAPTCHA_PREFIX = "captcha:";

    public static String generateCaptchaRedisKey(String key) {
        return CAPTCHA_PREFIX + key;
    }
}

2. 工具类使用

生成图片验证码接口（该接口无需权限校验）：

/**
 * 生成图片验证码
 *
 * @param key UUID字符串
 */
@GetMapping("/captcha/generator/{key}")
public void captchaGenerator(@PathVariable("key") String key, HttpServletResponse response) throws BaseException {
    userService.captchaGenerator(key, response);
}

public void captchaGenerator(String key, HttpServletResponse response) throws BaseException {
    //查看key的验证码是否已存在
    String captchaRedisKey = CaptchaGeneratorUtil.generateCaptchaRedisKey(key);
    boolean hasKey = Boolean.TRUE.equals(redisTemplate.hasKey(captchaRedisKey));
    if (hasKey) {
        throw new BaseException(ErrorCode.USER_KEY_REPETITION);
    }
    String captcha = CaptchaGeneratorUtil.generateRandomCode();
    BufferedImage image = CaptchaGeneratorUtil.createImage(captcha);
    //设置验证码，有效期1分钟
    redisTemplate.opsForValue().set(captchaRedisKey, captcha, 60L, TimeUnit.SECONDS);
    response.setContentType("image/jpeg");
    try (ServletOutputStream out = response.getOutputStream()) {
        ImageIO.write(image, "JPEG", out);
    } catch (IOException e) {
        throw new RuntimeException(e);
    }
}

登录接口或者其他涉及验证码的接口进行验证码校验：

//校验验证码
String key = loginPage.getKey();
String captcha = loginPage.getCaptcha();
if (StringUtils.isNullOrEmpty(key) || StringUtils.isNullOrEmpty(captcha)) {
    throw new BaseException(ErrorCode.USER_KEY_OR_CAPTCHA_NOT_FOUND);
}
String captchaRedisKey = CaptchaGeneratorUtil.generateCaptchaRedisKey(key);
String redisCaptcha = redisTemplate.opsForValue().get(captchaRedisKey);
if (StringUtils.isNullOrEmpty(redisCaptcha) || !captcha.equalsIgnoreCase(redisCaptcha)) {
    throw new BaseException(ErrorCode.USER_CAPTCHA_ERROR);
} else {
    //删除验证码缓存
    redisTemplate.delete(captchaRedisKey);
}

3. 代码兼容性

上面工具类代码在 OpenJ9 的虚拟机环境下运行报错：

2024-11-13 09:53:22 - [INFO] - [c835a7ef-d245-4af5-845c-60dc03518368] - [http-nio-8080-exec-8]- [c.r.g.m.u.CaptchaGeneratorUtil-42] - 生成的验证码文本 text = 3142
2024-11-13 09:53:22 - [INFO] - [c835a7ef-d245-4af5-845c-60dc03518368] - [http-nio-8080-exec-8]- [c.r.g.m.u.CaptchaGeneratorUtil-50] - 待生成验证码图片的文本 text = 3142
2024-11-13 09:53:23 - [ERROR] - [c835a7ef-d245-4af5-845c-60dc03518368] - [http-nio-8080-exec-8]- [c.r.g.m.h.GlobalExceptionHandler-107] - Unexpected exception received null!!
2024-11-13 09:53:23 - [ERROR] - [c835a7ef-d245-4af5-845c-60dc03518368] - [http-nio-8080-exec-8]- [c.r.g.m.h.GlobalExceptionHandler-108] - Exception {}
java.lang.NullPointerException: null
	at sun.awt.FontConfiguration.getVersion(FontConfiguration.java:1264)
	at sun.awt.FontConfiguration.readFontConfigFile(FontConfiguration.java:219)
	at sun.awt.FontConfiguration.init(FontConfiguration.java:107)
	at sun.awt.X11FontManager.createFontConfiguration(X11FontManager.java:774)
	at sun.font.SunFontManager$2.run(SunFontManager.java:431)
	at java.security.AccessController.doPrivileged(AccessController.java:678)
	at sun.font.SunFontManager.<init>(SunFontManager.java:376)
	at sun.awt.FcFontManager.<init>(FcFontManager.java:35)
	at sun.awt.X11FontManager.<init>(X11FontManager.java:57)
	at java.lang.J9VMInternals.newInstanceImpl(Native Method)
	at java.lang.Class.newInstance(Class.java:1852)
	at sun.font.FontManagerFactory$1.run(FontManagerFactory.java:83)
	at java.security.AccessController.doPrivileged(AccessController.java:678)
	at sun.font.FontManagerFactory.getInstance(FontManagerFactory.java:74)
	at sun.font.SunFontManager.getInstance(SunFontManager.java:250)
	at sun.font.FontDesignMetrics.getMetrics(FontDesignMetrics.java:264)
	at sun.java2d.SunGraphics2D.getFontMetrics(SunGraphics2D.java:855)
	at com.example.demo.util.CaptchaGeneratorUtil.createImage(CaptchaGeneratorUtil.java:67)
	at com.example.demo.service.AdminService.captchaGenerator(AdminService.java:93)
	at com.example.demo.controller.AdminController.captchaGenerator(AdminController.java:44)
	at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
	at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:62)
	at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)
	at java.lang.reflect.Method.invoke(Method.java:498)
	at org.springframework.web.method.support.InvocableHandlerMethod.doInvoke(InvocableHandlerMethod.java:190)
	at org.springframework.web.method.support.InvocableHandlerMethod.invokeForRequest(InvocableHandlerMethod.java:138)
	at org.springframework.web.servlet.mvc.method.annotation.ServletInvocableHandlerMethod.invokeAndHandle(ServletInvocableHandlerMethod.java:105)
	at org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter.invokeHandlerMethod(RequestMappingHandlerAdapter.java:893)
	at org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter.handleInternal(RequestMappingHandlerAdapter.java:798)
	at org.springframework.web.servlet.mvc.method.AbstractHandlerMethodAdapter.handle(AbstractHandlerMethodAdapter.java:87)
	at org.springframework.web.servlet.DispatcherServlet.doDispatch(DispatcherServlet.java:1040)
	at org.springframework.web.servlet.DispatcherServlet.doService(DispatcherServlet.java:943)
	at org.springframework.web.servlet.FrameworkServlet.processRequest(FrameworkServlet.java:1006)
	at org.springframework.web.servlet.FrameworkServlet.doGet(FrameworkServlet.java:898)
	at javax.servlet.http.HttpServlet.service(HttpServlet.java:634)
	at org.springframework.web.servlet.FrameworkServlet.service(FrameworkServlet.java:883)
	at javax.servlet.http.HttpServlet.service(HttpServlet.java:741)
	at org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:231)
	at org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:166)
	at org.apache.tomcat.websocket.server.WsFilter.doFilter(WsFilter.java:53)
	at org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:193)
	at org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:166)
	at com.redteamobile.gundam.management.filter.WrapperAndLogFilter.doFilterInternal(WrapperAndLogFilter.java:42)
	at org.springframework.web.filter.OncePerRequestFilter.doFilter(OncePerRequestFilter.java:119)
	at org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:193)
	at org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:166)
	at org.springframework.web.filter.RequestContextFilter.doFilterInternal(RequestContextFilter.java:100)
	at org.springframework.web.filter.OncePerRequestFilter.doFilter(OncePerRequestFilter.java:119)
	at org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:193)
	at org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:166)
	at org.springframework.web.filter.FormContentFilter.doFilterInternal(FormContentFilter.java:93)
	at org.springframework.web.filter.OncePerRequestFilter.doFilter(OncePerRequestFilter.java:119)
	at org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:193)
	at org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:166)
	at org.springframework.web.filter.HiddenHttpMethodFilter.doFilterInternal(HiddenHttpMethodFilter.java:94)
	at org.springframework.web.filter.OncePerRequestFilter.doFilter(OncePerRequestFilter.java:119)
	at org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:193)
	at org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:166)
	at org.springframework.web.filter.CharacterEncodingFilter.doFilterInternal(CharacterEncodingFilter.java:201)
	at org.springframework.web.filter.OncePerRequestFilter.doFilter(OncePerRequestFilter.java:119)
	at org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:193)
	at org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:166)
	at org.apache.catalina.core.StandardWrapperValve.invoke(StandardWrapperValve.java:202)
	at org.apache.catalina.core.StandardContextValve.invoke(StandardContextValve.java:96)
	at org.apache.catalina.authenticator.AuthenticatorBase.invoke(AuthenticatorBase.java:541)
	at org.apache.catalina.core.StandardHostValve.invoke(StandardHostValve.java:139)
	at org.apache.catalina.valves.ErrorReportValve.invoke(ErrorReportValve.java:92)
	at org.apache.catalina.core.StandardEngineValve.invoke(StandardEngineValve.java:74)
	at org.apache.catalina.connector.CoyoteAdapter.service(CoyoteAdapter.java:343)
	at org.apache.coyote.http11.Http11Processor.service(Http11Processor.java:367)
	at org.apache.coyote.AbstractProcessorLight.process(AbstractProcessorLight.java:65)
	at org.apache.coyote.AbstractProtocol$ConnectionHandler.process(AbstractProtocol.java:860)
	at org.apache.tomcat.util.net.NioEndpoint$SocketProcessor.doRun(NioEndpoint.java:1598)
	at org.apache.tomcat.util.net.SocketProcessorBase.run(SocketProcessorBase.java:49)
	at java.util.concurrent.ThreadPoolExecutor.runWorker(ThreadPoolExecutor.java:1149)
	at java.util.concurrent.ThreadPoolExecutor$Worker.run(ThreadPoolExecutor.java:624)
	at org.apache.tomcat.util.threads.TaskThread$WrappingRunnable.run(TaskThread.java:61)
	at java.lang.Thread.run(Thread.java:821)

从上面的错误日志来看，问题似乎与字体管理有关。在 JDK8 中，AWT 和字体管理有时会在非标准环境（如无头环境或某些特定配置的服务器环境）中遇到问题。错误日志中提到了 NullPointerException，并且堆栈跟踪指向了与字体配置和字体管理器相关的类和方法。

这里有几个可能的解决方案来尝试解决这个问题：

‌确保字体配置文件存在‌：

检查您的系统中是否存在 Java 期望的字体配置文件。这些文件通常位于 Java 安装目录的 lib 子目录下的 fonts 文件夹中。如果您在一个定制的环境中运行 Java，确保该环境有权限访问这些字体文件。

‌使用系统属性设置字体管理器‌：

有时可以通过设置系统属性来指定 Java 应该使用哪种字体管理器。例如，您可以尝试设置sun.awt.font.FontManagerFactory系统属性为sun.awt.FcFontManagerFactory（如果您的系统支持FcFontManager）。 您可以在启动 Java 应用程序时通过命令行参数设置这个系统属性，如：java -Dsun.awt.font.FontManagerFactory=sun.awt.FcFontManagerFactory YourApplication。

‌检查 AWT 无头模式‌：

如果您的应用程序在一个无头环境中运行（即没有显示器、键盘或鼠标），AWT 可能会遇到问题。您可以检查是否无意中启用了 AWT 的无头模式。 您可以通过设置系统属性java.awt.headless为 false 来确保 AWT 不是在无头模式下运行（如果您的环境支持图形界面）。

‌更新或回退 Java 版本‌：

尝试使用不同的 JDK8 版本来查看问题是否仍然存在。有时，特定版本的 JDK 可能包含与字体管理相关的已知问题。

‌使用容器或 VM 的特定配置‌：

如果您在 Docker 容器或虚拟机中运行 Java 应用程序，请检查容器或 VM 的配置，以确保它们支持图形操作和字体管理。

‌添加错误处理和日志记录‌：

在您的代码中添加更多的错误处理和日志记录，以便在问题发生时捕获更多关于环境和状态的信息。

‌联系技术支持‌：

如果上述方法都不能解决问题，您可能需要联系 OpenJ9 或 Java 的技术支持以获取更具体的帮助。

请注意，由于这个问题似乎与特定的环境配置有关，因此可能需要进行一些试验和错误排除才能找到确切的解决方案。