Node.js二维码生成器node-qrcode完全使用指南
【免费下载链接】node-qrcode qr code generator 
项目地址: https://gitcode.com/gh_mirrors/no/node-qrcode
node-qrcode是一个功能强大的二维码生成库，支持在服务器端和客户端生成QR码。本文将详细介绍该库的安装、配置和使用方法，帮助您快速掌握二维码生成技术。
项目概述
node-qrcode是一个纯JavaScript实现的二维码生成器，具有以下特性：
- 支持服务器端和客户端使用
- 提供CLI命令行工具
- 可将二维码保存为多种格式的图片
- 支持数字、字母数字、汉字和字节模式
- 支持混合模式
- 支持多字节字符（包括表情符号）
- 自动生成优化的数据段，实现最佳数据压缩和最小QR码尺寸
安装方法
本地安装
在项目目录中执行：
npm install --save qrcode
全局安装
如需在命令行中使用qrcode工具，可全局安装：
npm install -g qrcode
核心API详解
浏览器端API
toCanvas方法
将二维码绘制到Canvas元素上：
var QRCode = require('qrcode')
var canvas = document.getElementById('canvas')
QRCode.toCanvas(canvas, 'sample text', function (error) {
if (error) console.error(error)
console.log('success!')
})
toDataURL方法
生成包含二维码图像的Data URL：
var QRCode = require('qrcode')
QRCode.toDataURL('I am a pony!', function (err, url) {
console.log(url)
})
toString方法
返回二维码的字符串表示：
var QRCode = require('qrcode')
QRCode.toString('I am a pony!', {type: 'terminal'}, function (err, url) {
console.log(url)
})
服务器端API
toFile方法
将二维码保存为图像文件：
var QRCode = require('qrcode')
QRCode.toFile('path/to/filename.png', 'Some text', {
color: {
dark: '#00F', // 蓝色点
light: '#0000' // 透明背景
}, function (err) {
if (err) throw err
console.log('done')
})
错误纠正级别
QR码支持四种错误纠正级别，适用于不同的使用环境：
| 级别 | 错误纠正能力 | 说明 |
|---|---|---|
| L (低) | ~7% | 适用于清洁环境 |
| M (中) | ~15% | 默认级别 |
| Q (四分之一) | ~25% | 中等错误抵抗 |
| H (高) | ~30% | 适用于易受损环境 |
编码模式
node-qrcode支持多种编码模式，可根据内容自动选择最优模式：
数字模式
仅包含数字0-9，每3个字符用10位表示
字母数字模式
包含数字0-9、大写字母A-Z以及特殊字符，每2个字符用11位表示
汉字模式
支持Shift JIS系统中的汉字字符，每2个汉字用13位表示
字节模式
可编码ISO/IEC 8859-1字符集中的所有字符，每个字符用8位表示
实际应用示例
基础使用
const QRCode = require('qrcode')
// 生成Data URL
QRCode.toDataURL('Hello World!', function (err, url) {
console.log(url)
})
// 使用Promise
QRCode.toDataURL('Hello World!')
.then(url => {
console.log(url)
})
.catch(err => {
console.error(err)
})
高级配置
const options = {
errorCorrectionLevel: 'H',
type: 'image/png',
quality: 0.92,
margin: 1,
color: {
dark: '#010599FF',
light: '#FFBF60FF'
}
}
QRCode.toDataURL('text', options, function (err, url) {
if (err) throw err
var img = document.getElementById('image')
img.src = url
})
多字节字符支持
虽然QR码标准最初不支持多字节字符，但node-qrcode支持在字节模式下编码UTF-8字符。大多数QR码阅读器即使没有ECI（扩展通道解释）也能识别多字节字符。
命令行工具使用
node-qrcode提供了强大的CLI工具，可通过以下命令使用：
# 在终端显示二维码
qrcode "some text"
# 保存为PNG图像
qrcode -o out.png "some text"
// 使用红色作为前景色
qrcode -d F00 -o out.png "some text"
主要命令行选项：
-v, --qversion：QR码版本（1-40）-e, --error：错误纠正级别-t, --type：输出类型（png、svg、utf8）-o, --output：输出文件
性能优化建议
- 选择合适的错误纠正级别：根据使用环境选择适当的级别
- 使用自动模式：让库自动选择最优编码方式
- 批量生成时使用缓存：重复内容可缓存结果
常见问题解决
汉字编码问题
如需支持汉字模式，需要引入辅助函数：
var QRCode = require('qrcode')
var toSJIS = require('qrcode/helper/to-sjis')
QRCode.toDataURL(kanjiString, { toSJISFunc: toSJIS }, function (err, url) {
console.log(url)
})
二进制数据处理
处理二进制数据时，需要使用适当的数组类型：
// Uint8ClampedArray示例
const QRCode = require('qrcode')
QRCode.toFile(
'foo.png',
[{ data: new Uint8ClampedArray([253,254,255]), mode: 'byte' }],
...options...
)
通过本指南，您应该能够熟练使用node-qrcode库在各种场景下生成二维码。该库功能完善、使用简单，是Node.js项目中二维码生成的首选方案。
【免费下载链接】node-qrcode qr code generator 项目地址: https://gitcode.com/gh_mirrors/no/node-qrcode
创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考
