ChromiumHtmlToPdf

ChromiumHtmlToPdf是什么？

ChromiumHtmlToPdf是一个100%托管的C# .NETStandard 2.0库和.NET 6控制台应用程序（也可在Linux和macOS上运行），可用于通过Google Chromium（Google Chrome和Microsoft Edge浏览器）将HTML转换为PDF格式。

从4.0版本开始，该库现在完全异步，但如果需要，您仍可以不使用异步方式。

为什么我要开发它？

我需要一个替代wkHtmlToPdf的工具。wkHtmlToPdf是一个很棒的工具，但该项目在GitHub上已归档，不再添加新功能，而且它与HTML5的兼容性也不是100%。

许可信息

特此免费授予任何获得本软件及相关文档文件（"软件"）副本的人无限制地处理本软件的权利，
包括但不限于使用、复制、修改、合并、发布、分发、再许可和/或销售软件副本的权利，
并允许向其提供本软件的人这样做，但须符合以下条件：

上述版权声明和本许可声明应包含在本软件的所有副本或大部分内容中。

本软件按"原样"提供，不附带任何明示或暗示的保证，包括但不限于对适销性、
特定用途适用性和非侵权性的保证。在任何情况下，作者或版权持有人均不对任何索赔、
损害或其他责任负责，无论是在合同诉讼、侵权行为还是其他方面，
由软件或软件的使用或其他交易引起、由软件引起或与之相关。

通过NuGet安装

安装ChromiumHtmlToPdf最简单的方法是通过NuGet（是的，我知道nuget包的名称不同，这是因为已经有一个包使用了我现在使用的新名称）。

在Visual Studio的Package Manager Console中，只需输入以下命令：

Install-Package ChromeHtmlToPdf

从代码转换文件或URL

var pageSettings = new PageSettings()
using (var converter = new Converter())
{
    converter.ConvertToPdf(new Uri("http://www.google.nl"), @"c:\google.pdf", pageSettings);
}

// 显示PDF
System.Diagnostics.Process.Start(@"c:\google.pdf");

或者如果您想以异步方式执行

var pageSettings = new PageSettings()
using var converter = new Converter();
await converter.ConvertToPdfAsync(new Uri("http://www.google.nl"), @"c:\google.pdf", pageSettings);

// 显示PDF
System.Diagnostics.Process.Start(@"c:\google.pdf");

从Internet Information Services (IIS)转换

下载Google Chrome或Microsoft Edge便携版并解压
让您的网站在ApplicationPool身份下运行
将文件复制到Web服务器上项目所在的相同位置
从您的Web项目引用ChromeHtmlToPdfLib.dll
从代码中调用converter.ConverToPdf方法

就这么简单。

如果在启动Google Chrome或Microsoft Edge时遇到奇怪的错误，这可能是由于用于运行您网站的账户导致的。我遇到过类似的问题，通过在Windows服务中托管ChromiumHtmlToPdf并使用WCF服务进行调用来解决。

从命令行转换

ChromiumHtmlToPdfConsole --input https://www.google.com --output c:\google.pdf

控制台应用程序退出代码

0 = 成功，1 = 发生错误

在Linux或macOS上安装

安装.NET

有关如何在Linux上安装.NET，请参见此URL

https://docs.microsoft.com/en-us/dotnet/core/install/linux

有关如何在macOS上安装.NET，请参见此URL

https://docs.microsoft.com/en-us/dotnet/core/install/macos

安装Chrome

有关如何在Linux上安装Chrome，请参见此URL

https://support.google.com/chrome/a/answer/9025903?hl=en

有关如何在macOS上安装Chrome，请参见此URL

https://support.google.com/chrome/a/answer/7550274?hl=en

在Linux Ubuntu上安装Chrome的示例

wget -q -O - https://dl-ssl.google.com/linux/linux_signing_key.pub | sudo apt-key add -

sudo sh -c 'echo "deb [arch=amd64] http://dl.google.com/linux/chrome/deb/ stable main" >> /etc/apt/sources.list.d/google.list'

sudo apt-get update

sudo apt-get install google-chrome-stable

google-chrome --version

google-chrome --no-sandbox --user-data-dir

预编译二进制文件

您可以在此处找到适用于Windows、Linux和macOS的预编译二进制文件

控制台应用程序的.NET 6.0

控制台应用程序需要.NET 6才能运行，您可以从以下位置下载此框架

https://dotnet.microsoft.com/en-us/download/dotnet/6.0

旧版本（.net core 3.1 - 生命周期结束）

控制台应用程序的.NET Core 3.1（生命周期结束）

控制台应用程序需要.NET Core 3.1才能运行，您可以从以下位置下载此框架

https://dotnet.microsoft.com/en-us/download/dotnet/3.1

从scoop包管理器安装

有关scoop的更多信息，请参见 --> https://scoop.sh/#/

只需从任何PowerShell窗口运行以下命令（感谢https://github.com/arnos-stuff）

scoop install https://gist.githubusercontent.com/arnos-stuff/4f9b2d92d812b25d0ee8335c543cba78/raw/cfa861ab3078a20c69157ab45daf33f26005fd63/chrome-html-to-pdf.json

日志记录

从2.5.0版本开始，ChromiumHtmlToPdfLib使用Microsoft ILogger接口（https://docs.microsoft.com/en-us/dotnet/api/microsoft.extensions.logging.ilogger?view=dotnet-plat-ext-5.0）。您可以使用任何使用此接口的日志库。

ChromiumHtmlToPdfLib内置了一些日志记录器，可以在ChromiumHtmlToPdfLib.Logger命名空间中找到。

示例

var logger = !string.IsNullOrWhiteSpace(<某个日志文件>)
                ? new ChromiumHtmlToPdfLib.Loggers.Stream(File.OpenWrite(<某个日志文件>))
                : new ChromiumHtmlToPdfLib.Loggers.Console();

设置通用的 Google Chrome 或 Microsoft Edge 缓存目录

你不能在 Google Chrome 或 Microsoft Edge 实例之间共享缓存目录，因为第一个使用该缓存目录的实例会锁定它以供自己使用。最有效的利用缓存目录的方法是为每个运行的实例创建一个。

我在 WCF 服务中使用 Google Chrome，并使用以下类来优化缓存目录的使用。该类将创建一个实例 ID，我用它为每个运行的 Chrome 实例创建一个缓存目录。当实例关闭时，实例 ID 会被放回栈中，以便下一个执行的实例可以再次使用这个目录。

public static class InstanceId
{
    #region 字段
    private static readonly ConcurrentStack<string> ConcurrentStack;
    #endregion

    #region 构造函数
    static InstanceId()
    {
        ConcurrentStack = new ConcurrentStack<string>();

        for(var i = 100000; i > 0; i--)
            ConcurrentStack.Push(i.ToString().PadLeft(6, '0'));
    }
    #endregion

    #region Pop
    /// <summary>
    /// 返回一个实例 ID 并从 <see cref="ConcurrentStack"/> 中弹出
    /// </summary>
    /// <returns></returns>
    public static string Pop()
    {
        if (ConcurrentStack.TryPop(out var instanceId))
            return instanceId;

        throw new Exception("实例 ID 栈为空");
    }
    #endregion

    #region Push
    /// <summary>
    /// 将 <paramref name="instanceId"/> 推回 <see cref="ConcurrentStack"/> 的顶部
    /// </summary>
    /// <param name="instanceId"></param>
    public static void Push(string instanceId)
    {
        ConcurrentStack.Push(instanceId);
    }
    #endregion
}

在 Docker 容器中使用

# 禁止 apt-key 警告标准输出不是终端。在此脚本中使用是安全的。
ENV APT_KEY_DONT_WARN_ON_DANGEROUS_USAGE=DontWarn

# export DEBIAN_FRONTEND="noninteractive"
ENV DEBIAN_FRONTEND noninteractive

# 安装依赖 + 添加 Chrome Stable + 清除所有内容
RUN apt-get update && apt-get install -y \
	apt-transport-https \
	ca-certificates \
	curl \
	gnupg \
	--no-install-recommends \
	&& curl -sSL https://dl.google.com/linux/linux_signing_key.pub | apt-key add - \
	&& echo "deb [arch=amd64] https://dl.google.com/linux/chrome/deb/ stable main" > /etc/apt/sources.list.d/google-chrome.list \
	&& apt-get update && apt-get install -y \
	google-chrome-stable \
	--no-install-recommends \
	&& apt-get purge --auto-remove -y curl gnupg \
	&& rm -rf /var/lib/apt/lists/*

# Chrome Driver
RUN apt-get update && \
    apt-get install -y unzip && \
    wget https://chromedriver.storage.googleapis.com/2.31/chromedriver_linux64.zip && \
    unzip chromedriver_linux64.zip && \
    mv chromedriver /usr/bin && rm -f chromedriver_linux64.zip

更多信息请参见此问题 --> https://github.com/Sicos1977/ChromiumHtmlToPdf/issues/39

在 Linux 或 Docker 容器中使用此库

为了使库正常工作，默认情况下会设置 --no-sandbox 标志（在 Windows 上不设置此标志）。该库会自动检测你运行代码的系统，并在需要时设置该标志。如果由于某种原因出现转换错误，请检查是否设置了此标志，如果没有，则手动添加。

converter.AddChromiumArgument("--no-sandbox")

当 Chrome 在 Docker 容器中因未知原因崩溃时

在大多数桌面 Linux 发行版上，默认的 /dev/shm 分区足够大。然而，在许多使用 Docker 容器的云提供商（如 Google App Engine 灵活环境）或 Heroku 上，默认的 /dev/shm 大小明显较小（分别为 64MB 和 5MB）。在这些平台上，无法更改 /dev/shm 的大小，这使得使用 Chrome 变得困难或不可能。这对于那些想要利用其新的无头模式的人来说尤其是一个问题。

如果无法更改分区大小，则添加标志 --disable-dev-shm-usage 来告诉 Chrome 不要使用此分区

converter.AddChromiumArgument("--disable-dev-shm-usage")

核心团队

Sicos1977 (Kees van Spelde)

报告 Bug

有 bug 或功能请求？请开一个新的 issue。

在开新 issue 之前，请搜索现有 issue，以避免提交重复内容。

ChromiumHtmlToPdf

ChromiumHtmlToPdf