原生具備 Iterator 接口的數(shù)據(jù)結(jié)構(gòu)如下。
Array
Map
Set
String
TypedArray
函數(shù)的 arguments 對象
NodeList 對象
JavaScript 原有的表示“集合”的數(shù)據(jù)結(jié)構(gòu),主要是數(shù)組(Array)和對象(Object),ES6 又添加了Map和Set。這樣就有了四種數(shù)據(jù)集合,用戶還可以組合使用它們,定義自己的數(shù)據(jù)結(jié)構(gòu),比如數(shù)組的成員是Map,Map的成員是對象。這樣就需要一種統(tǒng)一的接口機制,來處理所有不同的數(shù)據(jù)結(jié)構(gòu)。
遍歷器(Iterator)就是這樣一種機制。它是一種接口,為各種不同的數(shù)據(jù)結(jié)構(gòu)提供統(tǒng)一的訪問機制。任何數(shù)據(jù)結(jié)構(gòu)只要部署Iterator接口,就可以完成遍歷操作(即依次處理該數(shù)據(jù)結(jié)構(gòu)的所有成員)。
Iterator 的作用有三個:一是為各種數(shù)據(jù)結(jié)構(gòu),提供一個統(tǒng)一的、簡便的訪問接口;二是使得數(shù)據(jù)結(jié)構(gòu)的成員能夠按某種次序排列;三是ES6創(chuàng)造了一種新的遍歷命令for...of循環(huán),Iterator接口主要供for...of消費。
Iterator 的遍歷過程是這樣的。
(1)創(chuàng)建一個指針對象,指向當(dāng)前數(shù)據(jù)結(jié)構(gòu)的起始位置。也就是說,遍歷器對象本質(zhì)上,就是一個指針對象。
(2)第一次調(diào)用指針對象的next方法,可以將指針指向數(shù)據(jù)結(jié)構(gòu)的第一個成員。
(3)第二次調(diào)用指針對象的next方法,指針就指向數(shù)據(jù)結(jié)構(gòu)的第二個成員。
(4)不斷調(diào)用指針對象的next方法,直到它指向數(shù)據(jù)結(jié)構(gòu)的結(jié)束位置。
每一次調(diào)用next方法,都會返回數(shù)據(jù)結(jié)構(gòu)的當(dāng)前成員的信息。具體來說,就是返回一個包含value和done兩個屬性的對象。其中,value屬性是當(dāng)前成員的值,done屬性是一個布爾值,表示遍歷是否結(jié)束。
下面是一個模擬next方法返回值的例子。
var it = makeIterator(['a', 'b']);
it.next() // { value: "a", done: false }
it.next() // { value: "b", done: false }
it.next() // { value: undefined, done: true }
function makeIterator(array) {
var nextIndex = 0;
return {
next: function() {
return nextIndex < array.length ?
{value: array[nextIndex++], done: false} :
{value: undefined, done: true};
}
};
}
上面代碼定義了一個makeIterator函數(shù),它是一個遍歷器生成函數(shù),作用就是返回一個遍歷器對象。對數(shù)組['a', 'b']執(zhí)行這個函數(shù),就會返回該數(shù)組的遍歷器對象(即指針對象)it。
next方法返回一個對象,表示當(dāng)前數(shù)據(jù)成員的信息。這個對象具有value和done兩個屬性,value屬性返回當(dāng)前位置的成員,done屬性是一個布爾值,表示遍歷是否結(jié)束,即是否還有必要再一次調(diào)用next方法。
默認 Iterator 接口
Iterator 接口的目的,就是為所有數(shù)據(jù)結(jié)構(gòu),提供了一種統(tǒng)一的訪問機制,即for...of循環(huán)(詳見下文)。當(dāng)使用for...of循環(huán)遍歷某種數(shù)據(jù)結(jié)構(gòu)時,該循環(huán)會自動去尋找 Iterator 接口。
一種數(shù)據(jù)結(jié)構(gòu)只要部署了 Iterator 接口,我們就稱這種數(shù)據(jù)結(jié)構(gòu)是”可遍歷的“(iterable)。
ES6 規(guī)定,默認的 Iterator 接口部署在數(shù)據(jù)結(jié)構(gòu)的Symbol.iterator屬性,或者說,一個數(shù)據(jù)結(jié)構(gòu)只要具有Symbol.iterator屬性,就可以認為是“可遍歷的”(iterable)。Symbol.iterator屬性本身是一個函數(shù),就是當(dāng)前數(shù)據(jù)結(jié)構(gòu)默認的遍歷器生成函數(shù)。執(zhí)行這個函數(shù),就會返回一個遍歷器。至于屬性名Symbol.iterator,它是一個表達式,返回Symbol對象的iterator屬性,這是一個預(yù)定義好的、類型為 Symbol 的特殊值,所以要放在方括號內(nèi)。
const obj = {
[Symbol.iterator] : function () {
return {
next: function () {
return {
value: 1,
done: true
};
}
};
}
};
上面代碼中,對象obj是可遍歷的(iterable),因為具有Symbol.iterator屬性。執(zhí)行這個屬性,會返回一個遍歷器對象。該對象的根本特征就是具有next方法。每次調(diào)用next方法,都會返回一個代表當(dāng)前成員的信息對象,具有value和done兩個屬性。
ES6 的有些數(shù)據(jù)結(jié)構(gòu)原生具備 Iterator 接口(比如數(shù)組),即不用任何處理,就可以被for...of循環(huán)遍歷。原因在于,這些數(shù)據(jù)結(jié)構(gòu)原生部署了Symbol.iterator屬性(詳見下文),另外一些數(shù)據(jù)結(jié)構(gòu)沒有(比如對象)。凡是部署了Symbol.iterator屬性的數(shù)據(jù)結(jié)構(gòu),就稱為部署了遍歷器接口。調(diào)用這個接口,就會返回一個遍歷器對象。
下面的例子是數(shù)組的Symbol.iterator屬性。
let arr = ['a', 'b', 'c'];
let iter = arr[Symbol.iterator]();
iter.next() // { value: 'a', done: false }
iter.next() // { value: 'b', done: false }
iter.next() // { value: 'c', done: false }
iter.next() // { value: undefined, done: true }
上面代碼中,變量arr是一個數(shù)組,原生就具有遍歷器接口,部署在arr的Symbol.iterator屬性上面。所以,調(diào)用這個屬性,就得到遍歷器對象。
對于原生部署 Iterator 接口的數(shù)據(jù)結(jié)構(gòu),不用自己寫遍歷器生成函數(shù),for...of循環(huán)會自動遍歷它們。除此之外,其他數(shù)據(jù)結(jié)構(gòu)(主要是對象)的 Iterator 接口,都需要自己在Symbol.iterator屬性上面部署,這樣才會被for...of循環(huán)遍歷。
一個對象如果要具備可被for...of循環(huán)調(diào)用的 Iterator 接口,就必須在Symbol.iterator的屬性上部署遍歷器生成方法(原型鏈上的對象具有該方法也可)。
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};
}
return {done: true, value: undefined};
}
}
function range(start, stop) {
return new RangeIterator(start, stop);
}
for (var value of range(0, 3)) {
console.log(value); // 0, 1, 2
}
上面代碼是一個類部署 Iterator 接口的寫法。Symbol.iterator屬性對應(yīng)一個函數(shù),執(zhí)行后返回當(dāng)前對象的遍歷器對象。
有了遍歷器接口,數(shù)據(jù)結(jié)構(gòu)就可以用for...of循環(huán)遍歷(詳見下文),也可以使用while循環(huán)遍歷。
var $iterator = ITERABLE[Symbol.iterator]();
var $result = $iterator.next();
while (!$result.done) {
var x = $result.value;
// ...
$result = $iterator.next();
}
上面代碼中,ITERABLE代表某種可遍歷的數(shù)據(jù)結(jié)構(gòu),$iterator是它的遍歷器對象。遍歷器對象每次移動指針(next方法),都檢查一下返回值的done屬性,如果遍歷還沒結(jié)束,就移動遍歷器對象的指針到下一步(next方法),不斷循環(huán)。
調(diào)用 Iterator 接口的場合
有一些場合會默認調(diào)用 Iterator 接口(即Symbol.iterator方法),除了下文會介紹的for...of循環(huán),還有幾個別的場合。
調(diào)用iterator的場合
(1)解構(gòu)賦值
對數(shù)組和 Set 結(jié)構(gòu)進行解構(gòu)賦值時,會默認調(diào)用Symbol.iterator方法。
let set = new Set().add('a').add('b').add('c');
let [x,y] = set;
// x='a'; y='b'
let [first, ...rest] = set;
// first='a'; rest=['b','c'];
(2)擴展運算符
擴展運算符(...)也會調(diào)用默認的 Iterator 接口。
// 例一
var str = 'hello';
[...str] // ['h','e','l','l','o']
// 例二
let arr = ['b', 'c'];
['a', ...arr, 'd']
// ['a', 'b', 'c', 'd']
上面代碼的擴展運算符內(nèi)部就調(diào)用 Iterator 接口。
實際上,這提供了一種簡便機制,可以將任何部署了 Iterator 接口的數(shù)據(jù)結(jié)構(gòu),轉(zhuǎn)為數(shù)組。也就是說,只要某個數(shù)據(jù)結(jié)構(gòu)部署了 Iterator 接口,就可以對它使用擴展運算符,將其轉(zhuǎn)為數(shù)組。
let arr = [...iterable];
(3)yield*
yield*后面跟的是一個可遍歷的結(jié)構(gòu),它會調(diào)用該結(jié)構(gòu)的遍歷器接口。
let generator = function* () {
yield 1;
yield* [2,3,4];
yield 5;
};
var iterator = generator();
iterator.next() // { value: 1, done: false }
iterator.next() // { value: 2, done: false }
iterator.next() // { value: 3, done: false }
iterator.next() // { value: 4, done: false }
iterator.next() // { value: 5, done: false }
iterator.next() // { value: undefined, done: true }
(4)其他場合
由于數(shù)組的遍歷會調(diào)用遍歷器接口,所以任何接受數(shù)組作為參數(shù)的場合,其實都調(diào)用了遍歷器接口。下面是一些例子。
for...of
Array.from()
Map(), Set(), WeakMap(), WeakSet()(比如new Map([['a',1],['b',2]]))
Promise.all()
Promise.race()
字符串的 Iterator 接口
字符串是一個類似數(shù)組的對象,也原生具有 Iterator 接口。
var someString = "hi";
typeof someString[Symbol.iterator]
// "function"
var iterator = someString[Symbol.iterator]();
iterator.next() // { value: "h", done: false }
iterator.next() // { value: "i", done: false }
iterator.next() // { value: undefined, done: true }
上面代碼中,調(diào)用Symbol.iterator方法返回一個遍歷器對象,在這個遍歷器上可以調(diào)用next方法,實現(xiàn)對于字符串的遍歷。
可以覆蓋原生的Symbol.iterator方法,達到修改遍歷器行為的目的。
var str = new String("hi");
[...str] // ["h", "i"]
str[Symbol.iterator] = function() {
return {
next: function() {
if (this._first) {
this._first = false;
return { value: "bye", done: false };
} else {
return { done: true };
}
},
_first: true
};
};
[...str] // ["bye"]
str // "hi"
上面代碼中,字符串str的Symbol.iterator方法被修改了,所以擴展運算符(...)返回的值變成了bye,而字符串本身還是hi。
Iterator接口與Generator函數(shù)
Symbol.iterator方法的最簡單實現(xiàn),還是使用Generator函數(shù)。
var myIterable = {};
myIterable[Symbol.iterator] = function* () {
yield 1;
yield 2;
yield 3;
};
[...myIterable] // [1, 2, 3]
// 或者采用下面的簡潔寫法
let obj = {
* [Symbol.iterator]() {
yield 'hello';
yield 'world';
}
};
for (let x of obj) {
console.log(x);
}
// hello
// world
上面代碼中,Symbol.iterator方法幾乎不用部署任何代碼,只要用yield命令給出每一步的返回值即可。
for...of循環(huán)可以代替數(shù)組實例的forEach方法。
const arr = ['red', 'green', 'blue'];
arr.forEach(function (element, index) {
console.log(element); // red green blue
console.log(index); // 0 1 2
});
JavaScript 原有的for...in循環(huán),只能獲得對象的鍵名,不能直接獲取鍵值。ES6 提供for...of循環(huán),允許遍歷獲得鍵值。
var arr = ['a', 'b', 'c', 'd'];
for (let a in arr) {
console.log(a); // 0 1 2 3
}
for (let a of arr) {
console.log(a); // a b c d
}
上面代碼表明,for...in循環(huán)讀取鍵名,for...of循環(huán)讀取鍵值。如果要通過for...of循環(huán),獲取數(shù)組的索引,可以借助數(shù)組實例的entries方法和keys方法.
類似數(shù)組的對象
類似數(shù)組的對象包括好幾類。下面是for...of
循環(huán)用于字符串、DOM NodeList 對象、arguments
對象的例子。
// 字符串
let str = "hello";
for (let s of str) {
console.log(s); // h e l l o
}
// DOM NodeList對象
let paras = document.querySelectorAll("p");
for (let p of paras) {
p.classList.add("test");
}
// arguments對象
function printArgs() {
for (let x of arguments) {
console.log(x);
}
}
printArgs('a', 'b');
// 'a'
// 'b'
對于字符串來說,for...of
循環(huán)還有一個特點,就是會正確識別32位 UTF-16 字符。
for (let x of 'a\uD83D\uDC0A') { console.log(x);}// 'a'// '\uD83D\uDC0A'
并不是所有類似數(shù)組的對象都具有 Iterator 接口,一個簡便的解決方法,就是使用Array.from
方法將其轉(zhuǎn)為數(shù)組。
let arrayLike = { length: 2, 0: 'a', 1: 'b' };
// 報錯
for (let x of arrayLike) {
console.log(x);
}
// 正確
for (let x of Array.from(arrayLike)) {
console.log(x);
}
###對象
對于普通的對象,for...of結(jié)構(gòu)不能直接使用,會報錯,必須部署了 Iterator 接口后才能使用。但是,這樣情況下,for...in循環(huán)依然可以用來遍歷鍵名。
let es6 = {
edition: 6,
committee: "TC39",
standard: "ECMA-262"
};
for (let e in es6) {
console.log(e);
}
// edition
// committee
// standard
for (let e of es6) {
console.log(e);
}
// TypeError: es6[Symbol.iterator] is not a function
上面代碼表示,對于普通的對象,for...in循環(huán)可以遍歷鍵名,for...of循環(huán)會報錯。
一種解決方法是,使用Object.keys方法將對象的鍵名生成一個數(shù)組,然后遍歷這個數(shù)組。
for (var key of Object.keys(someObject)) {
console.log(key + ': ' + someObject[key]);
}
另一個方法是使用 Generator 函數(shù)將對象重新包裝一下。
function* entries(obj) {
for (let key of Object.keys(obj)) {
yield [key, obj[key]];
}
}
for (let [key, value] of entries(obj)) {
console.log(key, '->', value);
}
// a -> 1
// b -> 2
// c -> 3
##與其他遍歷語法的比較
以數(shù)組為例,JavaScript 提供多種遍歷語法。最原始的寫法就是for循環(huán)。
for (var index = 0; index < myArray.length; index++) {
console.log(myArray[index]);
}
這種寫法比較麻煩,因此數(shù)組提供內(nèi)置的forEach方法。
myArray.forEach(function (value) {
console.log(value);
});
這種寫法的問題在于,*無法中途跳出forEach循環(huán)*,break命令或return命令都不能奏效。
for...in循環(huán)可以遍歷數(shù)組的鍵名。
for (var index in myArray) {
console.log(myArray[index]);
}
for...in循環(huán)有幾個缺點。
數(shù)組的鍵名是數(shù)字,但是for...in循環(huán)是以字符串作為鍵名“0”、“1”、“2”等等。
for...in循環(huán)不僅遍歷數(shù)字鍵名,還會遍歷手動添加的其他鍵,甚至包括原型鏈上的鍵。
某些情況下,for...in循環(huán)會以任意順序遍歷鍵名。
總之,for...in循環(huán)主要是為遍歷對象而設(shè)計的,不適用于遍歷數(shù)組。
for...of循環(huán)相比上面幾種做法,有一些顯著的優(yōu)點。
for (let value of myArray) {
console.log(value);
}
有著同for...in一樣的簡潔語法,但是沒有for...in那些缺點。
*不同于forEach方法,它可以與break、continue和return配合使用。*
提供了遍歷所有數(shù)據(jù)結(jié)構(gòu)的統(tǒng)一操作接口。
下面是一個使用break語句,跳出for...of循環(huán)的例子。
for (var n of fibonacci) {
if (n > 1000)
break;
console.log(n);
}
上面的例子,會輸出斐波納契數(shù)列小于等于1000的項。如果當(dāng)前項大于1000,就會使用break語句跳出for...of循環(huán)。