ZXing库 -- 生成二维码

引言

二维码（QR Code）因其高密度的数据存储能力和易于扫描的特性，在现代社会中得到了广泛应用。ZXing是一个开源的二维码生成与读取库，它支持多种编程语言，包括Java。本指南将详细介绍如何在Java项目中使用ZXing库来生成带有透明背景的二维码。

准备ZXing库

<dependencies>
    
    <dependency>
        <groupId>com.google.zxinggroupId>
        <artifactId>coreartifactId>
        <version>3.4.1version>
    dependency>
    
    <dependency>
        <groupId>com.google.zxinggroupId>
        <artifactId>javaseartifactId>
        <version>3.4.1version>
    dependency>
dependencies>

生成二维码

编写代码

package org.example.code_generate;

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 javax.imageio.ImageIO;
import java.awt.*;
import java.awt.image.BufferedImage;
import java.io.File;
import java.io.IOException;
import java.util.HashMap;
import java.util.Map;

public class QRCodeGenerator {
    private static final Color TRANSPARENT = new Color(0, 0, 0, 0);

    public static void main(String[] args) {
        // 要编码的信息
        String data = "https://example.com";
        // 生成二维码图片的文件路径
        String filePath = "../maven-demo/src/main/resources/qrcode_transparent.png";
        // 二维码图片的大小
        int size = 300;
        // 图片格式
        String format = "png";

        // 生成二维码矩阵
        Map<EncodeHintType, Object> hints = new HashMap<>();
        hints.put(EncodeHintType.CHARACTER_SET, "UTF-8");
        hints.put(EncodeHintType.ERROR_CORRECTION, ErrorCorrectionLevel.L);
        hints.put(EncodeHintType.MARGIN, 1);
        try {
            // 使用MultiFormatWriter编码生成BitMatrix对象
            BitMatrix bitMatrix = new MultiFormatWriter().encode(data, BarcodeFormat.QR_CODE, size, size, hints);
            // 将BitMatrix转换为BufferedImage对象
            BufferedImage qrCodeImage = createQRCodeImage(bitMatrix);
            // 将BufferedImage对象写入文件
            writeQRCodeImage(qrCodeImage, filePath, format);
            System.out.println("二维码生成成功！");
        } catch (Exception e) {
            System.err.println("二维码生成失败: " + e.getMessage());
            e.printStackTrace();
        }
    }

    /**
     * 将BitMatrix对象转换为BufferedImage图像对象
     * 此方法用于创建一个包含QR码图像的BufferedImage实例
     * 它通过检查BitMatrix中的每个点来设置像素颜色，从而生成QR码的图像表示
     *
     * @param bitMatrix 一个BitMatrix对象，包含了QR码的二进制数据信息
     * @return 返回一个BufferedImage对象，表示QR码图像
     */
    private static BufferedImage createQRCodeImage(BitMatrix bitMatrix) {
        // 获取QR码的宽度
        int width = bitMatrix.getWidth();
        // 获取QR码的高度
        int height = bitMatrix.getHeight();
        // 创建一个BufferedImage对象，用于绘制QR码图像
        BufferedImage image = new BufferedImage(width, height, BufferedImage.TYPE_INT_ARGB);

        // 遍历BitMatrix的每个点，设置图像的像素颜色
        for (int x = 0; x < width; x++) {
            for (int y = 0; y < height; y++) {
                // 如果当前点在BitMatrix中为true，则设置对应像素为黑色，否则设置为透明
                image.setRGB(x, y, bitMatrix.get(x, y) ? Color.BLACK.getRGB() : TRANSPARENT.getRGB());
            }
        }

        // 返回绘制好的QR码图像
        return image;
    }

    /**
     * 将生成的二维码图片写入到指定路径
     *
     * @param image 二维码图片对象
     * @param filePath 二维码图片的保存路径
     * @param format 图片的格式，如"png"、"jpg"等
     */
    private static void writeQRCodeImage(BufferedImage image, String filePath, String format) {
        try {
            // 创建文件对象，用于保存二维码图片
            File file = new File(filePath);
            // 将二维码图片按照指定格式写入到文件中
            ImageIO.write(image, format, file);
        } catch (IOException e) {
            // 捕获IO异常，并输出错误信息
            System.err.println("写入二维码图片失败: " + e.getMessage());
            // 打印异常堆栈跟踪信息，便于进一步调试
            e.printStackTrace();
        }
    }
}

运行代码并验证结果

解析二维码

编写代码

package org.example.code_generate;

import com.google.zxing.BinaryBitmap;
import com.google.zxing.LuminanceSource;
import com.google.zxing.MultiFormatReader;
import com.google.zxing.Result;
import com.google.zxing.client.j2se.BufferedImageLuminanceSource;
import com.google.zxing.common.HybridBinarizer;

import javax.imageio.ImageIO;
import java.awt.image.BufferedImage;
import java.io.File;

public class QRCodeReader {
    /**
     * 主程序入口
     * 本程序的主要功能是读取指定路径下的QR码图片，并解析其中包含的文本信息
     * @param args 命令行参数，本程序不使用此参数
     */
    public static void main(String[] args) {
        try {
            // 创建File对象，指向QR码图片文件
            File file = new File("../maven-demo/src/main/resources/qrcode_transparent.png");
            // 使用ImageIO读取图片文件，生成BufferedImage对象
            BufferedImage bufferedImage = ImageIO.read(file);
            // 创建BufferedImageLuminanceSource对象，用于后续的图片处理
            BufferedImageLuminanceSource source = new BufferedImageLuminanceSource(bufferedImage);
            // 创建BinaryBitmap对象，使用HybridBinarizer进行二值化处理
            BinaryBitmap binaryBitmap = new BinaryBitmap(new HybridBinarizer(source));
    
            // 使用MultiFormatReader解析QR码中的信息
            Result result = new MultiFormatReader().decode(binaryBitmap);
    
            // 输出解析得到的QR码文本信息
            System.out.println("QR Code Text is " + result.getText());
        } catch (Exception e) {
            // 捕获异常，输出错误信息
            System.err.println("Error while reading QR Code: " + e.getMessage());
        }
    }
}

运行代码并验证结果

注意事项

• 确保ZXing库的版本与你的Java版本兼容。
• 如果你想要生成不同大小或样式的二维码，可以调整width、height和hintMap中的参数。
• PNG格式是推荐的输出格式，因为它支持透明度。如果你选择其他格式（如JPEG），背景可能不会透明。
• 在生产环境中，考虑对二维码生成过程进行异常处理和日志记录，以便在出现问题时能够快速定位和解决。

结论

本指南详细介绍了如何在Java项目中使用ZXing库来生成带有透明背景的二维码。通过遵循上述步骤，你应该能够轻松地生成自定义的二维码，并将其用于各种应用场景中。ZXing库是一个强大且易于使用的工具，它能够帮助你快速实现二维码的生成与读取功能。