ES6(12)Generator（构造器） 函数的语法

基本概念：异步编程解决方案

Generator 函数是 ES6 提供的一种异步编程解决方案，语法行为与传统函数完全不同。

1、语法上：Generator 函数是一个状态机，封装了多个内部状态

执行 Generator 函数会返回一个遍历器对象

Generator 函数除了状态机，还是一个遍历器对象生成函数

执行 Generator 函数会返回一个遍历器对象，也就是说，Generator 函数除了状态机，还是一个遍历器对象生成函数。返回的遍历器对象，可以依次遍历 Generator 函数内部的每一个状态。

2、形式上：Generator 函数是一个普通函数，但是有两个特征

（1）function关键字与函数名之间有一个星号；

（2）函数体内部使用yield表达式，定义不同的内部状态（yield在英语里的意思就是“产出”）

3、调用 Generator 函数后：必须调用遍历器对象的next方法，使得指针移向下一个状态

该函数并不执行，返回的也不是函数运行结果，而是一个指向内部状态的指针对象，也就是上一章介绍的遍历器对象（Iterator Object）。

（1）每次调用next方法，内部指针就从函数头部或上一次停下来的地方开始执行，直到遇到下一个yield表达式（或return语句）为止

（2）Generator 函数是分段执行的，yield表达式是暂停执行的标记，而next方法可以恢复执行

下一步，必须调用遍历器对象的next方法，使得指针移向下一个状态。也就是说，每次调用next方法，内部指针就从函数头部或上一次停下来的地方开始执行，直到遇到下一个yield表达式（或return语句）为止。换言之，Generator 函数是分段执行的，yield表达式是暂停执行的标记，而next方法可以恢复执行。

function* aaa(){
    yield 'hello';
    yield 'world';
    return 'ending';
}

var hw=aaa();
console.log(aaa);
//[GeneratorFunction: aaa]

console.log(hw);
//Object [Generator] {}

console.log(hw.next());
// { value: 'hello', done: false }

console.log(hw.next());
// { value: 'world', done: false }

console.log(hw.next());
// { value: 'ending', done: true }

console.log(hw.next());
// { value: undefined, done: true }
复制代码

上边的函数有三个状态：hello，world 和 return 语句（结束执行）。

（3）next方法返回一个对象，它的value属性就是当前yield表达式的值，done属性的值表示遍历还没有结束

（4）一直执行到return语句（如果没有return语句，就执行到函数结束）

（5）next方法返回的对象的value属性，就是紧跟在return语句后面的表达式的值（如果没有return语句，则value属性的值为undefined）

（6）done属性的值为true，表示遍历已经结束

4、没有规定function关键字与函数名之间的星号，写在哪个位置

//都可以
function * foo(x, y) { ··· }
function *foo(x, y) { ··· }
function* foo(x, y) { ··· }
function*foo(x, y) { ··· }
复制代码

yield 表达式

由于 Generator 函数返回的遍历器对象，只有调用next方法才会遍历下一个内部状态，所以其实提供了一种可以暂停执行的函数。

yield表达式就是暂停标志

遍历器对象的next方法的运行逻辑

（1）遇到yield表达式，就暂停执行后面的操作，并将紧跟在yield后面的那个表达式的值，作为返回的对象的value属性值

（2）下一次调用next方法时，再继续往下执行，直到遇到下一个yield表达式

（3）如果没有再遇到新的yield表达式，就一直运行到函数结束，直到return语句为止，并将return语句后面的表达式的值，作为返回的对象的value属性值

（4）如果该函数没有return语句，则返回的对象的value属性值为undefined

（5）yield表达式后面的表达式，只有当调用next方法、内部指针指向该语句时才会执行，因此等于为JavaScript提供了手动的“惰性求值”（Lazy Evaluation）的语法功能

function* gen() {
  yield  123 + 456;
}
//yield后面的表达式123 + 456，不会立即求值，只会在next方法将指针移到这一句时，才会求值。
复制代码

yield表达式与return语句

既有相似之处，也有区别。

相似之处在于：都能返回紧跟在语句后面的那个表达式的值

区别在于：每次遇到yield，函数暂停执行，下一次再从该位置继续向后执行，而return语句不具备位置记忆的功能

一个函数里面，只能执行一次（或者说一个）return语句，但是可以执行多次（或者说多个）yield表达式

Generator 函数不用yield表达式,就变成了一个单纯的暂缓执行函数

function* f() {
  console.log('执行了！')
}

var generator = f();

setTimeout(function () {
  generator.next()
}, 2000);
复制代码

yield表达式只能用在 Generator 函数里面

用在其他地方都会报错。

(function (){
  yield 1;
})()
// SyntaxError: Unexpected number
复制代码

yield表达式如果用在另一个表达式之中，必须放在圆括号里面

function* demo() {
	//console.log('Hello' + yield); // SyntaxError
	//console.log('Hello' + yield 123); // SyntaxError
    
    console.log('Hello' + (yield)); // OK
    console.log('Hello' + (yield 123)); // OK
}

var a=demo();
console.log(a.next());  //{ value: undefined, done: false }
//Helloundefined

console.log(a.next());  //{ value: 123, done: false }
//Helloundefined

console.log(a.next());//{ value: undefined, done: true }
复制代码

yield表达式用作函数参数或放在赋值表达式的右边，可以不加括号

var foo=function(a,b){
    console.log(a);
    console.log(b);
}
//demo 有 三个yield 所以 需要四次next  done才等于true
function* demo() {
    foo(yield 'a', yield 'b'); // OK
    let input = yield; // OK
    console.log(input);
}

var a=demo();
console.log(a.next());  //{ value: 'a', done: false }

console.log(a.next());  //{ value: 'b', done: false }

console.log(a.next());  //这一步foo才执行 
						//undefined
                        // undefined
                        // { value: undefined, done: false }

console.log(a.next());  //undefined
                        // { value: undefined, done: true }

复制代码

与 Iterator 接口的关系

1、任意一个对象的Symbol.iterator方法，等于该对象的遍历器生成函数，调用该函数会返回该对象的一个遍历器对象

2、由于Generator 函数就是遍历器生成函数，因此可以把 Generator 赋值给对象的Symbol.iterator属性，从而使得该对象具有 Iterator 接口

var myIterable = {};
myIterable[Symbol.iterator] = function* () {
  yield 1;
  yield 2;
  yield 3;
};

[...myIterable] // [1, 2, 3]
复制代码

3、Generator 函数执行后，返回一个遍历器对象。该对象本身也具有Symbol.iterator属性，Symbol.iterator属性执行后返回自身

function* gen(){
  // some code
}

var g = gen();

g[Symbol.iterator]() === g
// true
复制代码

next 方法的参数

1、yield表达式本身没有返回值，或者说总是返回undefined(这就是为什么被赋值yield的变量都是 undefined的原因)

2、上一个yield下边（下一行，不是紧跟在yield的代码）的代码只有在下一个next后才会执行

3、next方法可以带一个参数，该参数就会被当作上一个yield表达式的返回值（把上一次的yield和紧跟yield的语句更改为next 的参数）

function* f() {
    for(var i = 0; true; i++) {
        var reset = yield i;
        console.log(reset);
        if(reset) { i = -1; }
    }
}

var g = f();

console.log(g.next());  // { value: 0, done: false }

console.log(g.next());  //undefined
                        // { value: 1, done: false }

console.log(g.next());  //undefined
                        // { value: 2, done: false }

console.log(g.next(true));    // true
                              //{ value: 0, done: false }

复制代码

如果next方法没有参数，每次运行到yield表达式，变量reset的值总是undefined。

当next方法带一个参数true时，变量reset就被重置为这个参数（即true），因此i会等于-1，下一轮循环就会从-1开始递增变为0。

通过next方法的参数 在不同阶段入不同值

1、Generator 函数从暂停状态到恢复运行，它的上下文状态（context）是不变的

2、通过next方法的参数，就有办法在 Generator 函数开始运行之后，继续向函数体内部注入值

也就是说，可以在Generator函数运行的不同阶段，从外部向内部注入不同的值，从而调整函数行为。

3、由于next方法的参数表示上一个yield表达式的返回值，所以在第一次使用next方法时，传递参数是无效的

function* foo(x) {
    var y = 2 * (yield (x + 1));
    var z = yield (y / 3);
    return (x + y + z);
}

var a = foo(5);
console.log(a.next());  // Object{value:6, done:false}  只执行到了var y； y=undefined
console.log(a.next());  // Object{value:NaN, done:false}    只执行到了var z；相当于 z=undefined/3=NaN
console.log(a.next());  // Object{value:NaN, done:true}    相当于  5+NaN+undefined

var b = foo(5);
console.log(b.next());            // { value:6, done:false }      y=undefined
console.log(b.next(12));    // { value:8, done:false }      y 后面的yield表达式重新设置为12 y=2*12=24  z=undefined
console.log(b.next(13));    // { value:42, done:true }      z 后面的yield表达式重新设置为13  5+24+13=42
复制代码

for…of 循环不再需要调用next方法

for...of循环可以自动遍历 Generator 函数运行时生成的Iterator对象，且此时不再需要调用next方法。

function* foo() {
  yield 1;
  yield 2;
  yield 3;
  yield 4;
  yield 5;
  return 6;
}

for (let v of foo()) {
  console.log(v);
}
// 1 2 3 4 5
复制代码

使原生对象支持for…of，通过 Generator 函数为它加上遍历接口

原生的 JavaScript 对象没有遍历接口，无法使用for...of循环，通过 Generator 函数为它加上这个接口，就可以用了。

function* objectEntries(obj) {
  let propKeys = Reflect.ownKeys(obj);

  for (let propKey of propKeys) {
    yield [propKey, obj[propKey]];
  }
}

let jane = { first: 'Jane', last: 'Doe' };

for (let [key, value] of objectEntries(jane)) {
  console.log(`${key}: ${value}`);
}
// first: Jane
// last: Doe
复制代码

将 Generator 函数加到对象的Symbol.iterator属性上面。

function* objectEntries() {
  let propKeys = Object.keys(this);

  for (let propKey of propKeys) {
    yield [propKey, this[propKey]];
  }
}

let jane = { first: 'Jane', last: 'Doe' };

jane[Symbol.iterator] = objectEntries;

for (let [key, value] of jane) {
  console.log(`${key}: ${value}`);
}
// first: Jane
// last: Doe
复制代码

扩展运算符（...）、解构赋值和Array.from方法可以将 Generator 函数返回的 Iterator 对象，作为参数

扩展运算符（...）、解构赋值和Array.from方法内部调用的，都是遍历器接口（for of）。这意味着，它们都可以将 Generator 函数返回的 Iterator 对象，作为参数。

function* numbers () {
  yield 1
  yield 2
  return 3
  yield 4
}

// 扩展运算符
[...numbers()] // [1, 2]

// Array.from 方法
Array.from(numbers()) // [1, 2]

// 解构赋值
let [x, y] = numbers();
x // 1
y // 2

// for...of 循环
for (let n of numbers()) {
  console.log(n)
}
// 1
// 2
复制代码

Generator.prototype.throw() 在函数体外抛出错误，然后在 Generator 函数体内捕获

Generator 函数返回的遍历器对象，都有一个throw方法，在函数体外抛出错误，然后在 Generator 函数体内捕获。

var g = function* () {
  try {
    yield;
  } catch (e) {
    console.log('内部捕获', e);
  }
};

var i = g();
i.next();

try {
  i.throw('a');
  i.throw('b');
} catch (e) {
  console.log('外部捕获', e);
}
// 内部捕获 a
// 外部捕获 b
复制代码

上面代码中，遍历器对象i连续抛出两个错误。第一个错误被 Generator 函数体内的catch语句捕获。i第二次抛出错误，由于 Generator 函数内部的catch语句已经执行过了，不会再捕捉到这个错误了，所以这个错误就被抛出了Generator函数体，被函数体外的catch语句捕获。

1、throw方法可以接受一个参数，该参数会被catch语句接收，建议抛出Error对象的实例

var g = function* () {
  try {
    yield;
  } catch (e) {
    console.log(e);
  }
};

var i = g();
i.next();
i.throw(new Error('出错了！'));
// Error: 出错了！(…)
复制代码

2、不要混淆遍历器对象的throw方法和全局的throw命令

上面代码的错误，是用遍历器对象的throw方法抛出的，而不是用throw命令抛出的。全局的throw命令抛出的错误只能被函数体外的catch语句捕获。

throw命令与g.throw方法是无关的，两者互不影响。

var g = function* () {
  while (true) {
    try {
      yield;
    } catch (e) {
      if (e != 'a') throw e;
      console.log('内部捕获', e);
    }
  }
};

var i = g();
i.next();

try {
  throw new Error('a');
  throw new Error('b');
} catch (e) {
  console.log('外部捕获', e);
}
// 外部捕获 [Error: a]
复制代码

3、Generator 函数内部没有部署try…catch代码块，那么throw方法抛出的错误，将被外部try...catch代码块捕获

var g = function* () {
  while (true) {
    yield;
    console.log('内部捕获', e);
  }
};

var i = g();
i.next();

try {
  i.throw('a');
  i.throw('b');
} catch (e) {
  console.log('外部捕获', e);
}
// 外部捕获 a
复制代码

4、Generator 函数内部和外部，都没有部署try…catch代码块那么程序将报错，直接中断执行

var gen = function* gen(){
  yield console.log('hello');
  yield console.log('world');
}

var g = gen();
g.next();
g.throw();
// hello
// Uncaught undefined
复制代码

5、throw方法抛出的错误要被内部捕获，前提是必须至少执行过一次next方法

function* gen() {
  try {
    yield 1;
  } catch (e) {
    console.log('内部捕获');
  }
}

var g = gen();
g.throw(1);
// Uncaught 1
复制代码

上面代码中，g.throw(1)执行时，next方法一次都没有执行过。这时，抛出的错误不会被内部捕获，而是直接在外部抛出，导致程序出错。这种行为其实很好理解，因为第一次执行next方法，等同于启动执行 Generator 函数的内部代码，否则Generator函数还没有开始执行，这时throw方法抛错只可能抛出在函数外部。

6、throw方法被捕获以后，会附带执行下一条yield表达式

也就是说，会附带执行一次next方法

只要Generator函数内部部署了try...catch代码块，那么遍历器的throw方法抛出的错误，不影响下一次遍历。

var gen = function* gen(){
  try {
    yield console.log('a');
  } catch (e) {
    // ...
  }
  yield console.log('b');
  yield console.log('c');
}

var g = gen();
g.next() // a
g.throw() // b
g.next() // c

复制代码

7、Generator 函数体内抛出的错误，也可以被函数体外的catch捕获

function* foo() {
  var x = yield 3;
  var y = x.toUpperCase();
  yield y;
}

var it = foo();

it.next(); // { value:3, done:false }

try {
  it.next(42);
} catch (err) {
  console.log(err);
}
复制代码

第二个next方法向函数体内传入一个参数 42，数值是没有toUpperCase方法的，所以会抛出一个 TypeError错误，被函数体外的catch捕获。

一旦 Generator 执行过程中抛出错误，且没有被内部捕获，就不会再执行下去了

一旦 Generator 执行过程中抛出错误，且没有被内部捕获，就不会再执行下去了。

如果此后还调用next方法，将返回一个value属性等于undefined、done属性等于true的对象，即 JavaScript 引擎认为这个 Generator 已经运行结束了。

function* g() {
  yield 1;
  console.log('throwing an exception');
  throw new Error('generator broke!');
  yield 2;
  yield 3;
}

function log(generator) {
  var v;
  console.log('starting generator');
  try {
    v = generator.next();
    console.log('第一次运行next方法', v);
  } catch (err) {
    console.log('捕捉错误', v);
  }
  try {
    v = generator.next();
    console.log('第二次运行next方法', v);
  } catch (err) {
    console.log('捕捉错误', v);
  }
  try {
    v = generator.next();
    console.log('第三次运行next方法', v);
  } catch (err) {
    console.log('捕捉错误', v);
  }
  console.log('caller done');
}

log(g());
// starting generator
// 第一次运行next方法 { value: 1, done: false }
// throwing an exception
// 捕捉错误 { value: 1, done: false }
// 第三次运行next方法 { value: undefined, done: true }
// caller done
复制代码

上面代码一共三次运行next方法，第二次运行的时候会抛出错误，然后第三次运行的时候，Generator 函数就已经结束了，不再执行下去了。

Generator.prototype.return()返回给定的值，并且终结遍历 Generator函数

Generator 函数返回的遍历器对象，还有一个return方法，可以返回给定的值，并且终结遍历 Generator 函数。

1、如果return方法调用时，不提供参数，则返回值的value属性为undefined

function* gen() {
  yield 1;
  yield 2;
  yield 3;
}

var g = gen();

g.next()        // { value: 1, done: false }
g.return('foo') // { value: "foo", done: true }
g.next()        // { value: undefined, done: true }
复制代码

2、调用return方法后，以后再调用next方法，value总是为undefined，done属性总是返回true

上面代码中，遍历器对象g调用return方法后，返回值的value属性就是return方法的参数foo。并且，Generator 函数的遍历就终止了，返回值的done属性为true，以后再调用next方法，done属性总是返回true。

3、如果 Generator 函数内部有try...finally代码块，且正在执行try代码块，那么return方法会推迟到finally代码块执行完再执行

function* numbers () {
  yield 1;
  try {
    yield 2;
    yield 3;
  } finally {
    yield 4;
    yield 5;
  }
  yield 6;
}
var g = numbers();
g.next() // { value: 1, done: false }
g.next() // { value: 2, done: false }
g.return(7) // { value: 4, done: false }
g.next() // { value: 5, done: false }
g.next() // { value: 7, done: true }
复制代码

上面代码中，调用return方法后，就开始执行finally代码块，然后等到finally代码块执行完，再执行return方法。

yield* 表达式，如果yield表达式后面跟的是一个遍历器对象，需要在yield表达式后面加上星号，表明它返回的是一个遍历器对象

1、在 Generator 函数内部，调用另一个 Generator 函数。需要在前者的函数体内部，自己手动完成遍历

function* foo() {
  yield 'a';
  yield 'b';
}

function* bar() {
  yield 'x';
  // 手动遍历 foo()
  for (let i of foo()) {
    console.log(i);
  }
  yield 'y';
}

for (let v of bar()){
  console.log(v);
}
// x
// a
// b
// y
复制代码

2、ES6 提供了yield*表达式，作为解决办法，用来在一个 Generator 函数里面执行另一个 Generator 函数

（1）yield*后面的 Generator 函数（没有return语句时），等同于在 Generator 函数内部，部署一个for...of循环

（2）yield*后面的 Generator 函数在有return语句时，则需要用var value = yield* iterator的形式获取return语句的值

function* foo() {
  yield 'a';
  yield 'b';
}

function* bar() {
  yield 'x';
  yield* foo();
  yield 'y';
}

// 等同于
function* bar() {
  yield 'x';
  yield 'a';
  yield 'b';
  yield 'y';
}

// 等同于
function* bar() {
  yield 'x';
  for (let v of foo()) {
    yield v;
  }
  yield 'y';
}

for (let v of bar()){
  console.log(v);
}
// "x"
// "a"
// "b"
// "y"
复制代码

从语法角度看，如果yield表达式后面跟的是一个遍历器对象，需要在yield表达式后面加上星号，表明它返回的是一个遍历器对象。这被称为yield*表达式。

function* inner() {
  yield 'hello!';
}

function* outer1() {
  yield 'open';
  yield inner();
  yield 'close';
}

var gen = outer1()
gen.next().value // "open"
gen.next().value // 返回一个遍历器对象
gen.next().value // "close"

function* outer2() {
  yield 'open'
  yield* inner()
  yield 'close'
}

var gen = outer2()
gen.next().value // "open"
gen.next().value // "hello!"
gen.next().value // "close"
复制代码

yield*后面跟着一个数组(字符串)，由于数组（字符串）原生支持遍历器，因此就会遍历数组成员

//yield命令后面如果不加星号，返回的是整个数组，加了星号就表示返回的是数组的遍历器对象。
function* gen(){
    yield* ["a", "b", "c"];
}
var n=gen();
console.log(n.next()); // { value:"a", done:false }
console.log(n.next()); // { value:"b", done:false }
console.log(n.next()); // { value:"c", done:false }
console.log(n.next()); // { value:undefined, done:true }

//yield表达式返回整个字符串，yield*语句返回单个字符。因为字符串具有 Iterator 接口，所以被yield*遍历
function* gen(){
    yield* 'hello';
}
var n=gen();
console.log(n.next()); // { value:"h", done:false }
console.log(n.next()); // { value:"e", done:false }
console.log(n.next()); // { value:"l", done:false }
console.log(n.next()); // { value:'l', done:true }
console.log(n.next()); // { value:'o', done:true }
console.log(n.next()); // { value:undefined, done:true }
复制代码

被代理的 Generator 函数有return语句,就可以向代理它的 Generator 函数返回数据

function* foo(){
    yield 2;
    yield 3;
    return 'foo';
}

function* bar(){
    yield 1;
    var v = yield* foo();
    console.log('v' + v);
    yield 4;
}

var it = bar();

console.log(it.next());     //{ value: 1, done: false }
console.log(it.next());     //{ value: 2, done: false }
console.log(it.next());     //{ value: 3, done: false }
console.log(it.next());     //vfoo
                            //{ value: 4, done: false }
console.log(it.next());     //{ value: undefined, done: true }
复制代码

function* genFuncWithReturn() {
  yield 'a';
  yield 'b';
  return 'The result';
}
function* logReturned(genObj) {
  let result = yield* genObj;
  console.log(result);
}

[...logReturned(genFuncWithReturn())]
// The result
// 值为 [ 'a', 'b' ]
复制代码

存在两次遍历。第一次是扩展运算符遍历函数logReturned返回的遍历器对象，第二次是yield*语句遍历函数genFuncWithReturn返回的遍历器对象。这两次遍历的效果是叠加的，最终表现为扩展运算符遍历函数genFuncWithReturn返回的遍历器对象。所以，最后的数据表达式得到的值等于[ 'a', 'b' ]。但是，函数genFuncWithReturn的return语句的返回值The result，会返回给函数logReturned内部的result变量，因此会有终端输出。

yield*命令可以很方便地取出嵌套数组的所有成员

function* iterTree(tree) {
  if (Array.isArray(tree)) {
    for(let i=0; i < tree.length; i++) {
      yield* iterTree(tree[i]);
    }
  } else {
    yield tree;
  }
}

const tree = [ 'a', ['b', 'c'], ['d', 'e'] ];

for(let x of iterTree(tree)) {
  console.log(x);
}
// a
// b
// c
// d
// e

复制代码

作为对象属性的 Generator 函数

如果一个对象的属性是 Generator 函数，可以简写成下面的形式。

let obj = {
  * myGeneratorMethod() {
    ···
  }
};
复制代码

它的完整形式如下，与上面的写法是等价的。

let obj = {
  myGeneratorMethod: function* () {
    // ···
  }
};
复制代码

Generator 函数的this

1、Generator 函数的实例，也继承了 Generator 函数的prototype对象上的方法

Generator 函数总是返回一个遍历器，ES6 规定这个遍历器是 Generator 函数的实例，也继承了 Generator 函数的prototype对象上的方法。

function* g() {}

g.prototype.hello = function () {
  return 'hi!';
};

let obj = g();

obj instanceof g // true
obj.hello() // 'hi!'
复制代码

2、Generator 函数也不能当构造函数

如果把g当作普通的构造函数，并不会生效，因为g返回的总是遍历器对象，而不是this对象。

function* g() {
  this.a = 11;
}

let obj = g();
obj.next();
obj.a // undefined
复制代码

3、Generator 函数也不能跟new命令一起用，会报错

function* F() {
  yield this.x = 2;
  yield this.y = 3;
}

new F()
// TypeError: F is not a constructor
复制代码

4、让 Generator 函数返回一个正常的对象实例，既可以用next方法，又可以获得正常的this

function* gen() {
  this.a = 1;
  yield this.b = 2;
  yield this.c = 3;
}

function F() {
  return gen.call(gen.prototype);
}

var f = new F();

f.next();  // Object {value: 2, done: false}
f.next();  // Object {value: 3, done: false}
f.next();  // Object {value: undefined, done: true}

f.a // 1
f.b // 2
f.c // 3
复制代码

Generator 与状态机

Generator 是实现状态机的最佳结构。

下面的clock函数就是一个状态机

//es5
var ticking = true;
var clock = function() {
  if (ticking)
    console.log('Tick!');
  else
    console.log('Tock!');
  ticking = !ticking;
}

//es6
//因为while一直成立 所以 一直循环产生Tick 、 Tock
var clock = function* () {
    while (true) {
        console.log('Tick!');
        yield;
        console.log('Tock!');
        yield;
    }
}();
console.log(clock.next());
console.log(clock.next());
console.log(clock.next());
console.log(clock.next());
// Tick!
//     { value: undefined, done: false }
// Tock!
//     { value: undefined, done: false }
// Tick!
//     { value: undefined, done: false }
// Tock!
//     { value: undefined, done: false }

复制代码

应用

（1）异步操作的同步化表达

Generator 函数的暂停执行的效果，意味着可以把异步操作写在yield表达式里面，等到调用next方法时再往后执行。这实际上等同于不需要写回调函数了，因为异步操作的后续操作可以放在yield表达式下面，反正要等到调用next方法时再执行。所以，Generator 函数的一个重要实际意义就是用来处理异步操作，改写回调函数。

function* loadUI() {
  showLoadingScreen();
  yield loadUIDataAsynchronously();
  hideLoadingScreen();
}
var loader = loadUI();	//调用`loadUI`函数时其实没有任何操作
// 加载UI
loader.next()			//第一次next

// 卸载UI
loader.next()			//第二次next
复制代码

第一次调用loadUI函数时，该函数不会执行，仅返回一个遍历器。

下一次对该遍历器调用next方法，则会显示Loading界面（showLoadingScreen），并且异步加载数据（loadUIDataAsynchronously）。

等到数据加载完成，再一次使用next方法，则会隐藏Loading界面。

Generator 函数部署 Ajax 操作

function* main() {
  var result = yield request("http://some.url");
  var resp = JSON.parse(result);
    console.log(resp.value);
}

function request(url) {
  makeAjaxCall(url, function(response){
    it.next(response);   //next必须加上参数 要不然main函数中 的 result是undefined
  });
}

var it = main();
it.next();
复制代码

通过 Generator 函数逐行读取文本文件

function* numbers() {
  let file = new FileReader("numbers.txt");
  try {
    while(!file.eof) {
      yield parseInt(file.readLine(), 10);
    }
  } finally {
    file.close();
  }
}
复制代码

（2）控制流管理

如果有一个多步操作非常耗时。

回调函数

step1(function (value1) {
  step2(value1, function(value2) {
    step3(value2, function(value3) {
      step4(value3, function(value4) {
        // Do something with value4
      });
    });
  });
});
复制代码

Promise

Promise.resolve(step1)
  .then(step2)
  .then(step3)
  .then(step4)
  .then(function (value4) {
    // Do something with value4
  }, function (error) {
    // Handle any error from step1 through step4
  })
  .done();
复制代码

Generator 函数

function* longRunningTask(value1) {
  try {
    var value2 = yield step1(value1);
    var value3 = yield step2(value2);
    var value4 = yield step3(value3);
    var value5 = yield step4(value4);
    // Do something with value4
  } catch (e) {
    // Handle any error from step1 through step4
  }
}
复制代码

然后，使用一个函数，按次序自动执行所有步骤。

scheduler(longRunningTask(initialValue));

function scheduler(task) {
  var taskObj = task.next(task.value);
  // 如果Generator函数未结束，就继续调用
  if (!taskObj.done) {
    task.value = taskObj.value
    scheduler(task);
  }
}
复制代码

上面这种做法，只适合同步操作，即所有的task都必须是同步的，不能有异步操作。因为这里的代码一得到返回值，就继续往下执行，没有判断异步操作何时完成。

利用for…of循环会自动依次执行yield命令的特性，提供一种更一般的控制流管理的方法

(只能用于所有步骤都是同步操作)

//数组steps封装了一个任务的多个步骤
let steps = [step1Func, step2Func, step3Func];

//Generator 函数iterateSteps则是依次为这些步骤加上yield命令
function* iterateSteps(steps){
  for (var i=0; i< steps.length; i++){
    var step = steps[i];
    yield step();
  }
}

//用for...of循环一次性依次执行所有任务的所有步骤
for (var step of iterateJobs(jobs)){
  console.log(step.id);
}
复制代码

for...of的本质是一个while循环，所以上面的代码实质上执行的是下面的逻辑

var it = iterateJobs(jobs);
var res = it.next();

while (!res.done){
  var result = res.value;
  // ...
  res = it.next();
}
复制代码

（3）利用 Generator 函数，可以在任意对象上部署Iterator接口

function* iterEntries(obj) {
  let keys = Object.keys(obj);
  for (let i=0; i < keys.length; i++) {
    let key = keys[i];
    yield [key, obj[key]];
  }
}

let myObj = { foo: 3, bar: 7 };

for (let [key, value] of iterEntries(myObj)) {
  console.log(key, value);
}

// foo 3
// bar 7
复制代码

对数组部署 Iterator 接口

function* makeSimpleGenerator(array){
  var nextIndex = 0;

  while(nextIndex < array.length){
    yield array[nextIndex++];
  }
}

var gen = makeSimpleGenerator(['yo', 'ya']);

gen.next().value // 'yo'
gen.next().value // 'ya'
gen.next().done  // true
复制代码

（4）作为数据结构

Generator 可以看作是数据结构，更确切地说，可以看作是一个数组结构

因为 Generator 函数可以返回一系列的值，这意味着它可以对任意表达式，提供类似数组的接口。

function* doStuff() {
  yield fs.readFile.bind(null, 'hello.txt');
  yield fs.readFile.bind(null, 'world.txt');
  yield fs.readFile.bind(null, 'and-such.txt');
}
复制代码

上面代码就是依次返回三个函数，但是由于使用了 Generator 函数，导致可以像处理数组那样，处理这三个返回的函数。

for (task of doStuff()) {
  // task是一个函数，可以像回调函数那样使用它
}

//相当于  ES5 
function doStuff() {
  return [
    fs.readFile.bind(null, 'hello.txt'),
    fs.readFile.bind(null, 'world.txt'),
    fs.readFile.bind(null, 'and-such.txt')
  ];
}
复制代码