ECMAScript6-基础16-Generator函数

目录

概念

yield表达式

与Iterator接口的关系

next 方法的参数

for...of 循环

Generator.prototype.throw()

Generator.prototype.return()

next()/throw()/return()的共同点

yield* 表达式

作为对象属性的Generator函数

Generator函数的this

Generator 与上下文

---

概念

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

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

Generator函数是一个普通函数，但是有3个特征：

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

②函数体内部使用yield表达式，定义不同的内部状态。

function* helloWorldGenerator() {   yield 'hello';   yield 'world';   return 'ending';} var hw = helloWorldGenerator();

Generator函数helloWorldGenerator，它内部有两个yield表达式（hello和world），即该函数有三个状态：hello，world 和 return 语句（结束执行）。

Generator 函数的调用方法与普通函数一样，也是在函数名后面加上一对圆括号。不同的是，调用Generator函数后，该函数并不执行，返回的也不是函数运行结果，而是一个指向内部状态的指针对象，也就是遍历器对象。下一步，必须调用遍历器对象的next方法，使得指针移向下一个状态。也就是说，每次调用next方法，内部指针就从函数头部或上一次停下来的地方开始执行，直到遇到下一个yield表达式（或return语句）为止。

hw.next() // { value: 'hello', done: false } hw.next() // { value: 'world', done: false } hw.next() // { value: 'ending', done: true } hw.next() // { value: undefined, done: true }

总结一下，调用 Generator 函数，返回一个遍历器对象，代表 Generator 函数的内部指针。以后，每次调用遍历器对象的next方法，就会返回一个有着value和done两个属性的对象。value属性表示当前的内部状态的值，是yield表达式后面那个表达式的值；done属性是一个布尔值，表示是否遍历结束。

yield表达式

由于 Generator 函数返回的遍历器对象，只有调用next方法才会遍历下一个内部状态，所以其实提供了一种可以暂停执行的函数。yield表达式就是暂停标志。遍历器对象的next方法的运行逻辑如下：

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

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

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

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

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

yield表达式与return语句既有相似之处，也有区别。相似之处在于，都能返回紧跟在语句后面的那个表达式的值。区别在于每次遇到yield，函数暂停执行，下一次再从该位置继续向后执行，而return语句不具备位置记忆的功能。一个函数里面，只能执行一次（或者说一个）return语句，但是可以执行多次（或者说多个）yield表达式。正常函数只能返回一个值，因为只能执行一次return；Generator 函数可以返回一系列的值，因为可以有任意多个yield。从另一个角度看，也可以说 Generator 生成了一系列的值。

Generator 函数可以不用yield表达式，这时就变成了一个单纯的暂缓执行函数。

注意，yield表达式只能用在 Generator 函数里面，用在其他地方都会报错。

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

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 } ② function* demo() {   foo(yield 'a', yield 'b'); // OK   let input = yield; // OK }

与Iterator接口的关系

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

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

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

next 方法的参数

yield表达式本身没有返回值，或者说总是返回undefined。next方法可以带一个参数，该参数就会被当作上一个yield表达式的返回值。

function* f() {   for(var i = 0; true; i++) {     var reset = yield i;     if(reset) { i = -1; }   } } var g = f(); g.next() // { value: 0, done: false } g.next() // { value: 1, done: false } g.next(true) // { value: 0, done: false }

先定义了一个可以无限运行的 Generator 函数f，如果next方法没有参数，每次运行到yield表达式，变量reset的值总是undefined。当next方法带一个参数true时，变量reset就被重置为这个参数（即true），因此i会等于-1，下一轮循环就会从-1开始递增。

这个功能有很重要的语法意义。Generator 函数从暂停状态到恢复运行，它的上下文状态（context）是不变的。通过next方法的参数，就有办法在 Generator 函数开始运行之后，继续向函数体内部注入值。也就是说，可以在 Generator 函数运行的不同阶段，从外部向内部注入不同的值，从而调整函数行为。

注意，由于next方法的参数表示上一个yield表达式的返回值，所以在第一次使用next方法时，传递参数是无效的。V8 引擎直接忽略第一次使用next方法时的参数，只有从第二次使用next方法开始，参数才是有效的。从语义上讲，第一个next方法用来启动遍历器对象，所以不用带有参数。

如果想要第一次调用next方法时，就能够输入值，可以在 Generator 函数外面再包一层。

for...of 循环

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

注意，一旦next方法的返回对象的done属性为true，for...of循环就会中止，且不包含return返回的对象；

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

Generator.prototype.throw()

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

第一个错误被 Generator 函数体内的catch语句捕获。i第二次抛出错误，由于 Generator 函数内部的catch语句已经执行过了，不会再捕捉到这个错误了，所以这个错误就被抛出了 Generator 函数体，被函数体外的catch语句捕获。

注意：

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

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

③如果 Generator 函数内部和外部，都没有部署try...catch代码块，那么程序将报错，直接中断执行。

④throw方法抛出的错误要被内部捕获，前提是必须至少执行过一次next方法。因为第一次执行next方法，等同于启动执行Generator函数的内部代码，否则Generator函数还没有开始执行，这时throw方法抛错只可能抛出在函数外部。

⑤throw方法被捕获以后，会附带执行下一条yield表达式。也就是说，会附带执行一次next方法。只要Generator函数内部部署了try...catch代码块，那么遍历器的throw方法抛出的错误，不影响下一次遍历。

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

⑦Generator 函数体外抛出的错误，可以在函数体内捕获；反过来，Generator 函数体内抛出的错误，也可以被函数体外的catch捕获。

⑧一旦 Generator 执行过程中抛出错误，且没有被内部捕获，就不会再执行下去了。如果此后还调用next方法，将返回一个value属性等于undefined、done属性等于true的对象，即 JavaScript 引擎认为这个 Generator 已经运行结束了。

Generator.prototype.return()

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

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 }

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

注意：

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

②如果 Generator 函数内部有try...finally代码块，且正在执行try代码块，那么return()方法会导致立刻进入finally代码块，执行完以后，整个函数才会结束。

next()/throw()/return()的共同点

next()是将yield表达式替换成一个值。

throw()是将yield表达式替换成一个throw语句。

return()是将yield表达式替换成一个return语句。

yield* 表达式

如果在 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

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

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*表达式。

yield*后面的 Generator 函数（没有return语句时），等同于在 Generator 函数内部，部署一个for...of循环。yield*后面的 Generator 函数（没有return语句时），不过是for...of的一种简写形式，完全可以用后者替代前者。

实际上，任何数据结构只要有 Iterator 接口，就可以被yield*遍历。

let read = (function* () {   yield 'hello';   yield* 'hello';})();   read.next().value // "hello" read.next().value // "h"

在有return语句时，则需要用var value = yield* iterator的形式获取return语句的值。

如果被代理的 Generator 函数有return语句，那么就可以向代理它的 Generator 函数返回数据。

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' ]

同时返回return值，还有之前默认的 Iterator 接口。

作为对象属性的Generator函数

如果一个对象的属性是 Generator 函数，可以简写成下面的形式。属性前面有一个星号，表示这个属性是一个 Generator 函数。

let obj = {   * myGeneratorMethod() {     ···   } }; 它的完整形式如下，与上面的写法是等价的 let obj = {   myGeneratorMethod: function* () {     // ···   } };

Generator函数的this

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

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

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

有，这里暂时先不说明了。

Generator 与上下文

JS代码运行时，会产生一个全局的上下文环境（context，又称运行环境），包含了当前所有的变量和对象。然后，执行函数（或块级代码）的时候，又会在当前上下文环境的上层，产生一个函数运行的上下文，变成当前（active）的上下文，由此形成一个上下文环境的堆栈（context stack）。

这个堆栈是“后进先出”的数据结构，最后产生的上下文环境首先执行完成，退出堆栈，然后再执行完成它下层的上下文，直至所有代码执行完成，堆栈清空。

Generator函数不是这样，它执行产生的上下文环境，一旦遇到yield命令，就会暂时退出堆栈，但是并不消失，里面的所有变量和对象会冻结在当前状态。等到对它执行next命令时，这个上下文环境又会重新加入调用栈，冻结的变量和对象恢复执行。