egg-dj-mysql(与egg-mysql保持一致,依赖的ali-rds 修改为dj-ali-rds)
MySQL 插件是为 egg 提供 MySQL 数据库访问的功能
此插件基于 dj-ali-rds 实现一个简单的配置封装,具体使用方法你还需要阅读 [dj-ali-rds] 的文档。
安装
$ npm i egg-dj-mysql --save
配置
通过 config/plugin.js
配置启动 MySQL 插件:
exportsmysql = enable: true package: 'egg-dj-mysql';
在 config/config.${env}.js
配置各个环境的数据库连接信息:
单数据源
exportsmysql = // 单数据库信息配置 client: // host host: 'mysql.com' // 端口号 port: '3306' // 用户名 user: 'test_user' // 密码 password: 'test_password' // 数据库名 database: 'test' // 是否加载到 app 上,默认开启 app: true // 是否加载到 agent 上,默认关闭 agent: false;
使用方式:
appmysql; // 单实例可以直接通过 app.mysql 访问
多数据源
exportsmysql = clients: // clientId, 获取client实例,需要通过 app.mysql.get('clientId') 获取 db1: // host host: 'mysql.com' // 端口号 port: '3306' // 用户名 user: 'test_user' // 密码 password: 'test_password' // 数据库名 database: 'test' // ... // 所有数据库配置的默认值 default: // 是否加载到 app 上,默认开启 app: true // 是否加载到 agent 上,默认关闭 agent: false;
使用方式:
const client1 = appmysql;client1; const client2 = appmysql;client2;
扩展
app.js
app.mysql
如果开启了 config.mysql.app = true
,则会在 app 上注入 ali-rds 客户端 的 Singleton 单例。
appmysql;appmysql;
agent.js
agent.mysql
如果开启了 config.mysql.agent = true
,则会在 agent 上注入 ali-rds 客户端 的 Singleton 单例。
agentmysql;agentmysql;
CRUD 使用指南
Create
// 插入const result = appmysql;const insertSuccess = resultaffectedRows === 1;
Read
Select
- Select all rows
let rows = db; SELECT * FROM `table-name`
- Select rows with condition
let rows = db; SELECT `author` `title` FROM `table-name` WHERE `type` = 'javascript' ORDER BY `id` DESC
let rows = db});#### 连表查询第一张表默认为a表 SELECT `a.name` as kk `a.like_count` 'a.avatar' 'a.uid' FROM `table-name` ASLEFT JOIN table2 as b ON auid = buser_id WHERE astate =0 AND acreate_time>=1522133665520 AND acreate_time<=Date GROUP BY 'a.uid' ORDER BY `a.like_count` DESC
Update
// 修改数据,将会根据主键 ID 查找,并更新const row = id: 123 name: 'fengmk2' otherField: 'other field value' modifiedAt: appmysqlliteralsnow // `now()` on db server;const result = appmysql;const updateSuccess = resultaffectedRows === 1;
Delete
const result = appmysql;
事务
手动控制
- 优点:beginTransaction, commit 或 rollback 都由开发者来完全控制,可以做到非常细粒度的控制。
- 缺点:手写代码比较多,不是每个人都能写好。忘记了捕获异常和 cleanup 都会导致严重 bug。
const conn = appmysql; try conn; conn; conn; catch err // error, rollback conn; // rollback call won't throw err throw err;
自动控制:Transaction with scope
- API:
*beginTransactionScope(scope, ctx)
scope
: 一个 generatorFunction,在这个函数里面执行这次事务的所有 sql 语句。ctx
: 当前请求的上下文对象,传入 ctx 可以保证即便在出现事务嵌套的情况下,一次请求中同时只有一个激活状态的事务。
- 优点:使用简单,不容易犯错,就感觉事务不存在的样子。
- 缺点:整个事务要么成功,要么失败,无法做细粒度控制。
const result = appmysql; // ctx 是当前请求的上下文,如果是在 service 文件中,可以从 `this.ctx` 获取到// if error throw on scope, will auto rollback
进阶
自定义SQL拼接
const results = appmysql;
表达式(Literal)
如果需要调用mysql内置的函数(或表达式),可以使用Literal
。
内置表达式
- NOW(): 数据库当前系统时间,通过
app.mysql.literals.now
获取。
appmysql; // INSERT INTO `$table`(`create_time`) VALUES(NOW())
自定义表达式
下例展示了如何调用mysql内置的CONCAT(s1, ...sn)
函数,做字符串拼接。
const Literal = appmysqlliteralsLiteral;const first = 'James';const last = 'Bond'; appmysql; // INSERT INTO `$table`(`id`, `fullname`) VALUES(123, CONCAT("James", "Bond"))
Questions & Suggestions
Please open an issue here.