浅析Node.js中的流程控制-node.js怎么运行

对于在node这种异步框架下的编程，唯一的难题是：如何控制哪些函数顺序执行，哪些函数并行执行。node中并没有内置的控制方法，在这里我分享编写本站程序时用到的一些技巧。

并行VS顺序

在应用程序中通常有一些步骤必须在先前的操作得出结果之后才能运行。在平常的顺序执行的程序中这非常容易解决，因为每一部分都必须等待前一部分执行完毕才能执行。

Node中，除了那些执行阻塞IO的方法，其他方法都会存在这个问题。比如，扫描文件夹、打开文件、读取文件内容、查询数据库等等。

对于我的博客引擎，有一些以树形结构组织的文件需要处理。步骤如下所示：

◆ 获取文章列表 (译者注：作者的博客采取文件系统存储文章，获取文章列表，起始就是扫描文件夹)。

◆ 读入并解析文章数据。

◆ 获取作者列表。

◆ 读取并解析作者数据。

◆ 获取HAML模版列表。

◆ 读取所有HAML模版。

◆ 获取资源文件列表。

◆ 读取所有资源文件。

◆ 生成文章html页面。

◆ 生成作者页面。

◆ 生成索引页(index page)。

◆ 生成feed页。

◆ 生成静态资源文件。

如你所见，有些步骤可以不依赖其他步骤独立执行(但有些不行)。例如，我可以同时读取所有文件，但必须在扫描文件夹获取文件列表之后。我可以同时写入所有文件，但是必须等待文件内容都计算完毕才能写入。

使用分组计数器

对于如下这个扫猫文件夹并读取其中文件的例子，我们可以使用一个简单的计数器：

var fs = require('fs');  
 
fs.readdir(".", function (err, files) {  
  var count = files.length,  
      results = {};  
  files.forEach(function (filename) {  
    fs.readFile(filename, function (data) {  
      results[filename] = data;  
      count--;  
      if (count <= 0) {  
        // Do something once we know all the files are read.  
      }  
    });  
  });  
});

嵌套回调函数是保证它们顺序执行的好方法。所以在readdir回调函数中，我们根据文件数量设定了一个倒数计数器。然后我们对每个文件执行readfile操作，它们将并行执行并以任意顺序完成。最重要的是，在每个文件读取完成时计数器的值会减小1，当它的值变为0的时候我们就知道文件全部读取完毕了。

通过传递回调函数避免过度嵌套

在取得文件内容之后，我们可以在最里层的函数中执行其他操作。但是当顺序操作超过7级之后，这将很快成为一个问题。

让我们使用传递回调的方式修改一下上面的实例：

var fs = require('fs');  
 
function read_directory(path, next) {  
  fs.readdir(".", function (err, files) {  
    var count = files.length,  
        results = {};  
    files.forEach(function (filename) {  
      fs.readFile(filename, function (data) {  
        results[filename] = data;  
        count--;  
        if (count <= 0) {  
          next(results);  
        }  
      });  
    });  
  });  
}  
 
function read_directories(paths, next) {  
  var count = paths.length,  
      data = {};  
  paths.forEach(function (path) {  
    read_directory(path, function (results) {  
      data[path] = results;  
      count--;  
      if (count <= 0) {  
        next(data);  
      }  
    });  
  });  
}  
 
read_directories(['articles', 'authors', 'skin'], function (data) {  
  // Do something  
});

现在我们写了一个混合的异步函数，它接收一些参数(本例中为路径)，和一个在完成所有操作后调用的回调函数。所有的操作都将在回调函数中完成，最重要的是我们将多层嵌套转化为一个非嵌套的回调函数。

Combo库

我利用空闲时间编写了一个简单的Combo库。基本上，它封装了进行事件计数，并在所有事件完成之后调用回调函数的这个过程。同时它也保证不管回调函数的实际执行时间，都能保证它们按照注册的顺序执行。

function Combo(callback) {  
  this.callback = callback;  
  this.items = 0;  
  this.results = [];  
}  
 
Combo.prototype = {  
  add: function () {  
    var self = this,  
        id = this.items;  
    this.items++;  
    return function () {  
      self.check(id, arguments);  
    };  
  },  
  check: function (id, arguments) {  
    this.results[id] = Array.prototype.slice.call(arguments);  
    this.items--;  
    if (this.items == 0) {  
      this.callback.apply(this, this.results);  
    }  
  }  
};

如果你想从数据库和文件中读取数据，并在完成之后执行一些操作，你可以如下进行：

// Make a Combo object.  
var both = new Combo(function (db_result, file_contents) {  
  // Do something  
});  
// Fire off the database query  
people.find({name: "Tim", age: 27}, both.add());  
// Fire off the file read  
fs.readFile('famous_quotes.txt', both.add());

数据库查询和文件读取将同时开始，当他们全部完成之后，传递给combo构造函数的回调函数将会被调用。第一个参数是数据库查询结果，第二个参数是文件读取结果。

结论

本篇文章中介绍的技巧：

◆ 通过嵌套回调，得到顺序执行的行为。

◆ 通过直接函数调用，得到并行执行的行为。

◆ 通过回调函数来化解顺序操作造成的嵌套。

◆ 使用计数器检测一组并行的操作什么时候完成。

◆ 使用类似combo这样的库来简化操作。

#p#

上一篇介绍流程控制的文章给我带来了很大的乐趣，现在我想要处理一些反馈，另外还要讨论一下inimino所作的伟大工作。

当前node中有两种处理异步返回值的方法：promises和event emitters。关于两种方法的细节，你可以阅读nodejs.org上的介绍。我将会讨论这两种方法和另一种处理异步返回值和流事件(streaming events)的方法。

为什么要区分Promise和EventEmitter?

在node中有两种处理事件的类，它们是：Promise和EventEmitter。Promise是函数的异步表现形式。

var File = require('file');  
var promise = File.read('mydata.txt');  
promise.addCallback(function (text) {  
  // Do something  
});  
promise.addErrback(function (err) {  
  // Handle error  
})

File.read接受文件名并返回文件内容。

有时我们需要监听可能多次发生的事件。例如，在一个web服务中，处理web请求时，body事件多次被触发，然后complete事件被触发。

Http.createServer(function (req, res) {  
  var body = "";  
  req.addListener('body', function (chunk) {  
    body += chunk;  
  });  
  req.addListener('complete', function () {  
    // Do something with body text  
  });  
}).listen(8080);

这两种方式的不同之处在于：在使用promise时，你会得到success事件或者error事件，但不会同时得到，也不会得到一个以上事件。在处理会发生多次的事件的时候，你就需要更强大的 EventEmitters。

创建自定义promise

假定我想为posix.open, posix.write, 和posix.close写一个便于使用的包装函数filewrite。(如下代码摘自”file”函数库中File.write函数的真实代码)

function fileWrite (filename, data) {  
  var promise = new events.Promise();  
  posix.open(filename, "w", 0666)  
    .addCallback(function (fd) {  
      function doWrite (_data) {  
        posix.write(fd, _data, 0, encoding)  
          .addCallback(function (written) {  
            if (written === _data.length) {  
              posix.close(fd);  
              promise.emitSuccess();  
            } else {  
              doWrite(_data.slice(written));  
            }  
          }).addErrback(function () {  
            promise.emitError();  
          });  
      }  
      doWrite(data);  
    })  
    .addErrback(function () {  
      promise.emitError();  
    });  
  return promise;  
};

filewrite函数可以以如下形式使用：

fileWrite("MyBlog.txt", "Hello World").addCallback(function () {  
  // It's done  
});

请注意，我必须创建一个promise对象，执行操作，然后将结果传递给这个promise对象。

还有更好的方法

promises工作良好，但是继续读过inimino之后，它所使用的方法令我印象深刻。

是否还记得我们的第一个例子?假设我们按照如下方式使用File.read：

var File = require('file');  
File.read('mydata.txt')(function (text) {  
  // Do something  
}, function (error) {  
  // Handle error  
});

它不返回promise对象，而是返回一个接受两个回调函数作为参数的函数：一个处理成功，一个处理失败。我把这种风格成为“Do风格”，下面我详细解释：

编写回调风格的代码

如果我们想定义一个不立刻返回值的函数。使用”Do”风格，filewirte函数应当如下使用：(假定之前提到的posix函数也是这个风格)

function fileWrite (filename, data) { return function (callback, errback) {  
  posix.open(filename, "w", 0666)(function (fd) {  
    function doWrite (_data) {  
      posix.write(fd, _data, 0, encoding)(  
        function (written) {  
          if (written === _data.length) {  
            posix.close(fd);  
            callback();  
          } else {  
            doWrite(_data.slice(written));  
          }  
        }, errback);  
    }  
    doWrite(data);  
  }, errback);  
}};

请注意，这样很容易就把错误信息返回给了调用者。同时，这种风格也使代码更短，更易阅读。

使用这种风格编写代码的关键是：不要返回promise，而是返回一个接受两个回调的函数，在需要的时候直接调用返回的函数。

“Do”函数库

前些日子我写了一个小型的函数库，叫做“Do”。实际上，它只有一个执行并行操作的函数，就像上一篇文章中介绍的“Combo”库。

实现

如下是整个函数的实现：

Do = {  
  parallel: function (fns) {  
    var results = [],  
        counter = fns.length;  
    return function(callback, errback) {  
      fns.forEach(function (fn, i) {  
        fn(function (result) {  
          results[i] = result;  
          counter--;  
          if (counter <= 0) {  
            callback.apply(null, results);  
          }  
        }, errback);  
      });  
    }  
  }  
};

结合回调风格，使用这个函数可以写出非常强大和简介的代码。

执行单个操作

我们假定有一个实现了这个新技巧的函数readFIle，可以如下使用这个函数：

// A single async action with error handling  
readFile('secretplans.txt')(function (secrets) {  
  // Do something  
}, function (error) {  
  // Handle Error  
});

执行并行操作

我们继续使用”Do"函数库

Do.parallel([  
    readFile('mylib.js'),  
    readFile('secretplans.txt'),  
])(function (source, secrets) {  
  // Do something  
}, function (error) {  
  // Handle Error  
});

上述代码代码并行执行了两个异步操作，并在全部执行完毕后执行指定代码。注意，如果没有错误发生，只有处理success的回调函数会被执行。如果出错，函数会将错误传递给通常的错误处理代码。

你也可传递一个文件名数组。

var files = ["one.txt", "two.txt", "three.txt"];  
var actions = files.map(function (filename) {  
  return readFile(filename);  
});  
 
Do.parallel(actions)(function () {  
  var contents = {},  
      args = arguments;  
  files.forEach(function (filename, index) {  
    contents[filename] = args[index];  
  });  
  // Do something  
});  
// Let error thow exception.

执行顺序操作

要执行顺序操作，只需将函数“串起来”即可：

readFile('names.txt')(  
  function upcase_slowly(string) { return function (next) {  
    setTimeout(function () {  
      next(string.toUpperCase());  
    }, 100);  
  }}  
)(  
  function save_data(string) { return function (next) {  
    writeFile('names_up.txt', string)(next);  
  }}  
)(function () {  
  // File was saved  
});

上述代码读取文件'names.txt'，完成之后调用upcase_slowly，然后将生成的新字符串专递给save_data函数。save_data函数是对writeFile的一个包装。当save_data函数执行完毕之后，将执行最终的回调函数。

Just for fun, here is the same example translated to the Jack language (still in development).

开个玩笑，如下代码是翻译成Jack语言(还在开发中)的示例代码：

readFile names.txt  
| fun string -> next ->  
  timeout 100, fun ->  
    next string.toUpperCase()  
| fun string -> next ->  
  writeFile 'names_up.txt', string | next  
| fun ->  
 # File was saved

原文：http://www.grati.org/?cat=35

【编辑推荐】