node-qrcode 二维码生成器完全使用指南

node-qrcode 二维码生成器完全使用指南

【免费下载链接】node-qrcode qr code generator 项目地址: https://gitcode.com/gh_mirrors/no/node-qrcode

node-qrcode 是一个功能强大的二维码生成库，支持在 Node.js 和浏览器环境中使用。它提供了丰富的配置选项，可以生成各种格式的二维码，包括 PNG、SVG 和终端文本格式。

安装与基础使用

安装方法

通过 npm 安装 node-qrcode：

npm install qrcode

基本用法示例

生成一个简单的二维码并转换为 Data URL：

const QRCode = require('qrcode');

QRCode.toDataURL('https://example.com', function (err, url) {
  if (err) throw err;
  console.log(url);
});

核心功能详解

服务器端使用

在服务器端将二维码保存为图片文件：

const QRCode = require('qrcode');

QRCode.toFile('./qrcode.png', '需要编码的文本', {
  color: {
    dark: '#000000',
    light: '#ffffff'
  }
}, function (err) {
  if (err) throw err;
  console.log('二维码已保存！');
});

浏览器端使用

在浏览器中直接显示二维码：

const QRCode = require('qrcode');

QRCode.toCanvas(document.getElementById('canvas'), '文本内容', function (err) {
  if (err) console.error(err);
  console.log('二维码生成成功！');
});

命令行工具

node-qrcode 还提供了命令行工具，可以直接在终端中使用：

// 在终端中显示二维码
qrcode "Hello World"

// 保存为PNG文件
qrcode -o output.png "Hello World"

// 自定义颜色
qrcode -d FF0000 -l FFFFFF -o qrcode.png "自定义内容"

高级配置选项

错误纠正级别

node-qrcode 支持四种错误纠正级别，适用于不同的使用场景：

• L (低) - 约7%的容错能力
• M (中) - 约15%的容错能力（默认）
• Q (四分位) - 约25%的容错能力
• H (高) - 约30%的容错能力

编码模式

支持多种编码模式，可根据内容类型选择最优方式：

• 数字模式 - 专门用于数字编码
• 字母数字模式 - 用于大写字母、数字和特定符号
• 字节模式 - 支持任意字节数据
• 汉字模式 - 专门用于日文汉字编码

自定义样式选项

可以自定义二维码的外观：

QRCode.toDataURL('文本内容', {
  width: 300,
  margin: 2,
  color: {
    dark: '#000000FF', // 黑色前景
    light: '#FFFFFFFF'  // 白色背景
  }
}, function (err, url) {
  // 处理生成的二维码
});

实际应用场景

Web 应用集成

在 Express 应用中提供二维码生成 API：

const express = require('express');
const QRCode = require('qrcode');
const app = express();

app.get('/qr', async (req, res) => {
  const { text = '默认文本' } = req.query;
  try {
    const qrImage = await QRCode.toDataURL(text);
    res.send(`<img src="${qrImage}" alt="生成的二维码">');
  } catch (err) {
    res.status(500).send('生成二维码失败');
  }
});

终端应用

在命令行工具中直接生成和显示二维码：

const QRCode = require('qrcode');

QRCode.toString('终端显示的二维码', { type: 'terminal' }, function (err, string) {
  console.log(string);
});

项目结构与示例

项目文件组织

项目采用模块化设计，主要代码位于 lib 目录下：

• lib/core/ - 核心二维码生成算法
• lib/renderer/ - 不同输出格式的渲染器
• examples/ - 丰富的使用示例

示例图片

项目中包含示例图片，展示了二维码的实际效果：

技术特性

跨平台支持

• 完整的 Node.js 环境支持
• 浏览器端兼容性良好
• 支持 React Native（使用 SVG 格式）

性能优化

• 自动选择最优编码模式
• 支持混合模式编码
• 智能数据压缩

多语言支持

• 支持中文、日文、希腊文等多种字符集
• 支持多字节字符（包括表情符号）

node-qrcode 是一个成熟稳定的二维码生成解决方案，无论是简单的网址分享还是复杂的商业应用，都能提供可靠的二维码生成服务。其丰富的配置选项和良好的跨平台兼容性，使其成为开发者的首选工具。

【免费下载链接】node-qrcode qr code generator 项目地址: https://gitcode.com/gh_mirrors/no/node-qrcode