使用原生 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`).

如何安装原生模块

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

通过 `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应用程序的目标平台和体系结构兼容。
确保在该模块的binding.gyp中win_delay_load_hook没有被设置为false。
如果升级了 Electron，你通常需要重新编译这些模块。

在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 调用看起来像这样：

 link.exe /OUT:"foo.node" "...\node.lib" delayimp.lib / DELAYLOAD:node.exe /DLL
     "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 以示例显示延迟载荷钩，如果您正在执行自己的操作。