异步操作和async函数（上）

异步编程对于JavaScript语言极为重要。JavaScript只有一个线程，如果没有异步编程，得卡死，基本没法用。

ES6诞生前，异步编程的方法大概有下面4种：

1. 回调函数
2. 事件监听
3. 发布 / 订阅
4. Promise对象

ES6将JavaScript异步编程带入了一个全新的阶段，ES7中的async函数更是给出了异步编程的最终方案。

基本概念

异步

所谓“异步”，简单说就是一个任务分成两段，先执行第一段，然后转而去执行其他任务，等做好准备再回过头来执行第二段。

比如，有一个任务是读取文件进行处理，任务的第一段是向操作系统发出请求，要求读取文件。然后，程序去执行其他任务，等到操作系统返回文件，再接着执行任务的第二段（处理文件）。这种不连续的执行，就叫作异步。

相应地，连续的执行就叫同步。由于是连续执行，不能插入其他任务，所以操作系统从硬盘读取文件这段时间，程序只能干等着。

回调函数

JavaScript语言对异步编程的实现就是回调函数。所谓回调函数，就是把任务的第二段单独写在一个函数中，等到重新执行该任务时直接调用这个函数。其英文名字“callback”直译过来就是“重新调用”。

读取文件进行处理是这样写的：

jscopied
fs.readFile('/etc/passwd', function (err, data) {
  if (err) throw err;
  console.log(data);
});

上面的代码中，readFile函数的第二个参数就是回调函数，也就是任务的第二段。等到操作系统返回了/etc/passwd这个文件后，回调函数才会执行。

一个有趣的问题是，为什么Node.js约定回调函数的第一个参数必须是错误对象err（如果没有错误，该参数就是null）？原因是执行分成两段，在这两段之间抛出的错误程序无法捕捉，只能当作参数传入第二段。

Promise

回调函数本身并没有问题，问题在于多个回调函数嵌套。假定读取A文件后再读取B文件，代码如下：

jscopied
fs.readFile(fileA, function (err, data) {
  fs.readFile(fileB, function (err, data) {
    // ...
  })
})

不难想象，如果依次读取多个文件，就会出现多重嵌套。代码不是纵向发展，而是横向发展，很快就会乱成一团，无法管理。这种情况就被称为“回调函数噩梦”（callback hell）。

Promise函数就是为了解决这个问题而提出的。

Promise的最大问题是代码冗余，原来的任务被Promise包装了一下，不管什么操作，一眼看去都是一堆then，原来的语义变得很不清楚。

那么，有没有更好的写法呢？

Generator函数

协程

传统的编辑语言早已有异步编辑的解决方案（其实是多任务的解决方案）。其中有一种叫作“协程”（coroutine），意思是多个线程互相协作，完成异步任务。

协程有点像函数，又有点像线程。其运行流程大致如下：

• 第1步，协程A开始执行。
• 第2步，协程A执行到一半，暂停，执行权转移到协程B。
• 第3步，（一段时间后）协程B交还执行权。
• 第4步，协程A恢复执行。

上面的协程A就是异步任务，因为它分成两段（或多段）执行。

举例来说，读取文件的协程写法如下：

jscopied
function* asyncJob () {
  // ... 其他代码
  var f = yield readFile(fileA);
  // ... 其他代码
}

上面的函数asyncJob是一个协程，它的奥妙就在于其中的yield命令。它表示执行到此处执行权就交给其他协程。也就是说，yield命令是异步两个阶段的分界线。

协程遇到yield命令就暂停，等到执行权返回，再从暂停的地方继续往后执行。它的最大优点就是代码写法非常像同步操作，如果去除yield命令，简直一模一样。

Generator函数的概念

请参考Generator函数。

异步任务的封装

下面看看如何使用Generator函数执行一个真实的异步任务。

jscopied
var fetch = require('node-fetch');

function* gen () {
  var url = 'https://api.github.com/users/github';
  var result = yield fetch(url);
  console.log(result.bio);
}

上面的代码中，Generator函数封装了一个异步操作，先读取一个远程接口，然后从JSON格式的数据解析信息。就像前面说的，这段代码非常像同步操作，只是加上了yield命令。

执行这段代码的方法如下：

jscopied
var g = gen();
var reslut = g.next();

result.value.then(data => {
  return data.json();
}).then(data => {
  g.next(data);
});

上面的代码中，首先执行Generator函数获取遍历器对象，然后使用next方法（第二行）执行异步任务的第一阶段。由于Fetch模块返回的是一个Promise对象，因此要用then方法调用下一个next方法。

可以看到，虽然Generator函数将异步操作表示得很简洁，但是流程管理（即何时执行第一阶段，何时执行第二阶段）却很不方便。

Thunk函数

参数的求值策略

Thunk函数早在20世纪60年代就诞生了。

那时，编程语言刚刚起步，计算机科学家还在研究编译器怎么写比较好。一个争论的焦点是“求值策略”，即函数的参数到底何时求值。

jscopied
var x = 1;

function f (m) {
  return m * 2;
}

f(x + 5)

上面的代码先定义函数f，然后向它传入表示式x + 5。那么，这个表达式应该何时求值？

一种意见是“传值调用”（call by value），即在进入函数体前就计算x + 5的值（等于6），再将这个值传入函数f。C语言就采用了这种策略。

jscopied
f(x + 5)
// 传值调用时就等同于
f(6)

另一种意见是“传名调用”（call by name），即直接将表达式x + 5传入函数体，只在用到它的时候求值，Haskell语言采用了这种策略。

jscopied
f(x + 5)
// 传名调用时等同于
(x + 5) * 2

传值调用和传名调用，哪一种比较好？回答是各有利弊。传值调用比较简单，但是对参数求值时实际上尚未用到这个参数，有可能造成损失。

jscopied
function f (a, b) {
  return b;
}

f(3 * x * x - 2 * x - 1, x);

上面的代码中，函数f的第一个参数是一个复杂的表达式，但是函数体内根本没有用到。对这个参数求值，实际上是没必要的。因此，有一些计算机科学家更倾向于“传名调用”。

Thunk函数的含义

编辑器的“传名调用”实现往往是先将参数放到一个临时函数中，再将这个临时函数传入函数体。这个临时函数就叫作Thunk函数。

jscopied
function f (m) {
  return m * 2;
}

f(x + 5)

// 等同于
var thunk = function () {
  return x + 5;
}

function f (thunk) {
  return thunk() * 2;
}

上面的代码中，函数f的参数x + 5被一个函数替换了。凡是用到原参数的地方，对Thunk函数求值即可。这就是Thunk函数的定义，它是“传名调用”的一种实现策略，用来替换某个表达式。

JavaScript语言的Thunk函数

JavaScript语言是传值调用，它的Thunk函数含义有所不同。在JavaScript语言中，Thunk函数替换的不是表达式，而是多参数函数，它将替换成单参数的版本，且只接受回调函数作为参数。

jscopied
// 正常版本的 readFile（多参数版本）
fs.readFile(fileName, callback);

// Thunk版本的 readFile（单参数版本）
var readFileThunk = Thunk(fileName);
readFileThunk(callback);

var Thunk = function (fileName) {
  return function (callback) {
    return fs.readFile(fileName, callback);
  }
}

上面的代码中，fs模块的readFile方法是一个多参数函数，两个参数分别为文件名和回调函数。经过转换处理，它变成了一个单参数函数，只接受回调函数作为参数。这个单参数版本，就叫作Thunk函数。

任何函数，只要参数有回调函数，就能写成Thunk函数的形式。下面是一个简单的Thunk函数转换器：

jscopied
var Thunk = function (fn) {
  return function () {
    var args = Array.prototype.slice.call(arguments);
    return function (callback) {
      args.push(callback);
      return fn.apply(this, args);
    }
  };
};

使用上面的转换器生成fs.readFile的Thunk函数如下：

jscopied
var readFileThunk = Thunk(fs.readFile);
readFileThunk(fileA)(callback);

Thunkify模块

用于生产环境的转换器，建议使用Thunkify模块。

安装命令如下：

shellcopied
$ nmp install thunkify

使用方式如下：

jscopied
var thunkify = require('thunkify');
var fs = require('fs');

var read = thunkify(fs.readFile);
read('package.json')(function (err, str)) {
  // ...
};

Thunkify的源码与前面那个简单的转换器非常像：

jscopied
function thunkify (fn) {
  return function () {
    var args = new Array(arguments.length);
    var ctx = this;

    for (var i = 0; i < args.length; i++) {
      args[i] = arguments[i];
    }

    return function (done) {
      var called;
      
      args.push(function () {
        if (called) return;
        called = true;
        done.apply(null, arguments);
      });

      try {
        fn.apply(ctx, args);
      } catch (err) {
        done(err);
      }
    }
  }
};

它的源码主要多了一个检查机制，变量called确保回调函数只运行一次。这样的设计与下文的Generator函数相关。请看下面的例子：

jscopied
function f (a, b, callback) {
  var sum = a + b;
  callback(sum);
  callback(sum);
}

var ft = thunkify(f);
var print = console.log.bind(console);
ft(1, 2)(print);

// 3

上面的代码中，由于thunkify只允许回调函数执行一次，所以只输出一行结果。

Generator函数的流程管理

你可能会问，Thunk函数有什么用？回答是以前确实没什么用，但是ES6有了Generator函数，Thunk函数现在可以用于Generator函数的自动流程管理。

以读取文件为例，下面的Generator函数封装了两个异步操作：

jscopied
var fs = require('fs');
var thunkify = require('thunkify');

var readFile = thunkify(fs.readFile);

var gen = function* () {
  var r1 = yield readFile('/etc/fstab');
  console.log(r1.toString());
  var r2 = yield readFile('/etc/shells');
  console.log(r2.toString());
}

上面的代码中，yield命令用于将程序的执行树移出Generator函数。那么就需要一种方法，将执行权再次交还给Generator函数。

这种方法就是Thunk函数，因为它可以在回调函数中将执行权交还给Generator函数。为了便于理解，我们先看如何手动执行上面的这个Generator函数。

jscopied
var g = gen();
var r1 = g.next();

r1.value(function (err, data) {
  if (err) throw err;
  var r2 = g.next(data);
  r2.value(function (err, data){
    if (err) throw err;
    g.next(data);
  });
});

上面的代码中，变量g是Generator函数的内部指针，表示目前执行到哪一步。next方法负责将指针移到下一步，并返回该步的信息（value属性和done属性）。

仔细查看上面的代码，可以发现Generator函数的执行过程其实就同一个回调函数反复传入next方法的value属性。于是我们可以用递归来自动完成这个过程。

Thunk函数的自动流程管理

Thunk函数真正的威力在于可以自动执行Generator函数。下面就是一个基于Thunk函数的Generator函数执行器。

jscopied
function run (fn) {
  var gen = fn();

  function next (err, data) {
    var result = gen.next(data);
    if (result.done) return;
    result.value(next);
  }

  next();
}

run(gen);

上面的run函数就是一个Generator函数的自动执行器。内部的next函数就是Thunk的回调函数。next函数先将指针移到Generator函数的下一步（gen.next方法），然后判断Generator函数是否结束（result.done属性），如果没有结束，就将next函数再传入Thunk函数(result.value属性)，否则直接退出。

有了这个执行器，执行Generator函数就方便多了。不管有多少个异步操作，直接传入run函数即可。当然，前提是每一个异步操作都要是Thunk函数。也就是说，跟在yield命令后面的必须是Thunk函数。

jscopied
var gen = function* () {
  var f1 = yield readFile('fileA');
  var f2 = yield readFile('fileB');
  // ...
  var fn = yield readFiel('fileN');
}
run(gen);

上面的代码中，函数gen封装了n个异步读取文件操作，只要执行run函数，这些操作就会自动完成。这样一来，异步操作不仅可以写得像同步操作，而且一行代码就可以执行了。

Thunk函数并不是Generator函数自动执行的唯一方案。因为自动执行的关键是，必须有一种机制自动控制Generator函数的流程，接收和交还程序的执行权。回调函数可以做到这一点，Promise对象也可做到这一点。

co模块

基本用法

co模块（https://github.com/tj/co）是著名程序员TJ Holowaychuk于2013年6月发布的一个小工具，用于Generator函数的自动执行。

比如有一个Generator函数，用于依次读取两个文件。

jscopied
var gen = function* () {
  var f1 = yield readFile('/etc/fstab');
  var f2 = yield readFile('/etc/shells');
  console.log(f1.toString())
  console.log(f2.toString())
}

co模块可以让你不用编写Generator函数的执行器。

jscopied
var co = require('co');
co(gen);

上面的代码中，Generator函数只要传入co函数就会自动执行。

co函数返回的是一个Promise对象，因此可以用then方法添加回调函数。

jscopied
co(gen).then(() => console.log('Generator函数执行完成'));

co模块的原理

为什么co模块可以自动执行Generator函数？

前面说过，Generator就是一个异步操作的容器。它的自动执行需要一种机制，当异步操作有了结果能够自动交回执行权。

有两种方法可以做到这一点：

1. 回调函数。将异步操作包装成Thunk函数，在回调函数中交回执行权。
2. Promise对象。将异步操作包装成Promise对象，用then方法交回执行权。

co模块其实就是将两种自动执行器包装成了一个模块。使用co的前提条件是，Generator函数的yield命令后面只能是Thunk函数或Promise对象。

上面已经介绍了基于Thunk函数的自动执行器，下面来看基于Promise对象的自动执行器。这是理解co模块所必需的。

基于Promise对象的自动执行

还是沿用上面的例子。首先，把fs模块的readFile方法包装成一个Promise对象。

jscopied
var fs = require('fs');

var readFile = function (fileName) {
  return new Promise((resolve, reject) => {
    fs.readFile(fileName, (error, data) => {
      if (error) reject(error);
      resolve(data);
    });
  });
};

var gen = function* () {
  var f1 = yield readFile('/etc/fstab');
  var f2 = yield readFile('/etc/shells');
  console.log(f1.toString());
  console.log(f2.toString());
};

然后，手动执行上面的Generator函数：

jscopied
var g = gen();

g.next().value.then(data => {
  g.next(data).value.then(data => {
    g.next(data);
  });
});

手动执行其实就是用then方法层层添加回调函数。理解了这一点，就可以写出一个自动执行器。

jscopied
function run (gen) {
  var g = gen();

  function next (data) {
    var result = g.next(data);
    if (result.done) return result.value;
    result.value.then(data => {
      next(data);
    });
  }

  next();
}

run(gen);

上面的代码中，只要Generator函数还没有执行到最后一步，next函数就调用自身以实现自动执行。

co模块的源码

co就是上面那个自动执行器的扩展，它的源码只有几十行，非常简单。

首先，co函数接受Generator函数作为参数，返回一个Promise对象。

jscopied
function co (gen) {
  var ctx = this;

  return new Promise(function (resolve, reject) {
  });
}

在返回的Promise对象中，co先检查参数gen是否为Generator函数。如果是，就执行该函数，得到一个内部指针对象；如果不是就返回，并将Promise对象的状态改为Resolved。

jscopied
function co (gen) {
  var ctx = this;

  return new Promise(function (resolve, reject) {
    if (typeof gen === 'function') gen = gen.call(ctx);
    if (!gen || typeof gen.next !== 'function') return resolve(gen);
  });
}

接着，co将Generator函数的内部指针对象的next方法包装成onFulfilled函数。这主要是为了能够捕捉抛出的错误。

jscopied
function co (gen) {
  var ctx = this;

  return new Promise(function (resolve, reject) {
    if (typeof gen === 'function') gen = gen.call(ctx);
    if (!gen || typeof gen.next !== 'function') return resolve(gen);

    onFulfilled();
    function onFulfilled (res) {
      var ret;
      try {
        ret = gen.next(res);
      } catch (e) {
        return reject(e);
      }
      next(ret);
    }
  });
}

最后，就是关键的next函数，它会反复调用自身。

jscopied
function next (ret) {
  if (ret.done) return resolve(ret.value);
  var value = toPromise.call(ctx, ret.value);
  if (value && isPromise(value)) return value.then(onFulfilled, onRejected);
  return onRejected(new TypeError('You may only yield a function, promise, generator, array, or object, but the following object was passed: "' + String(ret.value) + '"'));
}

上面的代码中，next函数的内部代码一共只有4行命令：

• 第1行，检查当前是否为Generator函数的最后一步，如果是就返回。
• 第2行，确保每一步的返回值是Promise对象。
• 第3行，使用then方法为返回值加上回调函数，然后通过onFulfilled函数再次调用next函数。
• 第4行，在参数不符合的情况下，将Promise对象改为Rejected，从而终止运行。

处理并发的异步操作

co支持并发的异步操作，即允许某些操作同时进行，行到它们全部完成才进行下一步。

这时，要把并发的操作都放在数组或对象里面，跟在yield语句后面。

jscopied
// 数组的写法
co(function* () {
  var res = yield [
    Promise.resolve(1),
    Promise.resolve(2)
  ];
  console.log(res);
}).catch(onerror);

// 对象的写法
co(function* () {
  var res = yield {
    1: Promise.resolve(1),
    2: Promise.resolve(2)
  };
  console.log(res);
}).catch(onerror);

下面是另一个例子：

jscopied
co(function* () {
  var values = [n1, n2, n3];
  yield values.map(someThingAsync);
});

function* someThingAsync (x) {
  // do somethin async
  return y;
}

上面的代码允许并发3个somethingAsync异步操作，等到它们全部完成才会进行下一步。

以上，摘抄自阮一峰老师的《ES6标准入门》