在日常开发中,我们常常需要将动态生成的 HTML 内容转换为 PDF 文件。无论是用于打印、存档还是分享,PDF 格式都因其跨平台兼容性和稳定性而备受青睐。今天,我们就来介绍一个强大的工具——HtmlToPDFCore,可以轻松实现 HTML 到 PDF 的转换,这真是轻便快捷重量级。
一、HtmlToPDFCore 是什么?HtmlToPDFCore 是一个基于 .NET Core 的开源库,能够将 HTML 文件或字符串转换为高质量的 PDF 文件。内置了适用于 Windows、Linux 和 macOS 的 Rotativa 文件,因此可以无缝运行在多种环境中。
主要特点:• 支持多平台(Windows、Linux、macOS)。
• 高质量的 PDF 输出。
• 易于集成到 .NET Core 项目中。
• 提供丰富的配置选项(如页面大小、方向、边距等)。
• 无需依赖项(wkhtmltopdf)
二、适用场景HtmlToPDFCore 可以广泛应用于以下场景:
1. 生成报表:将动态生成的 HTML 报表转换为 PDF。
2. 合同和协议:将在线编辑的合同内容保存为 PDF。
3. 发票和收据:将交易记录导出为 PDF 文件。
4. 文档归档:将网页内容保存为 PDF 以便长期存储。
三、环境支持HtmlToPDFCore 已经过测试,支持以下运行环境:
• Windows
• Linux
• Microsoft Azure 应用服务(使用 Linux 服务计划)
• Docker 容器
四、安装方法在 Visual Studio 中,可以通过 NuGet 包管理器控制台安装 HtmlToPDFCore。执行以下命令即可完成安装:
Install-Package HtmlToPDFCore
如果你使用的是 .NET CLI,也可以通过以下命令安装:
dotnet add package HtmlToPDFCore
五、快速上手展示如何使用 HtmlToPDFCore 将 HTML 字符串转换为 PDF 文件
using System;using System.IO;using Wkhtmltopdf.NetCore;classProgram{ static void Main(string[] args) { // 定义 HTML 内容 var html = @" PDF 示例 PDF 示例 - Carlos dos Santos 公众号:Net分享 https://mp.weixin.qq.com/s/LWuzVwJ6J9UyqnmP_1ecPw NetShre :https://www.dotnetshare.com "; // 初始化 HtmlToPDF 对象 var pdf = new HtmlToPDF(); // (可选)设置 PDF 参数 // pdf.DisableSmartShrinking = true; // pdf.Margins = new PageMargins(5, 5, 5, 5); // pdf.Orientation = PageOrientation.Landscape; // pdf.PageSize = Wkhtmltopdf.NetCore.Options.Size.A4; // 将 HTML 转换为 PDF 字节流 var buffer = pdf.ReturnPDF(html); // 定义输出文件路径 string pdfFile = "output.pdf"; // 如果文件已存在,则删除 if (File.Exists(pdfFile)) File.Delete(pdfFile); // 将字节流写入文件 using (var f = new FileStream(pdfFile, FileMode.Create)) { f.Write(buffer, 0, buffer.Length); f.Flush(); } Console.WriteLine("PDF 文件已成功生成!"); }}
六、高级配置HtmlToPDFCore 提供了许多高级配置选项,可以帮助你更精细地控制生成的 PDF 文件。以下是一些常用的配置参数:
参数名 | 描述 |
DisableSmartShrinking | 禁用智能缩放功能 |
Margins | 设置页面边距(单位:毫米) |
Orientation | 页面方向(纵向/横向) |
PageSize | 页面大小(如 A4、Letter 等) |
七、项目地址https://github.com/carloscds/HtmlToPDFCore
八、总结HtmlToPDFCore 是一个功能强大且易于使用的工具,可以帮助开发者快速实现 HTML 到 PDF 的转换。无论你是需要生成报表、合同还是其他类型的文档,它都能满足你的需求。需要注意的是在liunx环境或者是docker需要安装对应的字体,赶快动手试试吧!