跳转到主要内容

构建说明 (Windows)

请遵循以下指南在 Windows 上构建 Electron 本身，以便创建自定义 Electron 二进制文件。对于将您的应用程序代码与预构建的 Electron 二进制文件捆绑和分发，请参阅 应用程序分发 指南。

先决条件​

  • Windows 10 / Server 2012 R2 或更高版本
  • Visual Studio 2019 (>=16.0.0) 用于构建，但 Visual Studio 2022 (>=17.0.0) 更受推荐 - 免费下载 VS 2022 Community Edition
    • 有关需要哪些 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，选择 Modify → Individual Components，向下滚动并选择要安装的适当 Windows SDK。另一种选择是查看 Windows SDK 和模拟器存档 并下载独立版本的 SDK。
    • 还必须安装 SDK 调试工具。如果通过 Visual Studio Installer 安装了 Windows 10 SDK，则可以通过以下方式安装它们：Control Panel → Programs → Programs and Features → 选择“Windows Software Development Kit” → Change → Change → 选中“Debugging Tools For Windows” → Change。或者，您可以下载独立的 SDK 安装程序并使用它来安装调试工具。

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

构建 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）使用不同的参数来同时构建 32 位目标和 64 位目标。

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

其他构建步骤完全相同。

Visual Studio 项目​

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

$ 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 命令提示符代替。

无法在“...”处创建目录：文件名太长​

node.js 有一些 极其长的路径名，并且默认情况下，Windows 上的 git 无法正确处理长路径名（即使 Windows 支持它们）。这应该可以解决它

$ git config --system core.longpaths true

错误：使用了未声明的标识符“DefaultDelegateCheckMode”​

这可能发生在构建期间，当 Windows 调试工具与 Windows 驱动程序工具包一起安装时。卸载 Windows 驱动程序工具包，并按照上述步骤安装调试工具。

构建脚本挂起直到按下任意键​

此错误是 Windows 命令提示符的“功能”。当单击启用 QuickEdit 的命令提示符窗口时会发生这种情况，旨在允许轻松选择和复制输出文本。由于每次意外单击都会暂停构建过程，您可能希望在命令提示符属性中禁用此功能。