async.js 學習教程（一）

網上有一篇async.js的文章，但是看完后一頭霧水，里面很多錯誤，只好學習下官方的文檔

官方的文檔分為三個模塊：

1.Collections  集合

2.Control Flow  控制流程

3.Utils  公共模塊

最常用的應該就是第二個模塊了，async的主要功能也都集中在里面

Control Flow

1.series(tasks, [callback])      順序執行數組、集合內的函數，當前面一個函數執行完成就會立即執行下一個函數，如果函數觸發了錯誤，可以在callback函數中驗證，否則會一直執行完成tasks

async.series([
    function(callback){
        // do some stuff ...
        callback(null, 'one');
    },
    function(callback){
        // do some more stuff ...
        callback(null, 'two');
    }
],
// optional callback
function(err, results){
    // results is now equal to ['one', 'two']
});


// an example using an object instead of an array
async.series({
    one: function(callback){
        setTimeout(function(){
            callback(null, 1);
        }, 200);
    },
    two: function(callback){
        setTimeout(function(){
            callback(null, 2);
        }, 100);
    }
},
function(err, results) {
    // results is now equal to: {one: 1, two: 2}
});

 

 

2.parallel(tasks, [callback])　　並行執行數組、集合內的方法，不用等到前一個函數執行完再執行下一個函數，如果函數觸發了錯誤，可以在callback函數中驗證

async.parallel([
    function(callback){
        setTimeout(function(){
            callback(null, 'one');
        }, 200);
    },
    function(callback){
        setTimeout(function(){
            callback(null, 'two');
        }, 100);
    }
],
// optional callback
function(err, results){
    // the results array will equal ['one','two'] even though
    // the second function had a shorter timeout.
});


// an example using an object instead of an array
async.parallel({
    one: function(callback){
        setTimeout(function(){
            callback(null, 1);
        }, 200);
    },
    two: function(callback){
        setTimeout(function(){
            callback(null, 2);
        }, 100);
    }
},
function(err, results) {
    // results is now equals to: {one: 1, two: 2}
});

 

3.parallelLimit(tasks, limit, [callback])　　和2用法一樣，只是多了一個任務數量限制，最多允許多少個任務在並行執行

 

4.whilst(test, fn, callback)　　等同於while的用法，第一個參數為驗證條件，第二個參數為執行函數，第三個參數為驗證失敗后回調函數，一般在做延遲動畫用的比較多

var count = 0;

async.whilst(
    function () { return count < 5; },//驗證成功繼續，失敗進回調
    function (callback) {
        count++;
        setTimeout(callback, 1000);
    },
    function (err) {
        // 5 seconds have passed
    }
);

 

 

5.waterfall(tasks, [callback])　　tasks依次運行,前一個函數的回調會作為后一個函數的參數，如果有任何任務通過一個錯誤的回調，下一個函數不執行

async.waterfall([
    function(callback){
        callback(null, 'one', 'two');
    },
    function(arg1, arg2, callback){
      // arg1 now equals 'one' and arg2 now equals 'two'
        callback(null, 'three');
    },
    function(arg1, callback){
        // arg1 now equals 'three'
        callback(null, 'done');
    }
], function (err, result) {
   // result now equals 'done'    
});

貼上一個mongodb連接數據庫的例子

async.waterfall([
      function(cb){
          //打開數據庫
          mongodb.open(function(err,db){
              cb(err,db);
          });
      },
      function(db, cb){
          //實例化posts表
          db.collection('posts',function(err,collection){
              cb(err, collection);
          });
      },
      function(collection, cb){
          //通過用戶名、時間及標題查找文檔，並把一條留言對象添加到該文檔的 comments 數組里
          collection.update({
              "name": name,
              "time.day": day,
              "title": title
          }, {
              $push: {"comments": comment}
          } , function (err) {
              cb(err);
          });
      }
  ],function(err){
      mongodb.close();
      err ? callback(err) : callback(null);//callback為此函數執行完成的回調方法，用戶自定義方法
  });

waterfall主要用來解決回調嵌套回調的方法，如果回調嵌套超過2級就可以考慮使用waterfall，下面就是回調嵌套的一個示例

//打開數據庫
  mongodb.open(function (err, db) {
    if (err) {
      return callback(err);
    }
    //讀取 posts 集合
    db.collection('posts', function (err, collection) {
      if (err) {
        mongodb.close();
        return callback(err);
      }
      //根據用戶名、發表日期及文章名進行查詢
      collection.findOne({
        "name": name,
        "time.day": day,
        "title": title
      }, function (err, doc) {
        mongodb.close();
        if (err) {
          return callback(err);
        }
        callback(null, doc);//返回查詢的一篇文章（markdown 格式）
      });
    });
  });

 

 

6.compose(fn1, fn2...)　　按順序加入到隊列中，按順序執行，將上一個函數的結果作為下一個函數的值

function add1(n, callback) {
    setTimeout(function () {
        callback(null, n + 1);
    }, 10);
}

function mul3(n, callback) {
    setTimeout(function () {
        callback(null, n * 3);
    }, 10);
}

var add1mul3 = async.compose(mul3, add1);

add1mul3(4, function (err, result) {
   // result now equals 15
});

更多api請參見：https://github.com/caolan/async#times