Electron 内部:将 Chromium 构建为库
Electron 基于 Google 的开源项目 Chromium,该项目并非设计用于其他项目。本文介绍了如何将 Chromium 构建为 Electron 使用的库,以及构建系统多年来的演变过程。
使用 CEF
Chromium Embedded Framework (CEF) 是一个将 Chromium 转换为库的项目,并基于 Chromium 的代码库提供稳定的 API。Atom 编辑器和 NW.js 的早期版本使用了 CEF。
为了维护稳定的 API,CEF 隐藏了 Chromium 的所有细节,并用自己的接口封装了 Chromium 的 API。因此,当我们像将 Node.js 集成到网页中那样需要访问底层 Chromium API 时,CEF 的优势反而成为了阻碍。
因此,最终 Electron 和 NW.js 都转向了直接使用 Chromium 的 API。
作为 Chromium 的一部分构建
尽管 Chromium 官方不正式支持外部项目,但其代码库是模块化的,并且基于 Chromium 构建一个最小的浏览器很容易。提供浏览器界面的核心模块称为 Content Module。
要使用 Content Module 开发项目,最简单的方法是将项目作为 Chromium 的一部分进行构建。这可以通过先检出 Chromium 的源代码,然后将项目添加到 Chromium 的 DEPS
文件来实现。
NW.js 和 Electron 的早期版本都使用这种方式进行构建。
缺点是,Chromium 是一个非常庞大的代码库,需要非常强大的机器来构建。对于普通笔记本电脑来说,可能需要 5 个多小时。因此,这极大地影响了可以为项目做出贡献的开发者数量,也减慢了开发速度。
将 Chromium 构建为单个共享库
作为 Content Module 的使用者,Electron 在大多数情况下无需修改 Chromium 的代码,因此改进 Electron 构建的一个显而易见的方法是将 Chromium 构建为共享库,然后在 Electron 中链接它。通过这种方式,开发者在为 Electron 贡献代码时不再需要构建整个 Chromium。
用于此目的的 libchromiumcontent 项目由 @aroben 创建。它将 Chromium 的 Content Module 构建为共享库,然后提供 Chromium 的头文件和预构建二进制文件供下载。 libchromiumcontent 初始版本的代码可以在此链接中找到。
的 brightray 项目也作为 libchromiumcontent 的一部分而诞生,它为 Content Module 提供了一个薄层。
通过同时使用 libchromiumcontent 和 brightray,开发者可以快速构建浏览器,而无需深入了解构建 Chromium 的细节。它也消除了构建项目对高速网络和强大机器的需求。
除了 Electron,还有其他基于 Chromium 的项目也是以这种方式构建的,例如 Breach 浏览器。
过滤导出的符号
在 Windows 上,一个共享库可以导出多少符号存在限制。随着 Chromium 代码库的增长,libchromiumcontent 中导出的符号数量很快就超过了限制。
解决方案是在生成 DLL 文件时过滤掉不需要的符号。这是通过向链接器提供一个 .def
文件,然后使用脚本来判断某个命名空间下的符号是否应该被导出来实现的。
通过采用这种方法,尽管 Chromium 不断添加新的导出符号,libchromiumcontent 仍然可以通过剥离更多符号来生成共享库文件。
组件构建
在讨论 libchromiumcontent 中采取的下一步措施之前,首先介绍 Chromium 中的组件构建(component build)概念非常重要。
作为一个巨大的项目,Chromium 在构建时的链接步骤非常耗时。通常,当开发者做出一个小改动时,可能需要 10 分钟才能看到最终输出。为了解决这个问题,Chromium 引入了组件构建,它将 Chromium 中的每个模块构建为单独的共享库,这样最终链接步骤所需的时间就变得微不足道了。
分发原始二进制文件
随着 Chromium 的不断发展,Chromium 中导出的符号太多,甚至 Content Module 和 Webkit 的符号都超过了限制。简单地剥离符号已经无法生成可用的共享库了。
最终,我们不得不分发 Chromium 的原始二进制文件,而不是生成单个共享库。
如前所述,Chromium 中有两种构建模式。由于分发原始二进制文件,我们不得不在 libchromiumcontent 中分发两种不同的二进制文件发行版。一种称为 static_library
构建,它包含 Chromium 常规构建生成的每个模块的所有静态库。另一种是 shared_library
,它包含组件构建生成的每个模块的所有共享库。
在 Electron 中,Debug 版本链接到 libchromiumcontent 的 shared_library
版本,因为它下载量小,并且在链接最终可执行文件时耗时少。而 Electron 的 Release 版本则链接到 libchromiumcontent 的 static_library
版本,这样编译器可以生成完整的符号以便调试,并且链接器可以做更好的优化,因为它知道哪些目标文件是需要的,哪些是不需要的。
因此,对于日常开发,开发者只需构建 Debug 版本,这不需要良好的网络或强大的机器。虽然 Release 版本需要更好的硬件来构建,但它可以生成优化更好的二进制文件。
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。这项努力是完全值得的。