Java實現(xiàn)二維碼、條形碼功能(案例代碼)

更新時間：2024年01月02日 09:48:58 作者：何蘇三月

ZXing是一個開放源碼的,用Java實現(xiàn)的多種格式的1D/2D條碼圖像處理庫,它包含了聯(lián)系到其他語言的端口,Zxing可以實現(xiàn)使用手機的內(nèi)置的攝像頭完成條形碼的掃描及解碼,這篇文章主要介紹了Java實現(xiàn)二維碼、條形碼等功能,需要的朋友可以參考下

一、Zxing介紹

ZXing是一個開放源碼的，用Java實現(xiàn)的多種格式的1D/2D條碼圖像處理庫，它包含了聯(lián)系到其他語言的端口。Zxing可以實現(xiàn)使用手機的內(nèi)置的攝像頭完成條形碼的掃描及解碼。

二、關鍵類及方法說明

Zxing將生成圖形編碼的方式抽象成了一個類com.google.zxing.Writer, 在實現(xiàn)類中不僅僅生成二維碼，還可以生成條形碼等其他圖形編碼。

我們實際開發(fā)中，可以選擇Writer類的實現(xiàn)類MultiFormatWriter。

參數(shù)

參數(shù)	說明
String contents	編碼的內(nèi)容
BarcodeFormat format	編碼的方式(二維碼、條形碼...)
int width	生成的碼的寬度
int height	生成的碼的高度
Map<EncodeHintType,?> hints	編碼時額外的參數(shù)

額外參數(shù)說明

編碼額外的參數(shù)是以一個Map<EncodeHintType, ?>存在的，key為EncodeHintType枚舉，那么可以看到所有的參數(shù)類型。

參數(shù)	說明
ERROR_CORRECTION	容錯率，指定容錯等級，例如二維碼中使用的`ErrorCorrectionLevel`, Aztec使用`Integer`
CHARACTER_SET	編碼集
DATA_MATRIX_SHAPE	指定生成的數(shù)據(jù)矩陣的形狀，類型為`SymbolShapeHint`
MARGIN	生成條碼的時候使用，指定邊距，單位像素，受格式的影響。類型Integer, 或String代表的數(shù)字類型
PDF417_COMPACT	指定是否使用PDF417緊湊模式（具體含義不懂）類型`Boolean`
PDF417_COMPACTION	指定PDF417的緊湊類型
PDF417_DIMENSIONS	指定PDF417的最大最小行列數(shù)
AZTEC_LAYERS	aztec編碼相關，不理解
QR_VERSION	指定二維碼版本，版本越高越復雜，反而不容易解析

從上面的參數(shù)表格可以看出，適用于二維碼的有：ERROR_CORRECTION, CHARACTER_SET, MARGIN, QR_VERSION。

參數(shù)	使用說明
ERROR_CORRECTION	分為四個等級：L/M/Q/H, 等級越高，容錯率越高，識別速度降低。例如一個角被損壞，容錯率高的也許能夠識別出來。通常為H
CHARACTER_SET	編碼集，通常有中文，設置為 utf-8
MARGIN	默認為4, 實際效果并不是填寫的值，一般默認值就行
QR_VERSION	通常不變，設置越高，反而不好用

代碼演示

下面是最簡化的生成二維碼的代碼：

/**
 * 生成二維碼
 *
 * @param contents 二維碼內(nèi)容
 * @return 二維碼的描述對象 BitMatrix
 * @throws WriterException 編碼時出錯
 */
private BitMatrix encode(String contents) throws WriterException {
    final Map<EncodeHintType, Object> hints = new HashMap<>();
    hints.put(EncodeHintType.ERROR_CORRECTION, ErrorCorrectionLevel.H);
    hints.put(EncodeHintType.CHARACTER_SET, "utf-8");
    return new QRCodeWriter().encode(contents, BarcodeFormat.QR_CODE, 320, 320, hints);
}

沒錯，就是這么簡單。但是我們得到的是一個BitMatrix, 如果需要顯示出來則要根據(jù)不同平臺來處理。

BitMatrix 轉(zhuǎn)換成圖片

首先明確Java SE平臺和Android平臺的區(qū)別：Android平臺移除關于swing部分的代碼，所以如果SE平臺使用到這部分代碼，Android平臺則不能用，不幸的是，官方的代碼恰恰用到了這部分。

明確另外一個概念：圖片在一個平臺的存在形式有兩種，內(nèi)存和文件。雖然文件在不同平臺通用，但是轉(zhuǎn)換成文件的過程卻不是通用的。如Android中將Bitmap轉(zhuǎn)換成圖片文件，SE中將BufferedImage轉(zhuǎn)換成圖片文件。所以實際上，最重要的是將BitMatrix轉(zhuǎn)換成在內(nèi)存中圖片的存在形式。

Java SE平臺

將BitMatrix轉(zhuǎn)換成BufferedImage.

在官方提供的zxing-javase包中已經(jīng)有了相應的方法。下面是示例代碼：

BufferedImage bufferedImage = MatrixToImageWriter.toBufferedImage(bitMatrix, new MatrixToImageConfig(Color.BLACK.getRGB(), Color.WHITE.getRGB()));

其他就不過多介紹了，下面我們實際代碼完整演示一遍。

三、完整代碼演示

3.1 導入依賴

<!-- zxing生成二維碼 -->
<dependency>
    <groupId>com.google.zxing</groupId>
    <artifactId>core</artifactId>
    <version>3.3.3</version>
</dependency>
<dependency>
    <groupId>com.google.zxing</groupId>
    <artifactId>javase</artifactId>
    <version>3.3.3</version>
</dependency>

3.2 代碼示例

package com.pink.jucstudy.utils;
import com.google.zxing.BarcodeFormat;
import com.google.zxing.EncodeHintType;
import com.google.zxing.MultiFormatWriter;
import com.google.zxing.WriterException;
import com.google.zxing.client.j2se.MatrixToImageWriter;
import com.google.zxing.common.BitMatrix;
import com.google.zxing.qrcode.decoder.ErrorCorrectionLevel;
import java.io.File;
import java.io.IOException;
import java.nio.file.Path;
import java.util.HashMap;
import java.util.Map;
public class CodeX {
    /**
     * 1. 設置二維碼的參數(shù)
     * 2. 生成二維碼
     * 3. 將二維碼導出
     */
    /**
     *
     * @param content 編碼的內(nèi)容
     * @param path 本地保存的路徑
     * @return
     */
    public boolean createCode(String content,String path){
        // 1 設置基本參數(shù)
        int width = 300;
        int height = 300;
        String format = "png";//保存圖片的格式，注意：不同平臺可能有它的圖片格式要求
        // 2 設置額外參數(shù)，一定要保存到map集合中
        Map map = new HashMap();
        // 2.1 設置容錯率
        // 其中key鍵就是EncodeHintType.ERROR_CORRECTION
        // value值也是枚舉類ErrorCorrectionLevel.M，可自行選擇容錯率等級l>M>Q>H
        // 當?shù)燃壴礁?，掃描所需的時間越高，但是準確率越高。
        map.put(EncodeHintType.ERROR_CORRECTION, ErrorCorrectionLevel.M);
        // 2.2 生成條碼的時候使用，指定邊距，單位像素
        map.put(EncodeHintType.MARGIN,2);
        // 2.3 設置字符集
        map.put(EncodeHintType.CHARACTER_SET,"utf-8");
        // 3 生成二維碼
        // MultiFormatWriter繼承了Writer
        // 通過該對象的encode方法即可生成二維碼BitMatrix
        // 該方法形參分別對應了：
        // 第一個參數(shù)為編碼的內(nèi)容，
        // 第二個參數(shù)選擇生成編碼為二維碼
        // 第三第四分別對應編碼的寬度和高度
        // 第五個參數(shù)為對應的額外參數(shù)
        // 然后需要try、catch拋出異常
        try {
            BitMatrix encode = new MultiFormatWriter().encode(content, BarcodeFormat.QR_CODE, width, height, map);
            // 4 導出到本地
            File file = new File(path);
            Path path1 = file.toPath();
            System.out.println(path1);
            MatrixToImageWriter.writeToPath(encode,format,path1);
            return true;
        } catch (WriterException | IOException e) {
            e.printStackTrace();
        }
        return false;
    }
    public static void main(String[] args) {
        boolean code = new CodeX().createCode("夏至小姐姐，留個微信唄", "E:\\xx\\2.png");
        if (code){
            System.out.println("成功");
        }else {
            System.out.println("失敗了");
        }
    }
}

3.3 運行測試

3.4 測試Springboot生成二維碼并回顯到頁面上

    @GetMapping("/qrcode")
    public void qrcodeTest(HttpServletResponse response) throws WriterException, IOException {
        ServletOutputStream outputStream = response.getOutputStream();
        int width = 300;
        int height =300;
        String format = "png";
        HashMap<EncodeHintType, Object> map = new HashMap<>();
        map.put(EncodeHintType.ERROR_CORRECTION, ErrorCorrectionLevel.H);
        map.put(EncodeHintType.CHARACTER_SET,"utf-8");
        String content = "今年是兔年，兔飛猛進！豬兔猛進！";
        BitMatrix encode = new MultiFormatWriter().encode(content, BarcodeFormat.QR_CODE, width, height, map);
        MatrixToImageWriter.writeToStream(encode,format,outputStream);
        System.out.println("成功！");
    }

3.5 如果希望用html頁面的方式展示再寫頁面即可

<!doctype html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta name="viewport"
          content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0">
    <meta http-equiv="X-UA-Compatible" content="ie=edge">
    <title>首頁</title>
</head>
<body>
    <h5>掃碼獲取信息</h5>
    <img src="/qrcode">
</body>
</html>