构建说明
请按照以下指南构建Electron 本身，以便创建自定义 Electron 二进制文件。有关使用预构建的 Electron 二进制文件捆绑和发布您的应用程序代码，请参阅应用程序发布指南。
平台先决条件
在继续之前，请检查您的平台的构建先决条件
构建工具
Electron 的构建工具 自动执行了使用不同的配置和构建目标从源代码编译 Electron 的大部分设置。如果您希望手动设置环境，请参阅以下说明。
Electron 使用GN 进行项目生成，并使用ninja 进行构建。项目配置可以在 .gn 和 .gni 文件中找到。
GN 文件
以下 gn 文件包含构建 Electron 的主要规则
BUILD.gn定义了 Electron 本身的构建方式，并包含了与 Chromium 链接的默认配置。build/args/{testing,release,all}.gn包含构建 Electron 的默认构建参数。
GN 先决条件
您需要安装depot_tools，这是用于获取 Chromium 及其依赖项的工具集。
此外，在 Windows 上，您需要设置环境变量 DEPOT_TOOLS_WIN_TOOLCHAIN=0。为此，请打开 控制面板 → 系统和安全 → 系统 → 高级系统设置 并添加一个系统变量 DEPOT_TOOLS_WIN_TOOLCHAIN，其值为 0。这告诉 depot_tools 使用您本地安装的 Visual Studio 版本（默认情况下，depot_tools 会尝试下载一个 Google 内部版本，只有 Google 员工才能访问）。
设置 git 缓存
如果您计划多次签出 Electron（例如，将多个并行目录签出到不同的分支），使用 git 缓存将加快后续对 gclient 的调用。为此，请设置一个 GIT_CACHE_PATH 环境变量
$ export GIT_CACHE_PATH="${HOME}/.git_cache"
$ mkdir -p "${GIT_CACHE_PATH}"
# This will use about 16G.
获取代码
$ mkdir electron && cd electron
$ gclient config --name "src/electron" --unmanaged https://github.com/electron/electron
$ gclient sync --with_branch_heads --with_tags
# This will take a while, go get a coffee.
您可以使用您自己的 fork 而不是
https://github.com/electron/electron（例如https://github.com/<username>/electron）。
关于拉取/推送的说明
如果您打算将来从官方 electron 存储库中 git pull 或 git push，您现在需要更新相应文件夹的源 URL。
$ cd src/electron
$ git remote remove origin
$ git remote add origin https://github.com/electron/electron
$ git checkout main
$ git branch --set-upstream-to=origin/main
$ cd -
📝 gclient 通过检查 src/electron 文件夹中的一个名为 DEPS 的文件来查找依赖项（如 Chromium 或 Node.js）。运行 gclient sync -f 可确保构建 Electron 所需的所有依赖项与该文件匹配。
因此，为了拉取，您将运行以下命令
$ cd src/electron
$ git pull
$ gclient sync -f
构建
设置用于 chromium 构建工具的环境变量
在 Linux & MacOS 上
$ cd src
$ export CHROMIUM_BUILDTOOLS_PATH=`pwd`/buildtools
在 Windows 上
# cmd
$ cd src
$ set CHROMIUM_BUILDTOOLS_PATH=%cd%\buildtools
# PowerShell
$ cd src
$ $env:CHROMIUM_BUILDTOOLS_PATH = "$(Get-Location)\buildtools"
生成 Electron 的测试构建配置
在 Linux & MacOS 上
$ gn gen out/Testing --args="import(\"//electron/build/args/testing.gn\")"
在 Windows 上
# cmd
$ gn gen out/Testing --args="import(\"//electron/build/args/testing.gn\")"
# PowerShell
gn gen out/Testing --args="import(\`"//electron/build/args/testing.gn\`")"
生成 Electron 的发布构建配置
在 Linux & MacOS 上
$ gn gen out/Release --args="import(\"//electron/build/args/release.gn\")"
在 Windows 上
# cmd
$ gn gen out/Release --args="import(\"//electron/build/args/release.gn\")"
# PowerShell
$ gn gen out/Release --args="import(\`"//electron/build/args/release.gn\`")"
注意：这将在 src/ 下生成一个 out/Testing 或 out/Release 构建目录，其中包含测试或发布构建，具体取决于上面传递的配置。您可以用其他名称替换 Testing|Release，但它应该是 out 的子目录。
此外，您不必再次运行 gn gen——如果您想更改构建参数，可以运行 gn args out/Testing 以打开编辑器。要查看可用构建配置选项的列表，请运行 gn args out/Testing --list。
要构建，请使用 electron 目标运行 ninja：注意：这也会花费一些时间，并且可能会让您的笔记本电脑发热。
用于测试配置
$ ninja -C out/Testing electron
用于发布配置
$ ninja -C out/Release electron
这将构建之前的所有“libchromiumcontent”（即 chromium 的 content/ 目录及其依赖项，包括 Blink 和 V8），因此需要一段时间。
构建的可执行文件将在 ./out/Testing 下
$ ./out/Testing/Electron.app/Contents/MacOS/Electron
# or, on Windows
$ ./out/Testing/electron.exe
# or, on Linux
$ ./out/Testing/electron
打包
在 linux 上，首先剥离调试和符号信息
$ electron/script/strip-binaries.py -d out/Release
将 electron 构建打包为可分发的 zip 文件
$ ninja -C out/Release electron:electron_dist_zip
交叉编译
要为与您构建的平台不同的平台编译，请设置 target_cpu 和 target_os GN 参数。例如，要从 x64 主机编译 x86 目标，请在 gn args 中指定 target_cpu = "x86"。
$ gn gen out/Testing-x86 --args='... target_cpu = "x86"'
并非所有源代码和目标 CPU/OS 的组合都受 Chromium 支持。
| 主机 | 目标 | 状态 |
|---|---|---|
| Windows x64 | Windows arm64 | 实验性 |
| Windows x64 | Windows x86 | 自动测试 |
| Linux x64 | Linux x86 | 自动测试 |
如果您测试其他组合并发现它们有效，请更新本文档 :)
请参阅 GN 参考，了解target_os 和target_cpu 的允许值。
Windows on Arm（实验性）
要为 Windows on Arm 交叉编译，请遵循 Chromium 的指南 获取必要的依赖项、SDK 和库，然后在运行 gclient sync 之前在您的环境中使用 ELECTRON_BUILDING_WOA=1 构建。
set ELECTRON_BUILDING_WOA=1
gclient sync -f --with_branch_heads --with_tags
或者（如果使用 PowerShell）
$env:ELECTRON_BUILDING_WOA=1
gclient sync -f --with_branch_heads --with_tags
接下来，使用 target_cpu="arm64" 运行上述 gn gen。
测试
要运行测试，您首先需要针对与构建过程中构建的 Node.js 版本相同的版本构建测试模块。要为模块生成要编译的构建头文件，请在 src/ 目录下运行以下命令。
$ ninja -C out/Testing electron:node_headers
现在您可以运行测试。
如果您正在调试某些内容，传递一些额外的标志到 Electron 二进制文件可能会有所帮助
$ npm run test -- \
--enable-logging -g 'BrowserWindow module'
在多台机器之间共享 git 缓存
可以通过将 gclient git 缓存导出为 linux 上的 SMB 共享来与其他机器共享，但一次只能有一个进程/机器使用缓存。由 git-cache 脚本创建的锁将尝试阻止这种情况，但这可能无法在网络中完美运行。
在 Windows 上，SMBv2 具有目录缓存，这会导致 git 缓存脚本出现问题，因此有必要通过设置注册表项将其禁用
HKEY_LOCAL_MACHINE\System\CurrentControlSet\Services\Lanmanworkstation\Parameters\DirectoryCacheLifetime
为 0。更多信息：https://stackoverflow.com/a/9935126
这可以在 powershell 中快速设置（以管理员身份运行）
New-ItemProperty -Path "HKLM:\System\CurrentControlSet\Services\Lanmanworkstation\Parameters" -Name DirectoryCacheLifetime -Value 0 -PropertyType DWORD -Force
故障排除
gclient sync 出现关于变基的报错
如果 gclient sync 被中断，git 树可能处于不良状态，导致将来运行 gclient sync 时出现神秘消息
2> Conflict while rebasing this branch.
2> Fix the conflict and run gclient again.
2> See man git-rebase for details.
如果 src/electron 中没有 git 冲突或变基，您可能需要中止 src 中的 git am
$ cd ../
$ git am --abort
$ cd electron
$ gclient sync -f
如果您在 electron/src/ 或其他一些依赖项的存储库中签出了一个分支（而不是拥有一个分离的头），也可能会发生这种情况。如果是这种情况，在相应存储库中运行 git checkout --detach HEAD 应该可以解决问题。
我被要求输入 chromium-internal.googlesource.com 的用户名/密码
如果您在 Windows 上运行 gclient sync 时看到 Username for 'https://chrome-internal.googlesource.com': 的提示，可能是因为 DEPOT_TOOLS_WIN_TOOLCHAIN 环境变量未设置为 0。打开 控制面板 → 系统和安全 → 系统 → 高级系统设置，并添加一个系统变量 DEPOT_TOOLS_WIN_TOOLCHAIN，值为 0。这告诉 depot_tools 使用您本地安装的 Visual Studio 版本（默认情况下，depot_tools 会尝试下载一个 Google 内部版本，只有 Google 员工才能访问）。
e 模块未找到
如果即使运行了 npm i -g @electron/build-tools 也无法识别 e，即
Error: Cannot find module '/Users/<user>/.electron_build_tools/src/e'
我们建议您通过 nvm 安装 Node。这使得 Node 版本管理更容易，并且通常可以解决缺少 e 模块的问题。
RBE 身份验证随机失败，并显示“令牌无效”
这可能是由于机器上的本地时钟时间与实际时间相差很小造成的。可以使用 time.is 进行检查。