生成器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實現的。
