使用本机节点模块 | Using Native Node Modules
Using Native Node Modules
Electron支持本地节点模块,但由于Electron很可能使用与系统中安装的Node二进制文件不同的V8版本,因此在构建本地模块时必须手动指定Electron头文件的位置。
如何安装本地模块
三种安装本地模块的方法:
使用npm
通过设置一些环境变量,您可以npm
直接使用来安装模块。
为Electron安装所有依赖关系的示例:
# Electron's version.
export npm_config_target=1.2.3
# The architecture of Electron, can be ia32 or x64.
export npm_config_arch=x64
export npm_config_target_arch=x64
# Download headers for Electron.
export npm_config_disturl=https://atom.io/download/electron
# Tell node-pre-gyp that we are building for Electron.
export npm_config_runtime=electron
# Tell node-pre-gyp to build module from source code.
export npm_config_build_from_source=true
# Install all dependencies, and store cache to ~/.electron-gyp.
HOME=~/.electron-gyp npm install
为电子安装模块和重建
您也可以选择像其他Node项目一样安装模块,然后使用该electron-rebuild
软件包为Electron重建模块。该模块可以获得Electron版本,并处理手动下载头文件和为您的应用程序构建本机模块的步骤。
一个electron-rebuild
使用它安装并重建模块的例子:
npm install --save-dev electron-rebuild
# Every time you run "npm install", run this:
./node_modules/.bin/electron-rebuild
# On Windows if you have trouble, try:
.\node_modules\.bin\electron-rebuild.cmd
手动建立电子
如果您是开发本地模块的开发人员,并且想要针对Electron进行测试,则可能需要手动为Electron重新构建模块。您可以node-gyp
直接使用以构建Electron:
cd /path-to-module/
HOME=~/.electron-gyp node-gyp rebuild --target=1.2.3 --arch=x64 --dist-url=https://atom.io/download/electron
HOME=~/.electron-gyp
变化在哪里可以找到发展的头。该--target=1.2.3
是电子版本。该--dist-url=...
指定在哪里下载的头。该--arch=x64
模块是为64位系统构建的。
故障排除
如果您安装了本机模块并且发现它无法正常工作,则需要检查以下内容:
- 模块的体系结构必须与Electron的体系结构(ia32或x64)相匹配。
- 升级Electron后,通常需要重新构建模块。
- 当有疑问时,先运行
electron-rebuild
。
依赖于prebuild
prebuild
提供了一种轻松发布本地Node模块的方法,该模块具有用于多个版本的Node和Electron的预先构建的二进制文件。
如果模块为Electron中的使用提供二进制文件,请确保省略--build-from-source
和npm_config_build_from_source
环境变量以充分利用预先构建的二进制文件。
依赖于node-pre-gyp
该node-pre-gyp
工具提供了一种使用预先构建的二进制文件部署本地节点模块的方法,许多流行模块正在使用它。
通常,这些模块在Electron下工作良好,但有时当Electron使用比Node更新版本的V8时,并且有ABI更改时,可能会发生不好的事情。所以通常建议始终从源代码构建本地模块。
如果你正在跟踪的npm
安装模块的方式,那么这是自动进行的,如果不是,你必须通过--build-from-source
对npm
,或设置npm_config_build_from_source
环境变量。