首页 > 软件编程 > java > SpringBoot二维码生成

SpringBoot实现二维码生成的详细步骤与完整代码

2025-05-13 11:13:33 作者：全干程序员demo

如今,二维码的应用场景非常广泛,从支付到信息分享,二维码都扮演着重要角色,Spring Boot 是一个非常流行的 Java 基于 Spring 框架的微服务开发框架,它可以帮助开发者快速搭建应用,本文将详细介绍如何在 Spring Boot 项目中实现二维码的生成,需要的朋友可以参考下

一、环境搭建

开发工具
- 使用 IntelliJ IDEA 或 Eclipse 等主流的 Java 开发工具，这些工具对 Spring Boot 有良好的支持，能够方便地创建项目、管理依赖和运行代码。
JDK 环境
- 确保安装了 JDK 1.8 或更高版本，因为 Spring Boot 项目需要 Java 环境来运行。可以通过命令行输入 java -version 来检查 JDK 是否已正确安装。

二、创建 Spring Boot 项目

使用 Spring Initializr 创建项目
- 打开 Spring Initializr 网站。
- 在界面中选择以下内容：
  - Project：Maven（推荐使用 Maven 作为项目管理工具）
  - Language：Java
  - Spring Boot Version：选择最新的稳定版本
  - Dependencies：添加 “Spring Web” 依赖，因为我们需要通过 HTTP 接口来生成二维码
- 点击 “Generate” 按钮，下载生成的项目压缩包，解压后导入到开发工具中。

三、引入二维码生成依赖

为了在 Spring Boot 项目中生成二维码，我们需要使用一个第三方库。这里推荐使用 com.google.zxing，它是一个开源的、功能强大的二维码生成和解析库。

在 pom.xml 文件中添加依赖

<dependency>
    <groupId>com.google.zxing</groupId>
    <artifactId>core</artifactId>
    <version>3.4.1</version>
</dependency>
<dependency>
    <groupId>com.google.zxing</groupId>
    <artifactId>javase</artifactId>
    <version>3.4.1</version>
</dependency>

依赖说明
- core：提供了二维码生成和解析的核心功能。
- javase：提供了在 Java 环境下对二维码进行操作的工具类。

四、编写二维码生成代码

创建二维码生成服务类
- 在项目中创建一个名为 QrCodeService 的类，用于封装二维码生成的逻辑。

package com.example.qrcode.service;

import com.google.zxing.BarcodeFormat;
import com.google.zxing.EncodeHintType;
import com.google.zxing.WriterException;
import com.google.zxing.common.BitMatrix;
import com.google.zxing.qrcode.QRCodeWriter;
import com.google.zxing.qrcode.decoder.ErrorCorrectionLevel;

import javax.imageio.ImageIO;
import java.awt.*;
import java.awt.image.BufferedImage;
import java.io.File;
import java.io.IOException;
import java.util.HashMap;
import java.util.Map;

public class QrCodeService {

    /**
     * 生成二维码
     *
     * @param content 二维码内容
     * @param width   二维码宽度
     * @param height  二维码高度
     * @param filePath 二维码保存路径
     * @throws WriterException
     * @throws IOException
     */
    public void generateQRCode(String content, int width, int height, String filePath) throws WriterException, IOException {
        // 设置二维码参数
        Map<EncodeHintType, Object> hints = new HashMap<>();
        hints.put(EncodeHintType.CHARACTER_SET, "UTF-8"); // 设置字符编码
        hints.put(EncodeHintType.ERROR_CORRECTION, ErrorCorrectionLevel.H); // 设置容错级别
        hints.put(EncodeHintType.MARGIN, 2); // 设置边距

        // 创建二维码生成器
        QRCodeWriter qrCodeWriter = new QRCodeWriter();
        BitMatrix bitMatrix = qrCodeWriter.encode(content, BarcodeFormat.QR_CODE, width, height, hints);

        // 创建图片
        BufferedImage image = new BufferedImage(width, height, BufferedImage.TYPE_INT_RGB);
        image.createGraphics();

        Graphics2D graphics = (Graphics2D) image.getGraphics();
        graphics.setColor(Color.WHITE);
        graphics.fillRect(0, 0, width, height);
        graphics.setColor(Color.BLACK);
        for (int i = 0; i < width; i++) {
            for (int j = 0; j < height; j++) {
                if (bitMatrix.get(i, j)) {
                    graphics.fillRect(i, j, 1, 1);
                }
            }
        }

        // 保存图片
        File outputFile = new File(filePath);
        ImageIO.write(image, "png", outputFile);
    }
}

代码说明
- 使用 QRCodeWriter 类来生成二维码。
- 通过 BitMatrix 对象来表示二维码的矩阵信息。
- 使用 BufferedImage 来创建图片，并将二维码矩阵绘制到图片上。
- 最后，使用 ImageIO.write 方法将图片保存到指定路径。

五、创建控制器提供二维码生成接口

创建 QrCodeController 类
- 在项目中创建一个控制器类，用于接收用户请求并调用二维码生成服务。

package com.example.qrcode.controller;

import com.example.qrcode.service.QrCodeService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class QrCodeController {

    @Autowired
    private QrCodeService qrCodeService;

    /**
     * 生成二维码接口
     *
     * @param content 二维码内容
     * @param width   二维码宽度
     * @param height  二维码高度
     * @param filePath 二维码保存路径
     * @return
     */
    @GetMapping("/generateQRCode")
    public String generateQRCode(@RequestParam String content, @RequestParam int width, @RequestParam int height, @RequestParam String filePath) {
        try {
            qrCodeService.generateQRCode(content, width, height, filePath);
            return "二维码生成成功，保存路径为：" + filePath;
        } catch (Exception e) {
            e.printStackTrace();
            return "二维码生成失败：" + e.getMessage();
        }
    }
}

接口说明
- 使用 @RestController 注解标记为控制器类。
- 定义了一个 @GetMapping 方法，接收用户通过 GET 请求传递的参数，包括二维码内容、宽度、高度和保存路径。
- 调用 QrCodeService 的 generateQRCode 方法来生成二维码，并返回生成结果。

六、测试运行

启动 Spring Boot 应用
- 在开发工具中运行项目，启动 Spring Boot 应用。
发送请求测试
- 打开浏览器或使用工具（如 Postman）发送请求到接口地址，例如：

http://localhost:8080/generateQRCode?content=Hello%20World&width=200&height=200&filePath=D:/qrcode.png

如果一切正常，你会看到返回的提示信息，如 “二维码生成成功，保存路径为：D:/qrcode.png”，并且在指定路径下生成了二维码图片。

七、总结

通过上述步骤，我们成功地在 Spring Boot 项目中实现了二维码的生成功能。从项目创建、依赖引入、服务层代码编写到控制器接口的实现，每一步都详细说明了操作方法和代码实现。生成的二维码可以根据用户的需求自定义内容、大小和保存路径，具有很强的灵活性。此功能可以应用于多种场景，如活动二维码生成、商品二维码生成等，为开发者提供了便捷的工具。

以上就是SpringBoot实现二维码生成的详细步骤与完整代码的详细内容，更多关于SpringBoot二维码生成的资料请关注脚本之家其它相关文章！