跳转到主要内容

构建说明 (Windows)

请遵循以下指南，在 Windows 上构建 **Electron 本身**，以便创建自定义 Electron 二进制文件。有关使用预构建的 Electron 二进制文件打包和分发您的应用程序代码，请参阅 应用程序分发 指南。

先决条件​

  • Windows 10 / Server 2012 R2 或更高版本
  • Visual Studio 2019 (>=16.0.0) 用于构建，但首选 Visual Studio 2022 (>=17.0.0) - 免费下载 VS 2022 社区版
    • 有关所需的 Visual Studio 组件的更多详细信息，请参阅 Chromium 构建文档。
    • 如果您的 Visual Studio 安装在非默认目录中，您需要设置一些环境变量来将工具链指向您的安装路径。
      • vs2022_install = DRIVE:\path\to\Microsoft Visual Studio\2022\Community，将 2022 和 Community 替换为您的已安装版本，并将 DRIVE: 替换为 Visual Studio 所在的驱动器。通常是 C:。
      • WINDOWSSDKDIR = DRIVE:\path\to\Windows Kits\10，将 DRIVE: 替换为 Windows Kits 所在的驱动器。通常是 C:。
  • Node.js >= 22.12.0
  • Git
  • Windows SDK 10.0.15063.468 的 Windows 调试工具，如果您计划创建完整分发版，因为 symstore.exe 用于从 .pdb 文件创建符号存储。
    • 可以并排安装不同版本的 SDK。要安装 SDK，请打开 Visual Studio Installer，选择 修改 → 单个组件，向下滚动并选择相应的 Windows SDK 进行安装。另一个选择是查看 Windows SDK 和模拟器存档 并分别下载 SDK 的独立版本。
    • 还必须安装 SDK 调试工具。如果 Windows 10 SDK 是通过 Visual Studio installer 安装的，那么可以通过以下方式安装：控制面板 → 程序 → 程序和功能 → 选择“Windows 软件开发工具包” → 更改 → 更改 → 勾选“Windows 调试工具” → 更改。或者，您可以下载独立的 SDK 安装程序并使用它来安装调试工具。

如果您目前没有 Windows 安装，developer.microsoft.com 提供了有时间限制的 Windows 版本，您可以使用它们来构建 Electron。

Electron 的构建完全通过命令行脚本完成，无法使用 Visual Studio 完成。您可以使用任何编辑器来开发 Electron，但未来将支持使用 Visual Studio 进行构建。

注意

尽管 Visual Studio 不用于构建，但它仍然是 **必需的**，因为我们需要它提供的构建工具链。

从 Windows 安全中心排除源代码树​

Windows 安全中心不喜欢 Chromium 源代码中的一个文件（请参阅 https://crbug.com/441184），因此它会不断删除它，导致 gclient sync 问题。您可以通过 遵循这些说明 来将源代码树从 Windows 安全中心的监控中排除。

构建​

请参阅 构建说明：GN

32 位构建​

要构建 32 位目标，您需要将 target_cpu = "x86" 作为 GN 参数传递。您可以使用不同的 GN 输出目录（例如 out/Release-x86）和不同的参数来与 64 位目标一起构建 32 位目标。

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

其他构建步骤完全相同。

Visual Studio 项目​

要生成 Visual Studio 项目，您可以将 --ide=vs2017 参数传递给 gn gen

$ gn gen out/Testing --ide=vs2017

故障排除​

命令 xxxx 未找到​

如果您遇到诸如 Command xxxx not found 之类的错误，您可以尝试使用 VS2015 Command Prompt 控制台来执行构建脚本。

致命的内部编译器错误：C1001​

确保您安装了最新的 Visual Studio 更新。

LNK1181：无法打开输入文件“kernel32.lib”​

尝试重新安装 32 位 Node.js。

错误：ENOENT，stat 'C:\Users\USERNAME\AppData\Roaming\npm'​

创建该目录 应该可以解决问题

$ mkdir ~\AppData\Roaming\npm

node-gyp 未被识别为内部或外部命令​

如果您在使用 Git Bash 进行构建时遇到此错误，您应该改用 PowerShell 或 VS2015 Command Prompt。

无法在 '...' 创建目录：文件名太长​

node.js 有一些 路径名非常长，默认情况下 Windows 上的 git 不能正确处理长路径名（尽管 Windows 支持它们）。这应该可以解决问题。

$ git config --system core.longpaths true

错误：未声明的标识符 'DefaultDelegateCheckMode'​

在构建过程中，当使用 Windows Driver Kit 安装了 Windows 调试工具时，可能会发生这种情况。卸载 Windows Driver Kit，然后按照上述步骤安装调试工具。

构建脚本挂起直到按键​

此 bug 是 Windows 命令提示符的一个“特性”。当在启用了“快速编辑”的提示符窗口中单击时会发生这种情况，目的是为了方便选择和复制输出文本。由于每次意外单击都会暂停构建过程，因此您可能希望在命令提示符属性中禁用此功能。