使用 Node 原生模块

使用 Node 原生模块

Electron 支持原生的 Node 模块，但由于 Electron 非常有可能使用一个与您的系统上所安装的 Node 不同的 V8 引擎，您所使用的模块将需要被重新编译。否则，当您尝试运行您的应用程序时，将会遇到以下的错误：

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

如何安装原生模块

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

为 Electron 安装并重新编译模块

您可以像其他 Node 项目一样安装模块，然后用 electron-rebuild 包重建这些模块以适配 Electron 。这个包可以自动识别当前 Electron 版本，为你的应用自动完成下载 headers、重新编译原生模块等步骤。

例如，想要通过命令行下载 electron-rebuild 并重新编译：

npm install --save-dev electron-rebuild
# 每次运行"npm install"后，也运行这条命令
./node_modules/.bin/electron-rebuild
# 在windows下如果上述命令遇到了问题，尝试这个：
.\node_modules\.bin\electron-rebuild.cmd

更多有关使用方法和与其他工具结合的信息，请查阅该项目的README。

通过 `npm` 安装

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

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

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

为 Electron 手动编译

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

cd /path-to-module/
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版本。

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

故障排查

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

当有疑问时，请先执行 electron-rebuild。
确保原生模块与Electron应用程序的目标平台和体系结构兼容。
Make sure win_delay_load_hook is not set to false in the module’s binding.gyp.
如果升级了 Electron，你通常需要重新编译这些模块。

A note about `win_delay_load_hook`

在Windows上，默认情况下，node-gyp将原生模块与node.dll链接。 However, in Electron 4.x and higher, the symbols needed by native modules are exported by electron.exe, and there is no node.dll. In order to load native modules on Windows, node-gyp installs a delay-load hook that triggers when the native module is loaded, and redirects the node.dll reference to use the loading executable instead of looking for node.dll in the library search path (which would turn up nothing). As such, on Electron 4.x and higher, 'win_delay_load_hook': 'true' is required to load native modules.

If you get an error like Module did not self-register, or The specified procedure could not be found, it may mean that the module you’re trying to use did not correctly include the delay-load hook. If the module is built with node-gyp, ensure that the win_delay_load_hook variable is set to true in the binding.gyp file, and isn’t getting overridden anywhere. If the module is built with another system, you’ll need to ensure that you build with a delay-load hook installed in the main .node file. Your link.exe invocation should look like this:

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

In particular, it’s important that:

you link against node.lib from Electron and not Node. If you link against the wrong node.lib you will get load-time errors when you require the module in Electron.
you include the flag /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 is linked directly into the final DLL. If the hook is set up in a dependent DLL, it won’t fire at the right time.

See node-gyp for an example delay-load hook if you’re implementing your own.

依赖于 `prebuild` 的模块

prebuild provides a way to publish native Node modules with prebuilt binaries for multiple versions of Node and Electron.

如果为 Electron 提供二进制原生模块，请确保删除 --build-from-source 和 npm_config_build_from_source 环境变量来充分利用预编译的二进制文件。

依赖于 `node-pre-gyp` 的模块

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

通常这些模块在 Electron 中工作良好，但有时当 Electron 使用比 Node 新的 V8 版本且/或有 ABI 改变时，可能发生错误。因此，一般来说，建议始终从源代码编译原生模块。 electron-rebuild 会自动帮你处理这些问题。

如果你通过 npm 的方式安装模块，默认情况下这就完成了，如果没有，你需要传入 --build-from-source 给 npm, 或者设置 npm_config_build_from_source 环境变量。

使用原生 Node.js 模块