本文主要讲解async的函数: series,parallel, waterfall 函数的理解和 使用
async 函数是什么?
一句话,async 函数就是 Generator 函数的语法糖。
背景:
Node.js 使用事件驱动,非阻塞I/O 模型而得以轻量和高效。
事件发生后交由指定的程序处理,处理完成后就调用事件回调函数。回调机制使用Node.js具有了强大的并发处理能力,但也带来了一系列的回调嵌套问题。
async解决了什么问题?
解决回调嵌套的方法有很多,如:async、promise、事件发射器等。几种方案多少都使用过,今天介绍一下async中的常用方法。本篇主要介绍其流程控制部分。
async 提供的api包括三个部分::
- 流程控制
- 集合处理
- 工具
流程控制常用的方法有:
series、parallel、waterfall、whilst、auto
等。
这些方法功能如下:
- series:多个任务依次执行
- parallel:多个任务并发执行
- waterfall:多个任务依次执行,上一任务的输出可做为下一任务的输入参数
- whilst:while循环执行任务,但本次任务执行完毕后才会进入下一次循环
- auto:根据任务需要选择顺序或并发执行任务
下面重点介绍series、parallel、waterfall:
安装方法: npm install async
使用方法: var async=require('async');
1.Async.series(tasks, [callback])
- 用法:
series
方法用于依次执行(串行执行)多个方法
一个方法执行完毕后才会进入下一方法
方法之间没有数据传递
- 参数
- tasks:需要执行多个方法。tasks可以以数组形式传入,也可以以object对象形式传入。参数类型不同,影响的是返回数据的格式。每个方法都要一个回调方法
-
callback(err, result),用于处理错误或进入下一方法。当发生错误时(即:err参数存在时),其后的方法会跳过,错误被传入最终回调方法中。
callback(err, results):可选的最终回调方法。出错时,tasks中抛出的错误将在此方法中捕获,错误被传入err参数。不出错时,tasks中回调结果将被写入results参数中,以数据或对象形式提供。
- 实例
var async = require('async');
//以数组形式传入需要执行的多个方法
async.series([
function(callback){
// 执行一些操作后,callback进入下一方法
callback(null, 'one');
},
function(callback){
// 执行一些操作后,callback进入可选的最终回调方法
callback(null, 'two');
}
],
// 可选的最终回调
function(err, results){
// 当tasks中的任一方法发生错误,即回调形式为callback('错误信息')时,错误将被传递给err参数,未发生错误err参数为空
// results中为数组中两个方法的结果数组:['one', 'two']
});
//以object对象形式传入需要执行的多个方法
async.series({
one: function(callback){
// 执行一些操作后,callback进入下一方法
callback(null, 1);
},
two: function(callback){
// 执行一些操作后,callback进入可选的最终回调方法
callback(null, 2);
}
},
function(err, results) {
// 当tasks中的任一方法发生错误,即回调形式为callback('错误信息')时,错误将被传递给err参数,未发生错误err参数为空
// results中为数组中两个方法的结果对象:{one: 1, two: 2}
});
该函数的详细解释为:
- 依次执行一个函数数组中的每个函数,每一个函数执行完成之后才能执行下一个函数。
- 如果任何一个函数向它的回调函数中传了一个error,则后面的函数都不会被执行,并且将会立刻会将该error以及已经执行了的函数的结果,传给series中最后那个callback。
- 当所有的函数执行完后(没有出错),则会把每个函数传给其回调函数的结果合并为一个数组,传给series最后的那个callback。
- 还可以json的形式来提供tasks。每一个属性都会被当作函数来执行,并且结果也会以json形式传给series最后的那个callback。这种方式可读性更高一些。
- 需要注意的是:
如果中间某个函数出错,series函数如何处理
思考一下:如果某个函数传给回调的值为undefined, null, {}, []等,series如何处理
另外还需要注意的是:多个series调用之间是不分先后的,因为series本身也是异步调用。
2. parallel(tasks, [callback])
- 执行原理
parallel方法用于 并行执行 多个方法,所有传入的方法都是立即执行,方法之间没有数据传递。传递给最终callback的数组中的数据按照tasks中声明的顺序,而不是执行完成的顺序。
- 参数
- ** tasks:需要执行多个方法。tasks可以以 *** 数组形式传入,也可以以object对象*形式传入。和series函数一样,tasks参数类型不同,返回的results格式会不一样。
每个方法都要一个回调方法callback(err, result),回调方法需要提供一个err参数或是result参数。
当如果某个函数出错,则立刻将err和已经执行完的函数的结果值传给parallel最终的callback。其它未执行完的函数的值不会传到最终数据,但要占个位置。
- callback(err, results):可选的最终回调方法。出错时,tasks中抛出的错误将在此方法中捕获,错误被传入err参数。不出错时,tasks中回调结果将被写入results参数中,以数据或对象形式提供。
- 示例
//以数组形式传入需要执行的多个方法
async.parallel([
function(callback){
// 执行一些操作后,callback表示本方法执行完成
callback(null, 'one');
},
function(callback){
// 执行一些操作后,callback表示本方法执行完成
callback(null, 'two');
}
],
// 可选的最终回调
function(err, results){
// 当tasks中的任一方法发生错误,即回调形式为callback('错误信息')时,错误将被传递给err参数,未发生错误err参数为空
// results中为数组中两个方法的结果数组:['one', 'two'] ,即使第二个方法先执行完成,其结果也是在第一个方法结果之后
});
//以object对象形式传入需要执行的多个方法
async.parallel({
one: function(callback){
// 执行一些操作后,callback表示本方法执行完成
callback(null, 1);
},
two: function(callback){
// 执行一些操作后,callback表示本方法执行完成
callback(null, 2);
}
},
function(err, results) {
// 当tasks中的任一方法发生错误,即回调形式为callback('错误信息')时,错误将被传递给err参数,未发生错误err参数为空
// results中为数组中两个方法的结果对象:{one: 1, two: 2}
});
3. waterfall(tasks, [callback])
- 用法
waterfall方法与series方法类似用于依次执行多个方法,一个方法执行完毕后才会进入下一方法
不同与series方法的是:
waterfall之间有数据传递。
waterfall的多个方法只能以数组形式传入,不支持object对象。
- 参数
-
tasks:需要执行多个方法。tasks只能以数组形式传入。每个方法都要一个回调方法callback(err, result1, result2, ...),用于处理错误或进入下一方法。
当发生错误时(即:err参数存在时),其后的方法会跳过,错误被传入最终回调方法中。无错误时回调参数result1, result2……将做为下一方法的输入参数
callback(err, results):可选的最终回调方法。出错时,tasks中抛出的错误将在此方法中捕获,错误被传入err参数。不出错时,tasks中回调结果results为最后一个方法的回调结果。
- 示例
async.waterfall([
function(callback) {
callback(null, 'one', 'two');
},
function(arg1, arg2, callback) {
// arg1 现在是 'one', arg2 现在是 'two'
callback(null, 'three');
},
function(arg1, callback) {
// arg1 现在是 'three'
callback(null, 'done');
}
], function (err, result) {
//执行的任务中方法回调err参数时,将被传递至本方法的err参数
// 参数result为最后一个方法的回调结果'done'
});