使用google.zxing結合springboot生成二維碼功能
阿新 • • 發佈:2022-05-07
我們使用兩種方式,去生成二維碼,但是其實,二維碼的生成基礎,都是zxing包,這是Google開源的一個包,第一種是使用原始的zxing方式去實現,第二種是使用hutool來實現,hutool其實也是對於zxing的一個封裝,但是封裝前後,確實比較簡單了。
Zxing原生方式
新增依賴
<!-- 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>
二維碼生成工具類
下面是把生成二維碼的方法,封裝到了QRCodeUtil的類之中,這個方法看起來還是比較多的,但是也談不上太複雜,主要是對於BufferedImage生成圖片,然後就是ImageIO.write()方法,write的位置,可以是普通的磁碟檔案,也可以是web的流,我們使用web流的時候,就需要新增com.google.zxing-javase
的依賴。
@Component
@Slf4j
public class QRCodeUtil {
/**
* CODE_WIDTH:二維碼寬度,單位畫素
* CODE_HEIGHT:二維碼高度,單位畫素
* FRONT_COLOR:二維碼前景色,0x000000 表示黑色
* BACKGROUND_COLOR:二維碼背景色,0xFFFFFF 表示白色
* 演示用 16 進製表示,和前端頁面 CSS 的取色是一樣的,注意前後景顏色應該對比明顯,如常見的黑白
*/
private static final int CODE_WIDTH = 400;
private static final int CODE_HEIGHT = 400;
private static final int FRONT_COLOR = 0x000000;
private static final int BACKGROUND_COLOR = 0xFFFFFF;
/**
* @param codeContent 二維碼引數內容,如果是一個網頁地址,如 https://www.baidu.com/ 則 微信掃一掃會直接進入此地址, 如果是一些引數,如
* 1541656080837,則微信掃一掃會直接回顯這些引數值
* @param codeImgFileSaveDir 二維碼圖片儲存的目錄,如 D:/codes
* @param fileName 二維碼圖片檔名稱,帶格式,如 123.png
*/
public static void createCodeToFile(String codeContent, File codeImgFileSaveDir, String fileName) {
try {
if (codeContent == null || "".equals(codeContent)) {
log.info("二維碼內容為空,不進行操作...");
return;
}
codeContent = codeContent.trim();
if (codeImgFileSaveDir == null || codeImgFileSaveDir.isFile()) {
codeImgFileSaveDir = FileSystemView.getFileSystemView().getHomeDirectory();
log.info("二維碼圖片存在目錄為空,預設放在桌面...");
}
if (!codeImgFileSaveDir.exists()) {
codeImgFileSaveDir.mkdirs();
log.info("二維碼圖片存在目錄不存在,開始建立...");
}
if (fileName == null || "".equals(fileName)) {
fileName = new Date().getTime() + ".png";
log.info("二維碼圖片檔名為空,隨機生成 png 格式圖片...");
}
BufferedImage bufferedImage = getBufferedImage(codeContent);
/*
* javax.imageio.ImageIO:java擴充套件的影象IO
* write(RenderedImage im, String formatName, File output)
* im:待寫入的影象, formatName:影象寫入的格式,output:寫入的影象檔案,檔案不存在時會自動建立
*/
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 codeContent :二維碼內容
* @param outputStream :輸出流,比如 HttpServletResponse 的 getOutputStream
*/
public static void createCodeToOutputStream(String codeContent, OutputStream outputStream) {
try {
if (codeContent == null || "".equals(codeContent.trim())) {
log.info("二維碼內容為空,不進行操作...");
return;
}
codeContent = codeContent.trim();
BufferedImage bufferedImage = getBufferedImage(codeContent);
/*
* 區別就是以一句,輸出到輸出流中,如果第三個引數是 File,則輸出到檔案中
*/
ImageIO.write(bufferedImage, "png", outputStream);
log.info("二維碼圖片生成到輸出流成功...");
} catch (Exception e) {
e.printStackTrace();
log.error("發生錯誤: {}!", e.getMessage());
}
}
private static BufferedImage getBufferedImage(String codeContent) throws WriterException {
/*
* com.google.zxing.EncodeHintType:編碼提示型別,列舉型別
* EncodeHintType.CHARACTER_SET:設定字元編碼型別
* EncodeHintType.ERROR_CORRECTION:設定誤差校正
* ErrorCorrectionLevel:誤差校正等級,L = ~7% correction、M = ~15% correction、Q = ~25% correction、H = ~30% correction
* 不設定時,預設為 L 等級,等級不一樣,生成的圖案不同,但掃描的結果是一樣的
* EncodeHintType.MARGIN:設定二維碼邊距,單位畫素,值越小,二維碼距離四周越近
*/
Map<EncodeHintType, Object> hints = new HashMap();
hints.put(EncodeHintType.CHARACTER_SET, "UTF-8");
hints.put(EncodeHintType.ERROR_CORRECTION, ErrorCorrectionLevel.M);
hints.put(EncodeHintType.MARGIN, 1);
/*
* MultiFormatWriter:多格式寫入,這是一個工廠類,裡面過載了兩個 encode 方法,用於寫入條形碼或二維碼
* encode(String contents,BarcodeFormat format,int width, int height,Map<EncodeHintType,?> hints)
* contents:條形碼/二維碼內容
* format:編碼型別,如 條形碼,二維碼 等
* width:碼的寬度
* height:碼的高度
* hints:碼內容的編碼型別
* BarcodeFormat:列舉該程式包已知的條形碼格式,即建立何種碼,如 1 維的條形碼,2 維的二維碼 等
* BitMatrix:位(位元)矩陣或叫2D矩陣,也就是需要的二維碼
*/
MultiFormatWriter multiFormatWriter = new MultiFormatWriter();
BitMatrix bitMatrix = multiFormatWriter.encode(codeContent, BarcodeFormat.QR_CODE, CODE_WIDTH, CODE_HEIGHT, hints);
/*
* java.awt.image.BufferedImage:具有影象資料的可訪問緩衝影象,實現了 RenderedImage 介面
* BitMatrix 的 get(int x, int y) 獲取位元矩陣內容,指定位置有值,則返回true,將其設定為前景色,否則設定為背景色
* BufferedImage 的 setRGB(int x, int y, int rgb) 方法設定影象畫素
* x:畫素位置的橫座標,即列
* y:畫素位置的縱座標,即行
* rgb:畫素的值,採用 16 進位制,如 0xFFFFFF 白色
*/
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;
}
/**
* 根據本地二維碼圖片解析二維碼內容 注:圖片必須是二維碼圖片,但也可以是微信使用者二維碼名片,上面有名稱、頭像也是可以的)
*
* @param file 本地二維碼圖片檔案,如 E:\\logs\\2.jpg
* @return
* @throws Exception
*/
public static String parseQRCodeByFile(File file) {
String resultStr = null;
if (file == null || file.isDirectory() || !file.exists()) {
return resultStr;
}
try {
/*
* ImageIO的BufferedImage read(URL input)方法用於讀取網路圖片檔案轉為記憶體緩衝影象
* 同理還有:read(File input)、read(InputStream input)、、read(ImageInputStream stream)
*/
BufferedImage bufferedImage = ImageIO.read(file);
/*
* com.google.zxing.client.j2se.BufferedImageLuminanceSource:緩衝影象亮度源
* 將 java.awt.image.BufferedImage 轉為 zxing 的 緩衝影象亮度源
* 關鍵就是下面這幾句:HybridBinarizer 用於讀取二維碼影象資料,BinaryBitmap 二進位制點陣圖
*/
BufferedImageLuminanceSource source = new BufferedImageLuminanceSource(bufferedImage);
BinaryBitmap bitmap = new BinaryBitmap(new HybridBinarizer(source));
Hashtable hints = new Hashtable();
hints.put(DecodeHintType.CHARACTER_SET, "UTF-8");
/*
* 如果圖片不是二維碼圖片,則 decode 拋異常:com.google.zxing.NotFoundException
* MultiFormatWriter 的 encode 用於對內容進行編碼成 2D 矩陣
* MultiFormatReader 的 decode 用於讀取二進位制點陣圖資料
*/
Result result = new MultiFormatReader().decode(bitmap, hints);
resultStr = result.getText();
} catch (IOException e) {
e.printStackTrace();
} catch (NotFoundException e) {
e.printStackTrace();
log.error("圖片非二維碼圖片, 路徑是: {}!", file.getPath());
}
return resultStr;
}
/**
* 根據網路二維碼圖片解析二維碼內容, 區別僅僅在於 ImageIO.read(url); 這一個過載的方法)
*
* @param url 二維碼圖片網路地址,如 https://res.wx.qq.com/mpres/htmledition/images/mp_qrcode3a7b38.gif
* @return
* @throws Exception
*/
public static String parseQRCodeByUrl(URL url) {
String resultStr = null;
if (url == null) {
return resultStr;
}
try {
/*
* ImageIO 的 BufferedImage read(URL input) 方法用於讀取網路圖片檔案轉為記憶體緩衝影象
* 同理還有:read(File input)、read(InputStream input)、、read(ImageInputStream stream)
* 如果圖片網路地址錯誤,比如不能訪問,則 read 拋異常:javax.imageio.IIOException: Can't get input stream from URL!
*/
BufferedImage bufferedImage = ImageIO.read(url);
/*
* com.google.zxing.client.j2se.BufferedImageLuminanceSource:緩衝影象亮度源
* 將 java.awt.image.BufferedImage 轉為 zxing 的 緩衝影象亮度源
* 關鍵就是下面這幾句:HybridBinarizer 用於讀取二維碼影象資料,BinaryBitmap 二進位制點陣圖
*/
BufferedImageLuminanceSource source = new BufferedImageLuminanceSource(bufferedImage);
BinaryBitmap bitmap = new BinaryBitmap(new HybridBinarizer(source));
Hashtable hints = new Hashtable();
/*
* 如果內容包含中文,則解碼的字符集格式應該和編碼時一致
*/
hints.put(DecodeHintType.CHARACTER_SET, "UTF-8");
/*
* 如果圖片不是二維碼圖片,則 decode 拋異常:com.google.zxing.NotFoundException
* MultiFormatWriter 的 encode 用於對內容進行編碼成 2D 矩陣
* MultiFormatReader 的 decode 用於讀取二進位制點陣圖資料
*/
Result result = new MultiFormatReader().decode(bitmap, hints);
resultStr = result.getText();
} catch (IOException e) {
e.printStackTrace();
log.error("二維碼圖片地址錯誤, 地址是: {}!", url);
} catch (NotFoundException e) {
e.printStackTrace();
log.error("圖片非二維碼圖片, 地址是: {}!", url);
}
return resultStr;
}
新增Controller
public class QRCodeController {
@GetMapping("qrCode")
public void getQRCode(String codeContent, HttpServletResponse response) {
System.out.println("codeContent=" + codeContent);
try {
/*
* 呼叫工具類生成二維碼並輸出到輸出流中
*/
QRCodeUtil.createCodeToOutputStream(codeContent, response.getOutputStream());
log.info("成功生成二維碼!");
} catch (IOException e) {
log.error("發生錯誤, 錯誤資訊是:{}!", e.getMessage());
}
}
}
新增測試頁面
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>二維碼生成器</title>
<style type="text/css">
textarea {
font-size: 16px;
width: 300px;
height: 100px;
}
.hint {
color: red;
display: none;
}
.qrCodeDiv {
width: 200px;
height: 200px;
border: 2px solid sandybrown;
}
.qrCodeDiv img {
max-height: 100%;
max-width: 100%;
}
</style>
<script src="https://cdn.bootcss.com/jquery/2.1.1/jquery.min.js"></script>
<script type="text/javascript">
$(function () {
$("button").click(function () {
var codeContent = $("textarea").val();
console.log(codeContent);
if (codeContent.trim() == "") {
$(".hint").text("二維碼內容不能為空").fadeIn(500);
} else {
$(".hint").text("").fadeOut(500);
$("#codeImg").attr("src", "/qrCode?codeContent=" + codeContent);
}
});
});
</script>
</head>
<body>
<textarea placeholder="二維碼內容..."></textarea><br>
<button>生成二維碼</button>
<span class="hint"></span>
<div class="qrCodeDiv">
<img src="" id="codeImg">
</div>
</body>
</html>
Hutool的方式
Hutool的是非強制依賴性,因此zxing需要使用者自行引入,我們需要加入依賴。使用hutool的時候,com.google.zxing-javase
的依賴可以不需要。
新增依賴
<dependency>
<groupId>cn.hutool</groupId>
<artifactId>hutool-all</artifactId>
<version>5.3.10</version>
</dependency>
<dependency>
<groupId>com.google.zxing</groupId>
<artifactId>core</artifactId>
<version>3.3.3</version>
</dependency>
建立QRCodeService
QRCodeService
其實就是對QrCodeUtil
的功能的封裝,QrCodeUtil
此處的類是hutool工具提供的,和我們在上面與自己與自己提供的QRCodeUtil
類,不是同一個,這個需要注意一下。QrCodeUtil
的功能此處主要使用到了的是生成二維碼,到檔案或者流之中,QrConfig
是Hutool工具QrCodeUtil的配置類。
@Service
@Slf4j
public class QRCodeService {
// 自定義引數,這部分是Hutool工具封裝的
private static QrConfig initQrConfig() {
QrConfig config = new QrConfig(300, 300);
// 設定邊距,既二維碼和背景之間的邊距
config.setMargin(3);
// 設定前景色,既二維碼顏色(青色)
config.setForeColor(Color.CYAN.getRGB());
// 設定背景色(灰色)
config.setBackColor(Color.GRAY.getRGB());
return config;
}
/**
* 生成到檔案
*
* @param content
* @param filepath
*/
public void createQRCode2File(String content, String filepath) {
try {
QrCodeUtil.generate(content, initQrConfig(), FileUtil.file(filepath));
log.info("生成二維碼成功, 位置在:{}!", filepath);
} catch (QrCodeException e) {
log.error("發生錯誤! {}!", e.getMessage());
}
}
/**
* 生成到流
*
* @param content
* @param response
*/
public void createQRCode2Stream(String content, HttpServletResponse response) {
try {
QrCodeUtil.generate(content, initQrConfig(), "png", response.getOutputStream());
log.info("生成二維碼成功!");
} catch (QrCodeException | IOException e) {
log.error("發生錯誤! {}!", e.getMessage());
}
}
}
新增Controller
@RestController
@Slf4j
public class QRCodeController {
@Autowired
private QRCodeService qrCodeService;
@GetMapping("qrCode")
public void getQRCode(String codeContent, HttpServletResponse response) {
try {
qrCodeService.createQRCode2Stream(codeContent, response);
log.info("成功生成二維碼!");
} catch (Exception e) {
log.error("發生錯誤, 錯誤資訊是:{}!", e.getMessage());
}
}
}
效果測試
我們使用的頁面和上述相同,所以,頁面的情況是一樣的,效果展示如下: