bagpipe Version: 0.2.0 By @Jackson Tian

bagpipe.js

Bagpipe(风笛)

You are the bagpiper.

起源

在Node中我们可以十分方便利用异步和并行来提升我们的业务速度。但是,如果并发量过大,我们的服务器却可能吃不消,我们需要限制并发量。尽管http模块自身有http.Agent这样的玩意,用于控制socket的数量,但是通常我们的异步API早就封装好了。改动API的内部agent是不现实的,那么我们自己在逻辑层实现吧。

安装

npm install bagpipe

API

Bagpipe暴露的API只有构造器和实例方法push

在原始状态下,我们执行并发可能是如下这样的,这会形成100个并发异步调用。

for (var i = 0; i < 100; i++) {
  async(function () {
    // 异步调用
  });
}

如果需要限制并发,你的方案会是怎样?

Bagpipe的方案是如下这样的:

var Bagpipe = require('bagpipe');
// 设定最大并发数为10
var bagpipe = new Bagpipe(10);
for (var i = 0; i < 100; i++) {
  bagpipe.push(async, function () {
    // 异步回调执行
  });
}

是的,调用方式仅仅是将方法、参数、回调分拆一下通过push交给bagpipe即可。

这个方案与你预想的方案相比,如何?

原理

Bagpipe通过push将调用传入内部队列。如果活跃调用小于最大并发数,将会被取出直接执行,反之则继续呆在队列中。当一个异步调用结束的时候,会从队列前取出调用执行。以此来保证异步调用的活跃量不高于限定值。
当队列的长度大于100或者大于最大并发数的2倍时,Bagpipe对象将会触发它的full事件,该事件传递队列长度值。该值有助于评估业务性能参数。示例如下:

bagpipe.on('full', function (length) {
  console.warn('底层系统处理不能及时完成,队列拥堵,目前队列长度为:' + length);
});

模块状态

单元测试通过状态:Build Status。单元测试覆盖率100%

最佳实践

  • 确保异步调用的最后一个参数为回调参数
  • 监听full事件,以增加你对业务性能的评估
  • 目前异步方法未支持上下文。确保异步方法内部没有this引用
  • 异步调用应当具备timeout的业务处理,无论业务是否完成,总在一定的时间内保证返回

实际案例

当你需要遍历文件目录的时候,异步可以确保充分利用IO。你可以轻松发起成千上万个文件的读取。但是,系统文件描述符是有限的。不服的话,遇见下面这个错误再来重读此文。

Error: EMFILE, too many open files

也有人会考虑用同步方法来进行处理。但是,同步时,CPU与IO并不能并行利用,一定情况下,性能是不可弃的一项指标。用上Bagpipe,可以轻松享受并发,也能限制并发。

var bagpipe = new Bagpipe(10);

var files = ['这里有很多很多文件'];
for (var i = 0; i < files.length; i++) {
  // fs.readFile(files[i], 'utf-8', function (err, data) {
  bagpipe.push(fs.readFile, files[i], 'utf-8', function (err, data) {
    // 不会因为文件描述符过多出错
    // 妥妥的
  });
}

License

MIT许可证下发布,欢迎享受开源