SpringBoot生成和解析二维码完整工具类分享（提供Gitee源码）
前言：在日常的开发工作当中可能需要实现一个二维码小功能，我参考了网上很多关于SpringBoot生成二维码的教程，最终还是自己封装了一套完整生成二维码的工具类，可以支持基础的黑白二维码、带颜色的二维码、带Logo的二维码、带颜色和Logo的二维码和解析二维码五大功能，还可以生成具体的二维码文件或返回Base64，都是博主自己手写封装好的，这边免费开源给大家一键使用！只求大家一个免费的三连支持！
目录
一、问题记录
二、导入pom依赖
三、QRCodeUtil工具类完整代码
四、使用示例
五、Gitee源码
六、总结
一、问题记录
这边我使用的是zxing提供的jar包生成的二维码，不过有1个问题博客目前暂时未解决，如果有解决的方法希望可以在评论区交流一下，问题如下：
二维码的内容如果设置为中文，会报com.google.zxing.NotFoundException的错误，这个问题博主搜索了网上很多的信息也没有找到具体的解决方案。
二、导入pom依赖
org.springframework.boot
spring-boot-starter-web
com.google.zxing
core
3.3.0
com.google.zxing
javase
3.3.0
org.apache.commons
commons-lang3
org.springframework.boot
spring-boot-starter-test
test
三、QRCodeUtil工具类完整代码
package com.example.ewm.utils;
import java.awt.BasicStroke;
import java.awt.Graphics;
import java.awt.Graphics2D;
import java.awt.Image;
import java.awt.Shape;
import java.awt.geom.RoundRectangle2D;
import java.awt.image.BufferedImage;
import java.io.ByteArrayOutputStream;
import java.io.File;
import java.io.IOException;
import java.io.OutputStream;
import java.util.HashMap;
import java.util.Hashtable;
import java.util.Random;
import javax.imageio.ImageIO;
import com.google.zxing.*;
import com.google.zxing.client.j2se.BufferedImageLuminanceSource;
import com.google.zxing.client.j2se.MatrixToImageWriter;
import com.google.zxing.common.BitMatrix;
import com.google.zxing.common.HybridBinarizer;
import com.google.zxing.qrcode.QRCodeWriter;
import com.google.zxing.qrcode.decoder.ErrorCorrectionLevel;
import com.sun.org.apache.xerces.internal.impl.dv.util.Base64;
import org.apache.commons.lang3.StringUtils;
import org.springframework.stereotype.Component;
/**
* @author HTT
*/
@Component
public class QRCodeUtil {
/**
* 编码格式
*/
private static final String CHARSET = "utf-8";
/**
* 二维码后缀名
*/
private static final String FORMAT_NAME = "JPG";
/**
* 二维码尺寸
*/
private static final int QRCODE_SIZE = 300;
/**
* 插入图宽度
*/
private static final int WIDTH = 60;
/**
* 插入图高度
*/
private static final int HEIGHT = 60;
/**
* 插入图片
* @param source 文件流
* @param imgPath 图片路径
* @param needCompress 是否压缩图片
* @throws Exception
*/
private void insertImage(BufferedImage source, String imgPath, boolean needCompress) throws Exception {
File file = new File(imgPath);
if (!file.exists()) {
throw new Exception(imgPath+"图片文件不存在");
}
Image src = ImageIO.read(new File(imgPath));
int width = src.getWidth(null);
int height = src.getHeight(null);
// 压缩LOGO
if (needCompress) {
if (width > WIDTH) {
width = WIDTH;
}
if (height > HEIGHT) {
height = HEIGHT;
}
Image image = src.getScaledInstance(width, height, Image.SCALE_SMOOTH);
BufferedImage tag = new BufferedImage(width, height, BufferedImage.TYPE_INT_RGB);
Graphics g = tag.getGraphics();
// 绘制缩小后的图
g.drawImage(image, 0, 0, null);
g.dispose();
src = image;
}
// 插入LOGO
Graphics2D graph = source.createGraphics();
int x = (QRCODE_SIZE - width) / 2;
int y = (QRCODE_SIZE - height) / 2;
graph.drawImage(src, x, y, width, height, null);
Shape shape = new RoundRectangle2D.Float(x, y, width, width, 6, 6);
graph.setStroke(new BasicStroke(3f));
graph.draw(shape);
graph.dispose();
}
/**
* 创建带图片的二维码核心方法（如果图片路径为空，不会生成图片）
* @param content 二维码内容
* @param imgPath 图片路径
* @param needCompress 是否压缩图片
* @return
* @throws Exception
*/
private BufferedImage createEwm(String content, String imgPath, boolean needCompress) throws Exception {
Hashtable hints = new Hashtable(16);
hints.put(EncodeHintType.ERROR_CORRECTION, ErrorCorrectionLevel.H);
hints.put(EncodeHintType.CHARACTER_SET, CHARSET);
hints.put(EncodeHintType.MARGIN, 1);
BitMatrix bitMatrix = new MultiFormatWriter().encode(content, BarcodeFormat.QR_CODE, QRCODE_SIZE, QRCODE_SIZE,
hints);
int width = bitMatrix.getWidth();
int height = bitMatrix.getHeight();
BufferedImage image = new BufferedImage(width, height, BufferedImage.TYPE_INT_RGB);
for (int x = 0; x < width; x++) {
for (int y = 0; y < height; y++) {
image.setRGB(x, y, bitMatrix.get(x, y) ? 0xFF000000 : 0xFFFFFFFF);
}
}
if (StringUtils.isEmpty(imgPath)) {
return image;
}
// 插入图片
insertImage(image, imgPath, needCompress);
return image;
}
/**
* 创建自定义颜色和图片的二维码核心方法（如果图片路径为空，不会生成图片）
* @param content 二维码内容
* @param imgPath 图片路径
* @param needCompress 是否压缩图片
* @param frontColor 前景色
* @param backgroundColor 背景色
* @return
* @throws Exception
*/
private BufferedImage createEwm(String content, String imgPath, boolean needCompress,int frontColor,int backgroundColor) throws Exception {
Hashtable hints = new Hashtable(16);
hints.put(EncodeHintType.ERROR_CORRECTION, ErrorCorrectionLevel.H);
hints.put(EncodeHintType.CHARACTER_SET, CHARSET);
hints.put(EncodeHintType.MARGIN, 1);
BitMatrix bitMatrix = new MultiFormatWriter().encode(content, BarcodeFormat.QR_CODE, QRCODE_SIZE, QRCODE_SIZE,
hints);
int width = bitMatrix.getWidth();
int height = bitMatrix.getHeight();
BufferedImage image = new BufferedImage(width, height, BufferedImage.TYPE_INT_RGB);
for (int x = 0; x < width; x++) {
for (int y = 0; y < height; y++) {
image.setRGB(x, y, bitMatrix.get(x, y) ? frontColor : backgroundColor);
}
}
if (StringUtils.isEmpty(imgPath)) {
return image;
}
// 插入图片
insertImage(image, imgPath, needCompress);
return image;
}
/**
* 生成带图片的二维码保存为文件（如果图片路径为空，不会生成图片）
* @param content 二维码内容
* @param imgPath 图片路径
* @param destPath 存放路径
* @param needCompress 是否压缩图片
* @throws Exception
*/
private void generate(String content, String imgPath, String destPath, boolean needCompress) throws Exception {
BufferedImage image = createEwm(content, imgPath, needCompress);
mkdirs(destPath);
ImageIO.write(image, FORMAT_NAME, new File(destPath));
}
/**
* 创建自定义颜色和图片的二维码保存为文件（如果图片路径为空，不会生成图片）
* @param content 二维码内容
* @param imgPath 图片路径（路径为空，则只生成基础的二维码）
* @param destPath 存放路径
* @param needCompress 是否压缩图片
* @param frontColor 前景色
* @param backgroundColor 背景色
* 例举一些16进制的颜色代码
* 0x000000 黑
* 0xff0000 亮红
* 0x00ff00 亮绿
* 0xffff00 亮黄
* 0x0000ff 亮蓝
* 0xff00ff 亮紫
* 0x00ffff 亮浅蓝
* 0xffffff 白
* 0xc6c6c6 亮灰
* 0x848484 暗灰
* @throws Exception
*/
private void generate(String content, String imgPath, String destPath, boolean needCompress,int frontColor,int backgroundColor) throws Exception {
BufferedImage image = createEwm(content, imgPath, needCompress,frontColor,backgroundColor);
mkdirs(destPath);
ImageIO.write(image, FORMAT_NAME, new File(destPath));
}
/**
* 生成带有图片的二维码并返回Base64（如果图片路径为空，不会生成图片）
* @param content 二维码内容
* @param imgPath 图片路径
* @param needCompress 是否压缩图片
* @return
* @throws Exception
*/
private String generateBase64(String content, String imgPath, boolean needCompress) throws Exception {
if (!StringUtils.isEmpty(content)) {
HashMap hints = new HashMap<>();
hints.put(EncodeHintType.CHARACTER_SET, "utf-8");
hints.put(EncodeHintType.ERROR_CORRECTION, ErrorCorrectionLevel.H);
hints.put(EncodeHintType.MARGIN, 0);
BufferedImage bufferedImage = createEwm(content, imgPath, needCompress);
ByteArrayOutputStream os = new ByteArrayOutputStream();
ImageIO.write(bufferedImage, FORMAT_NAME, os);
String base64 = Base64.encode(os.toByteArray());
os.flush();
os.close();
return "data:image/png;base64," + base64;
}
return "";
}
/**
* 生成带有自定义颜色和图片的二维码并返回Base64（如果图片路径为空，不会生成图片）
* @param content 二维码内容
* @param imgPath 图片路径
* @param needCompress 是否压缩图片
* @param frontColor 前景色
* @param backgroundColor 背景色
* @return
* @throws Exception
*/
private String generateBase64(String content, String imgPath, boolean needCompress,int frontColor,int backgroundColor) throws Exception {
if (!StringUtils.isEmpty(content)) {
HashMap hints = new HashMap<>();
hints.put(EncodeHintType.CHARACTER_SET, "utf-8");
hints.put(EncodeHintType.ERROR_CORRECTION, ErrorCorrectionLevel.H);
hints.put(EncodeHintType.MARGIN, 0);
BufferedImage bufferedImage = createEwm(content, imgPath, needCompress,frontColor,backgroundColor);
ByteArrayOutputStream os = new ByteArrayOutputStream();
ImageIO.write(bufferedImage, FORMAT_NAME, os);
String base64 = Base64.encode(os.toByteArray());
os.flush();
os.close();
return "data:image/png;base64," + base64;
}
return "";
}
/**
* 创建多级目录
* @param destPath
*/
private void mkdirs(String destPath) {
File file = new File(destPath);
if (!file.exists() && !file.isDirectory()) {
file.mkdirs();
}
}
/**
* 根据文件解析二维码
* @param file
* @return
* @throws Exception
*/
private String analysis(File file) throws Exception {
BufferedImage image;
image = ImageIO.read(file);
if (image == null) {
return null;
}
BufferedImageLuminanceSource source = new BufferedImageLuminanceSource(image);
BinaryBitmap bitmap = new BinaryBitmap(new HybridBinarizer(source));
HashMap hints = new HashMap();
hints.put(DecodeHintType.CHARACTER_SET, CHARSET);
Result result = new MultiFormatReader().decode(bitmap, hints);
String resultStr = result.getText();
return resultStr;
}
/*******************************************************以下是创建二维码提供的方法封装*******************************************************/
/******************************另存为文件版本******************************/
/**
* 创建基础的二维码
* @param content 二维码内容
* @param destPath 存放路径
* @throws Exception
*/
public void create(String content, String destPath) throws Exception {
generate(content, null, destPath, false);
}
/**
* 创建带颜色基础的二维码
* @param content 二维码内容
* @param destPath 存放路径
* @throws Exception
*/
public void create(String content, String destPath,int frontColor,int backgroundColor) throws Exception {
generate(content, null, destPath, false,frontColor,backgroundColor);
}
/**
* 创建带图片的二维码
* @param content 二维码内容
* @param imgPath 图片路径
* @param destPath 存放路径
* @param needCompress 是否压缩图片
* @throws Exception
*/
public void create(String content, String imgPath, String destPath,boolean needCompress) throws Exception {
generate(content, imgPath, destPath, needCompress);
}
/**
* 创建带有自定义颜色和图片的二维码
* @param content 二维码内容
* @param imgPath 图片路径
* @param destPath 存放路径
* @param needCompress 是否压缩图片
* @param frontColor 前景色
* @param backgroundColor 背景色
* @throws Exception
*/
public void create(String content, String imgPath, String destPath,boolean needCompress,int frontColor,int backgroundColor) throws Exception {
generate(content, imgPath, destPath, needCompress,frontColor,backgroundColor);
}
/******************************另存为文件版本******************************/
/******************************Base64版本******************************/
/**
* 创建基础的二维码并返回Base64
* @param content
* @throws Exception
*/
public String create(String content) throws Exception {
return generateBase64(content,null,false);
}
/**
* 创建带颜色基础的二维码并返回Base64
* @param content
* @throws Exception
*/
public String create(String content,int frontColor,int backgroundColor) throws Exception {
return generateBase64(content,null,false,frontColor,backgroundColor);
}
/**
* 创建带图片的二维码并返回Base64
* @param content 二维码内容
* @param imgPath 图片路径
* @param needCompress 是否压缩图片
* @throws Exception
*/
public String create(String content, String imgPath,boolean needCompress) throws Exception {
return generateBase64(content, imgPath, needCompress);
}
/**
* 创建带有自定义颜色和图片的二维码并返回Base64
* @param content 二维码内容
* @param imgPath 图片路径
* @param needCompress 是否压缩图片
* @param frontColor 前景色
* @param backgroundColor 背景色
* @throws Exception
*/
public String create(String content, String imgPath,boolean needCompress,int frontColor,int backgroundColor) throws Exception {
return generateBase64(content, imgPath, needCompress,frontColor,backgroundColor);
}
/******************************Base64版本******************************/
/**
* 根据文件路径解析二维码
* @param path 文件路径
* @return
* @throws Exception
*/
public String decode(String path) throws Exception {
File file = new File(path);
if(!file.exists()){
throw new Exception("文件不存在！");
}
return analysis(file);
}
}
四、使用示例
友情提醒：代码中的布尔值是代表Logo图片是否需要被压缩，如果是true说明嵌入的Logo图片需要被压缩，我的建议是默认为true，因为如果不压缩，在使用decode解析带Logo的二维码的时候会报com.google.zxing.NotFoundException的错误，博主亲自测试过。
单元测试：
@SpringBootTest
class EwmApplicationTests {
@Resource
private QRCodeUtil qrCodeUtil;
@Test
void contextLoads() throws Exception {
qrCodeUtil.create("httstudy","F:\\基础二维码.jpg");
qrCodeUtil.create("httstudy","F:\\带颜色的二维码.jpg",0xff0000,0xffff00);
qrCodeUtil.create("httstudy","F:\\Logo.png","F:\\带logo的二维码.jpg",true);
qrCodeUtil.create("httstudy","F:\\Logo.png","F:\\带颜色和logo的二维码.jpg",true,0xff0000,0xffff00);
String str = qrCodeUtil.create("httstudy");
String str2 = qrCodeUtil.create("httstudy",0xff0000,0xffff00);
String str3 = qrCodeUtil.create("httstudy","F:\\Logo.png",true);
String str4 = qrCodeUtil.create("httstudy","F:\\Logo.png",true,0xff0000,0xffff00);
System.out.println(str);
System.out.println(str2);
System.out.println(str3);
System.out.println(str4);
String result = qrCodeUtil.decode("F:\\基础二维码.jpg");
String result2 = qrCodeUtil.decode("F:\\带颜色的二维码.jpg");
String result3 = qrCodeUtil.decode("F:\\带logo的二维码.jpg");
String result4 = qrCodeUtil.decode("F:\\带颜色和logo的二维码.jpg");
System.out.println(result);
System.out.println(result2);
System.out.println(result3);
System.out.println(result4);
}
}运行结果：
五、Gitee源码
码云地址：SpringBoot生成二维码完整工具类分享
六、总结
良心博主原创封装不易，把常见场景需要用到的二维码类型都给大家封装好了，只要像单元测试那样一键生成就好了，如有问题，欢迎评论区留言！