Java使用zxing实现二维码

miku

Java使用zxing实现二维码

​ 工作中有时候会遇到需要通过二维码展示信息的时候 , 这里简单的做个记录 ;

1 . 二维码纠错级别

​ 二维码纠错级别是指识别二维码时 , 对损坏和模糊的二维码有一定的容错能力 。

一般来说 , 二维码有四个纠错级别 ;

• L : 可以纠正7%左右的错误 ;
• M : 可以纠正15%左右的错误 ;
• Q : 可以纠正25%左右的错误 ;
• H : 可以纠正30%左右的错误 ;

总结 : 选择不同的纠错级别会影响二维码的大小，但纠错级别越高，二维码图片将更加容错 。

2 . ZXing

ZXing(Zebra Crossing)是Google开发的一个二维码解析和生成的开源库。

github地址 : https://github.com/zxing/zxing

3 . 使用

3 . 1 依赖

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

3 . 2 创建工具类

package com.alex.qrcode;

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;
import lombok.extern.slf4j.Slf4j;

import javax.imageio.ImageIO;
import java.awt.image.BufferedImage;
import java.io.ByteArrayOutputStream;
import java.util.HashMap;
import java.util.Map;

/**
 * @program: alex-util
 * @description: 二维码工具类
 * @author: <a href="https://sunalex.cn">Alex</a>
 * @create: 2023-09-03 00:28
 **/

@Slf4j
public class QrCodeUtil {

    /**
     * 字符编码
     */
    private static final String CHARSET = "UTF-8";
    /**
     * 图片格式
     */
    private static final String FORMAT_NAME = "PNG";
    /**
     * 默认宽度
     */
    private static final Integer WIDTH = 140;
    /**
     * 默认高度
     */
    private static final Integer HEIGHT = 140;

    /**
     * <h2>生成二维码</h2>
     *
     * @param data 二维码内容
     * @return base64
     */
    public static String generateQrCode(String data) {
        try {
            Map<EncodeHintType,Object> hints = new HashMap<>();
            // 设置UTF-8,防止中文乱码
            hints.put(EncodeHintType.CHARACTER_SET, CHARSET);
            // 设置二维码的纠错级别为H级别
            hints.put(EncodeHintType.ERROR_CORRECTION, ErrorCorrectionLevel.H);
            // 设置二维码四周的留白
            hints.put(EncodeHintType.MARGIN, 0);
            BitMatrix bitMatrix = new MultiFormatWriter().encode(data, BarcodeFormat.QR_CODE,WIDTH, HEIGHT, hints);
            BufferedImage image = new BufferedImage(WIDTH, HEIGHT, BufferedImage.TYPE_INT_RGB);
            for (int x = 0; x < WIDTH; x++) {
                for (int y = 0; y < HEIGHT; y++) {
                    image.setRGB(x, y, bitMatrix.get(x, y) ? 0xFF000000 : 0xFFFFFFFF);
                }
            }
            // 转换成base64
            ByteArrayOutputStream os = new ByteArrayOutputStream();
            ImageIO.write(image, FORMAT_NAME, os);
            byte[] bytes = os.toByteArray();
            return java.util.Base64.getEncoder().encodeToString(bytes);
        } catch (Exception e) {
            log.error("生成二维码异常");
            return null;
        }
    }
}

3 . 3 前端展示

​ 以上代码只需要在controller层接口调用生成二维码的方法后 , 将base64返回给前端 , 由前端进行渲染即可 ;

<img src="data:image/png;base64," + "后端获取到的base64值" alt="二维码">

总结

以上即可实现后端生成二维码的功能 , 二维码的内容可以是纯文本 , 也可以是url进行跳转 , 根据具体的需求进行 ;