JavaScript迭代器与生成器之生成器
生成器Gengrator是ES6 新增的函数功能，它允许你定义一个包含自有迭代算法的函数， 同时它可以自动维护自己的状态。本文来总结一下JAVAScript 中生成器的相关知识点。
一、什么是生成器
生成器是ES6新增的一个极为灵活的结构，拥有在一个函数块内暂停和恢复代码执行的能力。这种新能力具有深远的影响，比如，使用生成器可以自定义迭代器和实现协程。
生成器函数
生成器函数提供了一个强大的选择：它允许你定义一个包含自有迭代算法的函数， 同时它可以自动维护自己的状态。生成器函数使用 function* 语法编写
//生成器函数声明
function* generatorFn() {}
//生成器函数表达式
let generatorFn = function* () {};
//作为对象字面量方法的生成器函数
let foo = {
*generatorFn() {},
};
//作为类实例方法的生成器函数
class Foo {
*generatorFn() {}
}
//作为类静态方法的生成器函数
class Bar {
static *generatorFn() {}
}
//等价的生成器函数
function* generatorFnA() {}
function* generatorFnB() {}
function* generatorFnc() {}
//等价的生成器方法
class Foo {
*generatorFnD() {}
*generatorFnE() {}
}
注：箭头函数无法用来定义生成器函数
生成器对象
调用生成器函数会产生一个生成器对象。生成器对象一开始处于暂停执行（suspended）的状态。与迭代器相似，生成器对象也实现了Iterator接口，因此具有next（）方法。调用这个方法会让生成器开始或恢复执行。
function* generatorFn() {}
const gen = generatorFn();
console.log(gen); // generatorfn {<suspended>}
console.log(gen.next); // f next() {[native code]}
next()方法的返回值类似于迭代器，有一个done属性和一个value属性。函数体为空的生成器函数中间不会停留，调用一次next（）就会让生成器到达done：true状态。
function* generatorFn() {}
const gen = generatorFn();
console.log(gen); // generatorfn {<suspended>}
console.log(gen.next()); //{value: undefined, done: true}
生成器函数只会在初次调用next（）方法后开始执行，如下所示：
function* generatorFn() {
console.log("我执行了");
}
//初次调用生成器函数并不会打印日志
let gen = generatorFn();
gen.next(); // 我执行了
生成器对象实现了Iterable接口，它们默认的迭代器是自引用的：
function* generatorFn() {}
console.log(generatorFn); // f*generator(){}
console.log(generatorFn()[Symbol.iterator]);
// f[Symbol.iterator](){native code}
console.log(generatorFn());
// generatorFn{<suspended>}
console.log(generatorFn()[Symbol.iterator]());
// generatorFn{<suspended>}
const g = generatorFn();
console.log(g === g[Symbol.iterator]()); // true
二、yield关键字
生成器会在每个yield 语句后停止执行，在函数中停止执行的能力是极其强大的，yield 关键字指定了迭代器在被调用next的方法是应当按顺序返回的值，在没有调用next() 方法的时候，生成器函数里的的代码并不会执行，同时也可用通过return 返回生成器函数的返回值
function* generatorFn() {
console.log("start");
yield 1;
yield;
yield 2;
return 3;
}
let generatorObject = generatorFn();
console.log(generatorObject.next());
//start { value: 1, done: false}
console.log(generatorObject.next());
// { value: undefined, done: false }
console.log(generatorObject.next());
// { value: 2, done: false }
console.log(generatorObject.next());
// { value: 3, done: true }
此时的yield关键字有点像函数的中间返回语句，它生成的值会出现在next（）方法返回的对象里。通过yield关键字退出的生成器函数会处在done：false状态；通过return关键字退出的生成器函数会处于done：true状态。
yield关键字详解
yield 关键字可以和值或者是表达式在一起使用，因此可以通过生成器给迭代器添加项目，而不是机械化地将项目一个个列出：
// for循环内部使用yield关键字
function* createIterator2(items) {
//let 块级作用域
for (let i = 0; i < items.length; i++) {
yield items[i];
}
}
let iterator2 = createIterator2([1, 2, 3]);
console.log(iterator2.next());
//{value:1, done:false}
console.log(iterator2.next());
//{value:2, done:false}
console.log(iterator2.next());
//{value:3, done:false}
console.log(iterator2.next());
//{value:undefined, done:true}
注：yield 关键字只能用于生成器内部，用于其他位置会出现语法错误，即使在生成器内部的函数中也不行，下面的代码报错。
//有效
function* validGeneratorFn(){
yield;
}
//报错
function* invalidGeneratorFnA(){
function a(){
yield;
}
}
//报错
function* invalidGeneratorFnB(){
const b=()=>{
yield;
}
}
//报错
function* invalidGeneratorFnc(){
(()=>{
yield;})();
}
yield作为函数中间参数使用
使用 yield 实现输入和输出, yield 关键字还可以作为函数的中间参数使用,上一次让生成器函数暂停的 yield 关键字会接收到传给 next() 方法的第一个值。第一次调用 next() 传入的值不会被使用，因为这一次调用是为了开始执行生成器函数
function* generatorFn(initial) {
console.log(initial);
console.log(yield);
console.log(yield);
}
let generatorObject = generatorFn(1);
generatorObject.next(2); // 1
generatorObject.next(3); // 3
generatorObject.next(4); // 4
yield关键字同时用于输入输出
// yield 关键字可以同时用于输入和输出，如下
function* generatorFn() {
return yield 1;
}
let generatorObject = generatorFn();
console.log(generatorObject.next());
// { done: false, value: 1 }
console.log(generatorObject.next(2));
// { done: true, value: 2 }
因为函数必须对整个表达式求值才能确定要返回的值，所以它在遇到yield关键字时暂停执行并计算出要产生的值：1 。下一个调用next（）传入了 2 ，作为交给了同一个yield的值。然后这个值被确定为本次生成器函数要返回的值
使用yield实现递归算法
yield*最有用的地方是实现递归操作，此时生成器可以产生自身。看下面的例子：
function* Fn(n) {
if (n > 0) {
yield* nTimes(n - 1);
yield n - 1;
}
}
for (const x of Fn(3)) {
console.log(x);
}
// 0
// 1
// 2
在这个例子中，每个生成器首先都会从新创建的生成器对象产出每个值，然后再产出一个整数。结果就是生成器函数会递归地减少计数器值，并实例化另一个生成器对象。从最顶层来看，这就相当于创建一个可迭代对象并返回递增的整数
三、提前终止生成器
与迭代器类似，生成器也支持“可关闭”的概念。一个实现Iterator接口的对象一定有next（）方法，还有一个可选的return（）方法用于提前终止迭代器。生成器对象除了有这两个方法，还有第三个方法：thorw（）。
通过return和 throw两种方法，提前终止生成器，都会强制生成器进入关闭状态(generatorFn {<closed>})。
return()
一旦进入关闭状态，之后再调用next()都会显示 done: true状态。
function* gFn() {
yield 1;
yield 2;
yield 3;
}
const g = gFn();
console.log(g.next());
// {value: 1, done: false}
console.log(g.return("--return--"));
// {value: "--return--", done: true}
console.log(g);
// gFn {<closed>}
console.log(g.next(11));
// {value: undefined, done: true}
console.log(g.return(33));
// {value; 33, done; true}
当我们调用生成器的 return方法时，生成器会进入关闭状态，后续再调用 next方法，都会显示 done: true状态，且 value也只有在再次调用 return的时候才能得到不是 undefined的值。
for-of循环等内置语言结构会忽略状态为done:true的IteratorObject内部返回的值。
function* generatorFn() {
for (const x of [1, 2, 3]) {
yield x;
}
}
const g = generatorFn();
for (const x of g) {
console.log(x); // 1 2 3
}
for (const x of g) {
if (x > 1) {
g.return(4);
}
console.log(x); // 1 2
}
throw()
throw()方法会在暂停的时候将一个提供的错误注入到生成器对象中。如果错误未被处理，生成器就会关闭。
function* generatorFn() {
for (const x of [1, 2, 3]) {
yield x;
}
}
const g = generatorFn();
console.log(g); //generatorFn{<suspended>}
try {
g.throw("throw");
} catch (e) {
console.log(e); // throw
}
console.log(g); //generatorFn{<closed>}
不过，假如生成器函数内部处理了这个错误，那么生成器就不会关闭，而且还可以恢复执行。错误处理会跳过对应的yield，因此在这个例子中会跳过一个值，比如：
function* generatorFn() {
for (const x of [1, 2, 3]) {
try {
yield x;
} catch (e) {
console.log(e); // throw
}
}
}
const g = generatorFn();
console.log(g.next()); //{ value:1, done:false }
g.throw("throw");
console.log(g); // generatorFn {<suspended>}
console.log(g.next()); //{value:3, done:false}
在这个例子中，生成器在try/catch块中的yield关键字处暂停执行。在暂停期间，throw（）方法向生成器对象内部注入了一个错误：字符串‘throw'。这个错误会被yield关键字抛出。因为错误是在生成器的try/catch块中抛出的，所以仍然在生成器内部被捕获。可是，由于yield抛出了那个错误，生成器就不会再产出值2。此时，生成器函数继续执行，在下一次迭代再次遇到yield关键字时产出了值3。
四、自定义迭代器
上篇说过对象是没有实现迭代器，也就是说对象没有@@iterator，无法通过Symbol.iterator访问，所以不能遍历对象，为了可以实现对象的遍历，我们需要在对象上实现上面说的迭代器。通常有两种写法，一种是传统的写法，这种需要自己去控制内部的状态，另外一种是利用生成器函数返回的Generator的迭代器来实现，代码如下：
传统写法
let obj = {
name: "张三",
age: 18,
[Symbol.iterator]: () => {
// 这里不要用this， 因为是return fn, this 会丢失
let index = -1,
atrrList = Object.keys(obj);
const objIterator = {
next: () => {
let result = "";
index++;
if (index < atrrList.length) {
result = {
value: atrrList[index],
done: false,
};
} else {
result = {
done: true,
};
}
return result;
},
};
return objIterator;
},
};
for (const iterator of obj) {
console.log("atrrs:" + iterator + ",value:" + obj[iterator]);
}
生成器函数写法
// 为不可迭代的对象添加迭代器
let obj = {
a: 1,
b: 2
}
obj[Symbol.iterator] = function* () {
let keys = Object.keys(obj);
//取到key值的长度
let len = keys.length;
//定义循环变量
let n = 0;
//条件判断
while (n <= len - 1) {
yield { k: keys[n], v: obj[keys[n]] };
n++
}
}
//返回的是个对象的key和value
for (let { k, v } of obj) {
console.log(k, v); // name 张三 age 18
}
总结
生成器是ES6的一个新的函数类型，它并不像普通函数那样总是从运行开始到运行结束。取而代之的是，生成器yield可以在运行当中暂停，并且等到将来再次next()时再从暂停的地方恢复运行。
这种交替的暂停和恢复是合作式的双向消息传递，这意味着生成器具有独一无二的能力来暂停自身，这是通过关键字yield实现的。
