简介
electron-rebuild 是一个 npm 包，能够帮助你重建 Electron 项目中 node_modules 目录下某些需要编译的 native 模块。例如 serialport, usb, leveldown 等等。
如果你需要使用这些模块，但在 Electron 项目中遇到了问题，比如出现编译错误或者执行 node_modules 下模块时出现 Segment Fault 等等，那么可以使用 electron-rebuild 来尝试解决问题。
安装
你可以通过 npm 包管理器来安装 electron-rebuild，全局或者本地都可以。
# 全局安装 npm install -g electron-rebuild # 本地安装 npm install electron-rebuild --save-dev
使用
重建全局 native 模块
安装 electron-rebuild 后，我们可以使用 electron-rebuild -w 命令来重建全局安装的 native 模块，其中 -w 表示 watch，即监听文件变化并实时刷新。
# 重建全局 native 模块 electron-rebuild -w
在执行这个命令的时候，你需要保证以下几点：
- 在执行的时候，你需要已经安装了
Electron； - 在执行的时候，你需要已经安装了你想要重新构建的
native模块； - 如果你想要监听文件变化并实时刷新，电脑上需要安装
nodemon。
为 node_modules 下模块重新构建 native 模块
如果你的 Electron 项目中只有一些 native 模块没有编译成功，那你可以使用 electron-rebuild 来重建这些模块。
你需要在你的 package.json 文件中加入以下脚本：
{
"name": "your-project",
"scripts": {
"rebuild": "electron-rebuild"
}
}然后执行以下命令：
# 为 node_modules 下模块重新构建 native 模块 npm run rebuild
将重建的 native 模块映射到 app 目录
当你使用 Electron 开发应用的时候，你需要使用一些 native 模块。因为 Electron 中的 node.js 版本和系统的 node.js 版本不同，直接使用 npm install <module_name> 安装的 native 模块可能会在执行时出现问题。此时，我们需要使用 electron-rebuild 重新构建这些 native 模块，然后将它们映射到 app 目录下。
你需要在你的 index.js 文件中，加入以下代码：
const rebuild = require('electron-rebuild');
rebuild.default((_, __, cb) => {
cb();
})当你执行 npm run start 启动应用的时候，electron-rebuild 会自动重新构建 native 模块，并将它们映射到 app 目录下，你就可以在应用中使用这些模块了。
示例代码
package.json
-- -------------------- ---- -------
-
------- ----------------------------
---------- --------
-------------- ---
------- -----------
---------- -
---------- -------------------
-------- --------- --
--
--------- ---
---------- ------
------------------ -
----------- ----------
------------------- --------
-
-index.js
-- -------------------- ---- -------
----- - ---- ------------- - - --------------------
----- ---- - ----------------
----- ------- - ----------------------------
------------------- --- --- -- -
-----
--
-------- ------------ -- -
----- ---------- - --- ---------------
------ ----
------- ----
--------------- -
-------- -------------------- -------------
-
--
---------------------------------
-------------------------------------
-
----------------------- -- -
--------------
------------------ -------- -- -
-- ------------------------------------- --- -- --------------
--
--
--------------------------- -------- -- -
-- ----------------- --- --------- ----------
--总结
electron-rebuild 能够帮助我们重建 Electron 项目中一些需要编译的 native 模块。如果你在项目中使用了这些模块，在编译或者运行过程中遇到问题，可以尝试使用 electron-rebuild 来解决问题。同时，我们也需要注意一些细节，例如在执行 electron-rebuild -w 命令的时候，需要保证安装了 Electron 和需要重建的 native 模块，以及使用 electron-rebuild 将重建的 native 模块映射到 app 目录，使得我们在应用中可以正常使用这些模块。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/87798