ARM 上的 Windows
如果您的应用程序使用 Electron 6.0.8 或更高版本运行,您现在可以为其构建 Windows 10 on Arm 版本。这可以显著提高性能,但需要重新编译应用程序中使用的任何原生模块。它还可能需要对您的构建和打包脚本进行一些小的修复。
运行基础应用程序
如果您的应用程序不使用任何原生模块,那么创建应用程序的 ARM 版本非常简单。
- 请确保您的应用程序的
node_modules
目录是空的。 - 使用命令提示符,在像往常一样运行
npm install
/yarn install
之前,先运行set npm_config_arch=arm64
。 - 如果您将 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 链接器。要解决此问题,请执行以下操作:
- 复制适用于 VS 2017 的 x64_x86 交叉工具命令提示符快捷方式(例如,在开始菜单中找到它,右键单击,选择打开文件位置,复制并粘贴)到方便的位置。
- 右键单击新快捷方式并选择属性。
- 将目标字段末尾的
vcvarsamd64_x86.bat
更改为vcvarsamd64_arm64.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 头文件,并将 x86 和 x64 版本的 node.lib
下载到 %APPDATA%\..\Local\node-gyp\Cache
,但它不会下载 arm64 版本(此问题正在修复中)。要解决此问题:
- 从 https://electron.js.cn/headers/v6.0.9/win-arm64/node.lib 下载 arm64
node.lib
。 - 将其移动到
%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 远程调试器来调试原生模块。要进行调试:
- 通过命令提示符在目标设备上启动您的应用程序
.exe
(传递--inspect-brk
参数,使其在任何原生模块加载之前暂停)。 - 在您的开发机器上启动 Visual Studio 2017。
- 通过选择调试 > 附加到进程... 连接到目标设备,并输入 Visual Studio 远程调试器工具显示的设备 IP 地址和端口号。
- 点击刷新并选择 要附加的适当 Electron 进程。
- 您可能需要确保应用程序中原生模块的任何符号都已正确加载。要配置此项,请在 Visual Studio 2017 中转到调试 > 选项...,然后在调试 > 符号下添加包含
.pdb
符号的文件夹。 - 连接后,设置任何适当的断点,并使用 Chrome 的 Node 远程工具恢复 JavaScript 执行。
获取更多帮助
如果您在此文档中遇到问题,或者您的应用程序在为 x86 编译时可以正常工作,但在为 arm64 编译时不行,请 提交一个 issue,并在标题中包含“Windows on Arm”。