ES6学习笔记15 Generator 函数的异步应用

异步

所谓”异步”，简单说就是一个任务不是连续完成的，可以理解成该任务被人为分成两段，先执行第一段，然后转而执行其他任务，等做好了准备，再回过头执行第二段。

回调函数

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

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

上述读取文件的函数中，第三个参数就是回调函数，等到读取结果返回后，它才会执行

Generator函数

传统的编程语言使用”协程”来解决异步编程问题，所谓协程，意思是多个线程互相协作，完成异步任务。

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

• 第一步，协程A开始执行。
• 第二步，协程A执行到一半，进入暂停，执行权转移到协程B。
• 第三步，（一段时间后）协程B交还执行权。
• 第四步，协程A恢复执行。

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

Generator 函数是协程在 ES6 的实现，最大特点就是可以交出函数的执行权（即暂停执行）。整个 Generator 函数就是一个封装的异步任务，或者说是异步任务的容器。异步操作需要暂停的地方，都用yield语句注明。

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

异步任务的封装

下面利用Generator函数，执行了一个真实的异步任务

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

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

上述代码先读取一个远程接口，然后从JSON格式的数据解析信息。上述读取并返回数据结果的过程就是一个异步过程。只有结果返回后，才能输出信息。

执行上述代码的方法如下

var g = gen();
var result = g.next();

result.value.then(function(data){
  return data.json();   //解析数据并返回数据
}).then(function(data){
  g.next(data);    
});

Fetch模块返回的是一Promise对象，因此要用then方法调用下一个next方法，并把data传递给Generator函数，result才能被输出。

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

Thunk函数

Thunk函数是自动执行Generator函数的一种方法。Thunk函数的作用就是将一个多参数的函数，替换为一个只接受回调函数作为参数的单参数函数，有点函数柯里化的感觉

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

// Thunk版本的readFile（单参数版本）
var Thunk = function (fileName) {
  return function (callback) {
    return fs.readFile(fileName, callback);
  };
};

var readFileThunk = Thunk(fileName);
readFileThunk(callback);

上述经过转换的readFile方法只接受一个回调函数作为参数，这个单参数的版本函数就叫做Thunk函数

下面代码可以将一个函数转换为Thunk函数

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

// ES6版本
const Thunk = function(fn) {
  return function (...args) {
    return function (callback) {
      return fn.call(this, ...args, callback);
    }
  };
};

使用上面的转换器，生成fs.readFile的 Thunk 函数。

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

在生产环境下，可以使用Thunkify模块转换

$ npm install thunkify  //安装

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

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

Generator 函数的流程管理

Generator 函数封装了两个异步操作，分别用于读取两个文件，并输出结果。

var fs = require('fs');
var thunkify = require('thunkify');
var readFileThunk = thunkify(fs.readFile);

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

下面使用回调函数手动执行上面这个Generator函数

var g = gen();

var r1 = g.next();
r1.value(function (err, data) {   //注意，此时r1.value的值为一个Thunk函数
  if (err) throw err;
  var r2 = g.next(data);
  r2.value(function (err, data) {
    if (err) throw err;
    g.next(data);
  });
});

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

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

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

  next();
}

function* g() {
  // ...
}

run(g);

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

只要每一个异步操作，都是Thunk函数，我们就可以使用上述的递归方法自动执行Generator函数内部的多个异步操作。

基于Promise对象的自动执行

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

var fs = require('fs');

var readFile = function(filename){  //将读取文件操作包装为一个函数，返回一个Promise对象  
    return new Promise(function(resolve,reject){   
        fs.readFile(filename,function(error,data){
            if (error) return reject(error);
            return resolve(data);
        }); 
    });
};

var gen = function* (){
  var f1 = yield readFile('/etc/fstab');   //每个yield后面都为一个Promise对象
  var f2 = yield readFile('/etc/shells');
  console.log(f1.toString());
  console.log(f2.toString());
};

手动执行上述Generator函数

var g = gen();

g.next().value.then(function(data){
    g.next(data).value.then(function(data){
        g.next(data);
    });
});

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

function run(gen){
    var g = gen();
    function next(data){
        var p = g.next(data);
        if (p.done && p.value === undefined) return;
        p.value.then(function(data){
            next(data);
        });
    }
    next();
}

run(gen);

co模块

该模块用于Generator函数的自动执行

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

Generator 函数只要传入co函数，就会自动执行

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

co(gen).then(function (){
  console.log('Generator 函数执行完成');
});

Generator 就是一个异步操作的容器。它的自动执行需要一种机制，当异步操作有了结果，能够自动交回执行权。有两种方法可以做到这一点：

（1）回调函数。将异步操作包装成 Thunk 函数，在回调函数里面交回执行权

（2）Promise 对象。将异步操作包装成 Promise 对象，用then方法交回执行权。

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

co支持并发的异步操作，即允许某些操作同时进行，等到它们全部完成，才进行下一步。这时，要把并发的操作都放在数组或对象里面，跟在yield语句后面。

// 数组的写法
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);

下面是另一个例子

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

function* somethingAsync(x) {
  // do something async
  return y
}