跳到主要内容

构建说明 (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
  • Git
  • Windows SDK 10.0.15063.468 的 Windows 调试工具，如果你计划创建完整的分发包，因为 symstore.exe 用于从 .pdb 文件创建符号存储。
    • 可以并排安装不同版本的 SDK。要安装 SDK，请打开 Visual Studio 安装程序，选择 修改 → 单个组件，向下滚动并选择要安装的相应 Windows SDK。另一种选择是查看Windows SDK 和模拟器存档并分别下载 SDK 的独立版本。
    • 还必须安装 SDK 调试工具。如果通过 Visual Studio 安装程序安装了 Windows 10 SDK，则可以通过以下方式安装它们： 控制面板 → 程序 → 程序和功能 → 选择“Windows Software Development Kit” → 更改 → 更改 → 选中“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）和不同的参数，同时构建 32 位目标和 64 位目标。

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

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

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

$ git config --system core.longpaths true

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

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

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

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