引言
二维码(QR Code)作为一种快速、高容量、高密度的矩阵条码,已经在各行各业得到广泛应用。ZXing(Zebra Crossing)是一款由Google开源的Java二维码生成和解析库,提供了丰富的功能和易于使用的API。本篇博文将研究如何使用ZXing开源库生成二维码。
GitHub地址,猛戳:https://github.com/zxing/zxing
API文档,猛戳:Overview (ZXing 3.5.2 API)
介绍文档,猛戳:ZXing -- About
第一部分:引入ZXing库
了解ZXing
ZXing是一个强大的二维码处理库,除了支持生成和解析二维码外,还能处理其他一维条码。它是一个开源项目,通过Google Code托管,并在GitHub上进行维护。
集成ZXing到项目中
你可以通过Maven或手动下载JAR文件的方式将ZXing集成到你的Java项目中。以下是Maven的依赖配置:
XML
<!--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>
<!--commons-lang依赖-->
<dependency>
<groupId>commons-lang</groupId>
<artifactId>commons-lang</artifactId>
<version>2.6</version>
</dependency>
zxing常用API
EncodeHintType(编码提示类型)
EncodeHintType是用来设置二维码编码时的一些额外参数的枚举类型,常用枚举值如下:
-
ERROR_CORRECTION
:-
误差校正级别。对于黑白二维码,可选值为
L
(7%)、M
(15%)、Q
(25%)、H
(30%),表示二维码允许破损的最大容错率。在二维码出现破损时,根据设置的容错率级别,可以尝试修复二维码中的一些数据。 -
二维码在生成过程中,可能会出现一些损坏或者缺失的情况,例如打印时墨水耗尽、图像压缩、摄像头拍摄角度不对等。这些问题可能导致二维码无法完全识别,或者识别出来的数据不准确,而误差校正码就是为了解决这些问题而产生的。
-
例如,选择L级别的容错率,相当于允许在二维码的整体颜色区域中,最多可有约7%的坏像素点;而选择H级别的容错率时,最多可有约30%的坏像素点。
-
注意:误差校正级别的具体值需要通过ErrorCorrectionLevel的枚举值来获取。
-
-
CHARACTER_SET
:- 编码字符集。可以设置使用的字符编码,例如utf-8、gb2312等等。
-
MARGIN
:- 二维码的空白区域大小。可以设置二维码周围的留白大小,以便于在不同的嵌入场景中使用二维码。
BarcodeFormat(码格式)
BarcodeFormat是枚举类,通过它来制定二维码格式:
-
QR Code :QR Code是最常见的二维码格式之一,广泛应用于商品包装、票务、扫码支付等领域。QR Code矩阵有黑白两种颜色,其中黑色部分表示信息的编码,白色部分则用于衬托和辨识。
-
Aztec Code:Aztec Code是一种高密度、可靠性很高的二维码格式。相比于其他二维码格式,它具有更低的容错率、更小的尺寸和更高的解码效率。因此,它适合用于储存一些核心信息,例如个人信息、证件信息、账户密码等。
-
PDF417:是一种可以储存大量信息的二维码格式,它具有数据密度高、可靠性强等优点,可以应用于许多场景,例如航空机票,运输和配送标签,法律文件等。
-
Data Matrix:是一种小巧的二维码格式,它的编码方式类似于QR Code,但是其可靠性、识别率、扫描速度和牢固度都比QR Code更优秀。由于尺寸较小、可靠性较高,因此Data Matrix适合嵌入简单的产品标签、医疗图像、检测数据等领域。
第二部分:创建二维码生成服务
在Spring Boot项目中,我们可以创建一个服务类,专门用于生成二维码。以下是一个简单的示例:
java
@Service
public class QRCodeService {
// 定义一个名为generateQRCode的公共方法,它接收三个参数:content(字符串类型,表示二维码的内容)、width(整数类型,表示二维码的宽度)和height(整数类型,表示二维码的高度)。
public byte[] generateQRCode(String content, int width, int height) {
try {
// 创建一个名为hints的HashMap对象,用于存储二维码编码的提示信息。
Map<EncodeHintType, Object> hints = new HashMap<>();
// 设置错误纠正级别为L,表示较低的纠错能力。
hints.put(EncodeHintType.ERROR_CORRECTION, ErrorCorrectionLevel.L);
// 设置边距为2,即二维码边缘与内容之间的距离为2个像素。
hints.put(EncodeHintType.MARGIN, 2);
// 设置字符集为UTF-8,表示二维码支持UTF-8编码的字符。
hints.put(EncodeHintType.CHARACTER_SET, "UTF-8");
// 创建一个QRCodeWriter对象,用于生成二维码。
QRCodeWriter qrCodeWriter = new QRCodeWriter();
// 使用QRCodeWriter对象将内容编码为二维码,并指定宽度、高度和提示信息。
BitMatrix bitMatrix = qrCodeWriter.encode(content, BarcodeFormat.QR_CODE, width, height, hints);
// 将BitMatrix对象转换为BufferedImage对象,以便于后续处理。
BufferedImage bufferedImage = MatrixToImageWriter.toBufferedImage(bitMatrix);
// 创建一个ByteArrayOutputStream对象,用于将BufferedImage对象转换为字节数组。
ByteArrayOutputStream byteArrayOutputStream = new ByteArrayOutputStream();
// 将BufferedImage对象写入到ByteArrayOutputStream对象中,并指定输出格式为png。
ImageIO.write(bufferedImage, "png", byteArrayOutputStream);
// 将ByteArrayOutputStream对象中的数据转换为字节数组,并返回该字节数组。
return byteArrayOutputStream.toByteArray();
} catch (Exception e) {
// 如果在生成二维码过程中出现异常,则打印异常信息。
e.printStackTrace();
// 返回空字节数组。
return null;
}
}
}
在上述示例中,我们使用了ZXing的QRCodeWriter
和MatrixToImageWriter
来生成二维码图片。服务方法generateQRCode
接受内容、宽度和高度作为参数,并返回生成的二维码的字节数组。
第三部分:在Controller中使用生成服务
接下来,我们可以在Controller中使用刚刚创建的服务来生成二维码,并将其返回给前端。以下是一个简单的Controller示例:
java
@RestController
public class QRCodeController {
@Autowired
private QRCodeService qrCodeService;
// 使用@GetMapping注解,表示这是一个处理HTTP GET请求的方法。
// value属性指定了该方法对应的URL路径为"/generateQRCode"。
// produces属性指定了该方法返回的数据类型,即PNG格式的图片。
@GetMapping(value = "/generateQRCode", produces = MediaType.IMAGE_PNG_VALUE)
public byte[] generateQRCode(@RequestParam String content,
@RequestParam(defaultValue = "200") int width,
@RequestParam(defaultValue = "200") int height) {
// 调用qrCodeService的generateQRCode方法来生成二维码。
// 传入二维码的内容、宽度和高度作为参数。
return qrCodeService.generateQRCode(content, width, height);
}
}
在上述示例中,我们使用@GetMapping
注解定义了一个接口/generateQRCode
,接受内容、宽度和高度参数,并通过调用qrCodeService
生成二维码的字节数组,将其作为图片返回。
测试
结语
通过以上步骤,你已经成功集成了ZXing库,并在项目中实现了二维码的生成。这个功能在电子支付、活动签到、联系方式分享等场景中都有广泛的应用。希望本篇博文能够帮助你更好地理解如何在项目中使用ZXing库生成二维码,为你的项目增添更多的交互性和便利性。