构建说明
请遵循以下指南构建 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 会尝试下载一个只有 Googler 才有权限访问的 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.
除了
https://github.com/electron/electron，你也可以在这里使用你自己的 fork（例如https://github.com/<username>/electron）。
关于 pull/push 的说明
如果你打算将来从官方 electron 仓库进行 git pull 或 git push，你现在需要更新相应文件夹的 origin 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 所需的所有依赖项与该文件匹配。
因此，为了 pull，你需要运行以下命令
$ 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 的 Testing 构建配置
在 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 的 Release 构建配置
在 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 构建，具体取决于上面传递的配置。你可以将 Testing|Release 替换为其他名称，但它应该是 out 的子目录。
此外，你无需再次运行 gn gen — 如果你想更改构建参数，可以运行 gn args out/Testing 调出编辑器。要查看可用的构建配置选项列表，运行 gn args out/Testing --list。
要构建，运行 ninja 并指定 electron 目标： 注意：这也会需要一些时间，并且可能会使你的笔记本电脑发热。
对于 Testing 配置
$ ninja -C out/Testing electron
对于 Release 配置
$ 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"'
Chromium 并非支持所有源 CPU/操作系统与目标 CPU/操作系统的组合。
| 宿主平台 | 目标平台 | 状态 |
|---|---|---|
| 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
接下来，如上所述运行 gn gen 并指定 target_cpu="arm64"。
测试
要运行测试，首先需要针对作为构建过程一部分构建的同一版本 Node.js 构建测试模块。要在 src/ 目录下为模块编译生成构建头文件，运行以下命令。
$ ninja -C out/Testing electron:node_headers
你现在可以运行测试了。
如果你正在调试某个问题，向 Electron 二进制文件传递一些额外标志可能会有所帮助
$ npm run test -- \
--enable-logging -g 'BrowserWindow module'
在多台机器之间共享 git 缓存
可以将 gclient git 缓存导出为 SMB 共享并在 Linux 上与其他机器共享，但一次只能有一个进程/机器使用该缓存。git-cache 脚本创建的锁会尝试阻止这种情况，但在网络环境中可能无法完美工作。
在 Windows 上，SMBv2 有一个目录缓存，会与 git cache 脚本产生问题，因此需要通过设置注册表项来禁用它
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 抱怨 rebase 问题
如果 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 冲突或 rebase，你可能需要在 src 中中止 git am
$ cd ../
$ git am --abort
$ cd electron
$ gclient sync -f
如果你在 electron/src/ 或其他依赖项的仓库中检出了一个分支（而不是处于 detached head 状态），也可能发生这种情况。如果是这种情况，在相应的仓库中运行 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 会尝试下载一个只有 Googler 才有权限访问的 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 身份验证随机失败，并显示“Token not valid”
这可能是由于机器上的本地时钟时间偏差了一点点造成的。使用 time.is 进行检查。