快捷導(dǎo)航

基于SpringBoot生成二維碼的幾種實(shí)現(xiàn)方式

更新時(shí)間：2022年03月31日 12:09:44 作者：Love is beautiful

本文將基于Spring Boot介紹兩種生成二維碼的實(shí)現(xiàn)方式，一種是基于Google開發(fā)工具包，另一種是基于Hutool來(lái)實(shí)現(xiàn)，具有一定的參考價(jià)值，感興趣的可以了解一下

（1）進(jìn)銷存系統(tǒng) 想必大家都聽說(shuō)過(guò)，其系統(tǒng)中的商品二維碼承載了許多重要、核心的關(guān)鍵信息，比如商品編碼、商品名稱、規(guī)格、型號(hào)、單位、作用/使用說(shuō)明等信息；操作者可以借助硬件設(shè)備，如“掃碼槍”，通過(guò)掃描該二維碼后將該商品錄入到商品庫(kù)中；

（2）再比如溯源系統(tǒng)中的產(chǎn)品，用戶可以通過(guò)微信等APP中的掃一掃，掃描貼在產(chǎn)品上的二維碼，不出片刻即可得到該產(chǎn)品的相關(guān)信息，比如產(chǎn)品名稱、生源地、簡(jiǎn)介、價(jià)格、生產(chǎn)環(huán)境、經(jīng)手人等信息；

下面我們將基于Spring Boot，并采用兩種方式實(shí)現(xiàn)二維碼的生成，對(duì)于每一種方式還提供兩種類型的二維碼返回形式，即：物理文件和圖片響應(yīng)流

一、基于Google開發(fā)工具包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 進(jìn)制表示，和前端頁(yè)面 CSS 的取色是一樣的，注意前后景顏色應(yīng)該對(duì)比明顯，如常見的黑白
    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()) {
                //二維碼圖片存在目錄為空，默認(rèn)放在桌面...
                codeImgFileSaveDir = FileSystemView.getFileSystemView().getHomeDirectory();
            }
            if (!codeImgFileSaveDir.exists()) {
                //二維碼圖片存在目錄不存在，開始創(chuàng)建...
                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();
        }
    }
 
    /**
     * 生成二維碼并輸出到輸出流, 通常用于輸出到網(wǎng)頁(yè)上進(jìn)行顯示，輸出到網(wǎng)頁(yè)與輸出到磁盤上的文件中，區(qū)別在于最后一句 ImageIO.write
     * write(RenderedImage im,String formatName,File output)：寫到文件中
     * write(RenderedImage im,String formatName,OutputStream output)：輸出到輸出流中
     * @param content  ：二維碼內(nèi)容
     * @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);
 
            //區(qū)別就是這一句，輸出到輸出流中，如果第三個(gè)參數(shù)是 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：設(shè)置字符編碼類型
        hints.put(EncodeHintType.CHARACTER_SET, "UTF-8");
 
        //EncodeHintType.ERROR_CORRECTION：設(shè)置誤差校正
        //ErrorCorrectionLevel：誤差校正等級(jí)，L = ~7% correction、M = ~15% correction、Q = ~25% correction、H = ~30% correction
        //不設(shè)置時(shí)，默認(rèn)為 L 等級(jí)，等級(jí)不一樣，生成的圖案不同，但掃描的結(jié)果是一樣的
        hints.put(EncodeHintType.ERROR_CORRECTION, ErrorCorrectionLevel.M);
 
        //EncodeHintType.MARGIN：設(shè)置二維碼邊距，單位像素，值越小，二維碼距離四周越近
        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;
    }
}

上述代碼有點(diǎn)多，諸位可以在文末提供的下載地址將其下載下來(lái)，并用IDEA等開發(fā)工具將其打開，幾乎每行代碼debug都做了必要的注釋，在這里就不贅述了！

總的來(lái)說(shuō)，上面代碼主要包含了兩個(gè)部分，一部分是將實(shí)現(xiàn)如何將信息塞入二維碼并將其生成圖片存儲(chǔ)至物理文件目錄下；另一部分是實(shí)現(xiàn)如何直接將信息塞入二維碼并生成圖片最終以圖片流的形式將其返回給前端調(diào)用端；

（3）最后，我們需要新建一個(gè)QrCodeController控制器類，并在其中創(chuàng)建兩個(gè)請(qǐng)求方法，用于測(cè)試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;
    }
 
    //生成二維碼并將其返回給前端調(diào)用者
    @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;
}
}

最后是將該項(xiàng)目運(yùn)行起來(lái)并采用Postman對(duì)該接口進(jìn)行測(cè)試，首先是控制器第一個(gè)方法接口的測(cè)試，其測(cè)試結(jié)果如下圖所示（生成的二維碼圖片是存放在 E:\\shFiles\\QRCode 中的）：

最后是控制器第二個(gè)方法接口的測(cè)試，其測(cè)試結(jié)果如下圖所示：

PS：如果不想存儲(chǔ)二維碼圖片到實(shí)際的文件目錄，則可以采用“圖片流”的形式將其返回即可；反之，則可以將生成的二維碼圖片存儲(chǔ)起來(lái)并返回該圖片的訪問鏈接給到前端（這個(gè)就稍微有點(diǎn)麻煩了，既要存儲(chǔ)、又要賦予圖片的訪問域名和鏈接）；具體取舍可以根據(jù)實(shí)際業(yè)務(wù)情況來(lái)做抉擇吧！

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

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

 <!--二維碼開發(fā)工具集-->
        <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，用于處理真正的生成二維碼的業(yè)務(wù)邏輯，其核心代碼如下所示：

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控制器類中進(jìn)行調(diào)用，如下代碼所示：

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);
    }
}

通過(guò)瀏覽器訪問測(cè)試：