逐一處理集合中的每個項目是最常見的操作之一。JavaScript 提供了從 for、for each 到 map()、filter() 與陣列推導式的多種手段;而在 JavaScript 1.7 中,迭代器與生成器為核心語法帶來了全新的迭代機制,同時也讓 for…in、for each 的行為得以自訂。
迭代器是一個「每次走訪序列中一個元素,並記住目前走到哪裡」的物件。在 JavaScript 中,它提供一個 next() 方法回傳下一個元素;當序列走到底,就丟出 StopIteration 例外。
迭代器建立後,可以手動反覆呼叫 next(),也可以用 for…in/for each 隱式驅動。
var lang = { name: 'JavaScript', birthYear: 1995 };
var it = Iterator(lang);
var pair = it.next(); // ["name", "JavaScript"]
pair = it.next(); // ["birthday", 1995]
pair = it.next(); // 丟出 StopIteration
用 for…in 取代手動呼叫,迴圈會在 StopIteration 時自動結束:
var it = Iterator(lang); for (var pair in it) print(pair); // 每次輸出一個 [key, value]
若只想要鍵名,把 true 當作第二個參數傳入:
var it = Iterator(lang, true); for (var key in it) print(key);
使用 Iterator() 的一個好處是:掛在 Object.prototype 上的自訂屬性不會被納入走訪序列。
它同樣能作用在陣列上,此時鍵值對變成「索引,值」:
var langs = ['JavaScript', 'Python', 'Haskell']; var it = Iterator(langs); for (var pair in it) print(pair); // [index, language] var it2 = Iterator(langs, true); for (var i in it2) print(i); // 0, 1, 2
搭配 let 可以一次把索引與值解構到區塊變數:
var it = Iterator(langs); for (let [i, lang] in it) print(i + ': ' + lang); // "0: JavaScript" ...
有些集合需要用特定方式走訪,例如:範圍物件應逐一回傳其中的數字;樹的葉節點可用深度或廣度優先拜訪;資料庫查詢結果應一列列吐出不必先全載入;無限數列(如費氏數列)更需要在不建立無限長資料結構的前提下逐項產生。
先建立一個代表範圍的物件:
function Range(low, high){
this.low = low;
this.high = high;
}
接著實作迭代器,介面要求提供 next():
function RangeIterator(range){
this.range = range;
this.current = this.range.low;
}
RangeIterator.prototype.next = function(){
if (this.current > this.range.high)
throw StopIteration;
else
return this.current++;
};
最後為 Range 掛上特殊的 __iterator__ 方法,當有人嘗試迭代它時會被呼叫,並回傳一個 RangeIterator 實例:
Range.prototype.__iterator__ = function(){
return new RangeIterator(this);
};
var range = new Range(3, 5);
for (var i in range) print(i); // 3, 4, 5
自訂迭代器很靈活,但需要顯式維護內部狀態,實作時必須仔細規劃。生成器把這件事簡化了:只要函式中含有一個或多個 yield 運算式,它就是一個生成器。
注意:使用 yield 時,該段程式碼需放在 <script type="application/javascript;version=1.7">(或更高版本)中;XUL 腳本則無需特別指定。
呼叫生成器函式時,函式主體不會立刻執行,而是回傳一個 generator-iterator 物件。每次呼叫它的 next(),執行會推進到下一個 yield 並回傳其值;函式結束或遇到 return 時丟出 StopIteration。
function simpleGenerator(){
yield "first";
yield "second";
yield "third";
for (var i = 0; i < 3; i++)
yield i;
}
var g = simpleGenerator();
print(g.next()); // first
print(g.next()); // second
print(g.next()); // third
print(g.next()); // 0
print(g.next()); // 1
print(g.next()); // 2
print(g.next()); // StopIteration
生成器可以直接當作 __iterator__ 使用,程式碼量大幅縮減:
Range.prototype.__iterator__ = function(){
for (var i = this.low; i <= this.high; i++)
yield i;
};
生成器也可以永不結束,例如實作費氏數列:
function fibonacci(){
var fn1 = 1;
var fn2 = 1;
while (1) {
var current = fn2;
fn2 = fn1;
fn1 = fn1 + current;
yield current;
}
}
var sequence = fibonacci();
print(sequence.next()); // 1, 1, 2, 3, 5, 8, 13 ...
生成器可以帶參數(於首次呼叫時套用),也能用 return 提前終止:
function fibonacci(limit){
var fn1 = 1, fn2 = 1;
while (1) {
var current = fn2;
fn2 = fn1;
fn1 = fn1 + current;
if (limit && current > limit)
return;
yield current;
}
}
除了 next(),generator-iterator 還有 send(),可以回寫生成器內部狀態:傳給 send() 的值會成為上一個 yield 運算式的結果。使用前必須先呼叫過一次 next() 啟動生成器。
function fibonacci(){
var fn1 = 1, fn2 = 1;
while (1) {
var current = fn2;
fn2 = fn1;
fn1 = fn1 + current;
var reset = yield current;
if (reset) { fn1 = 1; fn2 = 1; }
}
}
var sequence = fibonacci();
print(sequence.next()); // 1
print(sequence.send(true)); // 1(重新開始)
print(sequence.next()); // 1
要注意 send(undefined) 等同 next();而用 send() 啟動一個全新的生成器時,傳入 undefined 以外的值會丟出 TypeError。
呼叫 throw() 並傳入例外值,可強制生成器在當前位置丟出例外並暫停;若處理過程中沒有再遇到 yield,例外會往外傳遞,之後呼叫 next() 則會得到 StopIteration。
close() 則用於強制結束生成器,其效果是:所有有效的 finally 區塊會執行;若 finally 丟出 StopIteration 以外的例外,該例外會傳給呼叫 close() 的一方;最後生成器終止。
陣列推導式最明顯的缺點是會在記憶體中建立一整個陣列。輸入很小時沒差,但當輸入龐大、或來源本身就是昂貴甚至無限的序列時,就會出問題。
生成器運算式在語法上幾乎與陣列推導式相同,只是用圓括號取代方括號(並以 for...in 取代 for each...in),建立的是生成器而非陣列,因此能延遲計算:
var doubles = [i * 2 for (i in it)]; // 立即建立整個陣列 var it2 = (i * 2 for (i in it)); // 需要時才計算 print(it2.next()); print(it2.next());
當生成器作為函式參數時,最外層的圓括號可以省略:
var result = doSomething(i * 2 for (i in it));
最後提醒:本文描述的是 JavaScript 1.7 時期(Firefox 專屬)的語法,Iterator()、__iterator__、StopIteration 與陣列推導式如今多已被標準化的 Symbol.iterator、function*、for...of 與 yield* 取代。新專案請直接採用標準寫法,除錯與跨環境相容性都會好上許多。