因行动设备的流行而跟着带动起来的 QR Code,是众多条码类型的其中一种,它让我们的生活更便利,传递信息的速度更快,省下许多使用键盘打字的时间。如果要产生出 QR Code,已经有许多相关的现成工具能够使用,甚至还能直接在网页上产生。可是如果要我们自己来做的话,究竟要如何才能产生 QR Code 呢?

magic-qr-code

magic-qr-code 是一个使用 Node.js 8 之后才支持的 N-API 所开发的模块,引用了这个函数库「QR Code generator library」(Rust 语言)来编码出 QR Code 的数据。

npmjs.com

npm 安装指令

npm install magic-qr-code

使用方法

将字符串编码成 QR Code

使用模块提供的 encodeString 函数可以将任意字符串编码成 QR Code 数据;encodeBuffer 函数则可以将任意 Buffer 编码成 QR Code 数据。用法如下:

import { encodeString } from "magic-qr-code";

encodeString("任意文字");

如果想要控制 QR Code 的容错率,可以再加上第二个参数,用法如下:

import { encodeString, ErrorCorrection } from "magic-qr-code";

encodeString("任意文字", ErrorCorrection.High);

以上的 ErrorCorrection.High 表示 30% 的容错率。另外还有 25% 的 ErrorCorrection.Quartile、15% 的 ErrorCorrection.Medium 和 7% 的 ErrorCorrection.Low。相同的任意文字,使用愈高的容错率编码出来的 QR Code 的「版本」(version)愈高,换句话说,QR Code 的数据量会愈大,呈现出来的点数会愈多。当然,增加容错率,并不一定会提升 QR Code 的版本,数据量还是得要超过该 QR Code 版本的上限,版本才会再往上提升。

这个模块会自动以该 QR Code 版本能够容许的最大容错率来选择容错率。举例来说,如果相同的任意文字使用 ErrorCorrection.Quartile 和 ErrorCorrection.High 所编码出来的 QR Code 都是同一个版本,就算我们传给 encodeString 或 encodeBuffer 函数的第二个参数是 ErrorCorrection.Quartile,这个模块会自动使用 ErrorCorrection.High 来进行编码。

QR Code 有区分不同的字符集,如果要被编码的字符串都是数字,就会使用数值(Numeric)模式来进行编码;如果要被编码的字符串都是数字、大写英文字母和部份有涵盖的标点符号,就会使用英数字(Alphanumeric)模式来进行编码。QR Code 编码的模式还会影响到每个版本所能容许的字符串长度,好像很复杂对吧?但是别紧张,使用这个模块来编码 QR Code,会自动选择合适的模式来进行编码,保证最后编码出来的 QR Code 是版本最小、容错率最高的!

encodeString 函数将字符串编码成 QR Code 的数据后,会以 Buffer 数组(Buffer[])的形式回传。如下:

import { encodeString } from "magic-qr-code";

const result = encodeString("https://magiclen.org".toUpperCase());
/*
 [
  <Buffer 01 01 01 01 01 01 01 00 01 01 00 00 01 00 01 01 01 01 01 01 01>,
  <Buffer 01 00 00 00 00 00 01 00 01 01 01 00 00 00 01 00 00 00 00 00 01>,
  <Buffer 01 00 01 01 01 00 01 00 01 01 01 00 00 00 01 00 01 01 01 00 01>,
  <Buffer 01 00 01 01 01 00 01 00 00 01 01 01 00 00 01 00 01 01 01 00 01>,
  <Buffer 01 00 01 01 01 00 01 00 01 00 00 01 01 00 01 00 01 01 01 00 01>,
  <Buffer 01 00 00 00 00 00 01 00 00 01 00 01 01 00 01 00 00 00 00 00 01>,
  <Buffer 01 01 01 01 01 01 01 00 01 00 01 00 01 00 01 01 01 01 01 01 01>,
  <Buffer 00 00 00 00 00 00 00 00 00 01 01 00 00 00 00 00 00 00 00 00 00>,
  <Buffer 01 00 00 01 01 01 01 01 01 00 00 01 00 01 00 00 01 00 01 01 01>,
  <Buffer 01 00 01 00 01 01 00 01 01 01 01 01 01 01 00 01 01 00 00 00 00>,
  <Buffer 00 00 01 00 01 00 01 00 01 01 01 01 00 00 01 00 00 01 00 00 00>,
  <Buffer 00 01 01 01 01 00 00 01 01 01 01 00 01 01 00 00 01 00 01 01 00>,
  <Buffer 00 01 00 01 00 01 01 00 01 01 01 01 00 01 01 01 00 01 00 01 01>,
  <Buffer 00 00 00 00 00 00 00 00 01 01 00 00 00 01 00 00 01 01 01 00 00>,
  <Buffer 01 01 01 01 01 01 01 00 01 00 01 00 00 01 00 00 00 01 01 01 00>,
  <Buffer 01 00 00 00 00 00 01 00 01 00 01 01 00 01 00 01 00 01 01 00 00>,
  <Buffer 01 00 01 01 01 00 01 00 01 01 01 00 01 00 01 01 00 01 01 00 00>,
  <Buffer 01 00 01 01 01 00 01 00 01 00 00 00 00 01 00 01 01 00 01 00 00>,
  <Buffer 01 00 01 01 01 00 01 00 00 01 00 00 00 00 01 00 00 01 00 01 01>,
  <Buffer 01 00 00 00 00 00 01 00 00 00 00 00 00 00 01 01 00 00 01 01 00>,
  <Buffer 01 01 01 01 01 01 01 00 01 01 00 01 01 01 00 00 00 01 00 01 00>
 ]
*/
将 QR Code 数据画成图

encodeString 函数会回传 Buffer 数组,每个 Buffer 均表示一排 QR Code 图形的横向数据,Buffer 中的值只会有 0 或 1。0 表示为白点;1 表示为黑点。利用这笔数据,我们就可以产生出 QR Code 的图形了!

Node.js 有一个强大的画图模块──canvas。这个 canvas 模块是用 C++ 语言来实作的,性能极佳。

将 canvas 模块和 magic-qr-code 模块搭配使用的代码如下:

import { writeFileSync } from "node:fs";

import { encodeString } from "magic-qr-code";
import { createCanvas } from "canvas";

const result = encodeString("https://magiclen.org".toUpperCase());

function draw(data: Buffer[], size = 1024) {
    const marginSize = 1;
    const dataLength = data.length;
    const dataLengthWithMargin = dataLength + (2 * marginSize);
    const canvas = createCanvas(size, size);
    const ctx = canvas.getContext("2d");
    const pointSize = Math.floor(size / dataLengthWithMargin);

    if (pointSize === 0) {
        throw new Error("cannot draw this QR Code");
    }

    const margin = Math.floor((size - (pointSize * dataLength)) / 2);

    ctx.fillStyle = "white";
    ctx.fillRect(0, 0, size, size);
    ctx.fillStyle = "black";

    for (let i = 0;i < dataLength;++i) {
        for (let j = 0;j < dataLength;++j) {
            if (data[i][j]) {
                const x = (j * pointSize) + margin;
                const y = (i * pointSize) + margin;

                ctx.fillRect(x, y, pointSize, pointSize);
            }
        }
    }

    return canvas;
}

const canvas = draw(result);

// Output

const pngBuffer = canvas.toBuffer();

writeFileSync("./out.png", pngBuffer);

以上程序会成功输出底下这张 PNG 格式的 QR Code:

以 Node.js 产生的 QR Code