es6中的Iterator介绍

一、Iterator（遍历器）的概念

JavaScript原有的表示“集合”的数据结构，主要是数组（Array）和对象（Object），ES6又添加了Map和Set。这样就有了四种数据集合，用户还可以组合使用它们，定义自己的数据结构，比如数组的成员是Map，Map的成员是对象。这样就需要一种统一的接口机制，来处理所有不同的数据结构。

遍历器（Iterator）就是这样一种机制。它是一种接口，为各种不同的数据结构ᨀ供统一的访问机制。任何数据结构只要部署Iterator接口，就可以完成遍历操作（即依次处理该数据结构的所有成员）。

Iterator 的三个作用：

• 是为各种数据结构，提供一个统一的、简便的访问接口
• 使得数据结构的成员能够按某种次序排列
• ES6创造了一种新的遍历命令for...of循环，Iterator接口主要供for…of消费

Iterator 的遍历过程:

• 创建一个指针对象，指向当前数据结构的起始位置。也就是说，遍历器对象本质上，就是
  一个指针对象
• 第一次调用指针对象的next方法，可以将指针指向数据结构的第一个成员
• 第二次调用指针对象的next方法，指针就指向数据结构的第二个成员
• 不断调用指针对象的next方法，直到它指向数据结构的结束位置

每一次调用next方法，都会返回数据结构的当前成员的信息。具体来说，就是返回一个包含value和done两个属性的对象。其中，value属性是当前成员的值，done属性是一个布尔值，表示遍历是否结束。

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函数，它是一个遍历器生成函数，作用就是返回一个遍历器对象。对数组[‘a’, ‘b’]执行这个函数，就会返回该数组的遍历器对象（即指针对象）it。指针对象的next方法，用来移动指针。开始时，指针指向数组的开始位置。然后，每次调用next方法，指针就会指向数组的下一个成员。第一次调用，指向a；第二次调用，指向b。

对于遍历器对象来说，done: false和value: undefined属性都是可以省略的，因此上面的makeIterator函数可以简写成下面的形式。

function makeIterator(array) {
	var nextIndex = 0;
  	return {
    	next: function() {
      		return nextIndex < array.length ?
	        {value: array[nextIndex++]} :
	        {done: true};
    	}
  	};
}

由于Iterator只是把接口规格加到数据结构之上，所以，遍历器与它所遍历的那个数据结构，实际上是分开的，完全可以写出没有对应数据结构的遍历器对象，或者说用遍历器对象模拟出数据结构。下面是一个无限运行的遍历器对象的例子。

var it = idMaker();

it.next().value // '0'
it.next().value // '1'
it.next().value // '2'
// ...

function idMaker() {
	var index = 0;

  	return {
    	next: function() {
      		return {value: index++, done: false};
    	}
  	};
}

上面的例子中，遍历器生成函数idMaker，返回一个遍历器对象（即指针对象）。但是并没有对应的数据结构，或者说，遍历器对象自己描述了一个数据结构出来。

二、调用Iterator接口的场合

有一些场合会默认调用Iterator接口（即Symbol.iterator方法），除了下文会介绍的for…of循环，还有几个别的场合。

1.解构赋值

对数组和Set结构进行解构赋值时，会默认调用在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.扩展运算符

扩展运算符（…）也会调用默认的iterator接口。

// 例一
var str = 'hello';
[...str] //  ['h','e','l','l','o']

// 例二
let arr = ['b', 'c'];
['a', ...arr, 'd']
// ['a', 'b', 'c', 'd']

实际上，这提供了一种简便机制，可以将任何部署了Iterator接口的数据结构，转为数组。也就是说，只要某个数据结构部署了Iterator接口，就可以对它使用扩展运算符，将其转为数组。

let arr = [...iterable];

3.yield*

yield*后面跟的是一个可遍历的结构，它会调用该结构的遍历器接口。

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.其他场合

由于数组的遍历会调用遍历器接口，所以任何接受数组作为参数的场合，其实都调用了遍历器接口。下面是一些例子。

for...of
Array.from()
Map(), Set(), WeakMap(), WeakSet()（比如new Map([['a',1],['b',2]])）
Promise.all()
Promise.race()

三、字符串的Iterator接口

字符串是一个类似数组的对象，也原生具有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 }

上面代码中，调用Symbol.iterator方法返回一个遍历器对象，在这个遍历器上可以调用next方法，实现对于字符串的遍历。
可以覆盖原生的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。

四、for…of循环

ES6 借鉴 C++、Java、C# 和 Python 语言，引入了for…of循环，作为遍历所有数据结构的统一的方法。一个数据结构只要部署了Symbol.iterator属性，就被视为具有iterator接口，就可以用for…of循环遍历它的成员。也就是说，for…of循环内部调用的是数据结构的Symbol.iterator方法。

for…of循环可以使用的范围包括数组、Set 和 Map 结构、某些类似数组的对象（比如arguments对象、DOM、 NodeList 对象）、以及字符串。

数组

数组原生具备Iterator接口（即默认部署了Symbol.iterator属性），for…of循环本质上就是调用这个接口产生的遍历器，可以用下面的代码证明。

const arr = [‘red’, ‘green’, ‘blue’];

for(let key of arr) { 
	console.log(key);   // red green blue 
}

const obj = {}; 
obj[Symbol.iterator] = arr[Symbol.iterator].bind(arr);

for(let key of obj) { 
	console.log(key);   // red green blue 
} 

上面代码中，空对象obj部署了数组arr的Symbol.iterator属性，结果obj的for…of循环，产生了与arr完全一样的结果。

for…of循环可以代替数组实例的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循环，只能获得对象的键名，不能直接获取键值。ES6提供for…of循环，允许遍历获得键值。

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循环读取键名，for…of循环读取键值。如果要通过for…of循环，获取数组的索引，可以借助数组实例的entries方法和keys方法。

for…of循环调用遍历器接口，数组的遍历器接口只返回具有数字索引的属性。这一点跟for…in循环也不一样。

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"
}

五、Set和Map结构

Set 和 Map 结构也原生具有 Iterator 接口，可以直接使用for…of循环。

var engines = new Set(["Gecko", "Trident", "Webkit", "Webkit"]);
for (var e of engines) {
	console.log(e);
}
// Gecko
// Trident
// Webkit

var es6 = new Map();
es6.set("edition", 6);
es6.set("committee", "TC39");
es6.set("standard", "ECMA-262");
for (var [name, value] of es6) {
  	console.log(name + ": " + value);
}
// edition: 6
// committee: TC39
// standard: ECMA-262

上面代码演示了如何遍历 Set 结构和 Map结构。值得注意的地方有两个，首先，遍历的顺序是按照各个成员被添加进数据结构的顺序。其次，Set 结构遍历时，返回的是一个值，而 Map结构遍历时，返回的是一个数组，该数组的两个成员分别为当前 Map 成员的键名和键值。

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 : 2

六、类似数组的对象

类似数组的对象包括好几类。下面是for…of循环用于字符串、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循环还有一个特点，就是会正确识别32位 UTF-16字符。

for (let x of 'a\uD83D\uDC0A') {
	console.log(x);
}
// 'a'
// '\uD83D\uDC0A'

并不是所有类似数组的对象都具有 Iterator 接口，一个简便的解决方法，就是使用Array.from()方法将其转为数组。

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结构不能直接使用，会报错，必须部署了 Iterator接口后才能使用。但是，这样情况下，for…in循环依然可以用来遍历键名。

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 is not iterable

上面代码表示，对于普通的对象，for…in循环可以遍历键名，for…of循环会报错。一种解决方法是，使用Object.keys()方法将对象的键名生成一个数组，然后遍历这个数组。

for (var key of Object.keys(someObject)) {
	console.log(key + ': ' + someObject[key]);
}

另一个方法是使用 Generator 函数将对象重新包装一下。

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

八、与其他遍历语法的比较

以数组为例，JavaScript 提供多种遍历语法。最原始的写法就是for循环。

for (var index = 0; index < myArray.length; index++) {
	console.log(myArray[index]);
}

这种写法比较麻烦，因此数组提供内置的forEach方法。

myArray.forEach(function (value) {
	console.log(value);
});

这种写法的问题在于，无法中途跳出forEach循环，break命令或return命令都不能奏效。

for…in循环可以遍历数组的键名。

for (var index in myArray) {
	console.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配合使用
• 提供了遍历所有数据结构的统一操作接口

for (let value of myArray) {
	console.log(value);
}

下面是一个使用break语句，跳出for…of循环的例子。

let arr = [1,3,5,7,9,11,13,15];
for (let n of arr) {
	if (n > 10){
    	break;
    }
  	console.log(n);   //1 3 5 7 9
}