PDFKit 使用教程

2024-09-14 08:07:09作者：滑思眉Philip

PDFKit 是一个强大的 JavaScript PDF 生成库，适用于 Node.js 和浏览器环境。它简化了复杂多页文档的创建过程，支持矢量图形、文本处理、图像嵌入、注释、表单等多种功能。PDFKit 的 API 设计简洁，链式调用让代码更易读，适合快速生成高质量的 PDF 文档。无论是简单的文本排版还是复杂的图形绘制，PDFKit 都能轻松应对，是开发者的理想选择。

项目地址：https://gitcode.com/gh_mirrors/pdf/pdfkit

1. 项目介绍

PDFKit 是一个用于生成 PDF 文档的 JavaScript 库，适用于 Node.js 和浏览器环境。它提供了简单易用的 API，使得创建复杂的、多页的、可打印的 PDF 文档变得非常容易。PDFKit 支持文本、图像、形状、链接、注释等多种元素的添加，并且可以自定义样式和布局。

2. 项目快速启动

安装

首先，你需要安装 PDFKit 库。你可以通过 npm 来安装：

npm install pdfkit

创建第一个 PDF 文档

以下是一个简单的示例，展示如何使用 PDFKit 创建一个包含文本的 PDF 文档：

const PDFDocument = require('pdfkit');
const fs = require('fs');

// 创建一个新的 PDF 文档
const doc = new PDFDocument();

// 将 PDF 文档写入文件
doc.pipe(fs.createWriteStream('output.pdf'));

// 添加文本内容
doc.fontSize(25).text('欢迎使用 PDFKit!', 100, 100);

// 结束文档并保存
doc.end();

运行上述代码后，你将在当前目录下生成一个名为 output.pdf 的文件，其中包含“欢迎使用 PDFKit!”的文本内容。

3. 应用案例和最佳实践

应用案例

生成发票

PDFKit 可以用于生成格式化的发票。你可以添加表格、公司徽标、客户信息等，并将其保存为 PDF 文件。

const PDFDocument = require('pdfkit');
const fs = require('fs');

const doc = new PDFDocument();
doc.pipe(fs.createWriteStream('invoice.pdf'));

doc.fontSize(20).text('发票', { align: 'center' });
doc.moveDown();

doc.fontSize(12).text('公司名称: 示例公司');
doc.text('地址: 示例地址');
doc.text('电话: 123-456-7890');
doc.moveDown();

doc.text('客户名称: 示例客户');
doc.text('地址: 示例地址');
doc.text('电话: 987-654-3210');
doc.moveDown();

doc.text('商品名称 数量 单价 总价');
doc.text('商品1 2 $10.00 $20.00');
doc.text('商品2 1 $15.00 $15.00');
doc.moveDown();

doc.text('总计: $35.00');

doc.end();