Electron Angular SQLite项目rebuild时bcrypt编译报C1083无node_api.h

项目配置信息 #

• 基础运行版本：Node v10.20.1、Angular CLI 11.2.11、TypeScript 4.1.5
• Electron生态依赖：Electron v12.0.5、electron-builder ^22.11.1、electron-rebuild ^2.3.5、node-addon-api ^3.1.0、node-gyp ^8.0.0
• 原生依赖来源：sqlite3 直接拉取mapbox官方仓库源代码

问题现象 #

执行npm run rebuild触发electron-rebuild全量重编译原生模块时，bcrypt模块在编译进度0%阶段中断，抛出编译错误：

fatal error C1083：无法打开包含文件'node_api.h'：没有该文件或目录

报错关联的编译工程路径为G:\Project\Project\node_modules\bcrypt\build\bcrypt_lib.vcxproj，最终编译流程终止。
完整错误栈如下：

electron-rebuild内部出现未处理错误
   node-gyp重编译路径为'G:\Project\Project\node_modules\bcrypt'的模块失败。
   错误：`C:\Program Files (x86)\Microsoft Visual Studio 2019\BuildTools\MSBuild\Current\Bin\MSBuild.exe` 执行失败，退出码为1
   错误：node-gyp重编译路径为'G:\Project\Project\node_modules\bcrypt'的模块失败。
   错误：`C:\Program Files (x86)\Microsoft Visual Studio 2019\BuildTools\MSBuild\Current\Bin\MSBuild.exe` 执行失败，退出码为1
   at ModuleRebuilder.rebuildNodeGypModule (G:\Project\Project\node_modules\electron-rebuild\lib\src\module-rebuilder.js:193:19)
   at process._tickCallback (internal/process/next_tick.js:68:7)

排查思路与可落地解决方案 #

node_api.h是Node-API原生接口的核心头文件，该类报错本质是编译流程未正确检索到这个头文件的存放路径，结合当前版本组合可按顺序排查处理：

• 优先校验bcrypt版本兼容性
  当前环境存在Node ABI版本差：本地Node v10.20.1对应ABI版本为64，Electron v12.0.5对应ABI版本为80。早于v5.0.0版本的bcrypt默认绑定低版本Node编译逻辑，不会自动读取Electron内置的Node头文件路径，极易触发头文件缺失错误。
  操作：将bcrypt依赖升级到5.0.0及以上版本，该版本已原生支持Node-API路径自动检索，适配Electron重编译流程。
• 清理旧缓存修正node-gyp检索逻辑
  当前安装的node-gyp 8.0.0与Node v10.20.1存在已知兼容问题：编译原生模块时会优先检索本地Node目录下的旧版头文件，不会主动拉取Electron对应版本的头文件资源。
  操作：
  1. 删除node_modules/bcrypt路径下的build、deps两个编译缓存目录
  2. 执行带参数的重编译命令：electron-rebuild -f -w bcrypt --runtime=electron --target=12.0.5，强制匹配Electron v12.0.5的运行时版本，从Electron官方发布的对应版本头文件目录拉取编译依赖，避免检索本地Node v10路径下的旧版头文件。
• 手动补全编译头文件路径配置
  虽然项目已安装node-addon-api@3.1.0，但旧版bcrypt的编译脚本未自动将这个包的头文件目录加入MSBuild的检索路径。
  操作：打开bcrypt根目录下的binding.gyp配置文件，在include_dirs配置项中新增配置行<!(node -e "require('node-addon-api').include")，确保编译时能直接读取项目内node-addon-api包中携带的node_api.h文件，无需依赖系统全局路径的头文件。
• 兜底兼容方案
  若以上调整后仍存在编译失败问题，可直接替换bcrypt为功能一致的纯JS实现哈希库bcryptjs，完全绕过原生模块编译流程，彻底规避这类头文件路径类的编译错误。

内容的提问来源于stack exchange，提问作者santosh singh