Generator函数

一、背景知识

  尽管Promise方法能够解决JS异步方法带来的嵌套地狱问题，但其本质上只是回调函数的改进，使用then方法以后，异步任务的两端执行更清楚了，除此以外，并无新意。而Promise最大的问题是代码冗余，原来的任务被Promise包装后，无论什么操作，一眼看上去都是很多then的堆积，原来的语义也变得很不清楚，因此Generator函数就产生了。

二、基本语法

  形式上Generator函数是一个普通函数，但是有两特征，一时function命令与函数名之间有一个*；二是函数体内部使用yield语句定义不同的内部状态：

function *show(){
    yield console.log(1);
    yield console.log(2);
}
let genObj = show();

  Generator函数的调用方法与普通函数一样，也是再函数名后面加上一对圆括号。但不同之处在于调用Generator函数后，该函数并不是马上执行，而是返回一个指向内部状态的指针对象。
  下一步，必须使用next方法，使得指针移向下一个状态，

genObj.next();
genObj.next();

执行结果

  试想一个场景，比如我们在进行某些异步操作时，可以通过yield暂停后续操作，而不是用回调函数的形式。

二、yield表达式

  next可以向yield传参：

function* show(){
    let a = yield;
    console.log(a);
}
let genObj = show();
genObj.next(12);
genObj.next(5);

执行结果

  为什么结果是5？yield语句本身没有返回值，或者说总是返回undefined，但next方法可以带一个参数，该参数会被当作上一条yield语句的返回值，所以上述代码返回5。
  yield可以返回结果：

function *show(){
    console.log(1);
    yield 12;
    console.log(2);
}
let genObj = show();
let res1 = genObj.next();
console.log(res1);
let res2 = genObj.next();
console.log(res2);

执行结果

  上述代码执行逻辑为，
  1.遇到yield语句就会暂停执行后面的操作，并将紧跟在yield后的表达式的值作为返回对象的value属性值。
  2.下一次调用next方法时再继续往下执行，直到遇到下一条yield语句。
  3.如果没有遇到新的yield语句，就一直执行到函数结束，直到return语句为止，并将return语句后面的表达式的值作为对象的value属性值。
  4.如果没有return语句，则返回对象的value属性值为undefined。

四、Generator异步应用

  这里需要结合Promise对象来执行，首先把fs模块的readFile方法包装成一个Promise对象

var fs = require('fs');

function readFile(filepath) {
    return new Promise((resolve, reject) => {
        fs.readFile(filepath, 'utf8', (err, data) => {
            if (err) reject(err);
            else resolve(data);
        });
    })
};

var gen = function* () {
    var f1 = yield readFile('./data/a.txt');
    var f2 = yield readFile('./data/b.txt');
    var f3 = yield readFile('./data/c.txt');
    console.log(f1.toString());
    console.log(f2.toString());
    console.log(f3.toString());
};

  然后我们先手动执行上述代码，需要注意的是每次yield返回的是一个Promise对象：

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

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

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

  而co模块就是上面自动执行器的扩展，用于Generator函数的自动执行：

var fs = require('fs');
var co = require('./data/co');

function readFile(filepath) {
    return new Promise((resolve, reject) => {
        fs.readFile(filepath, 'utf8', (err, data) => {
            if (err) reject(err);
            else resolve(data);
        });
    })
};

var gen = function* () {
    var f1 = yield readFile('./data/a.txt');
    var f2 = yield readFile('./data/b.txt');
    var f3 = yield readFile('./data/c.txt');
    console.log([f1,f2,f3]);
};
co(gen);

执行结果