Spring Boot ：生成二维码

本文由 简悦 SimpRead 转码， 原文地址 blog.csdn.net

二维码（QR Code）是一种方便的编码方式，被广泛用于各种场景，如支付、信息分享等。在 Spring Boot 项目中，我们可以使用 ZXing（Zebra Crossing）库来生成二维码。本文将介绍如何在 Spring Boot 项目中实现二维码的生成，包括引入依赖、创建服务类，并提供详细的代码示例。

1. 引入依赖

首先，在 Spring Boot 项目的 pom.xml 文件中引入 ZXing 相关的依赖：

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

2. 创建二维码生成服务类

创建一个服务类 QRCodeGenerationService，用于生成二维码图像：

import com.google.zxing.BarcodeFormat;
import com.google.zxing.EncodeHintType;
import com.google.zxing.WriterException;
import com.google.zxing.qrcode.QRCodeWriter;
import com.google.zxing.client.j2se.MatrixToImageWriter;
import com.google.zxing.common.BitMatrix;
import org.springframework.stereotype.Service;

import java.io.ByteArrayOutputStream;
import java.io.IOException;
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.util.HashMap;
import java.util.Map;

@Service
public class QRCodeGenerationService {

    private static final String CHARSET = "UTF-8";
    private static final int QR_CODE_WIDTH = 300;
    private static final int QR_CODE_HEIGHT = 300;
    private static final String TEMP_DIR = System.getProperty("java.io.tmpdir");

    public byte[] generateQRCodeImage(String text) throws WriterException, IOException {
        QRCodeWriter qrCodeWriter = new QRCodeWriter();
        Map<EncodeHintType, Object> hintMap = new HashMap<>();
        hintMap.put(EncodeHintType.CHARACTER_SET, CHARSET);
        BitMatrix bitMatrix = qrCodeWriter.encode(text, BarcodeFormat.QR_CODE, QR_CODE_WIDTH, QR_CODE_HEIGHT, hintMap);
        ByteArrayOutputStream outputStream = new ByteArrayOutputStream();
        MatrixToImageWriter.writeToStream(bitMatrix, "PNG", outputStream);
        return outputStream.toByteArray();
    }

    public String saveQRCodeImageToTempFile(String text) throws WriterException, IOException {
        QRCodeWriter qrCodeWriter = new QRCodeWriter();
        Map<EncodeHintType, Object> hintMap = new HashMap<>();
        hintMap.put(EncodeHintType.CHARACTER_SET, CHARSET);
        BitMatrix bitMatrix = qrCodeWriter.encode(text, BarcodeFormat.QR_CODE, QR_CODE_WIDTH, QR_CODE_HEIGHT, hintMap);
        Path tempFilePath = Files.createTempFile(Paths.get(TEMP_DIR), "qr_", ".png");
        MatrixToImageWriter.writeToPath(bitMatrix, "PNG", tempFilePath);
        return tempFilePath.toString();
    }
}

3. 创建控制器类

创建一个控制器类 QRCodeProcessingController，提供生成二维码的接口：

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.multipart.MultipartFile;

import java.io.IOException;

@RestController
public class QRCodeProcessingController {

    @Autowired
    private QRCodeGenerationService qrCodeGenerationService;

    @PostMapping("/generateQRCode")
    public ResponseEntity<String> generateQRCode(@RequestParam String content) {
        try {
            String qrCodeUrl = qrCodeGenerationService.saveQRCodeImageToTempFile(content);
            return new ResponseEntity<>(qrCodeUrl, HttpStatus.OK);
        } catch (IOException | WriterException e) {
            e.printStackTrace();
            return new ResponseEntity<>(e.getMessage(), HttpStatus.INTERNAL_SERVER_ERROR);
        }
    }
}

完整代码结构

src
├── main
│   ├── java
│   │   └── com
│   │       └── example
│   │           └── qrcode
│   │               ├── controller
│   │               │   └── QRCodeProcessingController.java
│   │               ├── service
│   │               │   ├── QRCodeGenerationService.java
│   │               │   └── QRCodeReadingService.java
│   │               └── QRCodeApplication.java
│   └── resources
│       └── application.yml

4. 测试生成二维码

使用前端界面输入文本并生成二维码。

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta >
    <title>Generate QR Code</title>
</head>
<body>
    <textarea id="textInput" rows="4" cols="50" placeholder="Enter text here"></textarea><br>
    <button onclick="generateQRCode()">Generate QR Code</button><br>
    <img id="qrCodeImage" src="" alt="QR Code">
    
    <script>
        function generateQRCode() {
            var text = document.getElementById("textInput").value;
            var xhr = new XMLHttpRequest();
            xhr.open("POST", "http://localhost:8080/generateQRCode", true);
            xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
            xhr.onreadystatechange = function() {
                if (xhr.readyState == 4 && xhr.status == 200) {
                    var qrCodeUrl = xhr.responseText;
                    document.getElementById("qrCodeImage").src = qrCodeUrl;
                }
            };
            xhr.send("content=" + encodeURIComponent(text));
        }
</script>
</body>
</html>

总结

通过本文，我们成功地在 Spring Boot 项目中集成了 ZXing 库，并实现了生成二维码的功能。我们通过引入依赖、创建二维码生成服务类和控制器类，实现了二维码图像的生成和展示。这种方式可以帮助我们在各种应用场景中生成二维码，方便信息的快速传递和分享。