node.js异步框架thenjs

发表于

项目中存在大量的es5回调的代码，而且生产环境对原生Promise、awati/async 支持不够好，所以使用then.js作为异步解决方案，避免回调地狱的问题，也能兼容老代码。本文简要介绍了then.js异步框架的特点、安装和基本用法。

它是什么

一个解决js异步回调问题的方案，它可以将“回调地狱”处理成并列的then链，方便代码的阅读和维护。
官网地址

特点

  • 可以像标准的 Promise 那样，把N多异步回调函数写成一个长长的 then 链，并且比 Promise 更简洁自然。因为如果使用标准 Promise 的 then 链，其中的异步函数都必须转换成 Promise，Thenjs 则无需转换，像使用 callback 一样执行异步函数即可。

  • 强大的 Error 机制，可以捕捉任何同步或异步的异常错误，甚至是位于异步函数中的语法错误。并且捕捉的错误任君处置。

  • 开启debug模式，可以把每一个then链运行结果输出到debug函数（未定义debug函数则用 console.log），方便调试。

安装&使用

$ npm install thenjs --save
var Thenjs = require("thenjs");

使用方式

demo

Thenjs(function (cont) {
  cont(null, result);
})
.then(function (cont) {
  cont(new Error('error!'), 123);
})
.fin(function (cont, error, result) {
  console.log(error, result);
  cont();
})
.each([0, 1, 2], function (cont, value) {
  //do sth with value
  cont(null);  // 并行执行队列任务，把队列 list 中的每一个值输入到 task 中运行
})
.then(function (cont, result) {
  console.log(result);
  cont();
})
.series([ // 串行执行队列任务
  function (cont) { task(88, cont); }, // 队列第一个是异步任务
  function (cont) { cont(null, 99); } // 第二个是同步任务
])
.then(function (cont, result) {
  console.log(result);
  cont(new Error('error!!'));
})
.fail(function (cont, error) { // 通常应该在链的最后放置一个 `fail` 方法收集异常
  console.log(error);
  console.log('DEMO END!');
});

两种方式定义

Thenjs().then(function(cont) { 
    cont(null); 
});
Thenjs(function(cont, result) { 
    cont(result); 
})
.then(function(cont, result) {
});

Thenjs.each(array, iterator)

将 array 中的值应用于 iterator 函数（同步或异步），并行执行。返回一个新的 Thenjs 对象。
返回结果result是一个数组，包含每个cont返回的值

Thenjs.each([0, 1, 2], function (cont, value) {
  task(value * 2, cont);
})
.then(function (cont, result) {
  console.log(result);
});

Thenjs.eachSeries(array, iterator)

同上，串行执行

Thenjs.parallel(tasksArray)

tasksArray 是一个函数（同步或异步）数组，并行执行。返回一个新的 Thenjs 对象。

Thenjs.parallel([
  function (cont) { task(88, cont); },
  function (cont) { cont(null, 99); }
])
.then(function (cont, result) {  //result 是返回结果的数组
  console.log(result);
});

Thenjs.series(tasksArray)

同上，接受函数数组参数，串行执行

Thenjs.parallelLimit(tasksArray, limit)

同parallel，并行执行，不过限制最大并发数为limit

Thenjs.eachLimit(array, iterator, limit)

同each，并行执行，限制最大并发数为limit

Thenjs.prototype.then(successHandler, [errorHandler])

如果上一链正确，则进入 successHandler 执行，否则进入 errorHandler 执行。返回一个新的 Thenjs 对象。

Thenjs(function (cont) {
  task(10, cont);
})
.then(function (cont, arg) {
  console.log(arg);
}, function (cont, error) {
  console.error(error);
});

Thenjs.prototype.finally(finallyHandler)

别名fin
无论上一链是否存在 error，均进入 finallyHandler 执行，等效于 .then(successHandler, errorHandler)。返回一个新的 Thenjs 对象。

Thenjs.prototype.fail(errorHandler)

fail 用于捕捉 error，如果在它之前的任意一个链上产生了 error，并且未被 then, finally 等捕获，则会跳过中间链，直接进入 fail。返回一个新的 Thenjs 对象。

prototype也有each eachSeries parallel series

Thenjs.prototype.each(array, iterator)
参数类似 Thenjs.each，返回一个新的 Thenjs 对象。

不同在于，参数可省略，如果没有参数，则会查找上一个链的输出结果作为参数，即上一个链可以这样 cont(null, array, iterator) 传输参数到each。下面三个队列方法行为类似。

Thenjs.prototype.eachSeries(array, iterator)
参数类似 Thenjs.eachSeries，返回一个新的 Thenjs 对象。

Thenjs.prototype.parallel(tasksArray)
参数类似 Thenjs.parallel，返回一个新的 Thenjs 对象。

Thenjs.prototype.series(tasksArray)
参数类似 Thenjs.series，返回一个新的 Thenjs 对象。

Thenjs.prototype.parallelLimit(tasksArray, limit)
参数类似 Thenjs.parallelLimit，返回一个新的 Thenjs 对象。

Thenjs.prototype.eachLimit(array, iterator, limit)
参数类似 Thenjs.eachLimit，返回一个新的 Thenjs 对象。