构建说明

按照下面的步骤构建 Electron，来生成自定义的 Electron 二进制文件。 为了将您的应用代码与预构建的 Electron 二进制文件打包并发布，请参阅 应用程序发布 指南。

平台要求

各个平台所对应的构建要求如下：

构建工具

Electron的构建工具 自动化了很多配置不同的从源代码编译Electron的设置和构建目标。 如果您希望手动设置环境，则说明如下。

Electron 使用 GN 生成项目，并用 Ninja 完成构建。 项目配置位于 .gn 和 .gni 文件中。

GN 文件

The following gn files contain the main rules for building Electron:

  • BUILD.gn 指明了如何构建 Electron，还包括与 Chromium 相关的默认配置。
  • build/args/{testing,release,all}.gn 包含 Electron 的默认构建参数。

前置知识

此外，你还需要安装depot_tools，这是一个用于获取Chromium，及其相关依赖工具。

另外，如果使用Windows系统, 你需要设置环境变量DEPOT_TOOLS_WIN_TOOLCHAIN=0。 依次打开 Control Panel → System and Security → System → Advanced system settings ，然后添加系统变量 DEPOT_TOOLS_WIN_TOOLCHAIN ，并设置默认值为 0. 这将促使depot_tools 使用本地已安装的Visual Studio(默认状态下，depot_tools将会下载一个只有谷歌内部员工有权限使用的内部版本)。

设置 git 缓存

如果您想 checkout 多份 Electron 源码 (例如多个并行目录 checkout 到不同的分支)， 推荐使用 git 缓存来加速后续对 gclient的调用。 为此，设置 GIT_CACHE_PATH 环境变量：

  1. $ export GIT_CACHE_PATH="${HOME}/.git_cache"
  2. $ mkdir -p "${GIT_CACHE_PATH}"
  3. # 这将使用大约16G

获取源码

  1. $ mkdir electron && cd electron
  2. $ gclient config --name "src/electron" --unmanaged https://github.com/electron/electron
  3. $ gclient sync --with_branch_heads --with_tags
  4. # 这将需要一段时间，喝杯咖啡休息一下。

除了使用 https://github.com/electron/electron， 你也可以使用你自己的 fork (形如 https://github.com/<username>/electron)。

拉/推的注意事项

如果您将来打算从 electron 官方地址进行 git pull 或 git push，那么您需要更新相应文件夹的源 URL。

  1. $ cd src/electron
  2. $ git remote remove origin
  3. $ git remote add origin https://github.com/electron/electron
  4. $ git checkout main
  5. $ git branch --set-upstream-to=origin/main
  6. $ cd -

📝 gclient 会检查 src/electron 目录下的 DEPS 文件，从中获取依赖信息 (就像 Chromium 或 Node.js 那样)。 运行 gclient sync -f 确保所有用来构建 Electron 的依赖都符合该文件的描述。

运行以下命令拉取源码：

  1. $ cd src/electron
  2. $ git pull
  3. $ gclient sync -f

构建

设置chromium build tools的环境变量

On Linux & MacOS

  1. $ cd src
  2. $ export CHROMIUM_BUILDTOOLS_PATH=`pwd`/buildtools

在 Windows 中:

  1. $ cd src
  2. $ set CHROMIUM_BUILDTOOLS_PATH=%cd%\buildtools

要生成 Electron 的测试构建配置，请执行以下操作：

  1. $ gn gen out/Testing --args="import(\"//electron/build/args/testing.gn\")"

要生成 Electron 的 Release build 配置，请执行以下操作：

  1. $ gn gen out/Release --args="import(\"//electron/build/args/release.gn\")"

注意： 通过上面的配置，这将在 src/ 下生成 out/Testing测试构建目录 或 out/Release 发布构建目录。 您可以用另一个名称替换 Testing|Release ，但它应该是 out 的子目录。

如果你想改变构建参数，可以通过运行gn args out/Testing来将参数带入编辑器，而无需再次运行gn gen命令。 要查看可用的构建配置选项的列表，运行 gn args out/Testing --list。

构建时请运行 ninja [参数] [输出目录] electron 注意：这也需要点时间，也可能会让你的电脑发烫。

测试配置：

  1. $ ninja -C out/Testing electron

发布配置：

  1. $ ninja -C out/Release electron

这个过程会构建 ‘libchromiumcontent’ 里的所有内容，(如 chromium中的content，及其依赖 Blink and V8), so it will take a while.

构建需要在./out/Testing文件下执行：

  1. $ ./out/Testing/Electron.app/Contents/MacOS/Electron
  2. # or, on Windows
  3. $ ./out/Testing/electron.exe
  4. # or, on Linux
  5. $ ./out/Testing/electron

打包

在linux上，请先删除调试和符号信息：

  1. $ electron/script/strip-binaries.py -d out/Release

将编译后的electron压缩成可分发的zip包：

  1. $ ninja -C out/Release electron:electron_dist_zip

交叉编译

想要在当前系统上编译其他平台， 设置 target_cpu and target_os GN 参数。 例如，要从一个x64主机编译一个 x86 目标程序，指定target_cpu = "x86" 中指定 gn args。

  1. $ gn gen out/Testing-x86 --args='... target_cpu = "x86"'

Not all combinations of source and target CPU/OS are supported by Chromium.

Host目标状态
Windows x64Windows arm64实验性功能
Windows x64Windows x86Automatically tested
Linux x64Linux x86Automatically tested

如果您测试其他组合并发现它们可以正常，请更新此文档 :)

See the GN reference for allowable values of target_os and target_cpu.

Windows on Arm (experimental)

To cross-compile for Windows on Arm, follow Chromium’s guide to get the necessary dependencies, SDK and libraries, then build with ELECTRON_BUILDING_WOA=1 in your environment before running gclient sync.

  1. set ELECTRON_BUILDING_WOA=1
  2. gclient sync -f --with_branch_heads --with_tags

Or (if using PowerShell):

  1. $env:ELECTRON_BUILDING_WOA=1
  2. gclient sync -f --with_branch_heads --with_tags

Next, run gn gen as above with target_cpu="arm64".

测试

To run the tests, you’ll first need to build the test modules against the same version of Node.js that was built as part of the build process. To generate build headers for the modules to compile against, run the following under src/ directory.

  1. $ ninja -C out/Testing third_party/electron_node:headers

You can now run the tests.

可以通过增加其它标记来调试程序，例如：

  1. $ npm run test -- \
  2.   --enable-logging -g 'BrowserWindow module'

在多个计算机之间共享 git 缓存

可以将gclient git 缓存与其他机器共享，导出为 SMB 在linux上共享。 但每次只能有一个进程或机器可以使用缓存。 The locks created by git-cache script will try to prevent this, but it may not work perfectly in a network.

On Windows, SMBv2 has a directory cache that will cause problems with the git cache script, so it is necessary to disable it by setting the registry key

  1. HKEY_LOCAL_MACHINE\System\CurrentControlSet\Services\Lanmanworkstation\Parameters\DirectoryCacheLifetime

to 0. 更多信息：https://stackoverflow.com/a/9935126

This can be set quickly in powershell (ran as administrator):

  1. New-ItemProperty -Path "HKLM:\System\CurrentControlSet\Services\Lanmanworkstation\Parameters" -Name DirectoryCacheLifetime -Value 0 -PropertyType DWORD -Force

故障排查

gclient sync complains about rebase

If gclient sync is interrupted the git tree may be left in a bad state, leading to a cryptic message when running gclient sync in the future:

  1. 2> Conflict while rebasing this branch.
  2. 2> Fix the conflict and run gclient again.
  3. 2> See man git-rebase for details.

If there are no git conflicts or rebases in src/electron, you may need to abort a git am in src:

  1. $ cd ../
  2. $ git am --abort
  3. $ cd electron
  4. $ gclient sync -f

This may also happen if you have checked out a branch (as opposed to having a detached head) in electron/src/ or some other dependency’s repository. If that is the case, a git checkout --detach HEAD in the appropriate repository should do the trick.

I’m being asked for a username/password for chromium-internal.googlesource.com

If you see a prompt for Username for 'https://chrome-internal.googlesource.com': when running gclient sync on Windows, it’s probably because the DEPOT_TOOLS_WIN_TOOLCHAIN environment variable is not set to 0. Open Control Panel → System and Security → System → Advanced system settings and add a system variable DEPOT_TOOLS_WIN_TOOLCHAIN with value 0. 这将促使depot_tools 使用本地已安装的Visual Studio(默认状态下，depot_tools将会下载一个只有谷歌内部员工有权限使用的内部版本)。

e Module not found

If e is not recognized despite running npm i -g @electron/build-tools, ie:

  1. Error: Cannot find module '/Users/<user>/.electron_build_tools/src/e'

We recommend installing Node through nvm. This allows for easier Node version management, and is often a fix for missing e modules.