Electron 中使用【SQLite】数据库

SQLite 介绍#

SQLite 是一个轻量级的数据库系统，通常用于嵌入式系统和桌面应用程序。

创建表#

CREATE TABLE 表名 (

列 1 数据类型,

列 2 数据类型,

列 3 数据类型,

…

);

1
create table users (
2
id INTEGER PRIMARY KEY AUTOINCREMENT,
3
name text,
4
age INTEGER
5
);

注：建表的时候确定不了该表是否存在

1
CREATE TABLE IF NOT EXISTS users;

删除表#

DROP TABLE 表名;

1
DROP TABLE users;

查询数据中所有表#

1
SELECT * FROM sqlite_master WHERE type = 'table';

添加列#

ALTER TABLE 表名 ADD COLUMN 列名数据类型;

1
ALTER TABLE users ADD COLUMN age INT;

删除列#

ALTER TABLE 表名 DROP COLUMN 列名;

1
ALTER TABLE users DROP COLUMN age;

插入数据#

INSERT INTO 表名 (列 1, 列 2, 列 3, …) VALUES (值 1, 值 2, 值 3, …);

1
INSERT INTO users (id, name, age) VALUES (3, 'John3', 325);

注：不是数字的值需要单引号或双引号包括

更新数据#

UPDATE 表名 SET 列 1=值 1, 列 2=值 2, … WHERE 条件;

1
UPDATE users SET age=26 WHERE id=1;

删除数据#

DELETE FROM 表名 WHERE 条件;

1
DELETE FROM users WHERE id=1;

查询数据#

查询所有数据

SELECT * FROM 表名;
```
1
SELECT * FROM users;
```
查询特定列的数据

SELECT 列名 1, 列名 2 FROM 表名;
```
1
SELECT name, age FROM users;
```
查询筛选条件数据

SELECT * FROM 表名 WHERE 条件;
```
1
SELECT * FROM users WHERE id=1;
```
分页查询

SELECT * FROM 要查询的表名 LIMIT 每页的行数 OFFSET 起始行号;
```
1
SELECT * FROM users LIMIT page_size OFFSET start_row;
```

SQLite 占位符写法#

1
db.run("UPDATE tbl SET name = ? WHERE id = ?", "bar", 2);
2
db.run("UPDATE tbl SET name = ? WHERE id = ?", [ "bar", 2 ]);
3
db.run("UPDATE tbl SET name = $name WHERE id = $id", { $id: 2, $name: "bar"
4
});

Electron 中使用 SQLite#

在 Electron 应用中，SQLite 数据库的逻辑通常写在主进程中，而不是渲染进程。

Electron 中为什么要这样使用？#

安全性

在 Electron 应用中，主进程和渲染进程通常具有不同的职责和安全性考虑。主进程负责管理应用的生命周期、创建和与数据库进行交互等任务，而渲染进程则负责显示用户界面和处理用户输入。将数据库逻辑放在主进程中可以增加安全性，因为主进程通常具有更严格的权限和访问控制。
资源管理

SQLite 数据库的连接和操作需要资源管理。将数据库逻辑放在主进程中可以更好地控制这些资源，避免在渲染进程中产生资源泄漏或竞争条件。
异步操作

SQLite 数据库操作通常是异步的，需要回调函数或 Promises 来处理结果。将数据库逻辑放在主进程中可以更好地处理这些异步操作，避免在渲染进程中产生阻塞或延迟。
简化应用结构

将数据库逻辑放在主进程中可以简化应用的结构，使代码更易于维护和调试。这样可以确保应用的不同部分（如渲染进程和主进程）能够更好地分离和独立工作。

渲染进程中：通过主进程、渲染进程的 IPC 通信进行调用。

sqlite3 使用步骤#

安装依赖#

1
npm install sqlite3
2
# or
3
yarn install sqlite3

数据库实例以及数据库本地文件#

1
//　　实例
2
let db
3
//　　数据库表本地文件
4
const db_path = path.join(app.getAppPath(), '/db-config/sqlite3.db')

连接数据库#

1
//　　连接数据库（electron初始化完成时调用）
2
db = new sqlite3.Database(db_path, (err) => { //　　err错误信息　　})

运行 SQL 语句#

run(sql [, param, ...] [, callback]) 参数运行 SQL 查询，然后调用回调

1
db.run(sql, ...(params || []), (err) => {
2
  //　　err 错误信息
3
  //　　rows返回值
4
})

all(sql [, param, ...] [, callback]) 参数运行 SQL 查询，然后调用所有结果行的回调

1
db.all(sql, ...(params || []), (err, rows) => {
2
  //　　err 错误信息
3
  //　　rows返回值
4
})

关闭数据库#

1
//　　关闭数据库（electron应用程序开始关闭窗口时调用）
2
db && db.close()

electron 使用步骤#

preload 预加载#

ipcRenderer.invoke 主要用于在渲染进程中发送消息给主进程，并接收主进程的返回结果。

它比传统的 ipcRenderer.send 和 ipcMain.on 方式更为方便，因为使用 invoke 可以直接收到主进程返回的信息，而不需要在主进程中再发送一个返回结果。

1
/** sqlite */
2
onExecSQL: (params: SqliteType) => {
3
  return IPC_R2M2R.invoke('sqlite:execSQL', params)
4
}

主进程#

ipcMain.handle 是 Electron 中主进程用来处理渲染进程发送过来的异步或同步消息的方法。这个方法可以接收一个事件和一个回调函数，事件是由渲染进程发送过来的消息，回调函数则是用来处理这个消息的函数。

ipcMain.handle 方法支持异步，触发的方法是 ipcRenderer.invoke

1
ipcMain.handle('sqlite:execSQL', (e, params) => {
2
  return Promise.resolve(execSQL(params))
3
})

渲染进程#

1
window.electronIPC.onExecSQL(data).then((res) => {
2
  //　　res返回值
3
})

完整代码#

1
import { onSplicingQuotation } from '@/utils'
2
import { SqlTypeMap } from '@/views/EDB/utils/variable'
3
/**
4
 * @Author: LGJ
5
 * @Description: 日志
6
 * @Date: 2024/1/2 13:41
7
 */
8
}
9
export const errorger = (strs: any[]) => {
10
  console.error('【error】', ...strs)
11
}
12

13
/**
14
 * @Author: LGJ
15
 * @Description: ERROR记录
16
 * @Date: 2024/1/2 16:04
17
 */
18
export const onCheckExecSQLRes = (data: {
19
  fun?: string,
20
  sql: string,
21
  params?: any,
22
}) => {
23
  return new Promise((resolve, reject) => {
24
    window.electronIPC
25
      .onExecSQL(data)
26
      .then((res: any) => {
27
        const { data, status, message } = res
28
        status === 0 ? resolve(data) : reject(message)
29
      })
30
      .catch((e) => {
31
        errorger([e, data])
32
      })
33
  }).catch((e) => {
34
    errorger([e, data])
35
  })
36
}
37

38
/**
39
 * @Author: LGJ
40
 * @Description: 创建表格
41
 * @Date: 2023/12/29 10:31
42
 */
43
export const onCreateTable = (table_name: string) => {
44
  const sql: string =
45
    'CREATE TABLE IF NOT EXISTS ' +
46
    table_name +
47
    ' (id INT PRIMARY KEY, company TEXT);'
48
  return onCheckExecSQLRes({ sql })
49
}
50

51
/**
52
 * @Author: LGJ
53
 * @Description: 删除表格
54
 * @Date: 2023/12/29 10:31
55
 */
56
export const onDeleteTable = (table_name: string) => {
57
  const sql: string = 'DROP TABLE ' + table_name + ';'
58
  return onCheckExecSQLRes({ sql })
59
}
60

61
/**
62
 * @Author: LGJ
63
 * @Description:  查询数据库有哪些表
64
 * @Date: 2024/1/2 11:24
65
 */
66
export const onSelectTable = () => {
67
  const sql: string = "SELECT * FROM sqlite_master WHERE type = 'table';"
68
  return onCheckExecSQLRes({ fun: 'all', sql })
69
}
70

71
/**
72
 * @Author: LGJ
73
 * @Description:
74
 * @Date: 2024/1/9 18:55
75
 */
76
export const onSelectTableColumn = (table_name: string) => {
77
  const sql: string = 'PRAGMA table_info(' + table_name + ');'
78
  return onCheckExecSQLRes({ fun: 'all', sql })
79
}
80

81
/**
82
 * @Author: LGJ
83
 * @Description: 添加列，SQLite不支持批量
84
 * @Date: 2023/12/29 10:59
85
 */
86
export const onAddTableColumn = (
87
  table_name: string,
88
  column_name: string,
89
  column_type: string
90
) => {
91
  const sql: string =
92
    'ALTER TABLE ' +
93
    table_name +
94
    ' ADD COLUMN ' +
95
    column_name +
96
    ' ' +
97
    SqlTypeMap[column_type || 'string'] +
98
    ';'
99
  return onCheckExecSQLRes({ sql })
100
}
101

102
/**
103
 * @Author: LGJ
104
 * @Description: 删除列，SQLite不支持批量
105
 * @Date: 2024/1/2 09:48
106
 */
107
export const onDeleteTableColumn = (
108
  table_name: string,
109
  column_name: string
110
) => {
111
  const sql: string =
112
    'ALTER TABLE ' + table_name + ' DROP COLUMN ' + column_name + ';'
113
  return onCheckExecSQLRes({ sql })
114
}
115

116
/**
117
 * @Author: LGJ
118
 * @Description: 添加表格数据
119
 * @Date: 2024/1/2 10:14
120
 */
121
export const onAddTableData = (
122
  table_name: string,
123
  table_data: Record<string, any>
124
) => {
125
  const columns: string[] = Object.keys(table_data)
126
  if (!columns.length) return
127
  const params: string[] = Object.values(table_data)
128
  const values: any = Array(params.length)
129
    .fill(null)
130
    .map((item: any) => '?')
131
  const sql: string =
132
    'INSERT INTO ' +
133
    table_name +
134
    ' (' +
135
    columns.join(',') +
136
    ') VALUES (' +
137
    values.join(',') +
138
    ');'
139
  return onCheckExecSQLRes({ sql, params })
140
}
141

142
/**
143
 * @Author: LGJ
144
 * @Description: 删除表格数据（id）
145
 * @Date: 2024/1/2 10:19
146
 */
147

148
export const onDeleteTableData = (table_name: string, row_id: number) => {
149
  const sql: string =
150
    'DELETE FROM ' +
151
    table_name +
152
    ' WHERE id = ' +
153
    onSplicingQuotation(row_id) +
154
    ';'
155
  return onCheckExecSQLRes({ sql })
156
}
157

158
/**
159
 * @Author: LGJ
160
 * @Description: 修改表格数据（id）
161
 * @Date: 2024/1/2 14:47
162
 */
163
export const onUpdateTableData = (
164
  table_name: string,
165
  row_id: number,
166
  update_data: Record<string, any>
167
) => {
168
  const columns: string[] = Object.keys(update_data)
169
  if (!columns.length) return
170
  const params: string[] = Object.values(update_data)
171
  const set_sql: string[] = []
172
  columns.forEach((key: string) => {
173
    set_sql.push(key + '= ?')
174
  })
175
  const sql: string =
176
    'UPDATE ' +
177
    table_name +
178
    ' SET ' +
179
    set_sql.join(',') +
180
    ' WHERE id = ' +
181
    onSplicingQuotation(row_id) +
182
    ';'
183
  return onCheckExecSQLRes({ sql, params })
184
}
185

186
/**
187
 * @Author: LGJ
188
 * @Description: 运行指定sql
189
 * @Date: 2024/2/21 11:11
190
 */
191
export const onRunAppointSql = (sql: string) => {
192
  return onCheckExecSQLRes({ fun: 'all', sql })
193
}

音乐

音乐