Java利用Zxing生成二维码及解析二维码内容
前言
Java 操作二维码的开源项目很多，如 SwetakeQRCode、BarCode4j、Zxing 等等
本篇文章是介绍利用Zxing来生成二维码图片在web网页上展示，同时解析二维码图片。
Zxing概述
ZXing是一个开放源码的，用Java实现的多种格式的1D/2D条码图像处理库，它包含了联系到其他语言的端口。
Zxing库的主要部分支持以下几个功能：核心代码的使用、适用于J2SE客户端的版本、适用于Android客户端的版本（即BarcodeScanner）、Android的集成（通过Intent支持和BarcodeScanner的集成）等。
GitHub地址，https://github.com/zxing/zxing
API文档，https://zxing.github.io/zxing/apidocs/index.html
介绍文档，https://zxing.github.io/zxing/
1、添加maven依赖
com.google.zxing
core
3.3.3
com.google.zxing
javase
3.3.3
zxing 二进制包下载地址：http://repo1.maven.org/maven2/com/google/zxing，
2、二维码生成工具类，如下：
/**
* 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;
/**
* 生成二维码 并 保存为图片：write(RenderedImage im,String formatName,File output)
*
* @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.trim())) {
System.out.println("二维码内容为空，不进行操作...");
return;
}
codeContent = codeContent.trim();
if (codeImgFileSaveDir == null || codeImgFileSaveDir.isFile()) {
codeImgFileSaveDir = FileSystemView.getFileSystemView().getHomeDirectory();
System.out.println("二维码图片存在目录为空，默认放在桌面...");
}
if (!codeImgFileSaveDir.exists()) {
codeImgFileSaveDir.mkdirs();
System.out.println("二维码图片存在目录不存在，开始创建...");
}
if (fileName == null || "".equals(fileName)) {
fileName = System.currentTimeMillis() + ".png";
System.out.println("二维码图片文件名为空，随机生成 png 格式图片...");
}else{
fileName = fileName + ".png";
}
/**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 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 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);
}
}
/**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);
System.out.println("二维码图片生成成功：" + 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())) {
System.out.println("二维码内容为空，不进行操作...");
return;
}
codeContent = codeContent.trim();
/**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 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 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);
}
}
/**
* 区别就是以一句，输出到输出流中，如果第三个参数是 File，则输出到文件中
*/
ImageIO.write(bufferedImage, "png", outputStream);
System.out.println("二维码图片生成到输出流成功...");
} catch (Exception e) {
e.printStackTrace();
}
}
/**
* 根据本地二维码图片————————解析二维码内容
* （注：图片必须是二维码图片，但也可以是微信用户二维码名片，上面有名称、头像也是可以的）
*
* @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();
System.out.println("-----图片非二维码图片：" + file.getPath());
}
return resultStr;
} 3、生成二维码文件到本地目录
3.1controller测试方法，如下：
/**
* 生成二维码并保存到指定的目录下
*/
@GetMapping("/create")
public void createQrCodeForFile(){
String codeContent = "https://www.baidu.com/";
File file = new File("C:/secFile");
QRBarCodeUtil.createCodeToFile(codeContent,file,"baidu");
}3.2、结果如下：
4、生成二维码并输出到网页上
4.1导入前端maven依赖：
org.springframework.boot
spring-boot-starter-freemarker
4.2前端代码，如下：
二维码生成器
![]()
4.3controller测试方法：
/**
* 页面初始化
* @return
*/
@GetMapping("/view")
public ModelAndView page(){
return new ModelAndView("qrCode");
}
/**
* 根据内容生成二维码并输出到页面显示
* @param codeContent 二维码内容
* @param response
*/
@GetMapping("/qrCode")
public void getQRCode(String codeContent, HttpServletResponse response) {
System.out.println("codeContent=" + codeContent);
try {
/**
* 调用工具类生成二维码并输出到输出流中
*/
QRBarCodeUtil.createCodeToOutputStream(codeContent, response.getOutputStream());
} catch (IOException e) {
e.printStackTrace();
}
}4.4页面效果及结果：
5、解析二维码
5.1 controller测试方法：
这里解析的二维码图片，就是上面生成的百度二维码图片。
/**
* 解析二维码图片内容
* @return
*/
@GetMapping("/getInfoByQrcode")
public String getInfoByQrcode(){
File qrCodeFile = new File("C:\\secFile\\baidu.png");
String qrCodeStr = QRBarCodeUtil.parseQRCodeByFile(qrCodeFile);
System.out.println(qrCodeStr);
return qrCodeStr;
}5.2 测试结果：
6、项目代码路径
项目github地址：https://github.com/lcs2314/QRCode
参考文章：
https://blog.csdn.net/wangmx1993328/article/details/83856391
https://www.cnblogs.com/huanzi-qch/p/10097791.html