二维码工具-QrCodeUtil

由来

由于大家对二维码的需求较多，对于二维码的生成和解析我认为应该作为简单的工具存在于Hutool中。考虑到自行实现的难度，因此Hutool针对被广泛接受的的zxing库进行封装。而由于涉及第三方包，因此归类到extra模块中。

使用

引入zxing

考虑到Hutool的非强制依赖性，因此zxing需要用户自行引入：

  1. <dependency>
  2.     <groupId>com.google.zxing</groupId>
  3.     <artifactId>core</artifactId>
  4.     <version>3.3.3</version>
  5. </dependency>

说明zxing-3.3.3是此文档编写时的最新版本，理论上你引入的版本应与此版本一致或比这个版本新。

生成二维码

在此我们将Hutool主页的url生成为二维码，微信扫一扫可以看到H5主页哦：

  1. // 生成指定url对应的二维码到文件，宽和高都是300像素
  2. QrCodeUtil.generate("https://hutool.cn/", 300, 300, FileUtil.file("d:/qrcode.jpg"));

效果qrcode.jpg：

二维码工具-QrCodeUtil - 图1

自定义参数（since 4.1.2）

  • 基本参数设定通过QrConfig可以自定义二维码的生成参数，例如长、宽、二维码的颜色、背景颜色、边距等参数，使用方法如下：
  1. QrConfig config = new QrConfig(300, 300);
  2. // 设置边距，既二维码和背景之间的边距
  3. config.setMargin(3);
  4. // 设置前景色，既二维码颜色（青色）
  5. config.setForeColor(Color.CYAN.getRGB());
  6. // 设置背景色（灰色）
  7. config.setBackColor(Color.GRAY.getRGB());
  9. // 生成二维码到文件，也可以到流
  10. QrCodeUtil.generate("http://hutool.cn/", config, FileUtil.file("e:/qrcode.jpg"));

效果qrcode.jpg:

二维码工具-QrCodeUtil - 图2

  • 附带logo小图标
  1. QrCodeUtil.generate(//
  2.     "http://hutool.cn/", //二维码内容
  3.     QrConfig.create().setImg("e:/logo_small.jpg"), //附带logo
  4.     FileUtil.file("e:/qrcodeWithLogo.jpg")//写出到的文件
  5. );

效果如图：

二维码工具-QrCodeUtil - 图3

  • 调整纠错级别很多时候，二维码无法识别，这时就要调整纠错级别。纠错级别使用zxing的ErrorCorrectionLevel枚举封装，包括：L、M、Q、H几个参数，由低到高。低级别的像素块更大，可以远距离识别，但是遮挡就会造成无法识别。高级别则相反，像素块小，允许遮挡一定范围，但是像素块更密集。
  1. QrConfig config = new QrConfig();
  2. // 高纠错级别
  3. config.setErrorCorrection(ErrorCorrectionLevel.H);
  4. QrCodeUtil.generate("https://hutool.cn/", config, FileUtil.file("e:/qrcodeCustom.jpg"));

效果如图：

二维码工具-QrCodeUtil - 图4

识别二维码

  1. // decode -> "http://hutool.cn/"
  2. String decode = QrCodeUtil.decode(FileUtil.file("d:/qrcode.jpg"));