[eggjs] egg-tx 接口级事务管理插件

2019-08-19

NPM versionbuild statusTest coverageKnown Vulnerabilitiesnpm download

一个 egg 事务插件,它支持 Mysql、Mongo 数据库,它能做到请求接口级别的事务管理。

依赖的插件

  • 对于使用 Mysql 数据库你需要开启 egg-sequelize插件。
  • 对于使用 Mongo 数据库你需要开启 egg-mongoose插件。

安装

$ npm i egg-tx --save

开启插件

// {app_root}/config/plugin.js
exports.tx = {
  enable: true,
  package: 'egg-tx',
};

配置

// {app_root}/config/config.default.js
exports.tx = {
    reqAction:['POST','PUT','DELETE'], 
    dbType:'mysql'
};
  • reqAction:将为指定动作的所有请求进行事务管理,该数组的值可为 GET、POST、PUT、DELETE、HEAD、PATCH、OPTIONS(默认值为 POST、PUT、DELETE)
  • dbType:所使用的数据库类型,该值可为 mysql 或 mongo (默认值为 mysql)

使用例子

你可以通过 ctx.tx.session获取到本次请求的事务会话对象,前提是它已经被事务管理器所管理。

mysql
await this.ctx.model.User.create(user, {
    transaction: this.ctx.tx.session,
});
mongo
await this.ctx.model.User.insertMany([
  { username: 'lyTongXue', password: '123456' },
], { session: this.ctx.tx.session });

注解

@tx

使用该注解的接口方法将会进行事务管理,即便 reqAction 配置项中未包含该动作类型的请求。

// {app_root}/app/controller/{controller_name}.js
/**
* @tx
*/
async create(){
}
@txIgnore

即便 reqAction 配置项中包含了该动作类型的请求,使用了该注解的接口方法将不会进行事务管理。

// {app_root}/app/controller/{controller_name}.js
/**
* @txIgnore
*/
async index(){
}

提问交流

1、接口方法的 jsDoc 是否有一定要求?

// --- 正确写法

/**
* @TX
*/
async create(){
}

// --- 错误写法

/**
* @TX
*/

async create(){
}

请到 egg issues异步交流。

License

MIT

原文链接:segmentfault.com

上一篇:vue文件分离
下一篇:jade-parser
相关教程
关注微信

扫码加入 JavaScript 社区

相关文章

首次访问,需要验证
微信扫码,关注即可
(仅需验证一次)

欢迎加入 JavaScript 社区

号内回复关键字:

回到顶部