electron + sqlite3 解决打包后无法写入数据库

前言

window环境。

electron@28.0.0
sqlite3@5.1.6
使用 electron-builder 打包。

本文旨在解决打包后无法写入数据库的问题。

但如果你是打包后无法访问sqlite，且有报错弹窗，不妨也看看本文。
也许是同一种原因。

错误原因分析

打包后无法创建db文件，是因为大部分人连接db，
都是用path模块，采用
path.join(__dirname, 'data.db') 类似这样的写法。

因为网上的垃圾教程都是这么教的，笔者也深受其害。

默认情况下，打包后获得的目录格式为（假设你的输出目录是dist/）

/dist/xxx.exe
/dist/resources/app.asar

xxx.exe是你的主程序。

electron打包后的项目根目录，指向app.asar 文件。

所以如果你在node里写的源代码是

const filePath = path.resolve(app.getAppPath(), 'storage', 'data.db')
const db = new sqlite3.Database(filePath)

在打包后，程序执行到这里，会去请求/dist/resources/app.asar/storage/data.sb文件。

再举一个例子，
假如你的项目目录是

myproject/package.json
myproject/main.js
myproject/src/dbserver/mydb.js
myproject/src/storage/data.db

然后在你mydb.js中这样写

const filePath = path.resolve(__dirname, '../storage/data.db')
const db = new sqlite3.Database(filePath)

在调试时候肯定是没问题的。

但是打包后，所有资源默认都被打包进app.asar，且根目录符号链接到app.asar。
程序执行到这里就会请求/resources/app.asar/src/storage/data.db这个地址。

如果你的打包设置是正确的，这一步并不会报错，因为data.db的的确确被打包进了这个路径。
你可以正确读取。

但是 app.asar是一个只可读不可写的文件。
当你要写入数据库的时候，就会发现怎么都无法写，甚至程序不报错。
因为用promise封装的db写入请求，只会一直pending，而不会reject。

为什么 app.asar只可读不可写？
某种意义上你可以把它看成程序的一部分。
如果app.asar被改写了，你可以认为你的程序遭到了入侵。
一般而言electron甚至鼓励你去校验app.asar的完整性，来确保自己的分发版本是正确的。

看起来这是一个合理的设计。

所以我们要做的应该是，让我们的db请求路径，不要指向app.asar。

正确解法

不要使用node提供的相对路径功能。
不要使用__dirname 变量。
不要使用electron.app.getAppPath()。
这些东西最后都会指向app.asar。

在生产环境就写一个相对路径字符串。

const isPackaged = app.isPackaged;
let filePath;
if(isPackaged){
	filePath = path.resolve('./resources/storage/data.db')
}
else{
	filePath = path.resolve(__dirname, '../storage/data.db')
}
const db = new sqlite3.Database(filePath)

同时在pakcge.json中配置extraResources字段。

"build":{
	 "extraResources":  {
	        "from": "./src/storage/",
	        "to": "storage"
	    },
}

这样整个/myproject/src/storage 目录都会被复制到/dist/resources/storage/位置。

这样最后程序执行db时，会指向/dist/resources/storage/data.db位置。
因为在path.resolve('./resources/storage/data.db') 这条命令中的，. 指向当前xxx.exe的运行位置。

这同样暗示我们，data.db应该作为一个外部文件管理，不应该放在src里。
src应该视为程序本体，在打包后，运行时，永远不变。
而data.db这种属于外部资源，打包后运行时会动态改变。
外部资源不应该在src里。
我上面举例的这种项目结构是不合理的。