前言
因為項目組最近開了個electron的新項目,已經二十多天沒有寫過文章了,恰巧剛遇到了sqlite相關的問題,于是把相關的問題和解決方法總結一下。
新項目用的的技術棧是Electron + Vue,公司的上一個electron項目使用的是electron-vue,但是這個庫的作者已經很長時間沒有維護了。部門老大想要使用新的技術,所以把這個項目構建的任務交給了本人,等有時間我會專門寫一篇文章來介紹我是如何搭建項目的。這次就先介紹一下sqlite3吧。
安裝
以前并沒有使用過sqlite, 所以本來以為直接
npm install sqlite3 --save
就可以了,后來才知道太天真了。
mac和windows安裝有些步驟不太一樣。
mac系統
首先第一步是先安裝node-gyp
因為是全局安裝,所以mac需要加上sudo
sudo npm install -g node-gyp
接下來就可以構建sqlite了,mac系統運行下面的命令就可以了
npm install sqlite3 --runtime=electron --target=5.0.7 --dist-url=https://atom.io/download/electron --save
target后面填electron的版本,作者使用的是最新的5.0.7
windows系統
windows相對蘋果而言需要安裝不少前置依賴,如果缺了這一步是無法構建成功的。
第一步安裝python,因為蘋果自帶python所以不用安裝,現在的有些windows系統好像也自帶python,如果沒有的話就安裝python 2.7。
安裝VS的C++依賴,作者之前因為這個卡了一天。
然后就和mac的步驟一樣了。
安裝node-gyp
npm install -g node-gyp
下載并編譯
npm install sqlite3 --runtime=electron --target=5.0.7 --dist-url=https://atom.io/download/electron --save
target后面填electron的版本,作者使用的是最新的5.0.7
構建成功后就可以直接使用了。
PS: 因為我在安裝的時候查閱了很多資料,發現不同的系統,甚至是不同的系統版本都可能導致失敗,作者使用的是mac系統最終成功安裝,同時給大家提供一些參考
官方文檔中有關electron下sqlite的安裝 https://github.com/mapbox/node-sqlite3#custom-builds-and-electron
stackoverflow上的一個提問 https://stackoverflow.com/questions/38716594/electron-app-cant-find-sqlite3-module
API封裝
sqlite3的api全部是異步回調函數的形式,我們當然希望使用Promise和async/await來開發,本來是有一個sqlite的npm包提供來這個功能,但是我在使用的時候沒有安裝成功,再加上sqlite3的api并不多,所以最后決定自己封裝。
代碼已經傳到github上了 https://github.com/Harlan-ZhangDongXing/sqlite
import sqlite3 from 'sqlite3'
const sqlite = sqlite3.verbose()
class Sqlite {
constructor() {
this.instance
this.db = null
}
// 連接數據庫
connect(path) {
return new Promise((resolve,reject) => {
this.db = new sqlite.Database(path, (err) => {
if(err === null) {
resolve(err)
} else {
reject(err)
}
})
})
}
// 運行sql
run(sql, params) {
return new Promise((resolve, reject) => {
this.db.run(sql, params, (err) => {
if(err === null) {
resolve(err)
} else {
reject(err)
}
})
})
}
// 運行多條sql
exec(sql) {
return new Promise((resolve, reject) => {
this.db.exec(sql, (err) => {
if(err === null) {
resolve(err)
} else {
reject(err)
}
})
})
}
// 查詢一條數據
get(sql, params) {
return new Promise((resolve, reject) => {
this.db.get(sql, params, (err, data) => {
if(err) {
reject(err)
} else {
resolve(data)
}
})
})
}
// 查詢所有數據
all(sql, params) {
return new Promise((resolve, reject) => {
this.db.all(sql, params, (err, data) => {
if(err) {
reject(err)
} else {
resolve(data)
}
})
})
}
// 關閉數據庫
close() {
this.db.close()
}
// 單例
static getInstance() {
this.instance = this.instance ? this.instance : new Sqlite()
return this.instance
}
}
export default Sqlite
目前只封裝了幾個常用的,需要的開發者可以仿照這個自己封裝。
下面貼一段在vue的create()鉤子函數中使用的示例
import Sqlite from './common/js/api/sqlite'
async created () {
const db = Sqlite.getInstance()
await db.connect('./database/tabletSign.db')
await db.run('CREATE TABLE IF NOT EXISTS test(a int, b char)')
await db.run(`INSERT INTO test VALUES(10, 'abcd')`)
const response = await db.all('SELECT * FROM test')
db.close()
}