generator 是 ES6 引入的新資料型別,外觀像函式,但有一個關鍵差異:普通函式只能用 return 回傳一次,而 generator 可以透過 yield 語法「暫停並交出值」多次,每次呼叫 next() 就從上次暫停處繼續。
定義方式是在 function 後面加上星號:
function* foo() { yield 1; }
它的核心價值是在函式內部保存狀態。普通函式每次呼叫都從頭開始,若需要記住上次的位置,往往得動用全域變數;generator 則天然具備 this 能力。
2.1 以 generator 產生連續 ID
'use strict';
function next_id(){
var id = 1;
while (id < 100) {
yield id;
id++;
}
return id;
}
// 測試
var x, pass = true, g = next_id();
for (x = 1; x < 100; x++) {
if (g.next().value !== x) {
pass = false;
alert('測試失敗!');
break;
}
}
if (pass) {
alert('測試通過!');
}
注意 var id = 1 這個區域變數,它在多次 next() 呼叫之間被完整保留下來,這正是 generator 的狀態保存能力。
2.2 無限迭代器
function* idMaker(){
var index = 0;
while (true) yield index++;
}
var gen = idMaker(); // Generator { }
console.log(gen.next().value); // 0
console.log(gen.next().value); // 1
console.log(gen.next().value); // 2
這是一個不會結束的序列。因為 generator 是「按需計算」,只要不逐一取用就不會真的無限跑下去,這在處理無限序列(如質數、費氏數列)時非常有用。
2.3 Generator.prototype.next()
next() 每次回傳一個物件,含 value 與 done 兩個屬性。迭代結束前 done 為 false,結束後為 true:
function* gen() {
yield 1;
yield 2;
yield 3;
}
var g = gen(); // Generator { }
g.next(); // { value: 1, done: false }
g.next(); // { value: 2, done: false }
g.next(); // { value: 3, done: false }
g.next(); // { value: undefined, done: true }
另外,next() 也可以接收參數,該值會成為上一個 yield 表達式的回傳結果,這是 generator 雙向通訊的機制。
2.4 Generator.prototype.return()
return() 會回傳指定值並直接結束迭代器:
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 }
要留意的是,若 done 已經是 true,再呼叫 return() 也不會改變什麼:
function* gen() { yield 1; }
var g = gen();
console.log(g.next()); // { value: 1, done: false }
console.log(g.next()); // { value: undefined, done: true }
console.log(g.return(1)); // { value: undefined, done: true }
實務上 return() 常用於提前中斷走訪,例如在 for...of 迴圈裡 break,引擎會自動呼叫它,讓 generator 中的 finally 區塊有機會執行收尾清理。
2.5 Generator.prototype.throw()
throw() 會向 generator 內部丟入一個例外,讓它有機會在 try/catch 中攔下並繼續,藉此重新取回控制權。回傳值同樣是含 value 與 done 的物件:
function* gen() {
while (true) {
try {
yield 42;
} catch (e) {
console.log("Error caught!");
}
}
}
var g = gen();
var a = g.next(); // { value: 42, done: false }
var b = g.throw(new Error("Something went wrong")); // "Error caught!" / { value: 42, done: false }
console.log(a);
console.log(b.value + "::" + b.done);
這個「外部能向內部拋錯」的能力,是 async/await 的實作基礎。事實上,async 函式在底層就是靠 generator 加自動執行的機制搭建起來的——await 相當於 yield,Promise 的 resolve 對應 next(),reject 對應 throw()。