SpringBoot中生成二维码的案例分享
更新时间：2024年08月22日 09:44:26 作者：码到三十五
在Spring Boot项目中整合ZXing库来生成二维码是一个常见的需求,zxing是一个功能强大的开源Java库,专门用于二维码的生成与解析,它支持Android、iOS、Java等多个平台,本文小编将给大家分享SpringBoot中生成二维码的案例,需要的朋友可以参考下
引言
在Spring Boot项目中整合ZXing库来生成二维码是一个常见的需求。
zxing，全称"Zebra Crossing"，是一个功能强大的开源Java库，专门用于二维码的生成与解析。它不仅能够生成QR码，还能解析包括QR码在内的多种二维码格式。ZXing提供了多语言API，使得开发者能够轻松地将二维码功能集成到各种应用中。它支持Android、iOS、Java等多个平台，并且除了QR码，还能解析其他一维码和二维码，如EAN、UPC、DataMatrix等。
1. 添加zxing库的依赖
<dependency>
<groupId>com.google.zxing</groupId>
<artifactId>core</artifactId>
<version>3.5.2</version>
</dependency>
<dependency>
<groupId>com.google.zxing</groupId>
<artifactId>javase</artifactId>
<version>3.5.2</version>
</dependency>
2. 生成二维码
创建一个SpringBoot服务类QRCodeService，用于生成二维码图片：
import com.google.zxing.BarcodeFormat;
import com.google.zxing.EncodeHintType;
import com.google.zxing.MultiFormatWriter;
import com.google.zxing.client.j2se.MatrixToImageWriter;
import com.google.zxing.common.BitMatrix;
import com.google.zxing.qrcode.decoder.ErrorCorrectionLevel;
import org.springframework.stereotype.Service;
import java.io.IOException;
import java.nio.file.FileSystems;
import java.nio.file.Path;
import java.util.HashMap;
import java.util.Map;
@Service
public class QRCodeService {
public void generateQRCodeImage(String text, int width, int height, String filePath)
throws IOException {
Map<EncodeHintType, Object> hints = new HashMap<>();
hints.put(EncodeHintType.CHARACTER_SET, "UTF-8");
hints.put(EncodeHintType.ERROR_CORRECTION, ErrorCorrectionLevel.M);
hints.put(EncodeHintType.MARGIN, 2);
BitMatrix bitMatrix = new MultiFormatWriter().encode(text, BarcodeFormat.QR_CODE, width, height, hints);
Path path = FileSystems.getDefault().getPath(filePath);
MatrixToImageWriter.writeToPath(bitMatrix, "PNG", path);
}
}
3. 调用二维码服务
3.1 将二维码图拍你保存
最后在SpringBoot的Controller中调用这个服务：
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;
import java.io.IOException;
@RestController
public class QRCodeController {
@Autowired
private QRCodeService qrCodeService;
@GetMapping("/generateQRCode")
public String generateQRCode(@RequestParam String text, @RequestParam int width, @RequestParam int height) {
try {
qrCodeService.generateQRCodeImage(text, width, height, "myqrcode.png");
return "QR Code generated successfully!";
} catch (IOException e) {
return "QR Code generation failed: " + e.getMessage();
}
}
}
当访问/generateQRCode端点并传递text、width和height参数时，它将生成一个名为myqrcode.png的二维码图片并保存到项目根目录下。
http://localhost:8080/generateQRCode?text=Hello,World!&width=350&height=350
3.2 直接返回二维码图片
修改QRCodeController来返回二维码图片：
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.core.io.ByteArrayResource;
import org.springframework.core.io.Resource;
import org.springframework.http.HttpHeaders;
import org.springframework.http.MediaType;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;
import java.awt.image.BufferedImage;
import java.io.ByteArrayOutputStream;
import java.io.IOException;
import javax.imageio.ImageIO;
import com.google.zxing.BarcodeFormat;
import com.google.zxing.EncodeHintType;
import com.google.zxing.MultiFormatWriter;
import com.google.zxing.common.BitMatrix;
import com.google.zxing.qrcode.decoder.ErrorCorrectionLevel;
@RestController
public class QRCodeController {
@GetMapping("/generateQRCode")
public ResponseEntity<Resource> generateQRCode(@RequestParam String text, @RequestParam Integer width, @RequestParam Integer height) throws IOException {
BitMatrix bitMatrix = new MultiFormatWriter().encode(text, BarcodeFormat.QR_CODE, width, height, getHints());
BufferedImage qrCodeImage = MatrixToImageWriter.toBufferedImage(bitMatrix);
ByteArrayOutputStream byteArrayOutputStream = new ByteArrayOutputStream();
ImageIO.write(qrCodeImage, "PNG", byteArrayOutputStream);
byte[] qrCodeBytes = byteArrayOutputStream.toByteArray();
HttpHeaders headers = new HttpHeaders();
headers.add(HttpHeaders.CONTENT_TYPE, MediaType.IMAGE_PNG_VALUE);
return ResponseEntity.ok()
.headers(headers)
.contentLength(qrCodeBytes.length)
.body(new ByteArrayResource(qrCodeBytes));
}
private Map<EncodeHintType, Object> getHints() {
Map<EncodeHintType, Object> hints = new HashMap<>();
hints.put(EncodeHintType.CHARACTER_SET, "UTF-8");
hints.put(EncodeHintType.ERROR_CORRECTION, ErrorCorrectionLevel.M);
hints.put(EncodeHintType.MARGIN, 2);
return hints;
}
}
generateQRCode先生成二维码的BitMatrix，然后转换为BufferedImage，以便获取二维码图片的字节流。
3.2 注册BufferedImage消息转换器返回图片
3.2中返回图片也可以通过注册一个SpringBoot的消息转换器来实现:
@Bean
public HttpMessageConverter<BufferedImage> createImageHttpMessageConverter() {
return new BufferedImageHttpMessageConverter();
}
返回图片
package com.example.demo.controller;
import java.awt.image.BufferedImage;
import org.springframework.http.HttpStatus;
import org.springframework.http.MediaType;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import com.google.zxing.BarcodeFormat;
import com.google.zxing.client.j2se.MatrixToImageWriter;
import com.google.zxing.common.BitMatrix;
import com.google.zxing.qrcode.QRCodeWriter;
@RestController
@RequestMapping("/qr")
public class QrCodeController {
@GetMapping(value = "/{barcode}", produces = MediaType.IMAGE_PNG_VALUE)
public ResponseEntity<BufferedImage> barbecueEAN13Barcode(@PathVariable("barcode") String barcode)
throws Exception {
QRCodeWriter barcodeWriter = new QRCodeWriter();
BitMatrix bitMatrix =
barcodeWriter.encode(barcode, BarcodeFormat.QR_CODE, 200, 200);
return new ResponseEntity<>(MatrixToImageWriter.toBufferedImage(bitMatrix),HttpStatus.OK);
}
}
现在，当访问/qr端点时，将直接收到一个二维码图片作为响应。
到此这篇关于SpringBoot中生成二维码的案例分享的文章就介绍到这了,更多相关SpringBoot生成二维码内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！
相关文章
这篇文章主要为大家详细介绍了Java如何采用POI原生方式实现自定义Excel表格表头并生成Excel文件,文中的示例代码讲解详细,有需要的小伙伴可以了解下2025-05-05
实际的爬虫是从一系列的种子链接开始。种子链接是起始节点，种子页面的超链接指向的页面是子节点（中间节点），对于非html文档，如excel等，不能从中提取超链接，看做图的终端节点2013-10-10
在java中保证接口幂等性,即多次调用同一接口产生与单次调用相同的结果,不会引发副作用,需要结合业务场景选择合适的方案,下面就来介绍五种实现方法,感兴趣的可以了解一下2025-09-09
SpringBoot集成Spring security JWT实现接口权限认证
这篇文章主要介绍了SpringBoot集成Spring security JWT实现接口权限认证，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧2021-04-04
Java 中Timer和TimerTask 定时器和定时任务使用的例子
这篇文章主要介绍了Java 中Timer和TimerTask 定时器和定时任务使用的例子，非常具有实用价值，需要的朋友可以参考下2017-05-05
Spring IoC容器支持多种依赖注入方式,本文主要介绍了Spring IOC 注入的3种方式小结,具有一定的参考价值,感兴趣的可以了解一下2024-08-08
这篇文章主要给大家介绍了关于Mybatis如何自动生成数据库表结构的相关资料，文中通过示例代码介绍的非常详细，对大家的学习或者使用Mybatis具有一定的参考学习价值，需要的朋友们下面来一起学习学习吧2019-11-11
SpringMVC框架整合Junit进行单元测试(案例详解)
本文详细介绍在SpringMVC任何使用Junit框架。首先介绍了如何引入依赖，接着介绍了编写一个测试基类，并且对其中涉及的各个注解做了一个详细说明，感兴趣的朋友跟随小编一起看看吧2021-05-05
Spring Boot定制type Formatters实例详解
在本篇文章里小编给大家整理的是关于Spring Boot定制type Formatters实例知识点，需要的朋友们学习下。2019-11-11
这篇文章主要为大家介绍了如何通过使用Byte Buddy便捷创建Java Agent的使用说明，有需要的朋友可以借鉴参考下希望能够有所帮助，祝大家多多进步2022-03-03
最新评论