DinkToPdf: .Net轻松搞定Html转PDF生成，几分钟上手!

大家好，我是深山踏红叶，今天来分享一个HTML 转 PDF 的相关库，DinkToPdf 是一个基于 .NET Core 的封装库，用于调用 wkhtmltopdf 库，通过 WebKit 渲染引擎将 HTML 页面转换为 PDF 文件。

核心功能

• o HTML 到 PDF 的转换：支持将 HTML 内容转换为 PDF 文件，同时提供多种页面设置和布局选项。
• o 多线程支持：提供了同步转换器，适用于多线程应用程序和 Web 服务器。
• o 丰富的配置选项：可以设置纸张大小、方向、边距、颜色模式等，还可以自定义页眉和页脚。

使用方法

1. 安装依赖

通过 NuGet 包管理器添加 DinkToPdf 依赖。

PM> Install-Package DinkToPdf

将本机库复制到项目的根文件夹。使用 P/Invoke 调用本机方法时，.NET Core 会从那里加载本机库。您可以在此处找到最新版本的本机库。为您的操作系统和平台（64 位或 32 位）选择合适的库。

2. 创建转换器实例

根据应用场景选择 BasicConverter 或 SynchronizedConverter。

var converter = new SynchronizedConverter(new PdfTools());

3. 构造 HTML 内容

可以是直接的 HTML 字符串，也可以是通过 URL 获取的页面内容。

var doc = new HtmlToPdfDocument()
{
 GlobalSettings = {
 ColorMode = ColorMode.Color,
 Orientation = Orientation.Portrait,
 PaperSize = PaperKind.A4,
 Margins = new MarginSettings() { Top = 10 },
 Out = @"C:TestThreadSafe\test.pdf",
 },
 Objects = {
 new ObjectSettings()
 {
 Page = "https://www.dotnetshare.com/",
 },
 }
};

4. 配置转换文档

通过 HtmlToPdfDocument 设置全局参数和对象参数。

var doc = new HtmlToPdfDocument()
{
 GlobalSettings = {
 ColorMode = ColorMode.Color,
 Orientation = Orientation.Landscape,
 PaperSize = PaperKind.A4Plus,
 },
 Objects = {
 new ObjectSettings() {
 PagesCount = true,
 HtmlContent = @"Lorem ipsum dolor sit amet, consectetur adipiscing elit. In consectetur mauris eget ultrices iaculis. Ut odio viverra, molestie lectus nec, venenatis turpis.",
 WebSettings = { DefaultEncoding = "utf-8" },
 HeaderSettings = { FontSize = 9, Right = "Page [page] of [toPage]", Line = true, Spacing = 2.812 }
 }
 }
};

5. 执行转换

调用 converter.Convert(doc) 方法完成转换。

byte[] pdf = converter.Convert(doc);
File.WriteAllBytes("example7.pdf", pdf);

6. 依赖关系注入

转换器必须注册为单例。

public void ConfigureServices(IServiceCollection services)
{
 // Add converter to DI
 services.AddSingleton(typeof(IConverter), new SynchronizedConverter(new PdfTools()));
}

完整实例

using DinkToPdf;
using DinkToPdf.Contracts;
using System;

namespaceDinkToPdfExample
{
 publicclassProgram
 {
 public static void Main(string[] args)
 {
 var converter = new BasicConverter(new PdfTools());
 //需要下载wkhtmltopdf工具 https://gitcode.com/gh_mirrors/di/DinkToPdf/blob/master/v0.12.4/64%20bit/
 var doc = new HtmlToPdfDocument()
 {
 GlobalSettings = {
 ColorMode = ColorMode.Color,
 Orientation = Orientation.Portrait,
 PaperSize = PaperKind.A4,
 },
 Objects = {
 new ObjectSettings() {
 //PagesCount = true,
 HtmlContent = @"
 


 
 
 
 


 
Netshare
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
姓名
年龄
职业
张三
25
程序员
李四
30
设计师
王五
28
产品经理



 ",
 WebSettings = { DefaultEncoding = "utf-8" },
 //HeaderSettings = { FontSize = 9, Right = "Page [page] of [toPage]", Line = true, Spacing = 2.812 }
 }
 }
 };

 byte[] pdf = converter.Convert(doc);
 File.WriteAllBytes("example8.pdf", pdf);
 }
 }
}

注意事项

• o DinkToPdf 依赖于 wkhtmltopdf，部署时需确保相关 DLL 文件存在。
• o 在某些情况下，可能需要额外配置字体路径以支持中文等特殊字符。

问题解决方案

One or more errors occurred. (Unable to load shared library 'libwkhtmltox' or one of its dependencies)

将项目下的 libwkhtmltox.dll 文件复制到项目目录下即可解决该问题。并且需要在根目录中包含 libwkhtmltox.dll、libwkhtmltox.dylib 和 libwkhtmltox.so，并在 .csproj 文件中包含以下内容：

文件地址：https://github.com/rdvojmoc/DinkToPdf/tree/master/v0.12.4

<ItemGroup>
 <None Update="libwkhtmltox.dll">
 <CopyToOutputDirectory>Always</CopyToOutputDirectory>
 </None>
 <None Update="libwkhtmltox.dylib">
 <CopyToOutputDirectory>Always</CopyToOutputDirectory>
 </None>
 <None Update="libwkhtmltox.so">
 <CopyToOutputDirectory>Always</CopyToOutputDirectory>
 </None>
</ItemGroup>

项目地址

https://github.com/rdvojmoc/DinkToPdf