阮一峰老师的ES6入门：Generator 函数的语法

Generator 函数的语法

1. 简介

基本概念

Generator 函数是 ES6 提供的一种异步编程解决方案，语法行为与传统函数彻底不一样。本章详细介绍 Generator 函数的语法和 API，它的异步编程应用请看《Generator 函数的异步应用》一章。

Generator 函数有多种理解角度。语法上，首先能够把它理解成，Generator 函数是一个状态机，封装了多个内部状态。

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

形式上，Generator 函数是一个普通函数，可是有两个特征。一是，function关键字与函数名之间有一个星号；二是，函数体内部使用yield表达式，定义不一样的内部状态（yield在英语里的意思就是“产出”）。

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

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

而后，Generator 函数的调用方法与普通函数同样，也是在函数名后面加上一对圆括号。不一样的是，调用 Generator 函数后，该函数并不执行，返回的也不是函数运行结果，而是一个指向内部状态的指针对象，也就是上一章介绍的遍历器对象（Iterator Object）。

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

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

上面代码一共调用了四次next方法。

第一次调用，Generator 函数开始执行，直到遇到第一个yield表达式为止。next方法返回一个对象，它的value属性就是当前yield表达式的值hello，done属性的值false，表示遍历尚未结束。

第二次调用，Generator 函数从上次yield表达式停下的地方，一直执行到下一个yield表达式。next方法返回的对象的value属性就是当前yield表达式的值world，done属性的值false，表示遍历尚未结束。

第三次调用，Generator 函数从上次yield表达式停下的地方，一直执行到return语句（若是没有return语句，就执行到函数结束）。next方法返回的对象的value属性，就是紧跟在return语句后面的表达式的值（若是没有return语句，则value属性的值为undefined），done属性的值true，表示遍历已经结束。

第四次调用，此时 Generator 函数已经运行完毕，next方法返回对象的value属性为undefined，done属性为true。之后再调用next方法，返回的都是这个值。

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

ES6 没有规定，function关键字与函数名之间的星号，写在哪一个位置。这致使下面的写法都能经过。

function * foo(x, y) { ··· } function *foo(x, y) { ··· } function* foo(x, y) { ··· } function*foo(x, y) { ··· } 

因为 Generator 函数仍然是普通函数，因此通常的写法是上面的第三种，即星号紧跟在function关键字后面。本书也采用这种写法。

yield 表达式

因为 Generator 函数返回的遍历器对象，只有调用next方法才会遍历下一个内部状态，因此其实提供了一种能够暂停执行的函数。yield表达式就是暂停标志。

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

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

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

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

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

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

function* gen() { yield 123 + 456; } 

上面代码中，yield后面的表达式123 + 456，不会当即求值，只会在next方法将指针移到这一句时，才会求值。

yield表达式与return语句既有类似之处，也有区别。类似之处在于，都能返回紧跟在语句后面的那个表达式的值。区别在于每次遇到yield，函数暂停执行，下一次再从该位置继续向后执行，而return语句不具有位置记忆的功能。一个函数里面，只能执行一次（或者说一个）return语句，可是能够执行屡次（或者说多个）yield表达式。正常函数只能返回一个值，由于只能执行一次return；Generator 函数能够返回一系列的值，由于能够有任意多个yield。从另外一个角度看，也能够说 Generator 生成了一系列的值，这也就是它的名称的来历（英语中，generator 这个词是“生成器”的意思）。

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

function* f() { console.log('执行了！') } var generator = f(); setTimeout(function () { generator.next() }, 2000); 

上面代码中，函数f若是是普通函数，在为变量generator赋值时就会执行。可是，函数f是一个 Generator 函数，就变成只有调用next方法时，函数f才会执行。

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

(function (){ yield 1; })() // SyntaxError: Unexpected number 

上面代码在一个普通函数中使用yield表达式，结果产生一个句法错误。

下面是另一个例子。

var arr = [1, [[2, 3], 4], [5, 6]]; var flat = function* (a) { a.forEach(function (item) { if (typeof item !== 'number') { yield* flat(item); } else { yield item; } }); }; for (var f of flat(arr)){ console.log(f); } 

上面代码也会产生句法错误，由于forEach方法的参数是一个普通函数，可是在里面使用了yield表达式（这个函数里面还使用了yield*表达式，详细介绍见后文）。一种修改方法是改用for循环。

var arr = [1, [[2, 3], 4], [5, 6]]; var flat = function* (a) { var length = a.length; for (var i = 0; i < length; i++) { var item = a[i]; if (typeof item !== 'number') { yield* flat(item); } else { yield item; } } }; for (var f of flat(arr)) { console.log(f); } // 1, 2, 3, 4, 5, 6 

另外，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 } 

yield表达式用做函数参数或放在赋值表达式的右边，能够不加括号。

function* demo() { foo(yield 'a', yield 'b'); // OK let input = yield; // OK } 

与 Iterator 接口的关系

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

因为 Generator 函数就是遍历器生成函数，所以能够把 Generator 赋值给对象的Symbol.iterator属性，从而使得该对象具备 Iterator 接口。

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

上面代码中，Generator 函数赋值给Symbol.iterator属性，从而使得myIterable对象具备了 Iterator 接口，能够被...运算符遍历了。

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

function* gen(){  // some code } var g = gen(); g[Symbol.iterator]() === g // true 

上面代码中，gen是一个 Generator 函数，调用它会生成一个遍历器对象g。它的Symbol.iterator属性，也是一个遍历器对象生成函数，执行后返回它本身。

2. 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 函数运行的不一样阶段，从外部向内部注入不一样的值，从而调整函数行为。

再看一个例子。

function* foo(x) { var y = 2 * (yield (x + 1)); var z = yield (y / 3); return (x + y + z); } var a = foo(5); a.next() // Object{value:6, done:false} a.next() // Object{value:NaN, done:false} a.next() // Object{value:NaN, done:true} var b = foo(5); b.next() // { value:6, done:false } b.next(12) // { value:8, done:false } b.next(13) // { value:42, done:true } 

上面代码中，第二次运行next方法的时候不带参数，致使 y 的值等于2 * undefined（即NaN），除以 3 之后仍是NaN，所以返回对象的value属性也等于NaN。第三次运行Next方法的时候不带参数，因此z等于undefined，返回对象的value属性等于5 + NaN + undefined，即NaN。

若是向next方法提供参数，返回结果就彻底不同了。上面代码第一次调用b的next方法时，返回x+1的值6；第二次调用next方法，将上一次yield表达式的值设为12，所以y等于24，返回y / 3的值8；第三次调用next方法，将上一次yield表达式的值设为13，所以z等于13，这时x等于5，y等于24，因此return语句的值等于42。

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

再看一个经过next方法的参数，向 Generator 函数内部输入值的例子。

function* dataConsumer() { console.log('Started'); console.log(`1. ${yield}`); console.log(`2. ${yield}`); return 'result'; } let genObj = dataConsumer(); genObj.next(); // Started genObj.next('a') // 1. a genObj.next('b') // 2. b 

上面代码是一个很直观的例子，每次经过next方法向 Generator 函数输入值，而后打印出来。

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

function wrapper(generatorFunction) { return function (...args) { let generatorObject = generatorFunction(...args); generatorObject.next(); return generatorObject; }; } const wrapped = wrapper(function* () { console.log(`First input: ${yield}`); return 'DONE'; }); wrapped().next('hello!') // First input: hello! 

上面代码中，Generator 函数若是不用wrapper先包一层，是没法第一次调用next方法，就输入参数的。

3. for...of 循环

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循环，依次显示 5 个yield表达式的值。这里须要注意，一旦next方法的返回对象的done属性为true，for...of循环就会停止，且不包含该返回对象，因此上面代码的return语句返回的6，不包括在for...of循环之中。

下面是一个利用 Generator 函数和for...of循环，实现斐波那契数列的例子。

function* fibonacci() { let [prev, curr] = [0, 1]; for (;;) { yield curr; [prev, curr] = [curr, prev + curr]; } } for (let n of fibonacci()) { if (n > 1000) break; console.log(n); } 

从上面代码可见，使用for...of语句时不须要使用next方法。

利用for...of循环，能够写出遍历任意对象（object）的方法。原生的 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 

上面代码中，对象jane原生不具有 Iterator 接口，没法用for...of遍历。这时，咱们经过 Generator 函数objectEntries为它加上遍历器接口，就能够用for...of遍历了。加上遍历器接口的另外一种写法是，将 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 

除了for...of循环之外，扩展运算符（...）、解构赋值和Array.from方法内部调用的，都是遍历器接口。这意味着，它们均可以将 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 

4. 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 

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

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

var g = function* () { try { yield; } catch (e) { console.log(e); } }; var i = g(); i.next(); i.throw(new Error('出错了！')); // Error: 出错了！(…) 

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

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] 

上面代码之因此只捕获了a，是由于函数体外的catch语句块，捕获了抛出的a错误之后，就不会再继续try代码块里面剩余的语句了。

若是 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 

上面代码中，Generator 函数g内部没有部署try...catch代码块，因此抛出的错误直接被外部catch代码块捕获。

若是 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 

上面代码中，g.throw抛出错误之后，没有任何try...catch代码块能够捕获这个错误，致使程序报错，中断执行。

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方法抛错只可能抛出在函数外部。

throw方法被捕获之后，会附带执行下一条yield表达式。也就是说，会附带执行一次next方法。

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 

上面代码中，g.throw方法被捕获之后，自动执行了一次next方法，因此会打印b。另外，也能够看到，只要 Generator 函数内部部署了try...catch代码块，那么遍历器的throw方法抛出的错误，不影响下一次遍历。

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

var gen = function* gen(){ yield console.log('hello'); yield console.log('world'); } var g = gen(); g.next(); try { throw new Error(); } catch (e) { g.next(); } // hello // world 

上面代码中，throw命令抛出的错误不会影响到遍历器的状态，因此两次执行next方法，都进行了正确的操做。

这种函数体内捕获错误的机制，大大方便了对错误的处理。多个yield表达式，能够只用一个try...catch代码块来捕获错误。若是使用回调函数的写法，想要捕获多个错误，就不得不为每一个函数内部写一个错误处理语句，如今只在 Generator 函数内部写一次catch语句就能够了。

Generator 函数体外抛出的错误，能够在函数体内捕获；反过来，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 执行过程当中抛出错误，且没有被内部捕获，就不会再执行下去了。若是此后还调用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 函数就已经结束了，再也不执行下去了。

5. 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。

function* gen() { yield 1; yield 2; yield 3; } var g = gen(); g.next()  // { value: 1, done: false } g.return() // { value: undefined, done: true } 

若是 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方法。

6. next()、throw()、return() 的共同点

next()、throw()、return()这三个方法本质上是同一件事，能够放在一块儿理解。它们的做用都是让 Generator 函数恢复执行，而且使用不一样的语句替换yield表达式。

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

const g = function* (x, y) { let result = yield x + y; return result; }; const gen = g(1, 2); gen.next(); // Object {value: 3, done: false} gen.next(1); // Object {value: 1, done: true} // 至关于将 let result = yield x + y // 替换成 let result = 1; 

上面代码中，第二个next(1)方法就至关于将yield表达式替换成一个值1。若是next方法没有参数，就至关于替换成undefined。

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

gen.throw(new Error('出错了')); // Uncaught Error: 出错了 // 至关于将 let result = yield x + y // 替换成 let result = throw(new Error('出错了')); 

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

gen.return(2); // Object {value: 2, done: true} // 至关于将 let result = yield x + y // 替换成 let result = return 2; 

7. 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 

上面代码中，foo和bar都是 Generator 函数，在bar里面调用foo，就须要手动遍历foo。若是有多个 Generator 函数嵌套，写起来就很是麻烦。

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" 

再来看一个对比的例子。

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" 

上面例子中，outer2使用了yield*，outer1没使用。结果就是，outer1返回一个遍历器对象，outer2返回该遍历器对象的内部值。

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

let delegatedIterator = (function* () { yield 'Hello!'; yield 'Bye!'; }()); let delegatingIterator = (function* () { yield 'Greetings!'; yield* delegatedIterator; yield 'Ok, bye.'; }()); for(let value of delegatingIterator) { console.log(value); } // "Greetings! // "Hello!" // "Bye!" // "Ok, bye." 

上面代码中，delegatingIterator是代理者，delegatedIterator是被代理者。因为yield* delegatedIterator语句获得的值，是一个遍历器，因此要用星号表示。运行结果就是使用一个遍历器，遍历了多个 Generator 函数，有递归的效果。

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

function* concat(iter1, iter2) { yield* iter1; yield* iter2; }  // 等同于 function* concat(iter1, iter2) { for (var value of iter1) { yield value; } for (var value of iter2) { yield value; } } 

上面代码说明，yield*后面的 Generator 函数（没有return语句时），不过是for...of的一种简写形式，彻底能够用后者替代前者。反之，在有return语句时，则须要用var value = yield* iterator的形式获取return语句的值。

若是yield*后面跟着一个数组，因为数组原生支持遍历器，所以就会遍历数组成员。

function* gen(){ yield* ["a", "b", "c"]; } gen().next() // { value:"a", done:false } 

上面代码中，yield命令后面若是不加星号，返回的是整个数组，加了星号就表示返回的是数组的遍历器对象。

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

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

上面代码中，yield表达式返回整个字符串，yield*语句返回单个字符。由于字符串具备 Iterator 接口，因此被yield*遍历。

若是被代理的 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(); it.next() // {value: 1, done: false} it.next() // {value: 2, done: false} it.next() // {value: 3, done: false} it.next(); // "v: foo" // {value: 4, done: false} it.next() // {value: undefined, done: true} 

上面代码在第四次调用next方法的时候，屏幕上会有输出，这是由于函数foo的return语句，向函数bar提供了返回值。

再看一个例子。

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 

因为扩展运算符...默认调用 Iterator 接口，因此上面这个函数也能够用于嵌套数组的平铺。

[...iterTree(tree)] // ["a", "b", "c", "d", "e"] 

下面是一个稍微复杂的例子，使用yield*语句遍历彻底二叉树。

// 下面是二叉树的构造函数， // 三个参数分别是左树、当前节点和右树 function Tree(left, label, right) { this.left = left; this.label = label; this.right = right; }  // 下面是中序（inorder）遍历函数。 // 因为返回的是一个遍历器，因此要用generator函数。 // 函数体内采用递归算法，因此左树和右树要用yield*遍历 function* inorder(t) { if (t) { yield* inorder(t.left); yield t.label; yield* inorder(t.right); } }  // 下面生成二叉树 function make(array) {  // 判断是否为叶节点 if (array.length == 1) return new Tree(null, array[0], null); return new Tree(make(array[0]), array[1], make(array[2])); } let tree = make([[['a'], 'b', ['c']], 'd', [['e'], 'f', ['g']]]);  // 遍历二叉树 var result = []; for (let node of inorder(tree)) { result.push(node); } result // ['a', 'b', 'c', 'd', 'e', 'f', 'g'] 

8. 做为对象属性的 Generator 函数

若是一个对象的属性是 Generator 函数，能够简写成下面的形式。

let obj = { * myGeneratorMethod() { ··· } }; 

上面代码中，myGeneratorMethod属性前面有一个星号，表示这个属性是一个 Generator 函数。

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

let obj = { myGeneratorMethod: function* () {  // ··· } }; 

9. Generator 函数的this

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

function* g() {} g.prototype.hello = function () { return 'hi!'; }; let obj = g(); obj instanceof g // true obj.hello() // 'hi!' 

上面代码代表，Generator 函数g返回的遍历器obj，是g的实例，并且继承了g.prototype。可是，若是把g看成普通的构造函数，并不会生效，由于g返回的老是遍历器对象，而不是this对象。

function* g() { this.a = 11; } let obj = g(); obj.next(); obj.a // undefined 

上面代码中，Generator 函数g在this对象上面添加了一个属性a，可是obj对象拿不到这个属性。

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

function* F() { yield this.x = 2; yield this.y = 3; } new F() // TypeError: F is not a constructor 

上面代码中，new命令跟构造函数F一块儿使用，结果报错，由于F不是构造函数。

那么，有没有办法让 Generator 函数返回一个正常的对象实例，既能够用next方法，又能够得到正常的this？

下面是一个变通方法。首先，生成一个空对象，使用call方法绑定 Generator 函数内部的this。这样，构造函数调用之后，这个空对象就是 Generator 函数的实例对象了。

function* F() { this.a = 1; yield this.b = 2; yield this.c = 3; } var obj = {}; var f = F.call(obj); f.next();  // Object {value: 2, done: false} f.next();  // Object {value: 3, done: false} f.next();  // Object {value: undefined, done: true} obj.a // 1 obj.b // 2 obj.c // 3 

上面代码中，首先是F内部的this对象绑定obj对象，而后调用它，返回一个 Iterator 对象。这个对象执行三次next方法（由于F内部有两个yield表达式），完成 F 内部全部代码的运行。这时，全部内部属性都绑定在obj对象上了，所以obj对象也就成了F的实例。

上面代码中，执行的是遍历器对象f，可是生成的对象实例是obj，有没有办法将这两个对象统一呢？

一个办法就是将obj换成F.prototype。

function* F() { this.a = 1; yield this.b = 2; yield this.c = 3; } var f = F.call(F.prototype); 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 

再将F改为构造函数，就能够对它执行new命令了。

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 

10. 含义

Generator 与状态机

Generator 是实现状态机的最佳结构。好比，下面的clock函数就是一个状态机。

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

上面代码的clock函数一共有两种状态（Tick和Tock），每运行一次，就改变一次状态。这个函数若是用 Generator 实现，就是下面这样。

var clock = function* () { while (true) { console.log('Tick!'); yield; console.log('Tock!'); yield; } }; 

上面的 Generator 实现与 ES5 实现对比，能够看到少了用来保存状态的外部变量ticking，这样就更简洁，更安全（状态不会被非法篡改）、更符合函数式编程的思想，在写法上也更优雅。Generator 之因此能够不用外部变量保存状态，是由于它自己就包含了一个状态信息，即目前是否处于暂停态。

Generator 与协程

协程（coroutine）是一种程序运行的方式，能够理解成“协做的线程”或“协做的函数”。协程既能够用单线程实现，也能够用多线程实现。前者是一种特殊的子例程，后者是一种特殊的线程。

（1）协程与子例程的差别

传统的“子例程”（subroutine）采用堆栈式“后进先出”的执行方式，只有当调用的子函数彻底执行完毕，才会结束执行父函数。协程与其不一样，多个线程（单线程状况下，即多个函数）能够并行执行，可是只有一个线程（或函数）处于正在运行的状态，其余线程（或函数）都处于暂停态（suspended），线程（或函数）之间能够交换执行权。也就是说，一个线程（或函数）执行到一半，能够暂停执行，将执行权交给另外一个线程（或函数），等到稍后收回执行权的时候，再恢复执行。这种能够并行执行、交换执行权的线程（或函数），就称为协程。

从实现上看，在内存中，子例程只使用一个栈（stack），而协程是同时存在多个栈，但只有一个栈是在运行状态，也就是说，协程是以多占用内存为代价，实现多任务的并行。

（2）协程与普通线程的差别

不难看出，协程适合用于多任务运行的环境。在这个意义上，它与普通的线程很类似，都有本身的执行上下文、能够分享全局变量。它们的不一样之处在于，同一时间能够有多个线程处于运行状态，可是运行的协程只能有一个，其余协程都处于暂停状态。此外，普通的线程是抢先式的，到底哪一个线程优先获得资源，必须由运行环境决定，可是协程是合做式的，执行权由协程本身分配。

因为 JavaScript 是单线程语言，只能保持一个调用栈。引入协程之后，每一个任务能够保持本身的调用栈。这样作的最大好处，就是抛出错误的时候，能够找到原始的调用栈。不至于像异步操做的回调函数那样，一旦出错，原始的调用栈早就结束。

Generator 函数是 ES6 对协程的实现，但属于不彻底实现。Generator 函数被称为“半协程”（semi-coroutine），意思是只有 Generator 函数的调用者，才能将程序的执行权还给 Generator 函数。若是是彻底执行的协程，任何函数均可以让暂停的协程继续执行。

若是将 Generator 函数看成协程，彻底能够将多个须要互相协做的任务写成 Generator 函数，它们之间使用yield表达式交换控制权。

Generator 与上下文

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

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

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

function* gen() { yield 1; return 2; } let g = gen(); console.log( g.next().value, g.next().value, ); 

上面代码中，第一次执行g.next()时，Generator 函数gen的上下文会加入堆栈，即开始运行gen内部的代码。等遇到yield 1时，gen上下文退出堆栈，内部状态冻结。第二次执行g.next()时，gen上下文从新加入堆栈，变成当前的上下文，从新恢复执行。

11. 应用

Generator 能够暂停函数执行，返回任意表达式的值。这种特色使得 Generator 有多种应用场景。

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

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

function* loadUI() { showLoadingScreen(); yield loadUIDataAsynchronously(); hideLoadingScreen(); } var loader = loadUI(); // 加载UI loader.next()  // 卸载UI loader.next() 

上面代码中，第一次调用loadUI函数时，该函数不会执行，仅返回一个遍历器。下一次对该遍历器调用next方法，则会显示Loading界面（showLoadingScreen），而且异步加载数据（loadUIDataAsynchronously）。等到数据加载完成，再一次使用next方法，则会隐藏Loading界面。能够看到，这种写法的好处是全部Loading界面的逻辑，都被封装在一个函数，循序渐进很是清晰。

Ajax 是典型的异步操做，经过 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); }); } var it = main(); it.next(); 

上面代码的main函数，就是经过 Ajax 操做获取数据。能够看到，除了多了一个yield，它几乎与同步操做的写法彻底同样。注意，makeAjaxCall函数中的next方法，必须加上response参数，由于yield表达式，自己是没有值的，老是等于undefined。

下面是另外一个例子，经过 Generator 函数逐行读取文本文件。

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

上面代码打开文本文件，使用yield表达式能够手动逐行读取文件。

（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(); 

上面代码已经把回调函数，改为了直线执行的形式，可是加入了大量 Promise 的语法。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命令的特性，提供一种更通常的控制流管理的方法。

let steps = [step1Func, step2Func, step3Func]; function* iterateSteps(steps){ for (var i=0; i< steps.length; i++){ var step = steps[i]; yield step(); } } 

上面代码中，数组steps封装了一个任务的多个步骤，Generator 函数iterateSteps则是依次为这些步骤加上yield命令。

将任务分解成步骤以后，还能够将项目分解成多个依次执行的任务。

let jobs = [job1, job2, job3]; function* iterateJobs(jobs){ for (var i=0; i< jobs.length; i++){ var job = jobs[i]; yield* iterateSteps(job.steps); } } 

上面代码中，数组jobs封装了一个项目的多个任务，Generator 函数iterateJobs则是依次为这些任务加上yield*命令。

最后，就能够用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）部署 Iterator 接口

利用 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 

上述代码中，myObj是一个普通对象，经过iterEntries函数，就有了 Iterator 接口。也就是说，能够在任意对象上部署next方法。

下面是一个对数组部署 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 表达，彻底能够用数组模拟 Generator 的这种用法。

function doStuff() { return [ fs.readFile.bind(null, 'hello.txt'), fs.readFile.bind(null, 'world.txt'), fs.readFile.bind(null, 'and-such.txt') ]; } 

上面的函数，能够用如出一辙的for...of循环处理！两相一比较，就不难看出 Generator 使得数据或者操做，具有了相似数组的接口。