基於SpringBoot生成二維條碼的幾種實現方式

2022-03-31 16:00:55

（1）進銷存系統想必大家都聽說過，其系統中的商品二維條碼承載了許多重要、核心的關鍵資訊，比如商品編碼、商品名稱、規格、型號、單位、作用/使用說明等資訊；操作者可以藉助硬體裝置，如“掃碼槍”，通過掃描該二維條碼後將該商品錄入到商品庫中；

（2）再比如溯源系統中的產品，使用者可以通過微信等APP中的掃一掃，掃描貼在產品上的二維條碼，不出片刻即可得到該產品的相關資訊，比如產品名稱、生源地、簡介、價格、生產環境、經手人等資訊；

下面我們將基於Spring Boot，並採用兩種方式實現二維條碼的生成，對於每一種方式還提供兩種型別的二維條碼返回形式，即：物理檔案和圖片響應流

一、基於Google開發工具包ZXing生成二維條碼

（1）首先，需要在pom.xml依賴組態檔中加入該工具包的依賴Jar，如下所示：

<!-- 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>

（2）然後，建立一二維條碼處理工具類QRCodeUtil，其核心程式碼如下所示：

/**
 * 二維條碼工具
 * @Author:debug (SteadyJack)
 * @Link: weixin-> debug0868  qq-> 1948831260
 * @Date: 2020/11/16 22:38
 **/
public class QRCodeUtil {
    private static final Logger log= LoggerFactory.getLogger(QRCodeUtil.class);
 
    //CODE_WIDTH：二維條碼寬度，單位畫素
    private static final int CODE_WIDTH = 400;
    //CODE_HEIGHT：二維條碼高度，單位畫素
    private static final int CODE_HEIGHT = 400;
    //FRONT_COLOR：二維條碼前景色，0x000000 表示黑色
    private static final int FRONT_COLOR = 0x000000;
    //BACKGROUND_COLOR：二維條碼背景色，0xFFFFFF 表示白色
    //演示用 16 進位製表示，和前端頁面 CSS 的取色是一樣的，注意前後景顏色應該對比明顯，如常見的黑白
    private static final int BACKGROUND_COLOR = 0xFFFFFF;
 
    public static void createCodeToFile(String content, File codeImgFileSaveDir, String fileName) {
        try {
            if (StringUtils.isBlank(content) || StringUtils.isBlank(fileName)) {
                return;
            }
            content = content.trim();
            if (codeImgFileSaveDir==null || codeImgFileSaveDir.isFile()) {
                //二維條碼圖片存在目錄為空，預設放在桌面...
                codeImgFileSaveDir = FileSystemView.getFileSystemView().getHomeDirectory();
            }
            if (!codeImgFileSaveDir.exists()) {
                //二維條碼圖片存在目錄不存在，開始建立...
                codeImgFileSaveDir.mkdirs();
            }
 
            //核心程式碼-生成二維條碼
            BufferedImage bufferedImage = getBufferedImage(content);
 
            File codeImgFile = new File(codeImgFileSaveDir, fileName);
            ImageIO.write(bufferedImage, "png", codeImgFile);
 
            log.info("二維條碼圖片生成成功：" + codeImgFile.getPath());
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
 
    /**
     * 生成二維條碼並輸出到輸出流, 通常用於輸出到網頁上進行顯示，輸出到網頁與輸出到磁碟上的檔案中，區別在於最後一句 ImageIO.write
     * write(RenderedImage im,String formatName,File output)：寫到檔案中
     * write(RenderedImage im,String formatName,OutputStream output)：輸出到輸出流中
     * @param content  ：二維條碼內容
     * @param outputStream ：輸出流，比如 HttpServletResponse 的 getOutputStream
     */
    public static void createCodeToOutputStream(String content, OutputStream outputStream) {
        try {
            if (StringUtils.isBlank(content)) {
                return;
            }
            content = content.trim();
            //核心程式碼-生成二維條碼
            BufferedImage bufferedImage = getBufferedImage(content);
 
            //區別就是這一句，輸出到輸出流中，如果第三個引數是 File，則輸出到檔案中
            ImageIO.write(bufferedImage, "png", outputStream);
 
            log.info("二維條碼圖片生成到輸出流成功...");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
 
    //核心程式碼-生成二維條碼
    private static BufferedImage getBufferedImage(String content) throws WriterException {
 
        //com.google.zxing.EncodeHintType：編碼提示型別,列舉型別
        Map<EncodeHintType, Object> hints = new HashMap();
 
        //EncodeHintType.CHARACTER_SET：設定字元編碼型別
        hints.put(EncodeHintType.CHARACTER_SET, "UTF-8");
 
        //EncodeHintType.ERROR_CORRECTION：設定誤差校正
        //ErrorCorrectionLevel：誤差校正等級，L = ~7% correction、M = ~15% correction、Q = ~25% correction、H = ~30% correction
        //不設定時，預設為 L 等級，等級不一樣，生成的圖案不同，但掃描的結果是一樣的
        hints.put(EncodeHintType.ERROR_CORRECTION, ErrorCorrectionLevel.M);
 
        //EncodeHintType.MARGIN：設定二維條碼邊距，單位畫素，值越小，二維條碼距離四周越近
        hints.put(EncodeHintType.MARGIN, 1);
        
        MultiFormatWriter multiFormatWriter = new MultiFormatWriter();
        BitMatrix bitMatrix = multiFormatWriter.encode(content, BarcodeFormat.QR_CODE, CODE_WIDTH, CODE_HEIGHT, hints);
        BufferedImage bufferedImage = new BufferedImage(CODE_WIDTH, CODE_HEIGHT, BufferedImage.TYPE_INT_BGR);
        for (int x = 0; x < CODE_WIDTH; x++) {
            for (int y = 0; y < CODE_HEIGHT; y++) {
                bufferedImage.setRGB(x, y, bitMatrix.get(x, y) ? FRONT_COLOR : BACKGROUND_COLOR);
            }
        }
        return bufferedImage;
    }
}

上述程式碼有點多，諸位可以在文末提供的下載地址將其下載下來，並用IDEA等開發工具將其開啟，幾乎每行程式碼debug都做了必要的註釋，在這裡就不贅述了！

總的來說，上面程式碼主要包含了兩個部分，一部分是將實現如何將資訊塞入二維條碼並將其生成圖片儲存至物理檔案目錄下；另一部分是實現如何直接將資訊塞入二維條碼並生成圖片最終以圖片流的形式將其返回給前端呼叫端；

（3）最後，我們需要新建一個QrCodeController控制器類，並在其中建立兩個請求方法，用於測試Google ZXing工具包這種方式生成兩種型別的二維條碼是否可行，其程式碼如下所示：

@RequestMapping("qr/code")
public class QrCodeController extends BaseController{
 
    private static final String RootPath="E:\shFiles\QRCode";
    private static final String FileFormat=".png";
 
    private static final ThreadLocal<SimpleDateFormat> LOCALDATEFORMAT=ThreadLocal.withInitial(() -> new SimpleDateFormat("yyyyMMddHHmmss"));
 
    //生成二維條碼並將其存放於本地目錄
    @PostMapping("generate/v1")
    public BaseResponse generateV1(String content){
        BaseResponse response=new BaseResponse(StatusCode.Success);
        try {
            final String fileName=LOCALDATEFORMAT.get().format(new Date());
            QRCodeUtil.createCodeToFile(content,new File(RootPath),fileName+FileFormat);
        }catch (Exception e){
            response=new BaseResponse(StatusCode.Fail.getCode(),e.getMessage());
        }
        return response;
    }
 
    //生成二維條碼並將其返回給前端呼叫者
    @PostMapping("generate/v2")
    public BaseResponse generateV2(String content,HttpServletResponse servletResponse){
        BaseResponse response=new BaseResponse(StatusCode.Success);
        try {
            QRCodeUtil.createCodeToOutputStream(content,servletResponse.getOutputStream());
 
        }catch (Exception e){
            response=new BaseResponse(StatusCode.Fail.getCode(),e.getMessage());
        }
        return response;
}
}

最後是將該專案執行起來並採用Postman對該介面進行測試，首先是控制器第一個方法介面的測試，其測試結果如下圖所示（生成的二維條碼圖片是存放在 E:\shFiles\QRCode 中的）：

最後是控制器第二個方法介面的測試，其測試結果如下圖所示：

PS：如果不想儲存二維條碼圖片到實際的檔案目錄，則可以採用“圖片流”的形式將其返回即可；反之，則可以將生成的二維條碼圖片儲存起來並返回該圖片的存取連結給到前端（這個就稍微有點麻煩了，既要儲存、又要賦予圖片的存取域名和連結）；具體取捨可以根據實際業務情況來做抉擇吧！

二、基於開源的Hutool工具生成二維條碼

下面，debug換一種實現方式，採用目前比較知名、流行的開源工具Hutool加以實現，同樣的道理需要在pom.xml中加入相應的Jar依賴，如下所示：

 <!--二維條碼開發工具集-->
        <dependency>
            <groupId>cn.hutool</groupId>
            <artifactId>hutool-all</artifactId>
            <version>4.6.10</version>
        </dependency>
 
 
        <!-- 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>

然後，需要自定義一Java Config組態檔，以Bean的形式顯示設定並注入QrConfig，如下程式碼所示：

package com.example.qrcode.Config;
 
import cn.hutool.extra.qrcode.QrConfig;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
 
import java.awt.*;
 
@Configuration
public class QRCode {
    @Bean
    public QrConfig qrConfig(){
        QrConfig qrConfig=new QrConfig();
        qrConfig.setBackColor(Color.white.getRGB());
        qrConfig.setForeColor(Color.black.getRGB());
        return qrConfig;
    }
}

緊接著我們建立一QRService，用於處理真正的生成二維條碼的業務邏輯，其核心程式碼如下所示：

package com.example.qrcode.Service;
 
import cn.hutool.extra.qrcode.QrCodeUtil;
import cn.hutool.extra.qrcode.QrConfig;
import com.example.qrcode.Config.QRCode;
import org.springframework.stereotype.Service;
import org.springframework.web.bind.annotation.RequestMapping;
 
import javax.annotation.Resource;
import javax.servlet.http.HttpServletResponse;
import java.io.File;
import java.io.IOException;
 
@Service
public class QRService {
    @Resource
    QrConfig qrconig;
    public void generateFile(String content, File file){
        //生成到本地檔案
        QrCodeUtil.generate(content, qrconig, file);
    }
    //輸出到流
    public void generateStream(String content, HttpServletResponse response) throws IOException {
        QrCodeUtil.generate(content,qrconig,"png",response.getOutputStream());
    }
}

最終，是在QRController控制器類中進行呼叫，如下程式碼所示：

package com.example.qrcode.Controller;
 
import com.example.qrcode.Service.QRService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
 
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
 
@RestController
public class QRController {
    @Autowired
    QRService qrService;
    @RequestMapping("123")
    public void generateV3(String content, HttpServletResponse servletResponse) throws IOException {
        qrService.generateStream(content,servletResponse);
    }
}

通過瀏覽器存取測試：

到此這篇關於基於SpringBoot生成二維條碼的幾種實現方式的文章就介紹到這了,更多相關SpringBoot生成二維條碼內容請搜尋it145.com以前的文章或繼續瀏覽下面的相關文章希望大家以後多多支援it145.com！

基於SpringBoot生成二維條碼的幾種實現方式

目錄

一、基於Google開發工具包ZXing生成二維條碼

二、基於開源的Hutool工具生成二維條碼

熱門文章