Electron 内部:将 Chromium 打造为库
Electron 基于 Google 的开源 Chromium,这是一个并非一定旨在供其他项目使用的项目。本文介绍了 Chromium 如何作为库构建以供 Electron 使用,以及构建系统多年来的发展历程。
使用 CEF
Chromium Embedded Framework (CEF) 是一个将 Chromium 转换为库的项目,并基于 Chromium 的代码库提供稳定的 API。Atom 编辑器和 NW.js 的早期版本使用了 CEF。
为了维护稳定的 API,CEF 隐藏了 Chromium 的所有细节,并用其自身的接口包装了 Chromium 的 API。因此,当我们需要访问底层的 Chromium API(例如将 Node.js 集成到网页中)时,CEF 的优势变成了障碍。
因此,最终 Electron 和 NW.js 都切换到直接使用 Chromium 的 API。
作为 Chromium 的一部分进行构建
尽管 Chromium 没有正式支持外部项目,但其代码库是模块化的,并且很容易基于 Chromium 构建一个最小的浏览器。提供浏览器界面的核心模块称为内容模块。
要使用内容模块开发项目,最简单的方法是将项目作为 Chromium 的一部分进行构建。这可以通过首先检出 Chromium 的源代码,然后将项目添加到 Chromium 的 DEPS
文件中来实现。
NW.js 和 Electron 的早期版本都使用这种方式进行构建。
缺点是,Chromium 的代码库非常庞大,需要功能强大的机器才能构建。对于普通的笔记本电脑来说,这可能需要 5 个多小时。因此,这极大地影响了可以为该项目做出贡献的开发人员数量,并且也使开发速度变慢。
将 Chromium 构建为单个共享库
作为内容模块的用户,Electron 在大多数情况下不需要修改 Chromium 的代码,因此改进 Electron 构建的一个显而易见的方法是将 Chromium 构建为共享库,然后在 Electron 中链接它。这样,开发人员在为 Electron 做出贡献时就不再需要构建所有 Chromium 代码了。
为了实现此目的,libchromiumcontent 项目由 @aroben 创建。它将 Chromium 的内容模块构建为共享库,然后提供 Chromium 的头文件和预构建二进制文件供下载。libchromiumcontent 初始版本的代码可以在 此链接 中找到。
brightray 项目也是作为 libchromiumcontent 的一部分诞生的,它在内容模块周围提供了一个精简的层。
通过一起使用 libchromiumcontent 和 brightray,开发人员可以快速构建浏览器,而无需深入了解 Chromium 的构建细节。并且它消除了构建项目对快速网络和强大机器的需求。
除了 Electron 之外,还有其他基于 Chromium 的项目也以这种方式构建,例如 Breach 浏览器。
过滤导出的符号
在 Windows 上,一个共享库可以导出的符号数量存在限制。随着 Chromium 代码库的增长,libchromiumcontent 中导出的符号数量很快超过了这个限制。
解决方案是在生成 DLL 文件时过滤掉不需要的符号。它通过 向链接器提供 .def
文件,然后使用脚本 判断命名空间下的符号是否应该导出 来实现。
通过采用这种方法,尽管 Chromium 持续添加新的导出符号,但 libchromiumcontent 仍然可以通过剥离更多符号来生成共享库文件。
组件构建
在讨论 libchromiumcontent 中采取的后续步骤之前,首先介绍 Chromium 中的组件构建概念非常重要。
作为一个大型项目,Chromium 在构建时链接步骤需要很长时间。通常,当开发人员进行小的更改时,可能需要 10 分钟才能看到最终输出。为了解决这个问题,Chromium 引入了组件构建,它将 Chromium 中的每个模块构建为独立的共享库,因此在最终链接步骤中花费的时间变得微不足道。
交付原始二进制文件
随着 Chromium 的持续发展,Chromium 中的导出符号数量非常多,即使内容模块和 Webkit 的符号也超过了限制。仅仅通过剥离符号是不可能生成可用的共享库的。
最后,我们不得不 交付 Chromium 的原始二进制文件,而不是生成单个共享库。
如前所述,Chromium 中有两种构建模式。由于交付原始二进制文件,我们必须在 libchromiumcontent 中交付两种不同的二进制文件分发版。一种称为 static_library
构建,它包含 Chromium 正常构建生成的每个模块的所有静态库。另一种是 shared_library
,它包含组件构建生成的每个模块的所有共享库。
在 Electron 中,调试版本链接到 libchromiumcontent 的 shared_library
版本,因为它下载起来很小,并且在链接最终可执行文件时花费的时间很少。Electron 的发布版本链接到 libchromiumcontent 的 static_library
版本,因此编译器可以生成完整的符号(这对调试很重要),并且链接器可以进行更好的优化,因为它知道哪些目标文件是需要的,哪些不是。
因此,对于正常的开发,开发者只需要构建调试版本,这不需要良好的网络或强大的机器。虽然发布版本需要更好的硬件来构建,但它可以生成优化更好的二进制文件。
gn
更新
作为世界上最大的项目之一,大多数普通系统都不适合构建 Chromium,Chromium 团队开发了自己的构建工具。
早期版本的 Chromium 使用 gyp
作为构建系统,但它构建速度缓慢,并且其配置文件对于复杂的项目来说难以理解。经过多年的开发,Chromium 切换到 gn
作为构建系统,它速度更快且架构清晰。
gn
的改进之一是引入了 source_set
,它表示一组目标文件。在 gyp
中,每个模块都由 static_library
或 shared_library
表示,对于 Chromium 的正常构建,每个模块都会生成一个静态库,并在最终的可执行文件中链接在一起。通过使用 gn
,每个模块现在仅生成一堆目标文件,最终的可执行文件只需将所有目标文件链接在一起,因此不再生成中间静态库文件。
但是,此改进给 libchromiumcontent 带来了很大的麻烦,因为 libchromiumcontent 实际上需要中间静态库文件。
解决此问题的第一次尝试是 修补 gn
以生成静态库文件,这解决了问题,但远非一个体面的解决方案。
第二次尝试是由 @alespergl 进行的,以 根据目标文件列表生成自定义静态库。它使用了一个技巧,首先运行一个虚拟构建来收集生成的全部目标文件的列表,然后通过将列表提供给 gn
来实际构建静态库。它对 Chromium 的源代码进行了最小的更改,并保持了 Electron 的构建架构。
总结
如您所见,与将 Electron 作为 Chromium 的一部分构建相比,将 Chromium 作为库构建需要更大的努力并需要持续维护。但是,后者消除了构建 Electron 对强大硬件的需求,从而使更多开发者能够构建和为 Electron 做出贡献。付出是完全值得的。