Electron中sqlite3的安装以及Promise形式API的封装

前言

因为项目组最近开了个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++依赖，作者之前因为这个卡了一天。

c++ 依赖.png

然后就和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()
  }

最后编辑于：2019.07.22 16:52:40