ChromiumHtmlToPdf

ChromiumHtmlToPdf

高效跨平台HTML到PDF转换库和应用

ChromiumHtmlToPdf是一个基于Google Chromium的开源.NET库和控制台应用,支持Windows、Linux和macOS。该工具提供高质量的HTML到PDF转换,完全兼容HTML5,支持异步操作。作为wkHtmlToPdf的现代替代方案,它具有更强大的功能和更好的兼容性。ChromiumHtmlToPdf易于集成,可通过NuGet安装,并提供详细文档和示例代码。

ChromiumHtmlToPdfHTML转PDFC#库.NETGoogle ChromeGithub开源项目

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%。

许可信息

ChromiumHtmlToPdf的版权归Kees van Spelde (Magic-Sessions) 所有,(C)2017-2024,并根据MIT许可证授权:

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

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

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

通过NuGet安装

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)

https://github.com/Sicos1977/ChromiumHtmlToPdf/releases/download/4.2.1/ChromiumHtmlToPdf_4_2_1.zip

控制台应用程序的.NET 6.0

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

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

旧版本(.net core 3.1 - 生命周期结束)

https://github.com/Sicos1977/ChromiumHtmlToPdf/releases/download/4.1.2/ChromiumHtmlToPdf_v4_0_2.zip https://github.com/Sicos1977/ChromiumHtmlToPdf/releases/download/4.0.1/ChromiumHtmlToPdf_v4_0_1.zip https://github.com/Sicos1977/ChromiumHtmlToPdf/releases/download/3.0.0/ChromiumHtmlToPdf_v3_0_0.zip https://github.com/Sicos1977/ChromiumHtmlToPdf/releases/download/2.6.5/ChromeHtmltoPdf_265.zip https://github.com/Sicos1977/ChromiumHtmlToPdf/releases/download/2.6.4/ChromeHtmlToPDF_264.zip https://github.com/Sicos1977/ChromiumHtmlToPdf/releases/download/2.6.0/ChromeHtmlToPDF_260.zip https://github.com/Sicos1977/ChromiumHtmlToPdf/releases/download/2.5.33/ChromeHtmlToPdf_253.zip https://github.com/Sicos1977/ChromiumHtmlToPdf/releases/download/2.5.1/ChromeHtmlToPdf_251.zip https://github.com/Sicos1977/ChromiumHtmlToPdf/releases/download/2.2/ChromeHtmlToPdf_220.zip https://github.com/Sicos1977/ChromiumHtmlToPdf/releases/download/2.1.6/ChromeHtmlToPdf_216.zip https://github.com/Sicos1977/ChromiumHtmlToPdf/releases/download/2.0.11/ChromeHtmlToPdf_211.zip

控制台应用程序的.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,以避免提交重复内容。

编辑推荐精选

Trae

Trae

字节跳动发布的AI编程神器IDE

Trae是一种自适应的集成开发环境(IDE),通过自动化和多元协作改变开发流程。利用Trae,团队能够更快速、精确地编写和部署代码,从而提高编程效率和项目交付速度。Trae具备上下文感知和代码自动完成功能,是提升开发效率的理想工具。

AI工具TraeAI IDE协作生产力转型热门
问小白

问小白

全能AI智能助手,随时解答生活与工作的多样问题

问小白,由元石科技研发的AI智能助手,快速准确地解答各种生活和工作问题,包括但不限于搜索、规划和社交互动,帮助用户在日常生活中提高效率,轻松管理个人事务。

热门AI助手AI对话AI工具聊天机器人
Transly

Transly

实时语音翻译/同声传译工具

Transly是一个多场景的AI大语言模型驱动的同声传译、专业翻译助手,它拥有超精准的音频识别翻译能力,几乎零延迟的使用体验和支持多国语言可以让你带它走遍全球,无论你是留学生、商务人士、韩剧美剧爱好者,还是出国游玩、多国会议、跨国追星等等,都可以满足你所有需要同传的场景需求,线上线下通用,扫除语言障碍,让全世界的语言交流不再有国界。

讯飞智文

讯飞智文

一键生成PPT和Word,让学习生活更轻松

讯飞智文是一个利用 AI 技术的项目,能够帮助用户生成 PPT 以及各类文档。无论是商业领域的市场分析报告、年度目标制定,还是学生群体的职业生涯规划、实习避坑指南,亦或是活动策划、旅游攻略等内容,它都能提供支持,帮助用户精准表达,轻松呈现各种信息。

AI办公办公工具AI工具讯飞智文AI在线生成PPTAI撰写助手多语种文档生成AI自动配图热门
讯飞星火

讯飞星火

深度推理能力全新升级,全面对标OpenAI o1

科大讯飞的星火大模型,支持语言理解、知识问答和文本创作等多功能,适用于多种文件和业务场景,提升办公和日常生活的效率。讯飞星火是一个提供丰富智能服务的平台,涵盖科技资讯、图像创作、写作辅助、编程解答、科研文献解读等功能,能为不同需求的用户提供便捷高效的帮助,助力用户轻松获取信息、解决问题,满足多样化使用场景。

热门AI开发模型训练AI工具讯飞星火大模型智能问答内容创作多语种支持智慧生活
Spark-TTS

Spark-TTS

一种基于大语言模型的高效单流解耦语音令牌文本到语音合成模型

Spark-TTS 是一个基于 PyTorch 的开源文本到语音合成项目,由多个知名机构联合参与。该项目提供了高效的 LLM(大语言模型)驱动的语音合成方案,支持语音克隆和语音创建功能,可通过命令行界面(CLI)和 Web UI 两种方式使用。用户可以根据需求调整语音的性别、音高、速度等参数,生成高质量的语音。该项目适用于多种场景,如有声读物制作、智能语音助手开发等。

咔片PPT

咔片PPT

AI助力,做PPT更简单!

咔片是一款轻量化在线演示设计工具,借助 AI 技术,实现从内容生成到智能设计的一站式 PPT 制作服务。支持多种文档格式导入生成 PPT,提供海量模板、智能美化、素材替换等功能,适用于销售、教师、学生等各类人群,能高效制作出高品质 PPT,满足不同场景演示需求。

讯飞绘文

讯飞绘文

选题、配图、成文,一站式创作,让内容运营更高效

讯飞绘文,一个AI集成平台,支持写作、选题、配图、排版和发布。高效生成适用于各类媒体的定制内容,加速品牌传播,提升内容营销效果。

热门AI辅助写作AI工具讯飞绘文内容运营AI创作个性化文章多平台分发AI助手
材料星

材料星

专业的AI公文写作平台,公文写作神器

AI 材料星,专业的 AI 公文写作辅助平台,为体制内工作人员提供高效的公文写作解决方案。拥有海量公文文库、9 大核心 AI 功能,支持 30 + 文稿类型生成,助力快速完成领导讲话、工作总结、述职报告等材料,提升办公效率,是体制打工人的得力写作神器。

openai-agents-python

openai-agents-python

OpenAI Agents SDK,助力开发者便捷使用 OpenAI 相关功能。

openai-agents-python 是 OpenAI 推出的一款强大 Python SDK,它为开发者提供了与 OpenAI 模型交互的高效工具,支持工具调用、结果处理、追踪等功能,涵盖多种应用场景,如研究助手、财务研究等,能显著提升开发效率,让开发者更轻松地利用 OpenAI 的技术优势。

下拉加载更多