使用Spring Boot实现图形验证码：从零开始的详细教程

在现代Web应用中，图形验证码是一种常见的防止机器人和恶意攻击的手段。今天，我们将深入探讨如何在Spring Boot项目中实现图形验证码。通过这个教程，你将学会如何生成和验证图形验证码，并将其集成到你的Spring Boot应用中。

一、项目初始化

首先，我们需要创建一个Spring Boot项目。如果你还没有Spring Boot项目，可以使用Spring Initializr快速生成一个。

1. 打开 Spring Initializr
2. 选择以下配置：
   • Project: Maven Project
   • Language: Java
   • Spring Boot: 2.5.4 (或最新版本)
   • Dependencies: Spring Web
3. 点击“Generate”按钮，下载生成的项目并解压。

二、添加依赖

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

<dependencies>
    <!-- Spring Web -->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
    <!-- FastJSON for JSON processing -->
    <dependency>
        <groupId>com.alibaba</groupId>
        <artifactId>fastjson</artifactId>
        <version>1.2.76</version>
    </dependency>
</dependencies>

三、生成图形验证码

接下来，我们需要编写生成图形验证码的代码。我们将创建一个工具类来生成验证码图片。

1. 创建验证码工具类

在src/main/java/com/example/demo/utils目录下创建一个名为CaptchaUtil.java的文件，并添加以下代码：

package com.example.demo.utils;

import java.awt.*;
import java.awt.image.BufferedImage;
import java.util.Random;

public class CaptchaUtil {

    private static final int WIDTH = 160;
    private static final int HEIGHT = 40;
    private static final int CODE_COUNT = 4;
    private static final int FONT_HEIGHT = 30;
    private static final int CODE_Y = 30;
    private static final char[] CODE_SEQUENCE = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz1234567890".toCharArray();

    public static BufferedImage generateCaptchaImage(StringBuilder code) {
        BufferedImage buffImg = new BufferedImage(WIDTH, HEIGHT, BufferedImage.TYPE_INT_RGB);
        Graphics2D g = buffImg.createGraphics();
        Random random = new Random();

        g.setColor(Color.WHITE);
        g.fillRect(0, 0, WIDTH, HEIGHT);

        Font font = new Font("Fixedsys", Font.BOLD, FONT_HEIGHT);
        g.setFont(font);

        g.setColor(Color.BLACK);
        g.drawRect(0, 0, WIDTH - 1, HEIGHT - 1);

        g.setColor(Color.BLACK);
        for (int i = 0; i < 30; i++) {
            int x = random.nextInt(WIDTH);
            int y = random.nextInt(HEIGHT);
            int xl = random.nextInt(12);
            int yl = random.nextInt(12);
            g.drawLine(x, y, x + xl, y + yl);
        }

        int red, green, blue;
        for (int i = 0; i < CODE_COUNT; i++) {
            String codeStr = String.valueOf(CODE_SEQUENCE[random.nextInt(CODE_SEQUENCE.length)]);
            red = random.nextInt(255);
            green = random.nextInt(255);
            blue = random.nextInt(255);

            g.setColor(new Color(red, green, blue));
            g.drawString(codeStr, (i + 1) * 30, CODE_Y);

            code.append(codeStr);
        }

        return buffImg;
    }
}

2. 创建验证码控制器

在src/main/java/com/example/demo/controller目录下创建一个名为CaptchaController.java的文件，并添加以下代码：

package com.example.demo.controller;

import com.example.demo.utils.CaptchaUtil;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

import javax.imageio.ImageIO;
import javax.servlet.http.HttpServletResponse;
import java.awt.image.BufferedImage;
import java.io.IOException;

@RestController
public class CaptchaController {

    @GetMapping("/captcha")
    public void getCaptcha(HttpServletResponse response) throws IOException {
        StringBuilder code = new StringBuilder();
        BufferedImage captchaImage = CaptchaUtil.generateCaptchaImage(code);

        response.setContentType("image/jpeg");
        response.setHeader("Pragma", "No-cache");
        response.setHeader("Cache-Control", "no-cache");
        response.setDateHeader("Expire", 0);

        ImageIO.write(captchaImage, "jpeg", response.getOutputStream());
    }
}

四、测试图形验证码

启动你的Spring Boot应用，打开浏览器并访问http://localhost:8080/captcha。你应该会看到一个随机生成的图形验证码。

五、验证图形验证码

为了验证用户输入的验证码，我们需要将生成的验证码存储在服务器端，并在用户提交时进行比对。这里我们使用Spring Session来存储验证码。

1. 添加Spring Session依赖

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

<dependency>
    <groupId>org.springframework.session</groupId>
    <artifactId>spring-session-core</artifactId>
</dependency>

2. 配置Spring Session

在src/main/resources/application.properties文件中添加以下配置：

spring.session.store-type=jdbc

3. 修改验证码控制器

我们需要将生成的验证码存储在Session中，并在用户提交时进行比对。

package com.example.demo.controller;

import com.example.demo.utils.CaptchaUtil;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;

import javax.imageio.ImageIO;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.awt.image.BufferedImage;
import java.io.IOException;

@RestController
public class CaptchaController {

    @GetMapping("/captcha")
    public void getCaptcha(HttpServletRequest request, HttpServletResponse response) throws IOException {
        StringBuilder code = new StringBuilder();
        BufferedImage captchaImage = CaptchaUtil.generateCaptchaImage(code);

        request.getSession().setAttribute("captcha", code.toString());

        response.setContentType("image/jpeg");
        response.setHeader("Pragma", "No-cache");
        response.setHeader("Cache-Control", "no-cache");
        response.setDateHeader("Expire", 0);

        ImageIO.write(captchaImage, "jpeg", response.getOutputStream());
    }

    @PostMapping("/verifyCaptcha")
    public String verifyCaptcha(HttpServletRequest request, @RequestParam("captcha") String captcha) {
        String sessionCaptcha = (String) request.getSession().getAttribute("captcha");
        if (sessionCaptcha != null && sessionCaptcha.equalsIgnoreCase(captcha)) {
            return "Captcha verified successfully!";
        } else {
            return "Captcha verification failed!";
        }
    }
}

六、总结

通过这个教程，我们从零开始在Spring Boot项目中实现了图形验证码的生成和验证。我们创建了一个工具类来生成验证码图片，并通过控制器将其展示给用户。同时，我们使用Spring Session来存储验证码，并在用户提交时进行比对。

希望这个教程对你有所帮助！如果你有任何问题或建议，欢迎在评论区留言。Happy coding!

百万大学生都在用的AI写论文工具，篇篇无重复