async使用简介之流程控制

Node.js 使用事件驱动,非阻塞I/O 模型而得以轻量和高效。事件发生后交由指定的程序处理,处理完成后就调用事件回调函数。回调机制使用Node.js具有了强大的并发处理能力,但也带来了 一系列的回调嵌套问题。解决回调嵌套的方法有很多,如:async、promise、事件发射器等。几种方案多少都使用过,今天介绍一下async中的常 用方法。本篇主要介绍其流程控制部分。

在async官方文档中,async的功能分为三个部分:流程控制、集合处理、工具。其流程控制部分,常用的方法有series、parallel、waterfall、whilst、auto等。这些方法功能如下:

  • series:多个任务依次执行

  • parallel:多个任务并发执行

  • waterfall:多个任务依次执行,上一任务的输出可做为下一任务的输入参数

  • whilst:while循环执行任务,但本次任务执行完毕后才会进入下一次循环

  • auto:根据任务需要选择顺序或并发执行任务


1. series(tasks, [callback])

series方法用于依次执行多个方法,一个方法执行完毕后才会进入下一方法,方法之间没有数据传递。

参数

tasks:需要执行多个方法。tasks可以以数组形式传入,也可以以object对象形式传入。每个方法都要一个回调方法callback(err, result),用于处理错误或进入下一方法。当发生错误时(即:err参数存在时),其后的方法会跳过,错误被传入最终回调方法中。
callback(err, results):可选的最终回调方法。出错时,tasks中抛出的错误将在此方法中捕获,错误被传入err参数。不出错时,tasks中回调结果将被写入results参数中,以数据或对象形式提供。

示例

//以数组形式传入需要执行的多个方法
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} 
});


2. parallel(tasks, [callback])

parallel方法用于并行执行多个方法,所有传入的方法都是立即执行,方法之间没有数据传递。传递给最终callback的数组中的数据按照tasks中声明的顺序,而不是执行完成的顺序。

参数

tasks:需要执行多个方法。tasks可以以数组形式传入,也可以以object对象形式传入。每个方法都要一个回调方法callback(err, result),回调方法需要提供一个err参数或是result参数。当发生错误时(即:err参数存在时),所有的方法停止执行,未执行完的方法将不 会被传递至最终回调方法中。
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'     
});


4. whilst(test, fn, callback)

当test条件为true时,重复执行方法fn。执行完毕后,callback结束循环,有错误时可将错误传入callback回调方法。whilst方法不能回调结果参数,当循环方法中有传出结果时需要将其写入到外部参数中。

参数

test():返回一个boolean型结果,用于判断是否再次执行fn方法。
fn(callback):当test为true时将执行循环执行此方法,执行完毕后执行callback(err)方法进入下一循环。发生错误时可传入err参数,传入err参数后循环将结束。
callback(err):最终回调方法。出错后或循环完成后进入些方法,出错时err参数为循环中回调的错误信息。

示例

var count = 0;
 
async.whilst(
    function () { return count < 5; }, function (callback) { count++; setTimeout(callback, 1000); }, function (err) { // 5秒后执行完毕 } );


5. auto(tasks, [callback])

auto方法根据传入的任务类型选择最佳的执行方式。不依赖于其它任务的方法将并发执行,依赖于其它任务的方法将在其执行完成后执行。

参数

tasks:需要执行多个方法。tasks只能以object对象形式传入。当传入任务类型为function时将并发执行,为数组时,将等待相关方法执行完成后再执行数组中最后一个方法。错误处理机制与其它方法相
callback(err, results):可选的最终回调方法。出错时,tasks中抛出的错误将在此方法中捕获,错误被传入err参数。不出错时,tasks中回调结果results为所有任务的回调结果集。

示例

async.auto({
    get_data: function(callback){
        console.log('in get_data');
         //一个取数据的方法
        // 与make_folder方法并行执行
        callback(null, 'data', 'converted to array');
    },
    make_folder: function(callback){
        console.log('in make_folder');
        // 一个创建文件夹的方法
        // 与make_folder方法并行执行
        callback(null, 'folder');
    },
    write_file: ['get_data', 'make_folder', function(callback, results){
        console.log('in write_file', JSON.stringify(results));
        // 此方法在等待get_data方法和make_folder执行完成后执行
        callback(null, 'filename');
    }],
    email_link: ['write_file', function(callback, results){
        console.log('in email_link', JSON.stringify(results));
        // 等待write_file执行完成后执行
        callback(null, {'file':results.write_file, 'email':'user@example.com'});
    }]
}, function(err, results) {
    console.log('err = ', err);
    console.log('results = ', results);
});


async中流程控制的方法还有很多,更多流程控制方法可参考其github文档:Async.js。下一篇将介绍一些async常用的集合处理方法。