快捷導(dǎo)航

SpringBoot實現(xiàn)二維碼生成的詳細(xì)步驟與完整代碼

更新時間：2025年05月13日 11:13:33 作者：全干程序員demo

如今,二維碼的應(yīng)用場景非常廣泛,從支付到信息分享,二維碼都扮演著重要角色,Spring Boot 是一個非常流行的 Java 基于 Spring 框架的微服務(wù)開發(fā)框架,它可以幫助開發(fā)者快速搭建應(yīng)用,本文將詳細(xì)介紹如何在 Spring Boot 項目中實現(xiàn)二維碼的生成,需要的朋友可以參考下

一、環(huán)境搭建

開發(fā)工具
- 使用 IntelliJ IDEA 或 Eclipse 等主流的 Java 開發(fā)工具，這些工具對 Spring Boot 有良好的支持，能夠方便地創(chuàng)建項目、管理依賴和運行代碼。
JDK 環(huán)境
- 確保安裝了 JDK 1.8 或更高版本，因為 Spring Boot 項目需要 Java 環(huán)境來運行。可以通過命令行輸入 java -version 來檢查 JDK 是否已正確安裝。

二、創(chuàng)建 Spring Boot 項目

使用 Spring Initializr 創(chuàng)建項目
- 打開 Spring Initializr 網(wǎng)站。
- 在界面中選擇以下內(nèi)容：
  - Project：Maven（推薦使用 Maven 作為項目管理工具）
  - Language：Java
  - Spring Boot Version：選擇最新的穩(wěn)定版本
  - Dependencies：添加 “Spring Web” 依賴，因為我們需要通過 HTTP 接口來生成二維碼
- 點擊 “Generate” 按鈕，下載生成的項目壓縮包，解壓后導(dǎo)入到開發(fā)工具中。

三、引入二維碼生成依賴

為了在 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 環(huán)境下對二維碼進行操作的工具類。

四、編寫二維碼生成代碼

創(chuàng)建二維碼生成服務(wù)類
- 在項目中創(chuàng)建一個名為 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 二維碼內(nèi)容
     * @param width   二維碼寬度
     * @param height  二維碼高度
     * @param filePath 二維碼保存路徑
     * @throws WriterException
     * @throws IOException
     */
    public void generateQRCode(String content, int width, int height, String filePath) throws WriterException, IOException {
        // 設(shè)置二維碼參數(shù)
        Map<EncodeHintType, Object> hints = new HashMap<>();
        hints.put(EncodeHintType.CHARACTER_SET, "UTF-8"); // 設(shè)置字符編碼
        hints.put(EncodeHintType.ERROR_CORRECTION, ErrorCorrectionLevel.H); // 設(shè)置容錯級別
        hints.put(EncodeHintType.MARGIN, 2); // 設(shè)置邊距

        // 創(chuàng)建二維碼生成器
        QRCodeWriter qrCodeWriter = new QRCodeWriter();
        BitMatrix bitMatrix = qrCodeWriter.encode(content, BarcodeFormat.QR_CODE, width, height, hints);

        // 創(chuàng)建圖片
        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 來創(chuàng)建圖片，并將二維碼矩陣?yán)L制到圖片上。
- 最后，使用 ImageIO.write 方法將圖片保存到指定路徑。

五、創(chuàng)建控制器提供二維碼生成接口

創(chuàng)建 QrCodeController 類
- 在項目中創(chuàng)建一個控制器類，用于接收用戶請求并調(diào)用二維碼生成服務(wù)。

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 二維碼內(nèi)容
     * @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 注解標(biāo)記為控制器類。
- 定義了一個 @GetMapping 方法，接收用戶通過 GET 請求傳遞的參數(shù)，包括二維碼內(nèi)容、寬度、高度和保存路徑。
- 調(diào)用 QrCodeService 的 generateQRCode 方法來生成二維碼，并返回生成結(jié)果。

六、測試運行

啟動 Spring Boot 應(yīng)用
- 在開發(fā)工具中運行項目，啟動 Spring Boot 應(yīng)用。
發(fā)送請求測試
- 打開瀏覽器或使用工具（如 Postman）發(fā)送請求到接口地址，例如：

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

如果一切正常，你會看到返回的提示信息，如 “二維碼生成成功，保存路徑為：D:/qrcode.png”，并且在指定路徑下生成了二維碼圖片。

七、總結(jié)

通過上述步驟，我們成功地在 Spring Boot 項目中實現(xiàn)了二維碼的生成功能。從項目創(chuàng)建、依賴引入、服務(wù)層代碼編寫到控制器接口的實現(xiàn)，每一步都詳細(xì)說明了操作方法和代碼實現(xiàn)。生成的二維碼可以根據(jù)用戶的需求自定義內(nèi)容、大小和保存路徑，具有很強的靈活性。此功能可以應(yīng)用于多種場景，如活動二維碼生成、商品二維碼生成等，為開發(fā)者提供了便捷的工具。

以上就是SpringBoot實現(xiàn)二維碼生成的詳細(xì)步驟與完整代碼的詳細(xì)內(nèi)容，更多關(guān)于SpringBoot二維碼生成的資料請關(guān)注腳本之家其它相關(guān)文章！

您可能感興趣的文章: