使用 Node 原生模块

原生Node.js模块由Electron支持，但由于Electron具有与给定Node.js不同的 应用二进制界面 （ABI）.js二进制（由于使用铬的 BoringSL 而不是 OpenSSL 等 差异），您使用的原生 模块需要为Electron重新编译。 否则，当您尝试运行您的应用程序时， 将会遇到以下的错误：

  1. Error: The module '/path/to/native/module.node'
  2. was compiled against a different Node.js version using
  3. NODE_MODULE_VERSION $XYZ. This version of Node.js requires
  4. NODE_MODULE_VERSION $ABC. Please try re-compiling or re-installing
  5. the module (for instance, using `npm rebuild` or `npm install`).

如何安装原生模块

有多种不同的方法来安装原生模块：

为 Electron 安装并重新编译模块

您可以像其他 Node 项目一样安装模块，然后用 electron-rebuild 包重建这些模块以适配 Electron 。 这个包可以自动识别当前 Electron 版本，为你的应用自动完成下载 headers、重新编译原生模块等步骤。 If you are using Electron Forge, this tool is used automatically in both development mode and when making distributables.

For example, to install the standalone electron-rebuild tool and then rebuild modules with it via the command line:

  1. npm install --save-dev electron-rebuild
  3. # Every time you run "npm install", run this:
  4. ./node_modules/.bin/electron-rebuild
  6. # If you have trouble on Windows, try:
  7. .\node_modules\.bin\electron-rebuild.cmd

For more information on usage and integration with other tools such as Electron Packager, consult the project’s README.

通过 npm 安装

只要设置一些系统环境变量，你就可以通过 npm 直接安装原生模块。

例如，要安装所有Electron的依赖：

  1. # Electron 的版本。
  2. export npm_config_target=1.2.3
  3. # Electron的目标架构, 可用的架构列表请参见
  4. # https://electronjs.org/docs/tutorial/support#supported-platforms
  5. export npm_config_arch=x64
  6. export npm_config_target_arch=x64
  7. # 下载 Electron 的 headers。
  8. export npm_config_disturl=https://electronjs.org/headers
  9. # 告诉 node-pre-gyp 我们是在为 Electron 生成模块。
  10. export npm_config_runtime=electron
  11. # 告诉 node-pre-gyp 从源代码构建模块。
  12. export npm_config_build_from_source=true
  13. # 安装所有依赖，并缓存到 ~/.electron-gyp。
  14. HOME=~/.electron-gyp npm install

为 Electron 手动编译

如果你是一个原生模块的开发人员，想在 Electron 中进行测试， 你可能要手动编译 Electron 模块。 你可以 使用 node-gyp 直接编译：

  1. cd /path-to-module/
  2. HOME=~/.electron-gyp node-gyp rebuild --target=1.2.3 --arch=x64 --dist-url=https://electronjs.org/headers
  • HOME=~/.electron-gyp 设置去哪找头文件
  • --target=1.2.3 设置了 Electron 的版本。
  • --dist-url=...设置了 Electron 的 headers 的下载地址。
  • --arch=x64 设置了该模块为适配64位操作系统而编译。

为Electron的自定义编译手动编译

如果是为一个与公共发行版不匹配的Electron自定义版本编译原生Node模块，需要让npm使用你的Electron自定义版本所对应的Node版本。

  1. npm rebuild --nodedir=/path/to/electron/vendor/node

故障排查

如果您安装了本机模块并发现它无法正常工作，则需要检查以下内容：

  • 当有疑问时，请先执行 electron-rebuild。
  • 确保原生模块与Electron应用程序的目标平台和体系结构兼容。
  • 确保在该模块的binding.gyp中win_delay_load_hook没有被设置为false。
  • 如果升级了 Electron，你通常需要重新编译这些模块。

关于win_delay_load_hook的说明

在Windows上，默认情况下，node-gyp将原生模块与node.dll链接。 然而，在Electron 4.x和更高的版本中，原生模块需要的symbols由electron.exe导出，并且没有node.dll。 为了在Windows上加载原生 模块 node-gyp 安装一个 延迟加载 钩子 当本地模块加载时触发 并重定向 节点。 ll 引用了使用 加载可执行文件而不是 节点。 在书库搜索中显示 的路径 路径(不会出现任何路径)。 因此，在 Electron 4.x 和更高版本， 'win_delay_load_hook': 'true' 需要加载本机模块。

如果您遇到错误，如 模块没有自注册， 或 无法找到指定的 程序这可能意味着你试图使用的模块 没有正确地包含延迟载荷钩。 如果模块是由 node-gyp, 确保将 win_delay_load_hook 变量设置为 true 在 中设置为 绑定。 yp 文件，不会在任何地方被忽略。 如果模块 是与另一个系统构建的， 您需要确保您在主 安装了 个延迟钩子来构建。 代码 文件。 您的 link.exe 调用 看起来像这样：

  1.  link.exe /OUT:"foo.node" "...\node.lib" delayimp.lib / DELAYLOAD:node.exe /DLL
  2.      "my_addon.obj" "win_delay_load_hook.obj"

尤其重要的是：

  • 您链接了 node.lib 来自 Electron 而不是节点。 如果您链接到 错误的 node.lib 当您需要 Electron 中的 模块时，您将会遇到加载时间错误。
  • 您包含标志 /DELAYLOAD:node.exe。 If the node.exe link is not delayed, then the delay-load hook won’t get a chance to fire and the node symbols won’t be correctly resolved.
  • win_delay_load_hook.obj 直接连接到最终的 DLL。 如果钩子 设置在依赖的 DLL 中，它不会在适当的时候开火。

请参阅 node-gyp 以示例显示延迟载荷钩，如果您正在执行自己的操作。

依赖于 prebuild 的模块

预构建 提供了一种发布 本机节点模块的方式，并且预建了二进制节点 和 Electron。

If the prebuild-powered module provide binaries for the usage in Electron, make sure to omit --build-from-source and the npm_config_build_from_source environment variable in order to take full advantage of the prebuilt binaries.

依赖于 node-pre-gyp 的模块

node-pre-gyp 工具 提供一种部署原生 Node 预编译二进制模块的方法， 许多流行的模块都是使用它。

Sometimes those modules work fine under Electron, but when there are no Electron-specific binaries available, you’ll need to build from source. Because of this, it is recommended to use electron-rebuild for these modules.

If you are following the npm way of installing modules, you’ll need to pass --build-from-source to npm, or set the npm_config_build_from_source environment variable.