Spring Boot 项目生成二维码
AI 摘要鱼粮不足,AI 今天先歇着 · 正文在下面
简介
二维码(QR Code) 是一种方便的编码方式,被广泛用于各种场景,如支付、信息分享等。在 Spring Boot 项目中,我们可以使用 ZXing(Zebra Crossing) 库来生成二维码。下面我将提供示例教程。
引入依赖
xml
<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>
二维码生成服务类
创建一个服务类 QRCodeGenerationService,用于生成二维码图像:
java
package com.salmon.qrcode.service;
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;
/**
* 二维码生成服务
*
* @author Salmon
* @since 2024-05-25
*/
@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();
}
}
二维码接口
创建一个控制器类 QRCodeProcessingController,提供生成二维码的接口:
java
package com.salmon.qrcode.controller;
import com.google.zxing.WriterException;
import com.salmon.qrcode.service.QRCodeGenerationService;
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 javax.annotation.Resource;
import java.io.IOException;
/**
* 二维码生成接口
*
* @author Salmon
* @since 2024-05-25
*/
@RestController
public class QRCodeProcessingController {
@Resource
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);
}
}
}
跨域配置
因为我的 demo 是将图片写入本地,而非上传到 oss,故访问会存在跨域问题

跨域配置代码
java
package com.salmon.qrcode.config;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.CorsRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
/**
* 全局跨域配置
*
* @author Salmon
* @since 2024-05-19
*/
@Configuration
public class CorsConfig implements WebMvcConfigurer {
@Override
public void addCorsMappings(CorsRegistry registry) {
// 配置所有请求
registry.addMapping("/**")
// 允许发送 Cookie
.allowCredentials(true)
// 放行哪些域名(必须用 patterns,否则 * 会和 allowCredentials 冲突)
.allowedOriginPatterns("*")
.allowedMethods("GET", "POST", "PUT", "DELETE", "OPTIONS")
.allowedHeaders("*")
.exposedHeaders("*");
}
}
测试生成二维码
我们编写一个前端页面,通过输入二维码内容,向后端请求来生成二维码
index.html:
html
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<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>

注意:不要在 idea 打开,因为通过 idea 打开或者通过 url 访问页面无法访问本地文件的
我们打开 index.html

输入内容,然后生成,即可取到本地图片

扫描结果

结语
本文简要介绍了生成二维码的方法。在实际应用中,二维码的使用非常灵活,其具体场景可以根据不同的业务需求来定制。例如,在我之前经历的项目中,二维码被应用于多种场合:包括O2O商户的二维码、支付收款码、好友邀请码、扫码登录以及扫码绑定设备等。在这些应用中,二维码能够存储前端路由或特定的跳转链接,从而有效地支持和简化用户操作与系统交互流程,增强用户体验。
评论
0 条—
还没有评论,来说第一句