跳到主要内容

Windows on ARM

如果你的应用使用 Electron 6.0.8 或更高版本运行,那么你现在可以为 Arm 上的 Windows 10 构建它。 这将显著提高性能,但需要重新编译你的应用中使用的任何原生模块。 它还可能需要对你的构建和打包脚本进行小的修复。

运行一个基本应用

如果你的应用不使用任何原生模块,那么创建一个 Arm 版本的应用就非常容易。

  1. 确保你的应用的 node_modules 目录为空。
  2. 使用命令提示符,在像往常一样运行 npm install/yarn install 之前,运行 set npm_config_arch=arm64
  3. 如果你已将 Electron 作为开发依赖项安装,npm 将下载并解压 arm64 版本。 然后你可以像往常一样打包和分发你的应用。

一般注意事项

架构特定代码

许多 Windows 特定代码包含 if... else 逻辑,用于在 x64 或 x86 架构之间进行选择。

if (process.arch === 'x64') {
// Do 64-bit thing...
} else {
// Do 32-bit thing...
}

如果你想以 arm64 为目标,像这样的逻辑通常会选择错误的架构,因此请仔细检查你的应用程序和构建脚本中是否存在这样的条件。 在自定义构建和打包脚本中,你应该始终检查环境中的 npm_config_arch 的值,而不是依赖于当前进程架构。

原生模块

如果你使用原生模块,你必须确保它们是针对 MSVC 编译器 v142(在 Visual Studio 2017 中提供)编译的。 你还必须检查原生模块提供或引用的任何预构建的 .dll.lib 文件是否可用于 Windows on Arm。

测试你的应用

要测试你的应用,请使用运行 Windows 10(版本 1903 或更高版本)的 Windows on Arm 设备。 确保将你的应用程序复制到目标设备 - 当从网络位置加载你的应用程序资源时,Chromium 的沙箱将无法正常工作。

开发先决条件

Node.js/node-gyp

建议使用 Node.js v12.9.0 或更高版本。 如果不希望更新到新版本的 Node,你可以改为手动更新 npm 的 node-gyp 副本到 5.0.2 或更高版本,其中包含编译 Arm 原生模块所需的更改。

Visual Studio 2017

交叉编译原生模块需要 Visual Studio 2017(任何版本)。 你可以通过 Microsoft 的 Visual Studio Dev Essentials 计划下载 Visual Studio Community 2017。 安装后,你可以通过从命令提示符运行以下命令来添加特定于 Arm 的组件

vs_installer.exe ^
--add Microsoft.VisualStudio.Workload.NativeDesktop ^
--add Microsoft.VisualStudio.Component.VC.ATLMFC ^
--add Microsoft.VisualStudio.Component.VC.Tools.ARM64 ^
--add Microsoft.VisualStudio.Component.VC.MFC.ARM64 ^
--includeRecommended

创建交叉编译命令提示符

在环境中设置 npm_config_arch=arm64 会创建正确的 arm64 .obj 文件,但标准的 VS 2017 开发人员命令提示符将使用 x64 链接器。 为了解决这个问题

  1. 复制 VS 2017 的 x64_x86 交叉工具命令提示符快捷方式(例如,通过在开始菜单中找到它,右键单击,选择打开文件位置,复制和粘贴)到方便的位置。
  2. 右键单击新的快捷方式,然后选择属性
  3. 更改目标字段,使其末尾读取 vcvarsamd64_arm64.bat 而不是 vcvarsamd64_x86.bat

如果成功完成,命令提示符应在启动时打印类似于以下内容

**********************************************************************
** Visual Studio 2017 Developer Command Prompt v15.9.15
** Copyright (c) 2017 Microsoft Corporation
**********************************************************************
[vcvarsall.bat] Environment initialized for: 'x64_arm64'

如果要在 Windows on Arm 设备上直接开发应用程序,请在目标中替换 vcvarsx86_arm64.bat,以便可以使用设备的 x86 模拟进行交叉编译。

链接到正确的 node.lib

默认情况下,node-gyp 解压 Electron 的 node 标头并将 node.lib 的 x86 和 x64 版本下载到 %APPDATA%\..\Local\node-gyp\Cache 中,但它不会下载 arm64 版本(此问题的修复正在开发中。) 为了解决这个问题

  1. https://electron.js.cn/headers/v6.0.9/win-arm64/node.lib 下载 arm64 node.lib
  2. 将其移动到 %APPDATA%\..\Local\node-gyp\Cache\6.0.9\arm64\node.lib

6.0.9 替换为你正在使用的版本。

交叉编译原生模块

完成以上所有操作后,打开你的交叉编译命令提示符并运行 set npm_config_arch=arm64。 然后像往常一样使用 npm install 构建你的项目。 与交叉编译 x86 模块一样,如果原生模块以前是为另一个架构编译的,你可能需要删除 node_modules 以强制重新编译原生模块。

调试原生模块

调试原生模块可以使用 Visual Studio 2017(在你的开发机器上运行)和相应的 Visual Studio 远程调试器(在目标设备上运行)完成。 要调试

  1. 通过命令提示符在目标设备上启动你的应用程序 .exe(传递 --inspect-brk 以在加载任何原生模块之前暂停它)。
  2. 在你的开发机器上启动 Visual Studio 2017。
  3. 通过选择调试 > 附加到进程...连接到目标设备,然后输入设备 IP 地址和 Visual Studio 远程调试器工具显示的端口号。
  4. 单击刷新并选择要附加的相应 Electron 进程
  5. 你可能需要确保正确加载应用程序中原生模块的任何符号。 要配置此项,请转到 Visual Studio 2017 中的调试 > 选项...,并在调试 > 符号下添加包含你的 .pdb 符号的文件夹。
  6. 附加后,设置任何适当的断点,并使用 Chrome 的 Node 远程工具恢复 JavaScript 执行。

获取更多帮助

如果你遇到此文档的问题,或者如果你的应用程序在为 x86 编译时有效,但为 arm64 编译时无效,请提交一个 issue,标题中包含“Windows on Arm”。