HTML 转 PDF 最佳实现方案
随着 Web 技术的发展,有很多需要将 HTML 内容转换为 PDF 文档并下载的场景,比如常见的收据、发票、电子报告、对账清单、文档翻译等等。
本文将研究当前比较流行的基于 Node.js 技术栈的 HTML 转 PDF 库:Puppeteer、jsPDF 和 PDFKit,大纲如下:
Puppeteer 是谷歌开发的一个 Node.js 库,为控制无头(或完整)Chrome 或 Chromium 浏览器提供了一个高级 API。它是最流行的开源 HTML 到 PDF 转换器,支持 HTML、CSS 和 Javascript。
Puppeteer 允许您自动化Web浏览器中的各种任务,例如 Web 抓取、网站测试、截图创建和 PDF 生成。它利用 Chrome 或 Chromium Web 浏览器的功能将 HTML 内容呈现为 PDF 文件。
下面使用 Puppeteer 快速初始化一个项目:
nvm use 20.6.1
mkdir puppeteer-demo
cd puppeteer-demo
npm init -y
npm install puppeteer
touch index.js
在 index.js 中添加如下代码:
import puppeteer from 'puppeteer';
(async () => {
const browser = await puppeteer.launch({
headless: 'new',
});
const page = await browser.newPage();
await page.setContent(
`<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Document</title>
</head>
<body>
<style>
body {
display: grid;
place-items: center;
margin: 0;
background-color: #ccc;
min-height: 100vh;
}
</style>
<h1>Hello, Puppeteer!</h1>
</body>
</html>`
);
await page.pdf({ path: 'result.pdf', format: 'A4' });
await browser.close();
})();
在上面的代码中,我们导入 Puppeteer 库,启动无头 Chromium 浏览器,并在浏览器中创建一个新页面。我们还会根据页面内容和指定选项(如路径和格式)生成 PDF,生成完成后关闭浏览器并释放资源。
PDFKit 是 Javascript 生态系统中最古老和最成熟的 PDF库 之一。目前仍得到良好维护并定期更新。该库通常使用 Node.js 在服务器端环境中创建和操作 PDF 文档。它允许您通过定义每个页面的内容、布局和格式来以程序方式生成PDF文件。
PDFKit 提供了用于 PDF 文档生成的高级 API,并支持各种功能,使其成为创建自定义 PDF 的多功能工具。作为 PDFKit 的包装器,已开发出多个 PDF 库,支持自定义字体和图像嵌入。
让我们来快速初始化一个 PDFKit 项目:
nvm use 20.6.1
mkdir pdfkit-demo
cd pdfkit-demo
npm init -y
npm install pdfkit
touch index.js
在 index.js 中添加如下代码:
import fs from 'node:fs';
import PDFDocument from 'pdfkit';
const doc = new PDFDocument();
const stream = fs.createWriteStream('example.pdf');
doc.pipe(stream);
doc.fontSize(12).text('Hello, PDFKit!', { align: 'center' });
doc.end();
stream.on('finish', () => {
console.log('success');
});
执行 node index.js 后,可以看到 PDF 可以生成生成,并触发 finish 事件的回调函数执行,打印出了 success 。
jsPDF 是一个流行的 Javascript PDF 生成器,允许用户动态在 Web 浏览器中生成 PDF 文件。这个库维护良好,稳定易用,并且有丰富的文档。
jsPDF 在客户端操作,非常适合在 Web 应用程序中生成 PDF ,无需在服务器端生成。它可以修改现有布局,并允许用户通过自定义来控制他们的 PDF。还可以用来编辑现有的 PDF 文档或从头创建一个,包括图像、表格和形状等内容。
示例中使用官方提供的 CDN 地址 https://cdnjs.cloudflare.com/ajax/libs/jspdf/2.5.1/jspdf.umd.min.js
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Document</title>
<script src="https://cdnjs.cloudflare.com/ajax/libs/jspdf/2.5.1/jspdf.umd.min.js"></script>
</head>
<body>
<style>
body {
display: grid;
place-items: center;
margin: 0;
background-color: #ccc;
min-height: 100vh;
}
</style>
<h1>Hello, jsPDF!</h1>
<script>
document.addEventListener("DOMContentLoaded", function () {
const pdf = new window.jsPDF();
const element = document.body;
pdf.html(element, {
callback: function (pdf) {
// Save the PDF to a file or display it
pdf.save("output.pdf");
},
});
});
</script>
</body>
</html>
文档地址:http://raw.githack.com/MrRio/jsPDF/master/docs/index.html
为便于大家参考,下面总结了 Puppeteer、jsPDF 和 PDFKit 库在 PDF 生成、文件大小、浏览器集成和社区支持方面的比较:
Puppeteer jsPDF PDFKit PDF生成 从 HTML 和网页内容生成 PDF 从 HTML 和 SVG 内容生成 PDF 从头开始创建 PDF 文件大小 无法控制 PDF 大小 无法控制 PDF 大小 提供对 PDF 文件大小的控制 浏览器集成 为网页渲染提供无头 Chrome 集成 没有浏览器集成 没有浏览器集成 社区支持和更新 活跃的社区支持和更新 活跃的社区支持和更新 活跃的社区支持和更新
当为 HTML 转 PDF 需求选择实现方案时,可以参考以上实现方案。如果你想从头开始生成 PDF,PDFKit 可能是你最好的选择。要通过 HTML 或者 SVG 内容快速转换为 PDF,jsPDF 可能更合适。对应网页渲染和交互式内容,强烈建议你选择 Puppeteer。
最后,方案选择在很大程度上还取决于你的项目类型、规范及开发者个人喜好。