生成器Gengrator是ES6 新增的函數(shù)功能，它允許你定義一個(gè)包含自有迭代算法的函數(shù)， 同時(shí)它可以自動維護(hù)自己的狀態(tài)。本文來總結(jié)一下JAVAScript 中生成器的相關(guān)知識點(diǎn)。
一、什么是生成器
生成器是ES6新增的一個(gè)極為靈活的結(jié)構(gòu)，擁有在一個(gè)函數(shù)塊內(nèi)暫停和恢復(fù)代碼執(zhí)行的能力。這種新能力具有深遠(yuǎn)的影響，比如，使用生成器可以自定義迭代器和實(shí)現(xiàn)協(xié)程。
生成器函數(shù)
生成器函數(shù)提供了一個(gè)強(qiáng)大的選擇：它允許你定義一個(gè)包含自有迭代算法的函數(shù)， 同時(shí)它可以自動維護(hù)自己的狀態(tài)。生成器函數(shù)使用 function* 語法編寫
//生成器函數(shù)聲明
function* generatorFn() {}
//生成器函數(shù)表達(dá)式
let generatorFn = function* () {};
//作為對象字面量方法的生成器函數(shù)
let foo = {
*generatorFn() {},
};
//作為類實(shí)例方法的生成器函數(shù)
class Foo {
*generatorFn() {}
}
//作為類靜態(tài)方法的生成器函數(shù)
class Bar {
static *generatorFn() {}
}
//等價(jià)的生成器函數(shù)
function* generatorFnA() {}
function* generatorFnB() {}
function* generatorFnc() {}
//等價(jià)的生成器方法
class Foo {
*generatorFnD() {}
*generatorFnE() {}
}
注：箭頭函數(shù)無法用來定義生成器函數(shù)
生成器對象
調(diào)用生成器函數(shù)會產(chǎn)生一個(gè)生成器對象。生成器對象一開始處于暫停執(zhí)行（suspended）的狀態(tài)。與迭代器相似，生成器對象也實(shí)現(xiàn)了Iterator接口，因此具有next（）方法。調(diào)用這個(gè)方法會讓生成器開始或恢復(fù)執(zhí)行。
function* generatorFn() {}
const gen = generatorFn();
console.log(gen); // generatorfn {<suspended>}
console.log(gen.next); // f next() {[native code]}
next()方法的返回值類似于迭代器，有一個(gè)done屬性和一個(gè)value屬性。函數(shù)體為空的生成器函數(shù)中間不會停留，調(diào)用一次next（）就會讓生成器到達(dá)done：true狀態(tài)。
function* generatorFn() {}
const gen = generatorFn();
console.log(gen); // generatorfn {<suspended>}
console.log(gen.next()); //{value: undefined, done: true}
生成器函數(shù)只會在初次調(diào)用next（）方法后開始執(zhí)行，如下所示：
function* generatorFn() {
console.log("我執(zhí)行了");
}
//初次調(diào)用生成器函數(shù)并不會打印日志
let gen = generatorFn();
gen.next(); // 我執(zhí)行了
生成器對象實(shí)現(xiàn)了Iterable接口，它們默認(rèn)的迭代器是自引用的：
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關(guān)鍵字
生成器會在每個(gè)yield 語句后停止執(zhí)行，在函數(shù)中停止執(zhí)行的能力是極其強(qiáng)大的，yield 關(guān)鍵字指定了迭代器在被調(diào)用next的方法是應(yīng)當(dāng)按順序返回的值，在沒有調(diào)用next() 方法的時(shí)候，生成器函數(shù)里的的代碼并不會執(zhí)行，同時(shí)也可用通過return 返回生成器函數(shù)的返回值
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 }
此時(shí)的yield關(guān)鍵字有點(diǎn)像函數(shù)的中間返回語句，它生成的值會出現(xiàn)在next（）方法返回的對象里。通過yield關(guān)鍵字退出的生成器函數(shù)會處在done：false狀態(tài)；通過return關(guān)鍵字退出的生成器函數(shù)會處于done：true狀態(tài)。
yield關(guān)鍵字詳解
yield 關(guān)鍵字可以和值或者是表達(dá)式在一起使用，因此可以通過生成器給迭代器添加項(xiàng)目，而不是機(jī)械化地將項(xiàng)目一個(gè)個(gè)列出：
// for循環(huán)內(nèi)部使用yield關(guān)鍵字
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 關(guān)鍵字只能用于生成器內(nèi)部，用于其他位置會出現(xiàn)語法錯誤，即使在生成器內(nèi)部的函數(shù)中也不行，下面的代碼報(bào)錯。
//有效
function* validGeneratorFn(){
yield;
}
//報(bào)錯
function* invalidGeneratorFnA(){
function a(){
yield;
}
}
//報(bào)錯
function* invalidGeneratorFnB(){
const b=()=>{
yield;
}
}
//報(bào)錯
function* invalidGeneratorFnc(){
(()=>{
yield;})();
}
yield作為函數(shù)中間參數(shù)使用
使用 yield 實(shí)現(xiàn)輸入和輸出, yield 關(guān)鍵字還可以作為函數(shù)的中間參數(shù)使用,上一次讓生成器函數(shù)暫停的 yield 關(guān)鍵字會接收到傳給 next() 方法的第一個(gè)值。第一次調(diào)用 next() 傳入的值不會被使用，因?yàn)檫@一次調(diào)用是為了開始執(zhí)行生成器函數(shù)
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關(guān)鍵字同時(shí)用于輸入輸出
// yield 關(guān)鍵字可以同時(shí)用于輸入和輸出，如下
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 }
因?yàn)楹瘮?shù)必須對整個(gè)表達(dá)式求值才能確定要返回的值，所以它在遇到y(tǒng)ield關(guān)鍵字時(shí)暫停執(zhí)行并計(jì)算出要產(chǎn)生的值：1 。下一個(gè)調(diào)用next（）傳入了 2 ，作為交給了同一個(gè)yield的值。然后這個(gè)值被確定為本次生成器函數(shù)要返回的值
使用yield實(shí)現(xiàn)遞歸算法
yield*最有用的地方是實(shí)現(xiàn)遞歸操作，此時(shí)生成器可以產(chǎn)生自身。看下面的例子：
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
在這個(gè)例子中，每個(gè)生成器首先都會從新創(chuàng)建的生成器對象產(chǎn)出每個(gè)值，然后再產(chǎn)出一個(gè)整數(shù)。結(jié)果就是生成器函數(shù)會遞歸地減少計(jì)數(shù)器值，并實(shí)例化另一個(gè)生成器對象。從最頂層來看，這就相當(dāng)于創(chuàng)建一個(gè)可迭代對象并返回遞增的整數(shù)
三、提前終止生成器
與迭代器類似，生成器也支持“可關(guān)閉”的概念。一個(gè)實(shí)現(xiàn)Iterator接口的對象一定有next（）方法，還有一個(gè)可選的return（）方法用于提前終止迭代器。生成器對象除了有這兩個(gè)方法，還有第三個(gè)方法：thorw（）。
通過return和 throw兩種方法，提前終止生成器，都會強(qiáng)制生成器進(jìn)入關(guān)閉狀態(tài)(generatorFn {<closed>})。
return()
一旦進(jìn)入關(guān)閉狀態(tài)，之后再調(diào)用next()都會顯示 done: true狀態(tài)。
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}
當(dāng)我們調(diào)用生成器的 return方法時(shí)，生成器會進(jìn)入關(guān)閉狀態(tài)，后續(xù)再調(diào)用 next方法，都會顯示 done: true狀態(tài)，且 value也只有在再次調(diào)用 return的時(shí)候才能得到不是 undefined的值。
for-of循環(huán)等內(nèi)置語言結(jié)構(gòu)會忽略狀態(tài)為done:true的IteratorObject內(nèi)部返回的值。
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()方法會在暫停的時(shí)候?qū)⒁粋€(gè)提供的錯誤注入到生成器對象中。如果錯誤未被處理，生成器就會關(guān)閉。
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>}
不過，假如生成器函數(shù)內(nèi)部處理了這個(gè)錯誤，那么生成器就不會關(guān)閉，而且還可以恢復(fù)執(zhí)行。錯誤處理會跳過對應(yīng)的yield，因此在這個(gè)例子中會跳過一個(gè)值，比如：
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}
在這個(gè)例子中，生成器在try/catch塊中的yield關(guān)鍵字處暫停執(zhí)行。在暫停期間，throw（）方法向生成器對象內(nèi)部注入了一個(gè)錯誤：字符串‘throw'。這個(gè)錯誤會被yield關(guān)鍵字拋出。因?yàn)殄e誤是在生成器的try/catch塊中拋出的，所以仍然在生成器內(nèi)部被捕獲。可是，由于yield拋出了那個(gè)錯誤，生成器就不會再產(chǎn)出值2。此時(shí)，生成器函數(shù)繼續(xù)執(zhí)行，在下一次迭代再次遇到y(tǒng)ield關(guān)鍵字時(shí)產(chǎn)出了值3。
四、自定義迭代器
上篇說過對象是沒有實(shí)現(xiàn)迭代器，也就是說對象沒有@@iterator，無法通過Symbol.iterator訪問，所以不能遍歷對象，為了可以實(shí)現(xiàn)對象的遍歷，我們需要在對象上實(shí)現(xiàn)上面說的迭代器。通常有兩種寫法，一種是傳統(tǒng)的寫法，這種需要自己去控制內(nèi)部的狀態(tài)，另外一種是利用生成器函數(shù)返回的Generator的迭代器來實(shí)現(xiàn)，代碼如下：
傳統(tǒng)寫法
let obj = {
name: "張三",
age: 18,
[Symbol.iterator]: () => {
// 這里不要用this， 因?yàn)槭莚eturn 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]);
}
生成器函數(shù)寫法
// 為不可迭代的對象添加迭代器
let obj = {
a: 1,
b: 2
}
obj[Symbol.iterator] = function* () {
let keys = Object.keys(obj);
//取到key值的長度
let len = keys.length;
//定義循環(huán)變量
let n = 0;
//條件判斷
while (n <= len - 1) {
yield { k: keys[n], v: obj[keys[n]] };
n++
}
}
//返回的是個(gè)對象的key和value
for (let { k, v } of obj) {
console.log(k, v); // name 張三 age 18
}
總結(jié)
生成器是ES6的一個(gè)新的函數(shù)類型，它并不像普通函數(shù)那樣總是從運(yùn)行開始到運(yùn)行結(jié)束。取而代之的是，生成器yield可以在運(yùn)行當(dāng)中暫停，并且等到將來再次next()時(shí)再從暫停的地方恢復(fù)運(yùn)行。
這種交替的暫停和恢復(fù)是合作式的雙向消息傳遞，這意味著生成器具有獨(dú)一無二的能力來暫停自身，這是通過關(guān)鍵字yield實(shí)現(xiàn)的。
