一、安裝
項(xiàng)目文件夾中執(zhí)行
npm install --save qrcode
或者，全局安裝
npm install -g qrcode
二、使用
在javascript中使用
Module bundlers
<!-- index.html -->
<html>
<body>
<canvas id="canvas"></canvas>
<script src="bundle.js"></script>
</body>
</html>
// index.js -> bundle.js
var QRCode = require('qrcode')
var canvas = document.getElementById('canvas')
QRCode.toCanvas(canvas, 'sample text', function (error) {
if (error) console.error(error)
console.log('success!');
})
Precompiled bundle
<canvas id="canvas"></canvas>
<script src="/build/qrcode.min.js"></script>
<script>
QRCode.toCanvas(document.getElementById('canvas'), 'sample text', function (error) {
if (error) console.error(error)
console.log('success!');
})
</script>
如果通過(guò)npm安裝，文件存儲(chǔ)在node_modules/qrcode/build/folder中。
在ES6/ES7中使用
import QRCode from 'qrcode'
// import引入可能會(huì)導(dǎo)致報(bào)錯(cuò)，可以嘗試require
// const QRCode = require('qrcode');
// With promises
QRCode.toDataURL('I am a pony!')
.then(url => {
console.log(url)
})
.catch(err => {
console.error(err)
})
// With async/await
const generateQR = async text => {
try {
console.log(await QRCode.toDataURL(text))
} catch (err) {
console.error(err)
}
}
三、模糊識(shí)別（此處為意譯，原文直譯為：糾錯(cuò)級(jí)別）
在二維碼部分模糊的情況下依然可以進(jìn)行識(shí)別，分為四個(gè)識(shí)別等級(jí)。更高的級(jí)別可以識(shí)別更模糊的二維碼，但會(huì)降低二維碼的容量（見(jiàn)第四節(jié)）。
如果生成的二維碼不會(huì)被破壞，建議使用低識(shí)別等級(jí)。
| 等級(jí) | 最大模糊面積 |
|---|---|
| L（低級(jí)） | ≤7% |
| M（中級(jí)） | ≤15% |
| Q（四分之一） | ≤25% |
| H（高級(jí)） | ≤30% |
可以通過(guò)options.errorCorrectionLevel屬性設(shè)置錯(cuò)誤級(jí)別。
如果未指定，則默認(rèn)值為M。
QRCode.toDataURL('some text', { errorCorrectionLevel: 'H' }, function (err, url) {
console.log(url)
})
四、二維碼容量
容量取決于二維碼的版本和模糊識(shí)別等級(jí)，編碼模式也會(huì)影響可存儲(chǔ)數(shù)據(jù)的量。
二維碼版本：即二維碼的規(guī)格，二維碼共有40種規(guī)格的矩陣，從21x21（版本1），到177x177（版本40），每一版本比前一版本的邊增加4個(gè)模塊。
下表顯示了每種編碼模式和每個(gè)模糊識(shí)別等級(jí)的最大可存儲(chǔ)字符數(shù)。
| 編碼模式 | L（低級(jí)） | M（中級(jí)） | Q（四分之一） | H（高級(jí)） |
|---|---|---|---|---|
| 數(shù)字 | 7089 | 5596 | 3993 | 3057 |
| 數(shù)字+字母 | 4296 | 3391 | 2420 | 1852 |
| 字節(jié) | 2953 | 2331 | 1663 | 1273 |
| 漢字 | 1817 | 1435 | 1024 | 784 |
注意：使用混合模式（見(jiàn)第五節(jié)）時(shí)，最大字符數(shù)可能不同。
可以通過(guò)options.version屬性設(shè)置二維碼版本。
如果未指定版本，則將使用更合適的值。除非需要特定版本，否則不需要此選項(xiàng)。
QRCode.toDataURL('some text', { version: 2 }, function (err, url) {
console.log(url)
})
五、編碼模式
編碼模式可以更有效的方式編碼字符串。編碼模式取決于字符串內(nèi)容。
| 編碼模式 | 字符 | 壓縮 |
|---|---|---|
| 數(shù)字 | 0, 1, 2, 3, 4, 5, 6, 7, 8, 9 | 3個(gè)字符由10位表示 |
| 數(shù)字+字母 | 0–9, A–Z (大寫(xiě)), 空格, $, %, *, +, -, ., /, : | 2個(gè)字符由11位表示 |
| 漢字 | 基于JIS X 0208的Shift JIS系統(tǒng)的特征 | 2個(gè)漢字由13位表示 |
| 字節(jié) | ISO / IEC 8859-1字符集中的字符 | 每個(gè)字符由8位表示 |
如果輸入文本未知，選擇正確的模式可能會(huì)很棘手。
在這些情況下，字節(jié)模式是最佳選擇，因?yàn)樗凶址伎梢杂盟M(jìn)行編碼。
但是，如果QR碼閱讀器支持混合模式，則使用自動(dòng)模式可能會(huì)產(chǎn)生更好的效果。
混合模式
混合模式也是可能的?？梢詮木哂胁煌幋a模式的一系列段生成二維碼以?xún)?yōu)化數(shù)據(jù)壓縮。
但是，從模式切換到另一種模式的成本可能會(huì)導(dǎo)致最壞的結(jié)果，如果不考慮它。有關(guān)如何指定具有不同編碼模式的段的示例，請(qǐng)參見(jiàn)手動(dòng)模式。
自動(dòng)模式
默認(rèn)使用自動(dòng)模式。輸入字符串在各種段中自動(dòng)分割，優(yōu)化后使用混合模式產(chǎn)生最短的比特流。
這是生成二維碼的首選方式。
例如，字符串ABCDE12345678？A1A將分為3個(gè)段，具有以下模式：
| 分割 | 編碼模式 |
|---|---|
| ABCDE | 數(shù)字+字母 |
| 12345678 | 數(shù)字 |
| ？A1A | 字節(jié) |
段和模式的任何其他組合將導(dǎo)致更長(zhǎng)的比特流。
如果您需要保持較小的QR碼，此模式將產(chǎn)生最佳效果。
手動(dòng)模式
如果自動(dòng)模式不適合您或您有特定需求，也可以使用手動(dòng)模式指定每個(gè)段。通過(guò)這種方式，不會(huì)應(yīng)用任何段優(yōu)化。
分段列表可以作為對(duì)象數(shù)組傳遞：
var QRCode = require('qrcode')
var segs = [
{ data: 'ABCDEFG', mode: 'alphanumeric' },
{ data: '0123456', mode: 'numeric' }
]
QRCode.toDataURL(segs, function (err, url) {
console.log(url)
})
漢字模式
使用漢字模式可以以?xún)?yōu)化的方式對(duì)
ShiftJIS系統(tǒng)中的字符進(jìn)行編碼。
遺憾的是，沒(méi)有辦法從例如以UTF-8編碼的字符計(jì)算ShiftedJIS值，因此需要從輸入字符到SJIS值的轉(zhuǎn)換表。
默認(rèn)情況下，此表不包含在包中，以使包盡可能小。如果您的應(yīng)用程序需要漢字支持，則需要傳遞一個(gè)函數(shù)，該函數(shù)負(fù)責(zé)將輸入字符轉(zhuǎn)換為適當(dāng)?shù)闹怠?br> lib通過(guò)可選文件提供輔助方法，您可以包含該文件，如下例所示。
注意：僅當(dāng)您希望受益于數(shù)據(jù)壓縮時(shí)才需要支持漢字模式，否則仍然可以使用字節(jié)模式對(duì)漢字進(jìn)行編碼。
var QRCode = require('qrcode')
var toSJIS = require('qrcode/helper/to-sjis')
QRCode.toDataURL(kanjiString, { toSJISFunc: toSJIS }, function (err, url) {
console.log(url)
})
使用預(yù)編譯包：
<canvas id="canvas"></canvas>
<script src="/build/qrcode.min.js"></script>
<script src="/build/qrcode.tosjis.min.js"></script>
<script>
QRCode.toCanvas(document.getElementById('canvas'),
'sample text', { toSJISFunc: QRCode.toSJIS }, function (error) {
if (error) console.error(error)
console.log('success!')
})
</script>
六、多字節(jié)字符
初始二維碼標(biāo)準(zhǔn)中不存在對(duì)多字節(jié)字符的支持，但可以在字節(jié)模式下編碼UTF-8字符。
二維碼提供了一種通過(guò)ECI（擴(kuò)展信道解釋?zhuān)┲付ú煌?lèi)型字符集的方法，但它尚未在此lib中完全實(shí)現(xiàn)。
但是，大多數(shù)二維碼閱讀器即使沒(méi)有ECI也能識(shí)別多字節(jié)字符。
請(qǐng)注意，單個(gè)漢字/假名或表情符號(hào)最多可占用4個(gè)字節(jié)。
