脚本之家 服务器常用软件
快捷导航
您的位置：首页 → 软件编程 → java → SpringBoot生成二维码

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生成二维码内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

相关文章

  • SpringMVC @RequestBody自动转json Http415错误的解决

    SpringMVC @RequestBody自动转json Http415错误的解决

    这篇文章主要介绍了SpringMVC @RequestBody自动转json Http415错误的解决方案，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
    2023-04-04
  • Java基础知识之I/O流和File类文件操作

    Java基础知识之I/O流和File类文件操作

    众所周知java语言提供给程序员非常多的包供编程时使用,方便又快捷,下面这篇文章主要给大家介绍了关于Java基础知识之I/O流和File类文件操作的相关资料,文中通过实例代码介绍的非常详细,需要的朋友可以参考下
    2022-04-04
  • 通过Java实现bash命令过程解析

    通过Java实现bash命令过程解析

    这篇文章主要介绍了通过Java实现bash命令过程解析,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2020-01-01
  • java.lang.NoClassDefFoundError错误解决办法

    java.lang.NoClassDefFoundError错误解决办法

    这篇文章主要介绍了java.lang.NoClassDefFoundError错误解决办法的相关资料,需要的朋友可以参考下
    2017-06-06
  • java如何创建一个jdbc程序详解

    java如何创建一个jdbc程序详解

    使用Java程序来操作数据库，后者更加直接的话就是使用Java程序来发送SQL语句的技术称之为：JDBC。下面这篇文章主要给大家介绍了关于利用java如何创建一个jdbc程序的相关资料，需要的朋友可以参考借鉴，下面来一起看看吧。
    2017-11-11
  • Java Chassis3熔断机制的改进路程技术解密

    Java Chassis3熔断机制的改进路程技术解密

    这篇文章主要介绍了Java Chassis 3技术解密之熔断机制的改进路程实例分析,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2024-01-01
  • SpringMVC深入讲解文件的上传下载实现

    SpringMVC深入讲解文件的上传下载实现

    这篇文章主要为大家详细介绍了springMVC实现文件上传和下载的方法，文中示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
    2022-06-06
  • 详解Java虚拟机(JVM)运行时

    详解Java虚拟机(JVM)运行时

    JVM（Java虚拟机）是一个抽象的计算模型。这篇文章主要介绍了Java虚拟机(JVM)运行时的相关知识,需要的朋友可以参考下
    2018-10-10
  • SpringBoot下载文件遇到文件损坏等问题解决方案

    SpringBoot下载文件遇到文件损坏等问题解决方案

    调用接口下载spring boot工程的resources目录下的excel模板文件,非常常见的一个文件下载功能,但是却容易遇到很多坑,下面总结记录下
    2023-10-10
  • java实现简单的爬虫之今日头条

    java实现简单的爬虫之今日头条

    最近在学习搜索方面的东西，需要了解网络爬虫方面的知识，虽然有很多开源的强大的爬虫，但本着学习的态度，想到之前在做资讯站的时候需要用到爬虫来获取一些文章,今天刚好有空就研究了一下.在网上看到了一个demo,使用的是Jsoup,我拿过来修改了一下,有需要的朋友可以参考
    2016-11-11

最新评论