2021SC@SDUSC Zxing开源代码（四）QR码的编码（一）

2021SC@SDUSC

---

前言：在上一篇博客中，我介绍了Zxing生成二维码/条形码的一般步骤和所共用的类及其方法。在本篇中，我将着重对QR码的编码算法进行分析。本篇博客前半部分，主要介绍了QR码的相关知识，以及QR码的编码步骤；后半部分对QR码的编码类QRCodeWriter进行分析。

---

一、QR码简介

1.1 简介

QR码属于矩阵式二维码中的一个种类，由DENSO(日本电装)公司开发，由JIS和ISO将其标准化。
其基本结构如下：

位置探测图形、位置探测图形分隔符、定位图形：用于对二维码的定位，对每个QR码来说，位置都是固定存在的，只是大小规格会有所差异；
校正图形：规格确定，校正图形的数量和位置也就确定了；
格式信息：表示改二维码的纠错级别，分为L、M、Q、H；
版本信息：即二维码的规格，QR码符号共有40种规格的矩阵（一般为黑白色），从21x21（版本1），到177x177（版本40），每一版本符号比前一版本 每边增加4个模块。
数据和纠错码字：实际保存的二维码信息，和纠错码字（用于修正二维码损坏带来的错误）。

1.2 QR码的特点

①高速读取：QR就是取自“Quick Response”的首字母，通过摄像头从拍摄到解码到显示内容也就三秒左右，对摄像的角度也没有什么要求；

②高容量、高密度：理论上内容经过压缩处理后可以存7089个数字，4296 个字母和数字混合字符，2953个8位字节数据，1817个汉字；

③支持纠错处理：即使编码变脏或破损，也可自动恢复数据。这一“纠错能力”具备4个级别，用户可根据使用环境选择相应的级别。调高级别，纠错能力也相应提高，但由于数据量会随之增加，编码尺寸也也会变大。内容重复编码以便在部分被遮挡时仍能被扫码识别，因此可以支持中央放置遮挡图标而不影响二维码识别。
level L : 最大 7% 的错误能够被纠正；
level M : 最大 15% 的错误能够被纠正；
level Q : 最大 25% 的错误能够被纠正；
level H : 最大 30% 的错误能够被纠正；

④结构化：看似无规则的图形，其实对区域有严格的定义，下图就是一个模式2、版本1的QR图结构。

在上图21*21的矩阵中，黑白的区域在QR码规范中被指定为固定的位置，称为寻像图形（finder pattern） 和 定位图形(timing pattern)。寻像图形和定位图形用来帮助解码程序确定图形中具体符号的坐标。
黄色的区域用来保存被编码的数据内容以及纠错信息码。
蓝色的区域，用来标识纠错的级别（也就是Level L到Level H)和所谓的"Mask pattern",这个区域被称为“格式化信息”（format information）。

⑤扩展能力：QR码的Structure Append特点，使一个QR码可以分解成多个QR码，反之，也可以将多个QR码的数据组合到一个QR码中来。如图：

1.3 QR码的模式和版本

QR码分为Model1和Model2两种模式，Model1是对QR的初始定义，Model2是对Model1的扩展，目前使用较为普遍的是Model2。
QR图的大小(size)被定义为版本（Version)，版本号从1到40。版本1就是一个21* 21的矩阵，每增加一个版本号，矩阵的大小就增加4个模块(Module)，因此，版本40就是一个177*177的矩阵。（版本越高，意味着存储的内容越多，纠错能力也越强）。

二、QR码的编码过程

• 数据分析：确定编码的字符类型，按相应的字符集转换成符号字符；
  选择纠错等级，在规格一定的条件下，纠错等级越高，真实数据的容量越小。

• 数据编码：将数据字符转换为位流，每8位一个码字，整体构成一个数据的码字序列。知道这个数据码字序列就知道了二维码的数据内容。

容量如下：

格式	容量
数字	最多7089字符
字母	最多4296字符
二进制数（8 bit）	最多2953字节
日文汉字/片假名	最多1817字符（采用Shift JIS）
中文汉字	最多984字符（采用UTF-8）
中文汉字	最多1800字符（采用BIG5）

模式编码如下：

模式	指示符
ECI	0111
数字	0001
字母数字	0010
8位字节	0100
日本汉字	1000
中文汉字	1101
结构链接	0011
FNCI	0101（第一位置）、1001（第二位置）
终止符（信息结尾）	0000

数据可以按照一种模式进行编码，以便进行更高效的解码。
例如：对数据：01234567编码（版本1-H），
①分组：012 345 67
②转成二进制：012→0000001100，，345→0101011001，67 →1000011
③转成序列：0000001100 0101011001 1000011
④字符数 转成二进制：8→0000001000
⑤加入模式指示符（上图数字）0001：0001 0000001000 0000001100 0101011001 1000011
对于字母、中文、日文等只是分组的方式、模式等内容有所区别。基本方法是一致的。

• 纠错编码：按需要将上面的码字序列分块，并根据纠错等级和分块的码字，产生纠错码字，并把纠错码字加入到数据码字序列后面，成为一个新的序列。
  在二维码规格和纠错等级确定的情况下，其实它所能容纳的码字总数和纠错码字数也就确定了，比如：版本10，纠错等级时H时，总共能容纳346个码字，其中224个纠错码字。
  就是说二维码区域中大约1/3的码字时冗余的。对于这224个纠错码字，它能够纠正112个替代错误（如黑白颠倒）或者224个据读错误（无法读到或者无法译码），这样纠错容量为：112/346=32.4%。

• 构造最终数据信息：在规格确定的条件下，将上面产生的序列按次序放如分块中。
  按规定把数据分块，然后对每一块进行计算，得出相应的纠错码字区块，把纠错码字区块 按顺序构成一个序列，添加到原先的数据码字序列后面。
  如：D1, D12, D23, D35, D2, D13, D24, D36, … D11, D22, D33, D45, D34, D46, E1, E23,E45, E67, E2, E24, E46, E68，…

• 构造矩阵：将探测图形、分隔符、定位图形、校正图形和码字模块放入矩阵中。
  
  把上面的完整序列填充到相应规格的二维码矩阵的区域中。

• 掩摸：将掩摸图形用于符号的编码区域，使得二维码图形中的深色和浅色（黑色和白色）区域能够比率最优的分布。

• 格式和版本信息：生成格式和版本信息放入相应区域内。
  版本7-40都包含了版本信息，没有版本信息的全为0。二维码上两个位置包含了版本信息，它们是冗余的。
  版本信息共18位，6X3的矩阵，其中6位时数据为，如版本号8，数据位的信息时 001000，后面的12位是纠错位。

三、代码分析

了解了上述QR码的编码过程，对于Zxing源代码的分析有很大的帮助。

QRCodeWriter

QRCodeWriter类是Zxing生成QR码的入口，它继承自父类Writer，其父类在上一篇博客中有提到。QRCodeWriter对象的作用是将二维码渲染为灰度值的二维位矩阵数组。

它默认安静区(Quiet Zone)的值为4（QUIET_ZONE_SIZE=4；），安静区是每个条形码开始和结束时的空白边缘空间,使扫描仪能够准确地读取信息。在大多数情况下,安静区不需要很大。

编码方法如下：此方法继承自Writer父类，具体代码分析都已注释在相应位置

@Override
  public BitMatrix encode(String contents,
                          BarcodeFormat format,
                          int width,
                          int height,
                          Map<EncodeHintType,?> hints) throws WriterException {
	//要编码的内容为空
    if (contents.isEmpty()) {
      throw new IllegalArgumentException("Found empty contents");
    }
	//要生成的不是QR码
    if (format != BarcodeFormat.QR_CODE) {
      throw new IllegalArgumentException("Can only encode QR_CODE, but got " + format);
    }
	//要生成的QR码长或宽小于0
    if (width < 0 || height < 0) {
      throw new IllegalArgumentException("Requested dimensions are too small: " + width + 'x' +
          height);
    }
	//纠错等级
    ErrorCorrectionLevel errorCorrectionLevel = ErrorCorrectionLevel.L;
    //安静区大小
    int quietZone = QUIET_ZONE_SIZE;
    //获取QR码的其他参数
    if (hints != null) {
    	//获取容错等级
      if (hints.containsKey(EncodeHintType.ERROR_CORRECTION)) {
        errorCorrectionLevel = ErrorCorrectionLevel.valueOf(hints.get(EncodeHintType.ERROR_CORRECTION).toString());
      }
      //获取边距
      if (hints.containsKey(EncodeHintType.MARGIN)) {
        quietZone = Integer.parseInt(hints.get(EncodeHintType.MARGIN).toString());
      }
    }
	//调用编码方法
    QRCode code = Encoder.encode(contents, errorCorrectionLevel, hints);
    //返回相应参数
    return renderResult(code, width, height, quietZone);
  }

渲染结果生成的私有方法如下：其输出为BitMatrix位矩阵

  // 请注意，输入矩阵使用0==白色，1==黑色，而输出矩阵使用0==黑色，255==白色（即8位灰度位图）。
  private static BitMatrix renderResult(QRCode code, int width, int height, int quietZone) {
    ByteMatrix input = code.getMatrix();
    if (input == null) {
      throw new IllegalStateException();
    }
    int inputWidth = input.getWidth();
    int inputHeight = input.getHeight();
    int qrWidth = inputWidth + (quietZone * 2);
    int qrHeight = inputHeight + (quietZone * 2);
    int outputWidth = Math.max(width, qrWidth);
    int outputHeight = Math.max(height, qrHeight);

    int multiple = Math.min(outputWidth / qrWidth, outputHeight / qrHeight);
    // 填充包括安静区和额外的白色像素，以适应要求的尺寸。
    // 例如，如果输入为25x25，QR将为33x33，包括安静区。如果请求的尺寸为200x160，则对于132x132的QR，倍数将为4。这些将处理从100x100（实际QR）到200x160的所有填充。
    int leftPadding = (outputWidth - (inputWidth * multiple)) / 2;
    int topPadding = (outputHeight - (inputHeight * multiple)) / 2;

    BitMatrix output = new BitMatrix(outputWidth, outputHeight);

    for (int inputY = 0, outputY = topPadding; inputY < inputHeight; inputY++, outputY += multiple) {
      // 写入条形码此行的内容
      for (int inputX = 0, outputX = leftPadding; inputX < inputWidth; inputX++, outputX += multiple) {
        if (input.get(inputX, inputY) == 1) {
          output.setRegion(outputX, outputY, multiple, multiple);
        }
      }
    }

    return output;
  }

参考资料

QR码生成原理
二维码（QR code）基本结构及生成原理