egg-rate-limiter-flexible

![NPM version][npm-image] ![npm download][download-image]

• 基于rate-limiter-flexible，采用mongodb的流量控制
• 支持egg [js]
• 支持Controller控制器内分别配置请求速率限制

Install

1$ npm i egg-rate-limiter-flexible --save

Usage

1// {app_root}/config/plugin.js
2exports.rateLimiterFlexible = {
3  enable: true,
4  package: 'egg-rate-limiter-flexible',
5};

Configuration

1// {app_root}/config/config.default.js
2exports.rateLimiterFlexible = {
3  router: [
4    {
5      path: '/', // 限制路由路径 此规则不会匹配(index.html?id=1)[http://url/index.html?id=1]
6      max: 5,
7      time: '7s', // 时间单位 s m h d y ...
8      status: 209, // http 响应状态码
9      message: 'Custom request overrun error message'//自定义请求超限错误信息
10    },
11    {
12      path: '/api',
13      max: 5,
14      time: '7s', //时间单位 s m h d y ...
15      message: 'Custom request overrun error message'//自定义请求超限错误信息
16    }
17  ]
18};

see config/config.default.js for more detail.

Example

Configure ratelimiter information in ${app_root}/app/controller/home.js:

Controller

1export class HomeController {
2
3  async index(ctx) {
4    const { ctx, service } = this;
5
6    // 超出速率限制返回判断
7    // [true]为超出速率限制   [false]则继续向下执行
8    // js返回方法为 ctx.body = 'message'
9    if (await ctx.isRateLimited({ max: 5, time: '5s' })) {
10       ctx.body = 'Rate limit exceeded'
11    }
12
13    //...
14    //业务逻辑
15    //...
16
17    // 正常返回
18    ctx.body = 'success'
19  }
20}
21

Questions & Suggestions

Please open an issue here.

License

MIT