Electron 14.x.y 以上页面加载 node_sqlite3 reload 的时候崩溃的问题

问题产生原因

Electron 14.x.y 开始,Electron 废弃了一个接口:app.allowRendererProcessReuse

根据其官方文档描述,当设置了 app.allowRendererProcessReusetrue 时,render 进程在加载 native module 的时候,如果发生了重新加载代码的情况会自动复用某些底层的初始化代码。

因此,当 Electron 加载 node_sqlite3 的时候,由于加载了旧的结构代码(稍后会解释为什么此处是旧的结构),在 reload 的时候就崩溃了。

为什么 node_sqlite3 加载的是旧的结构

分析 node_sqlite3 源代码。在 src\database.cc 的代码中可以发现如下的代码:

Napi::Object Database::Init(Napi::Env env, Napi::Object exports) {
    Napi::HandleScope scope(env);

    Napi::Function t = DefineClass(env, "Database", {
        InstanceMethod("close", &Database::Close),
        InstanceMethod("exec", &Database::Exec),
        InstanceMethod("wait", &Database::Wait),
        InstanceMethod("loadExtension", &Database::LoadExtension),
        InstanceMethod("serialize", &Database::Serialize),
        InstanceMethod("parallelize", &Database::Parallelize),
        InstanceMethod("configure", &Database::Configure),
        InstanceMethod("interrupt", &Database::Interrupt),
        InstanceAccessor("open", &Database::OpenGetter, nullptr)
    });

#if NAPI_VERSION < 6
    constructor = Napi::Persistent(t);
    constructor.SuppressDestruct();
#else
    Napi::FunctionReference* constructor = new Napi::FunctionReference();
    *constructor = Napi::Persistent(t);
    env.SetInstanceData(constructor);
#endif

    exports.Set("Database", t);
    return exports;
}

参照 "Class property and descriptor" example crashes in Electron render process on reload 的处置结果可知,node_sqlite3 代码在底层实际上已经修复了该问题。但是在 reload 的时候仍然出现了错误的情况,说明修改的代码在预编译的时候并没有生效。即,默认编译的时候,NAPI_VERSION 的值小于 6。

继续分析 node_sqlite3 源代码。发现它使用的是 node-pre-gyp 的组件来进行本地编译工作的。在 node-pre-gyp 项目的 readme 中我们发现,在项目中,可以设置项目支持的 napi_versions。而在 node_sqlite3package.json 中,napi_versions 为:

"napi_versions": [
    3
]

即,限定了当前版本最高支持到 napi 版本 3。修改 package.json 中 napi_versions 如下:

"napi_versions": [
    3,
    4,
    5,
    6,
    7,
    8
]

再次 build,这时候就会发现编译的 native module 跟随本地的 node 版本的 napi 版本相同了(由于 electron 中使用的 electron-builder 或者 electron-rebuild,因此此处在后面继续解释)。至此,代码修改部分就基本结束了。

关于 node_sqlite3 在 electron 上 electron-builder 与 electron-rebuild 的使用问题

electron-builder

electron-builderpackage.json 中需要配置一段 script 脚本:"postinstall": "electron-builder install-app-deps",该脚本就是用来安装 native module 的。

在安装的过程中,会根据 electron-builder 的配置,将 native module 链接到指定 electron 的 node 版本。

通过跟踪代码后发现,其实现原理是调用了 nodejs 的 spawn 函数,执行了 npm install 命令。

追踪 electron-builder 的代码,最后确定该命令的代码位于 app-builder-lib\out\util\yarn.js 中的 installDependencies 方法中。

由于其在 env 中配置了 electron 相对应的 node 的 lib 路径,因此会在 native module build 过程中,直接连接使用 electron 相关版本的 lib。因此,此处的本质还是使用 node-sqlite3 自身的配置对 node-sqlite 进行的编译操作。最多对 node 连接的 lib 做了替换操作。

electron-rebuild

目前项目中并未有 electron-rebuild 的使用。因此,并未细究 electron-rebuild 的技术细节。

根据 electron-rebuild 的文档简介,rebuild 过程中,electron-rebuild 会使用 node-gyp 对需要 rebuild 的 native module 进行 rebuild 操作。从结果来看,rebuild 过程中 napi 版本,连接的 node 版本都是使用的 electron 相应的 node 版本。

但是,编译产生的文件却在 napi-v{napi_build_version}-win32-x64 文件夹中,而不是 napi-v8-win32-x64 文件夹中。这就导致了,electron 加载 node 模块的时候,仍旧加载了旧版本的 node 模块(因为 npm install 的时候就 build 好了该模块),仍旧出现问题。

当然,如果此时将 napi-v{napi_build_version}-win32-x64 的 node 文件替换掉 napi-v8-win32-x64 文件夹中 node 文件,该问题仍然可以得以解决。

参考

Electron 重大更改

"Class property and descriptor" example crashes in Electron render process on reload

你可能感兴趣的:(Electron 14.x.y 以上页面加载 node_sqlite3 reload 的时候崩溃的问题)