Generator 大概是我在 ES6 中最感興趣的特性。說它「神奇」並不誇張:它與以往 JavaScript 的行為模式差異極大,初學時甚至顯得晦澀,但一旦理解,就會發現它能讓原本纏繞成一團的回呼地獄,被拉直成一條條清楚的直線。
function* quips(name) {
yield "hello " + name + "!";
yield "i hope you are enjoying the blog posts";
if (name.startsWith("X")) {
yield "it's cool how your name starts with X, " + name;
}
yield "see you later!";
}
它長得很像普通函數,但少了兩處關鍵差異:
function*,而非 function。yield。它和 return 有幾分神似,但任何函數都只能返回一次,Generator 卻能 yield 任意多次——每次 yield 都會暫停執行,之後再從該處恢復。「能暫停」正是 Generator 與普通函數最根本的分野。
> var iter = quips("jorendorff");
[object Generator]
> iter.next()
{ value: "hello jorendorff!", done: false }
> iter.next()
{ value: "i hope you are enjoying the blog posts", done: false }
> iter.next()
{ value: "see you later!", done: false }
> iter.next()
{ value: undefined, done: true }
普通函數一旦被呼叫就立刻執行,直到 return 或拋出例外為止。Generator 不同:呼叫 quips("jorendorff") 不會執行任何一行程式,它只是回傳一個 Generator 物件,此時函數暫停在第一行之前。之後每呼叫一次 .next(),它就往前跑到下一個 yield 為止,並把該處產生的值交回給呼叫者。跑到函數尾端時,done 變為 true、value 為 undefined。
從實作角度看,每次遇到 yield,函數的執行框架(區域變數、參數、暫存值與目前執行位置)會被從堆疊中卸下,而 Generator 物件仍持有該框架的參照,因此下次 .next() 就能原地復原。
特別要強調:Generator 不是多執行緒。它與呼叫者永遠在同一條執行線上,執行順序確定且有序,不存在資源競爭與結果不確定的問題;差別只在於它能於 yield 標記處主動讓出控制權。
ES6 的迭代器並非內建類別,而是一個擴充點:只要實作 [Symbol.iterator]() 與 .next(),任何物件都能成為迭代器。但手寫一整套協議著實繁瑣,以一個從 start 數到 stop 的 range 為例:
class RangeIterator {
constructor(start, stop) {
this.value = start;
this.stop = stop;
}
[Symbol.iterator]() {
return this;
}
next() {
var value = this.value;
if (value < this.stop) {
this.value++;
return {done: false, value: value};
} else {
return {done: true, value: undefined};
}
}
}
// 回傳一個從 start 遞增到 stop 的迭代器
function range(start, stop) {
return new RangeIterator(start, stop);
}
這 23 行寫法與 Java、Swift 的思路相近,看似無懈可擊,但迭代器協議強迫我們把一個自然的迴圈拆散成狀態管理,可讀性自然打了折扣。
改用 Generator,只需要四行:
function* range(start, stop) {
for (var i = start; i < stop; i++) yield i;
}
之所以能如此精簡,是因為所有 Generator 都原生實作了 .next() 與 [Symbol.iterator](),你只需要把迴圈邏輯寫出來即可。用 Generator 寫迭代器,就像用一句話表達意思,而不必寫一封又長又繞的信。
this 並逐值 yield 的 Generator,把它掛到該物件的 [Symbol.iterator] 上即可。function* splitIntoRows(icons, rowLength) {
for (var i = 0; i < icons.length; i += rowLength) {
yield icons.slice(i, i + rowLength);
}
}
原本會先算出全部結果再打包成陣列回傳,現在則是回傳迭代器,結果在需要時才逐個計算。兩者行為不同,但呼叫端多半感受不到差別。
for (var data of myNewGenerator(args)) 消費,往往能讓長而繞的函數一分為二。function* filter(test, iterable) {
for (var item of iterable) {
if (test(item)) yield item;
}
}
傳統非同步 API 需要回呼函數,三個非同步任務串起來就是三層縮排,錯誤處理約定又各家不同,成功與失敗被默默丟棄也是常事。我們早已接受「非同步程式碼天生不如同步程式碼親切」這件事。
Generator 提供了另一條路。Q.async 便是把 Generator 與 Promise 結合的實驗性嘗試,讓非同步程式碼長得接近同步版本:
// 同步版本
function makeNoise() {
shake();
rattle();
roll();
}
// 非同步版本,回傳在製造噪音完成後才 resolve 的 Promise
function makeNoise_async() {
return Q.async(function* () {
yield shake_async();
yield rattle_async();
yield roll_async();
});
}
最大的差別只是在每個非同步呼叫前加上 yield。而在 Q.async 裡,你可以像寫同步程式那樣使用 if 與 try-catch,學習成本大幅降低。當時 ES7 也已在規劃結合 Promise 與 Generator 的非同步函數語法,靈感來自 C# 的類似設計。
服務端方面,io.js 可直接使用 Generator,Node.js 則需加上 --harmony 啟動參數。瀏覽器端,Firefox 27 與 Chrome 39 以上已支援;若要上 production,可透過 Babel 或 Google Traceur 轉譯為 ES5。
題外話:JavaScript 版的 Generator 最早由 Brendan Eich 實作,靈感源自 Python,而 Python 又取自 Icon;Firefox 2.0 早在 2006 年就已納入。標準化之路並不平順,語法與行為歷經多次變動,Firefox 與 Chrome 中的 ES6 Generator 由 Andy Wingo 完成,並獲得 Bloomberg 贊助。
本文尚未觸及 .throw()、.return()、.next() 的可選參數與 yield* 語法。就學 Generator 的方式而言,我們也在這裡先 yield 一下,剩下的留待下回——看似簡單的特性,往往蘊藏著極大的用處。