js生成二維碼——QRCode.js中文文檔

QRCode v1.2.2
原文地址
API文檔

一、安裝

項(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> 

如果通過npm安裝,文件存儲在node_modules/qrcode/build/folder中。

在ES6/ES7中使用

import QRCode from 'qrcode' 
// import引入可能會導(dǎo)致報(bào)錯,可以嘗試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)
  }
}

三、模糊識別(此處為意譯,原文直譯為:糾錯級別)

在二維碼部分模糊的情況下依然可以進(jìn)行識別,分為四個識別等級。更高的級別可以識別更模糊的二維碼,但會降低二維碼的容量(見第四節(jié))。
如果生成的二維碼不會被破壞,建議使用低識別等級。

等級 最大模糊面積
L(低級) ≤7%
M(中級) ≤15%
Q(四分之一) ≤25%
H(高級) ≤30%

可以通過options.errorCorrectionLevel屬性設(shè)置錯誤級別。
如果未指定,則默認(rèn)值為M。

QRCode.toDataURL('some text', { errorCorrectionLevel: 'H' }, function (err, url) {
  console.log(url)
})

四、二維碼容量

容量取決于二維碼的版本和模糊識別等級,編碼模式也會影響可存儲數(shù)據(jù)的量。

二維碼版本:即二維碼的規(guī)格,二維碼共有40種規(guī)格的矩陣,從21x21(版本1),到177x177(版本40),每一版本比前一版本的邊增加4個模塊。

下表顯示了每種編碼模式和每個模糊識別等級的最大可存儲字符數(shù)。

編碼模式 L(低級) M(中級) Q(四分之一) H(高級)
數(shù)字 7089 5596 3993 3057
數(shù)字+字母 4296 3391 2420 1852
字節(jié) 2953 2331 1663 1273
漢字 1817 1435 1024 784

注意:使用混合模式(見第五節(jié))時,最大字符數(shù)可能不同。

可以通過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個字符由10位表示
數(shù)字+字母 0–9, A–Z (大寫), 空格, $, %, *, +, -, ., /, : 2個字符由11位表示
漢字 基于JIS X 0208的Shift JIS系統(tǒng)的特征 2個漢字由13位表示
字節(jié) ISO / IEC 8859-1字符集中的字符 每個字符由8位表示

如果輸入文本未知,選擇正確的模式可能會很棘手。
在這些情況下,字節(jié)模式是最佳選擇,因?yàn)樗凶址伎梢杂盟M(jìn)行編碼。
但是,如果QR碼閱讀器支持混合模式,則使用自動模式可能會產(chǎn)生更好的效果。

混合模式

混合模式也是可能的??梢詮木哂胁煌幋a模式的一系列段生成二維碼以優(yōu)化數(shù)據(jù)壓縮。
但是,從模式切換到另一種模式的成本可能會導(dǎo)致最壞的結(jié)果,如果不考慮它。有關(guān)如何指定具有不同編碼模式的段的示例,請參見手動模式。

自動模式

默認(rèn)使用自動模式。
輸入字符串在各種段中自動分割,優(yōu)化后使用混合模式產(chǎn)生最短的比特流。
這是生成二維碼的首選方式。
例如,字符串ABCDE12345678?A1A將分為3個段,具有以下模式:

分割 編碼模式
ABCDE 數(shù)字+字母
12345678 數(shù)字
?A1A 字節(jié)

段和模式的任何其他組合將導(dǎo)致更長的比特流。
如果您需要保持較小的QR碼,此模式將產(chǎn)生最佳效果。

手動模式

如果自動模式不適合您或您有特定需求,也可以使用手動模式指定每個段。通過這種方式,不會應(yīng)用任何段優(yōu)化。
分段列表可以作為對象數(shù)組傳遞:

var QRCode = require('qrcode')
 
var segs = [
  { data: 'ABCDEFG', mode: 'alphanumeric' },
  { data: '0123456', mode: 'numeric' }
]
 
QRCode.toDataURL(segs, function (err, url) {
  console.log(url)
})

漢字模式

使用漢字模式可以以優(yōu)化的方式對Shift JIS系統(tǒng)中的字符進(jìn)行編碼。
遺憾的是,沒有辦法從例如以UTF-8編碼的字符計(jì)算Shifted JIS值,因此需要從輸入字符到SJIS值的轉(zhuǎn)換表。
默認(rèn)情況下,此表不包含在包中,以使包盡可能小。

如果您的應(yīng)用程序需要漢字支持,則需要傳遞一個函數(shù),該函數(shù)負(fù)責(zé)將輸入字符轉(zhuǎn)換為適當(dāng)?shù)闹怠?/p>

lib通過可選文件提供輔助方法,您可以包含該文件,如下例所示。

注意:僅當(dāng)您希望受益于數(shù)據(jù)壓縮時才需要支持漢字模式,否則仍然可以使用字節(jié)模式對漢字進(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)中不存在對多字節(jié)字符的支持,但可以在字節(jié)模式下編碼UTF-8字符。

二維碼提供了一種通過ECI(擴(kuò)展信道解釋)指定不同類型字符集的方法,但它尚未在此lib中完全實(shí)現(xiàn)。

但是,大多數(shù)二維碼閱讀器即使沒有ECI也能識別多字節(jié)字符。

請注意,單個漢字/假名或表情符號最多可占用4個字節(jié)。


七、API文檔

點(diǎn)此跳轉(zhuǎn)至https://www.npmjs.com/package/qrcode#api

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時請結(jié)合常識與多方信息審慎甄別。
平臺聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點(diǎn),簡書系信息發(fā)布平臺,僅提供信息存儲服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

  • 字符是用戶可以讀寫的最小單位。計(jì)算機(jī)所能支持的字符組成的集合,就叫做字符集。字符集通常以二維表的形式存在。二維表的...
    劉惜有閱讀 8,398評論 2 14
  • ??金星老師說:等我女兒長大了,我會告訴她,如果一個男人心疼你擠公交,埋怨你不按時吃飯,一直提醒你少喝酒傷身體,陰雨...
    誰道青春瘋狂閱讀 170評論 1 2
  • 還是個小姑娘的時候,我扎著高高的馬尾,戴著鮮艷的發(fā)帶,或紅或綠或粉,每天象個花蝴蝶圍著大人們飛來飛去。媽媽是個整潔...
    木蘭禪舞閱讀 443評論 0 2
  • 文/陳葉子 天色將暗,城市里各種標(biāo)志性的建筑上都亮起了燈,讓人不能不感受到整個城市的繁華。我與她并肩走進(jìn)這家餐館,...
    chenyezizjnu閱讀 325評論 0 0

友情鏈接更多精彩內(nèi)容