C#如何实现PDF文件生成 QuestPDF库使用教程

QuestPDF 是 .NET 平台最轻量现代的 PDF 生成库,基于 Fluent API 用 C# 直接描述文档结构,需注册中文字体(如 Noto Sans CJK)以支持中文,安装 via NuGet,.NET 6+ 原生兼容。

用 C# 生成 PDF,QuestPDF 是目前最轻量、现代且易上手的开源库之一。它基于 Fluent API 设计,用 C# 代码直接描述文档结构(类似 HTML + CSS),无需模板引擎或外部依赖,编译即用。

安装 QuestPDF

在项目中通过 NuGet 安装:

  • Visual Studio:右键项目 → “管理 NuGet 包” → 搜索并安装 QuestPDF
  • 命令行:dotnet add package QuestPDF

注意:.NET 6+ 项目可直接使用;若用 .NET Framework,请确认版本兼容性(建议升级至 .NET 6/7/8)。

快速生成一个简单 PDF

以下是最小可运行示例,生成含标题和段落的 PDF:

using QuestPDF.Fluent;
using QuestPDF.Helpers;
using QuestPDF.Infrastructure;

// 初始化(只需一次,通常放在 Program.cs 或 Startup) Document.Create(container => { container.Page(page => { page.Size(PageSizes.A4); page.Margin(2, Unit.Centimetre); page.Content().Element(ComposeContent); }); }) .GeneratePdf("output.pdf");

void ComposeContent(IContainer container) { container .PaddingVertical(40) .Column(column => { column.Item().Text("欢迎使用 QuestPDF!").FontSize(24).Bold(); column.Item().Text("这是一个由 C# 代码生成的 PDF 文档。").FontSize(14); }); }

运行后会在当前目录生成 output.pdf。关键点:

  • Document.Create 定义整个文档
  • Page 控制页面尺寸、边距、页眉页脚
  • Content() 是主体区域,用 Column/Row/Grid 布局
  • 所有样式(字体、颜色、对齐等)链式调用,直观清晰

常用功能与写法

QuestPDF 支持表格、图片、分页、页码、条件内容等实用特性:

  • 表格:用 Table + ColumnsDefinition + Cell 构建,支持自动列宽、跨行跨列
  • 图片:用 .Image(bytes).Image(path),支持缩放、居中、比例约束
  • 页码:在页脚中用 page.Number() + page.TotalPages(),如 "第 {0} 页,共 {1} 页"
  • 条件渲染:C# 的 if / foreach 可直接嵌入布局逻辑,比如只在数据非空时显示某区块
  • 自定义字体:需先注册(支持 TTF/OTF),再用 .Font(...) 应用,中文需指定支持 Unicode 的字体(如 Noto Sans CJK)

中文支持与字体配置

默认不支持中文,需手动加载中文字体:

// 注册字体(推荐放在程序启动时执行一次)
QuestPDF.Settings.License = LicenseType.Community;
FontManager.RegisterFont(File.ReadAllBytes("NotoSansCJKsc-Regular.otf"));

// 使用时指定字体 .Text("你好,世界!").Font("Noto Sans CJK SC");

推荐字体:

  • 免费可商用:Google 的 Noto Sans CJK(SC/TC/JP/KO 版本按需选)
  • 系统字体(Windows):"Microsoft YaHei""SimSun",但跨平台部署需谨慎

未正确注册字体时,中文会显示为空白或方块,这是新手最常遇到的问题。

基本上就这些。QuestPDF 上手快、调试直观、扩展性强,适合报表、合同、发票、导出文档等场景。不复杂但容易忽略字体和布局嵌套层级——多看官方 示例库,5 分钟就能写出专业 PDF。