Skip to content

Latest commit

 

History

History
285 lines (215 loc) · 8.43 KB

README.zh-CN.md

File metadata and controls

285 lines (215 loc) · 8.43 KB
Raw

egg-mysql

NPM version Node.js CI Test coverage npm download

MySQL 插件是为 egg 提供 MySQL 数据库访问的功能

此插件基于 ali-rds 实现一个简单的配置封装，具体使用方法你还需要阅读 ali-rds 的文档。

安装

npm i egg-mysql --save

配置

通过 config/plugin.ts 配置启动 MySQL 插件:

export default {
  mysql: {
    enable: true,
    package: 'egg-mysql',
  },
}

在 config/config.${env}.ts 配置各个环境的数据库连接信息：

单数据源

export default {
  mysql: {
    // 单数据库信息配置
    client: {
      // host
      host: 'mysql.com',
      // 端口号
      port: '3306',
      // 用户名
      user: 'test_user',
      // 密码
      password: 'test_password',
      // 数据库名
      database: 'test',    
    },
    // 是否加载到 app 上，默认开启
    app: true,
    // 是否加载到 agent 上，默认关闭
    agent: false,
  },
}

使用方式：

await app.mysql.query(sql, values); // 单实例可以直接通过 app.mysql 访问

多数据源

export default {
  mysql: {
    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 = app.mysqls.get('db1');
await client1.query(sql, values);

const client2 = app.mysqls.get('db2');
await client2.query(sql, values);

扩展

Application

app.mysql

如果开启了 config.mysql.app = true，则会在 app 上注入 ali-rds 客户端 的 Singleton 单例。

await app.mysql.query(sql);
await app.mysqls.get('db1').query(sql);

Agent

agent.mysql

如果开启了 config.mysql.agent = true，则会在 agent 上注入 ali-rds 客户端 的 Singleton 单例。

await agent.mysql.query(sql);
await agent.mysqls.get('db1').query(sql);

CRUD 使用指南

Create

// 插入
const result = await app.mysql.insert('posts', { title: 'Hello World' });
const insertSuccess = result.affectedRows === 1;

Read

// 获得一个
const post = await app.mysql.get('posts', { id: 12 });
// 查询
const results = await app.mysql.select('posts',{
  where: { status: 'draft' },
  orders: [['created_at','desc'], ['id','desc']],
  limit: 10,
  offset: 0
});

Update

// 修改数据，将会根据主键 ID 查找，并更新
const row = {
  id: 123,
  name: 'fengmk2',
  otherField: 'other field value',
  modifiedAt: app.mysql.literals.now, // `now()` on db server
};
const result = await app.mysql.update('posts', row);
const updateSuccess = result.affectedRows === 1;

Delete

const result = await app.mysql.delete('table-name', {
  name: 'fengmk2'
});

事务

手动控制

  • 优点：beginTransaction, commit 或 rollback 都由开发者来完全控制，可以做到非常细粒度的控制。
  • 缺点：手写代码比较多，不是每个人都能写好。忘记了捕获异常和 cleanup 都会导致严重 bug。
const conn = await app.mysql.beginTransaction();

try {
  await conn.insert(table, row1);
  await conn.update(table, row2);
  await conn.commit();
} catch (err) {
  // error, rollback
  await conn.rollback(); // rollback call won't throw err
  throw err;
}

自动控制：Transaction with scope

  • API：async beginTransactionScope(scope, ctx)
    • scope: 一个 generatorFunction，在这个函数里面执行这次事务的所有 sql 语句。
    • ctx: 当前请求的上下文对象，传入 ctx 可以保证即便在出现事务嵌套的情况下，一次请求中同时只有一个激活状态的事务。
  • 优点：使用简单，不容易犯错，就感觉事务不存在的样子。
  • 缺点：整个事务要么成功，要么失败，无法做细粒度控制。
const result = await app.mysql.beginTransactionScope(async (conn) => {
  // don't commit or rollback by yourself
  await conn.insert(table, row1);
  await conn.update(table, row2);
  return { success: true };
}, ctx); // ctx 是当前请求的上下文，如果是在 service 文件中，可以从 `this.ctx` 获取到
// if error throw on scope, will auto rollback

进阶

自定义SQL拼接

const results = await app.mysql.query('update posts set hits = (hits + ?) where id = ?', [1, postId]);

表达式(Literal)

如果需要调用mysql内置的函数（或表达式），可以使用Literal。

内置表达式

  • NOW(): 数据库当前系统时间，通过app.mysql.literals.now获取。
await app.mysql.insert(table, {
  create_time: app.mysql.literals.now
});

// INSERT INTO `$table`(`create_time`) VALUES(NOW())

自定义表达式

下例展示了如何调用mysql内置的CONCAT(s1, ...sn)函数，做字符串拼接。

const Literal = app.mysql.literals.Literal;
const first = 'James';
const last = 'Bond';
await app.mysql.insert(table, {
  id: 123,
  fullname: new Literal(`CONCAT("${first}", "${last}"`),
});

// INSERT INTO `$table`(`id`, `fullname`) VALUES(123, CONCAT("James", "Bond"))

Questions & Suggestions

Please open an issue here.

License

MIT

Contributors


fengmk2
jtyjty99999
popomore
semantic-release-bot
atian25
dead-horse

AntiMoron
guoshencheng
Krryxa
cnwangjie
starandtina
shangwenhe

This project follows the git-contributor spec, auto updated at Mon Mar 06 2023 21:57:18 GMT+0800.