Iterator和for...of循环详解
1、Iterator的概念
JavaScript原有的表示"集合"的数据结构，主要是数组(Array)和对象(Object)，ES6又添加了Map和Set。这样就有了4种数据集合，用户还可以组合使用它们，定义自己的数据结构，比如数组的成员是Map,Map的成员是对象。这样就需要一种统一的接口机制来处理所有不同的数据结构。
遍历器(Iterator)就是这样一种机制。它是一种接口，为各种不同的数据结构提供统一的访问机制。任何数据结构，只要部署Iterator接口，就可以完成遍历操作（即依次处理该数据结构的所有成员）。
Iterator的作用有3个：一是为各种数据结构提供一个统一的、简便的访问接口；二是使得数据结构的成员能够按某种次序排列；三是ES6创造了一种新的遍历命令------for...of循环，Iterator接口主要供for...of消费。
Iterator的遍历过程是这样的。
- 创建一个指针对象，指向当前数据结构的起始位置。也就是说，遍历器对象本质上就是一个指针对象。
- 第一次调用指针对象的next方法，可以将指针指向数据结构的第一个成员。
- 第二次调用指针对象的next方法，指针就指向数据结构的第二个成员。
- 不断调用指针对象的next方法，直到它指向数据结构的结束位置。
每一次调用next方法，都会返回数据结构的当前成员的信息。具体来说，就是返回一个包含value和done两个属性的对象。其中，value属性是当前成员的值，done属性是一个布尔值，表示遍历是否结束。
下面是一个模拟next方法返回值的例子。
js
let it = makeIterator(['a', 'b']);
console.log(it.next());//{ value: 'a', done: false }
console.log(it.next());//{ value: 'b', done: false }
console.log(it.next());//{ value: undefined, done: true }
function makeIterator(array) {
let nextIndex = 0;
return {
next: function() {
return nextIndex < array.length ?
{value: array[nextIndex++], done:false} :
{value: undefined, done: true}
}
}
}上面的代码定义了一个makeIterator函数，它是一个遍历器生成函数，作用就是返回一个遍历器对象。对数组[ˈaˈ，ˈbˈ]执行这个函数，就会返回该数组的遍历器对象（即指针对象）it。
指针对象的next方法用于移动指针。开始时，指针指向数组的开始位置。然后，每次调用next方法，指针就会指向数组的下一个成员。第一次调用，指向a；第二次调用，指向b。
next方法返回一个对象，表示当前数据成员的信息。这个对象具有value和done两个属性：value属性返回当前位置的成员；done属性是一个布尔值，表示遍历是否结束，即是否还有必要再一次调用next方法。
总之，调用指针对象的next方法，就可以遍历事先给定的数据结构。
对于遍历器对象来说，done:false和value:undefined属性都是可以省略的，因此上面的makeIterator函数可以简写成下面的形式。
js
function makeIterator(array) {
let nextIndex = 0;
return {
next: function() {
return nextIndex < array.length ?
{value: array[nextIndex++]} :
{done: true}
}
}
}由于Iterator只是把接口规格加到了数据结构上，所以，遍历器与所遍历的数据结构实际上是分开的，完全可以写出没有对应数据结构的遍历器对象，或者说用遍历器对象模拟出数据结构。
下面是一个无限运行的遍历器对象的例子。
js
let it = idMaker();
console.log(it.next().value);//0
console.log(it.next().value);//1
console.log(it.next().value);//2
function idMaker() {
let index = 0;
return {
next: function() {
return {value: index++, done: false};
}
}
}上面的例子中，遍历器生成函数idMaker返回一个遍历器对象（即指针对象）。但是并没有对应的数据结构，或者说，遍历器对象自己描述了一个数据结构。
在ES6中，有些数据结构原生具备Iterator接口（比如数组），即不用任何处理就可以被for...of循环遍历，有些就不行（比如对象）。原因在于，这些数据结构原生部署了Symbol.iterator属性（详见下文），另外一些数据结构没有。凡是部署了Symbol.iterator属性的数据结构，就称为部署了遍历器接口。调用这个接口，就会返回一个遍历器对象。
2、数据结构的默认Iterator接口
Iterator接口的目的，就是为所有数据结构提供一种统一的访问机制，即for...of循环（详见下文）。当使用for...of循环遍历某种数据结构时，该循环会自动去寻找Iterator接口。
ES6规定，默认的Iterator接口部署在数据结构的Symbol.iterator属性，或者说，一个数据结构只要具有Symbol.iterator属性，就可以认为是"可遍历的"(iterable)。调用Symbol.iterator方法，就会得到当前数据结构默认的遍历器生成函数。Symbol.iterator本身是一个表达式，返回Symbol对象的iterator属性，这是一个预定义好的、类型为Symbol的特殊值，所以要放在方括号中。
在ES6中，有3类数据结构原生具备Iterator接口：数组、某些类似数组的对象，以及Set和Map结构。
js
let arr = ['a', 'b', 'c'];
let iter = arr[Symbol.iterator]();
console.log(iter.next());//{ value: 'a', done: false }
console.log(iter.next());//{ value: 'b', done: false }
console.log(iter.next());//{ value: 'c', done: false }
console.log(iter.next());//{ value: undefined, done: true }上面的代码中，变量arr是一个数组，原生具有遍历器接口，部署在arr的Symbol.iterator属性上。所以，调用这个属性就会得到遍历器对象。
上面提到，原生部署Iterator接口的数据结构有3类，对于这3类数据结构，不用自己写遍历器生成函数，for...of循环会自动遍历它们。除此之外，其他数据结构（主要是对象）的Iterator接口，都需要自己在Symbol.iterator属性上部署，这样才会被for...of循环遍历。对象(Object)之所以没有默认部署Iterator接口，是因为对象的哪个属性先遍历，哪个属性后遍历是不确定的，需要开发者手动指定。本质上，遍历器是一种线性处理，对于任何非线性的数据结构，部署遍历器接口就等于部署一种线性转换。不过，严格地说，对象部署遍历器接口并不是很必要，因为这时对象实际上被当作Map结构使用，ES5没有Map结构，而ES6原生提供了。
一个对象如果要有可被for...of循环调用的Iterator接口，就必须在Symbol.iterator属性上部署遍历器生成方法（原型链上的对象具有该方法也可）。
js
class RangeIterator {
constructor(start, stop) {
this.value = start;
this.stop = stop;
}
[Symbol.iterator]() {
return this;
}
next() {
let value = this.value;
if(value < this.stop) {
this.value++;
return {done: false, value: value};
} else {
return {done: true, value: undefined};
}
}
}
function range(start, stop) {
return new RangeIterator(start, stop);
}
for(let value of range(0, 3)) {
console.log(value);
}
// 0
// 1
// 2上面的代码是一个类部署Iterator接口的写法。
Symbol.iterator属性对应一个函数，执行后返回当前对象的遍历器对象。
下面是通过遍历器实现指针结构的例子。
js
function Obj(value) {
this.value = value;
this.next = null;
}
Obj.prototype[Symbol.iterator] = function() {
let iterator = {
next: next
};
let current = this;
function next() {
if(current) {
let value = current.value;
let done = current == null;
current = current.next;
return {
done: done,
value: value
}
} else {
return {
done: true
}
}
}
return iterator;
}
let one = new Obj(1);
let two = new Obj(2);
let three = new Obj(3);
one.next = two;
two.next = three;
for(let i of one) {
console.log(i);
}
// 1
// 2
// 3上面的代码首先在构造函数的原型链上部署Symbol.iterator方法，调用该方法会返回遍历器对象iterator，调用该对象的next方法，在返回一个值的同时自动将内部指针移到下一个实例。下面是另一个为对象添加Iterator接口的例子。
js
let obj = {
data: ['hello', 'world'],
[Symbol.iterator]() {
const self = this;
let index = 0;
return {
next() {
if(index < self.data.length) {
return {
value: self.data[index++],
done: false
};
} else {
return {
value: undefined,
done: true
}
}
}
}
}
}对于类似数组的对象（存在数值键名和length属性），部署Iterator接口有一个简便方法，就是Symbol.iterator方法直接引用数组的Iterator接口。
js
NodeList.prototype[Symbol.iterator] = Array.prototype[Symbol.iterator];
//或者
NodeList.prototype[Symbol.iterator] = [][Symbol.iterator];
[...document.querySelectorAll('div')]//可以执行了下面是类似数组的对象调用数组的Symbol.iterator方法的例子。
js
let iterable = {
0: 'a',
1: 'b',
2: 'c',
length: 3,
[Symbol.iterator]: Array.prototype[Symbol.iterator]
};
for (let item of iterable) {
console.log(item);
}
// a
// b
// c注意，普通对象部署数组的Symbol.iterator方法并无效果。
js
let iterable = {
a: 'a',
b: 'b',
c: 'c',
length: 3,
[Symbol.iterator]: Array.prototype[Symbol.iterator]
};
for (let item of iterable) {
console.log(item);
}
// undefined
// undefined
// undefined如果Symbol.iterator方法对应的不是遍历器生成函数（即返回一个遍历器对象），解释引擎将报错。
js
let obj = {};
obj[Symbol.iterator] = () => 1;上面的代码中，变量obj的Symbol.iterator方法对应的不是遍历器生成函数，因此报错。
3、调用Iterator接口的场合
有一些场合会默认调用Iterator接口（即Symbol.iterator方法），除了下文会介绍的for...of循环，还有几个别的场合。
3.1、解构赋值
对数组和Set结构进行解构赋值时，会默认调用Symbol.iterator方法。
js
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']3.2、扩展运算符
扩展运算符(...)也会调用默认的Iterator接口。
js
//例一
let str = 'hello';
console.log([...str]);//[ 'h', 'e', 'l', 'l', 'o' ]
//列二
let arr = ['b', 'c'];
console.log(arr);//[ 'b', 'c' ]实际上，这提供了一种简便机制，可以将任何部署了Iterator接口的数据结构转为数组。也就是说，只要某个数据结构部署了Iterator接口，就可以对它使用扩展运算符，将其转为数组。
js
let arr = [...iterable];3.3、yield*
yield＊后面跟的是一个可遍历的结构，它会调用该结构的遍历器接口。
js
let generator = function* () {
yield 1;
yield* [2, 3, 4];
yield 5;
};
let iterator = generator();
console.log(iterator.next());//{ value: 1, done: false }
console.log(iterator.next());//{ value: 2, done: false }
console.log(iterator.next());//{ value: 3, done: false }
console.log(iterator.next());//{ value: 4, done: false }3.4、其他场合
由于数组的遍历会调用遍历器接口，所以任何接受数组作为参数的场合其实都调用了遍历器接口。下面是一些例子。
- for...of
- Array.from()
- Map()、Set()、WeakMap()和WeakSet()（比如newMap([[ˈaˈ，1],[ˈbˈ，2]])）
- Promise.all()
- Promise.race()
4、字符串的Iterator接口
字符串是一个类似数组的对象，也原生具有Iterator接口。
js
let someString = 'hi';
console.log(typeof someString[Symbol.iterator]);
//function
let iterator = someString[Symbol.iterator]();
console.log(iterator.next());//{ value: 'h', done: false }
console.log(iterator.next());//{ value: 'i', done: false }
console.log(iterator.next());//{ value: undefined, done: true }上面的代码中，调用Symbol.iterator方法返回一个遍历器对象，在其上可以调用next方法实现对于字符串的遍历。
可以覆盖原生的Symbol.iterator方法达到修改遍历器行为的目的。
js
let str = new String('hi');
console.log([...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
};
};
console.log([...str]);
//[ 'bye' ]上面的代码中，字符串str的Symbol.iterator方法被修改了，所以扩展运算符(...)返回的值变成了bye，而字符串本身还是hi。
5、Iterator接口与Generator函数
Symbol.iterator方法的最简单实现还是使用Generator函数。
js
let myIterable = {};
myIterable[Symbol.iterator] = function* () {
yield 1;
yield 2;
yield 3;
};
console.log([...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命令给出每一步的返回值即可。
6、遍历器对象的return()、throw()
遍历器对象除了具有next方法，还可以具有return方法和throw方法。如果你自己写遍历器对象生成函数，那么next方法是必须部署的，return方法和throw方法则是可选部署的。
return方法的使用场合是：如果for...of循环提前退出（通常是因为出错，或者有break语句或continue语句），就会调用return方法；如果一个对象在完成遍历前需要清理或释放资源，就可以部署return方法。
js
function readLinesSync(file) {
return {
next() {
if(file.isAtEndOfFile()) {
file.close();
return {done: true};
}
},
return() {
file.close();
return {done: true};
}
}
}上面的代码中，函数readLinesSync接受一个文件对象作为参数，返回一个遍历器对象，其中除了next方法，还部署了return方法。下面，我们让文件的遍历提前返回，这样就会触发执行return方法。
js
for (let line of readLinesSync(fileName)) {
console.log(x);
break;
}注意，return方法必须返回一个对象，这是Generator规格决定的。
throw方法主要是配合Generator函数使用，一般的遍历器对象用不到这个方法。
7、for...of循环
ES6借鉴了C++、Java、C＃和Python语言，引入了for...of循环作为遍历所有数据结构的统一方法。一个数据结构只要部署了Symbol.iterator属性，就被视为具有Iterator接口，就可以用for...of循环遍历它的成员。也就是说，for...of循环内部调用的是数据结构的Symbol.iterator方法。
for...of循环可以使用的范围包括数组、Set和Map结构、某些类似数组的对象（比如arguments对象、DOMNodeList对象）、后文的Generator对象，以及字符串。
7.1、数组
数组原生具备Iterator接口，for...of循环本质上就是调用这个接口产生的遍历器，这可以用下面的代码证明。
js
const arr = ['red', 'green', 'blue'];
let iterator = arr[Symbol.iterator]();
for(let v of arr) {
console.log(v);
}
// red
// green
// blue
for(let v of iterator) {
console.log(v);
}
// red
// green
// blue上面的for...of循环的两种写法是等价的。for...of循环可以代替数组实例的forEach方法。
js
const arr = ['red', 'green', 'blue'];
let iterator = arr[Symbol.iterator]();
arr.forEach(function(element, index) {
console.log(element);
console.log(index);
})
// red
// 0
// green
// 1
// blue
// 2JavaScript原有的for...in循环，只能获得对象的键名，不能直接获取键值。ES6提供for...of循环，允许遍历获得键值。
js
let 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循环读取键名，for...of循环读取键值。如果要通过for...of循环获取数组的索引，可以借助数组实例的entries方法和keys方法。
for...of循环调用遍历器接口，数组的遍历器接口只返回具有数字索引的属性。这一点跟for...in循环也不一样。
js
let arr = [3, 5, 7];
arr.foo = 'hello';
for(let i in arr) {
console.log(i);
}
// 0
// 1
// 2
// foo
for(let i of arr) {
console.log(i);
}
// 3
// 5
// 7上面的代码中，for...of循环不会返回数组arr的foo属性。
7.2、Set和Map结构
Set和Map结构也原生具有Iterator接口，可以直接使用for...of循环。
js
let engines = new Set(['gecko', 'Trident', 'Webkit', 'Webkit']);
for(let e of engines) {
console.log(e);
}
// gecko
// Trident
// Webkit
let map = new Map();
map.set('dition', 6);
map.set('committee', 'TC39');
map.set('standard', 'ECMA-262');
for (let [name, value] of map) {
console.log(name + ': ' + value);
}
// dition: 6
// committee: TC39
// standard: ECMA-262上面的代码演示了如何遍历Set结构和Map结构。值得注意的地方有两个：首先，遍历的顺序是按照各个成员被添加进数据结构的顺序；其次，Set结构遍历时返回的是一个值，而Map结构遍历时返回的是一个数组，该数组的两个成员分别为当前Map成员的键名和键值。
js
let map = new Map().set('a', 1).set('b', 2);
for (let pair of map) {
console.log(pair);
}
// [ 'a', 1 ]
// [ 'b', 2 ]
for(let [key, value] of map) {
console.log(key + ' : ' + value);
}
// a : 1
// b : 27.3、计算生成的数据结构
有些数据结构是在现有数据结构的基础上计算生成的。比如，ES6的数组、Set、Map都部署了以下3个方法，调用后都返回遍历器对象。
entries()返回一个遍历器对象，用于遍历［键名，键值］组成的数组。对于数组，键名就是索引值；对于Set，键名与键值相同。Map结构的iterator接口默认就是调用entries方法。· keys()返回一个遍历器对象，用于遍历所有的键名。values()返回一个遍历器对象，用于遍历所有的键值。
这3个方法调用后生成的遍历器对象所遍历的都是计算生成的数据结构。
js
let arr = ['a', 'b', 'c'];
for (let pair of arr.entries()) {
console.log(pair);
}
// [ 0, 'a' ]
// [ 1, 'b' ]
// [ 2, 'c' ]7.4、类似数组的对象
类似数组的对象包括好几类。下面是for...of循环用于字符串、DOM NodeList对象、arguments对象的例子。
js
//字符串
let str = 'hello';
for(let s of str) {
console.log(s);
}
//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');7.5、对象
对于普通的对象，for...of结构不能直接使用，会报错，必须部署了Iterator接口才能使用。但是，这样的情况下，for...in循环依然可用于遍历键名。
js
let obj = {
edition: 6,
committee: 'TC39',
standard: 'ECMA-262'
};
for(e in obj) {
console.log(e);
}
// edition
// committee
// standard
for(e of obj) {
console.log(e);
}
//TypeError: obj is not iterable上面的代码表示，对于普通的对象，for...in循环可以遍历键名，for...of循环会报错。一种解决方法是，使用Object.keys方法将对象的键名生成一个数组，然后遍历这个数组。
js
for (let key of Object.keys(obj)) {
console.log(key + ': ' + obj[key]);
}
// edition: 6
// committee: TC39
// standard: ECMA-262在对象上部署Iterator接口的代码，参见本章前面部分。一个方便的方法是将数组的Symbol.iterator属性直接赋值给其他对象的Symbol.iterator属性。比如，想要让for...of循环遍历jQuery对象，只要加上下面这一行就可以了。
js
jQuery.prototype[Symbol.iterator] = Array.prototype[Symbol.iterator];另一个方法是使用Generator函数将对象重新包装一下。
js
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);
}
// edition -> 6
// committee -> TC39
// standard -> ECMA-2627.6、其他遍历语法的比较
以数组为例，JavaScript提供了多种遍历语法。最原始的写法就是for循环。
js
for (let index = 0; index < myArray.length; index++) {
console.log(myArray[index]);
}这种写法比较麻烦，因此数组提供了内置的forEach方法。
js
myArray.forEach(function (value) {
consoele.log(value);
})这种写法的问题在于，无法中途跳出forEach循环，break命令或return命令都不能奏效。for...in循环可以遍历数组的键名。
js
for (let index in myArray) {
consoele.log(myArray[index]);
}for...in循环有几个缺点。
- 数组的键名是数字，但是for...in循环是以字符串作为键名，"0"、"1"、"2"等。
- for...in循环不仅遍历数字键名，还会遍历手动添加的其他键，甚至包括原型链上的键。
- 某些情况下，for...in循环会以任意顺序遍历键名。
总之，for...in循环主要是为遍历对象而设计的，不适用于遍历数组。for...of循环相比上面几种做法有一些显著的优点。
- 有着同for...in一样的简洁语法，但是没有for...in那些缺点。
- 不同于forEach方法，它可以与break、continue和return配合使用。
- 提供了遍历所有数据结构的统一操作接口。
下面是一个使用break语句跳出for...of循环的例子。
js
for (let n of fibonacci) {
if(n > 1000)
break;
console.log(n);
}上面的例子会输出斐波纳契数列小于等于1000的项。如果当前项大于1000，就会使用break语句跳出for...of循环。