基于 WebSocket 与 pdfmake 构建实时 PDF 文档推送服务
pdfmake 是一个基于纯 JavaScript 构建的文档生成引擎,支持在 Node.js 服务端及浏览器客户端高效输出 PDF 文件。将 pdfmake 与 WebSocket 技术相结合,可以构建出一套响应迅速的实时 PDF 生成与推送架构。
核心环境初始化
在开始开发前,需确保 Node.js 环境已就绪。通过 npm 安装 pdfmake 及其依赖:
npm install pdfmake
PDF 文档定义与生成
pdfmake 通过 JSON 结构描述文档内容。以下示例展示了如何在服务端定义内容并将其输出为 PDF 流:
const PdfPrinter = require('pdfmake');
const fontDescriptors = {
Roboto: {
normal: 'fonts/Roboto-Regular.ttf',
bold: 'fonts/Roboto-Medium.ttf'
}
};
const printer = new PdfPrinter(fontDescriptors);
function generateDocument(contentData) {
const docDefinition = {
content: [
{ text: '实时生成的报告', style: 'header' },
{ text: contentData }
]
};
return printer.createPdfKitDocument(docDefinition);
}
构建 WebSocket 实时交互管道
利用 WebSocket 实现全双工通信,可以由客户端触发生成请求,服务端完成渲染后直接回传二进制流。以下是使用 ws 库的逻辑实现思路:
const WebSocket = require('ws');
const wss = new WebSocket.Server({ port: 8080 });
wss.on('connection', (ws) => {
ws.on('message', (message) => {
const data = JSON.parse(message);
// 调用生成器获取 PDF 流
const pdfDoc = generateDocument(data.content);
let chunks = [];
pdfDoc.on('data', (chunk) => chunks.push(chunk));
pdfDoc.on('end', () => {
const result = Buffer.concat(chunks);
ws.send(result); // 将二进制 PDF 数据推送到前端
});
pdfDoc.end();
});
});
架构扩展建议
- 并发控制:在高并发场景下,建议引入 Bull 或 RabbitMQ 等消息队列,将 PDF 渲染任务异步化,避免 Node.js 单线程阻塞。
- 内存管理:直接在内存中处理 PDF 流适用于小文件,对于大型报表,应优先将生成的流写入临时磁盘路径或 Blob 对象存储,随后通过 URL 回传。
- 样式模板化:将复杂的文档结构封装为函数或模板引擎,通过传入动态 JSON 参数进行数据填充,以保持代码逻辑的可维护性。
- 资源缓存:针对频繁请求的固定内容,可计算请求参数的哈希值作为缓存 Key,实现命中缓存直接返回 PDF,显著降低 CPU 消耗。