Iterator
JS现在表示“集合”的数据结构，就是Array、Object、Map、Set，用户可以组合使用它们，定义自己的数据结构，这样就需要一种统一的接口机制，来处理所有不同的数据结构。
遍历器（Iterator）就是这样一种机制。它是一种接口，为各种不同的数据结构提供统一的访问机制。任何数据结构只要部署 Iterator 接口，就可以完成遍历操作（即依次处理该数据结构的所有成员）。 ES6 创造了一种新的遍历命令for...of循环，Iterator 接口主要供for...of消费。
Iterator 的遍历过程是这样的：
1.创建一个指针对象，指向当前数据结构的起始位置。也就是说，遍历器对象本质上，就是一个指针对象。
2.第一次调用指针对象的next方法，可以将指针指向数据结构的第一个成员。
3.不断调用指针对象的next方法，直到它指向数据结构的结束位置。
每次调用next的方法会返回一个对象，拥有两个属性value和done，value是当前成员的值，done属性是一个布尔值，表示遍历是否结束。
// 模拟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};
}
};
}
// 三元判断的中done:false value:undefined是可以省略的
// 改写
nextIndex < array.length ?
{value: array[nextIndex++]} :
{done: true};
默认的 Iterator 接口
ES6 规定，默认的 Iterator 接口部署在数据结构的Symbol.iterator属性，或者说，一个数据结构只要具有Symbol.iterator属性，就可以认为是“可遍历的”（iterable）。Symbol.iterator属性本身是一个函数，就是当前数据结构默认的遍历器生成函数。执行这个函数，就会返回一个遍历器对象，该对象的根本特征就是具有next方法。每次调用next方法，都会返回一个代表当前成员的信息对象，具有value和done两个属性。
凡是部署了Symbol.iterator属性的数据结构，就称为部署了遍历器接口。调用这个接口，就会返回一个遍历器对象。原生具备 Iterator 接口的数据结构有：Array、Map、Set、String、TypedArray、函数的 arguments 对象、NodeList 对象。
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 }
其他数据结构（主要是对象）的 Iterator 接口，都需要自己在Symbol.iterator属性(或者原型链上的对象具有该方法也可)上面部署，这样才会被for...of循环遍历。
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);
}
// range(0, 3) 会返回一个对象，即RangeIterator实例
// 被for of 循环，就会查看这个对象是否有Symbol.iterator属性
// 并调用得到一个遍历器对象，拥有就可以使用for of循环
// 每次就是调用这个对象的next方法
for (var value of range(0, 3)) {
console.log(value); // 0, 1, 2
}
遍历器实现指针结构
function Obj(value) {
this.value = value;
this.next = null;
}
Obj.prototype[Symbol.iterator] = function() {
var iterator = { next: next };
var current = this;
function next() {
// 在返回一个值的同时，自动将内部指针移到下一个实例。
// 这里的判断就是指，如果下一个实例不存在了，就返回 done:true，遍历结束。
if (current) {
var value = current.value;
current = current.next;
return { done: false, value: value };
} else {
return { done: true };
}
}
return iterator;
}
var one = new Obj(1);
var two = new Obj(2);
var three = new Obj(3);
one.next = two;
two.next = three;
// 循环调用的实例的next方法
// current.next是用来控制指针
for (var i of one){
console.log(i); // 1, 2, 3
}
对于类似数组的对象（存在数值键名和length属性），部署 Iterator 接口，有一个简便方法，就是Symbol.iterator方法直接引用数组的 Iterator 接口。
NodeList.prototype[Symbol.iterator] = Array.prototype[Symbol.iterator];
// 或者
NodeList.prototype[Symbol.iterator] = [][Symbol.iterator];
[...document.querySelectorAll('div')] // 可以执行了
// 存在数值键名和length属性的对象
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方法对应的不是遍历器生成函数（即会返回一个遍历器对象），解释引擎将会报错。
有了遍历器接口，数据结构就可以用for...of循环遍历（详见下文），也可以使用while循环遍历。
// 要这样用
// iterable是上例中定义的对象
// 不是直接调用iterable的next，而是先调用Symbol.iterator获得遍历器对象
// 在调用遍历器对象的next方法
var $iterator = iterable[Symbol.iterator]();
var $result = $iterator.next();
while (!$result.done) {
var x = $result.value;
// ...
$result = $iterator.next();
}
调用 Iterator 接口的场合
除了for...of循环，还有别的几个场合会使用Iterator接口（即Symbol.iterator方法）
1.对数组和 Set 结构进行解构赋值时，会默认调用Symbol.iterator方法
2.扩展运算符（...）也会调用默认的 Iterator 接口。可以将任何部署了 Iterator 接口的数据结构，转为数组。也就是说，只要某个数据结构部署了 Iterator 接口，就可以对它使用扩展运算符，将其转为数组。
3.yield*后面跟的是一个可遍历的结构，它会调用该结构的遍历器接口。
4.Array.from()
5.Map(), Set(), WeakMap(), WeakSet()（比如new Map([['a',1],['b',2]])）
6.Promise.all(),Promise.race()
字符串的 Iterator 接口
字符串是一个类似数组的对象，也原生具有 Iterator 接口。
var str = new String("hi");
// 使用...扩展运算法能将字符串转为数组
[...str] // ["h", "i"]
// 重写Symbol.iterator方法 达到修改遍历器行为的目的。
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"] 只返回一次 'bye'
// 因为_first在第一次调用之后就是false了
str // "hi"
遍历器对象的 return()，throw()
遍历器对象除了具有next方法，还可以具有return方法和throw方法。如果你自己写遍历器对象生成函数，只有next方法是必须部署的。
return方法的使用场合是，如果for...of循环提前退出（通常是因为出错，或者有break语句），就会调用return方法。如果一个对象在完成遍历前，需要清理或释放资源，就可以部署return方法。
function readLinesSync(file) {
return {
[Symbol.iterator]() {
return {
next() {
return { done: false };
},
return() {
file.close();
return { done: true };
}
};
},
};
}
// 情况一
for (let line of readLinesSync(fileName)) {
console.log(line);
break;
// 先执行console 在执行return()方法
}
// 情况二
for (let line of readLinesSync(fileName)) {
console.log(line);
// 先执行console 在执行return()方法 在抛出错误
throw new Error();
}
throw方法主要是配合 Generator 函数使用
for ... of
ES6引入了for...of循环，作为遍历所有数据结构的统一的方法。for...of循环内部调用的是数据结构的Symbol.iterator方法。
for...of循环可以使用的范围包括数组、Set 和 Map 结构、某些类似数组的对象（比如arguments对象、DOM NodeList 对象）、Generator 对象，以及字符串。
数组
一个数据结构只要部署了Symbol.iterator属性，就被视为具有 iterator 接口，就可以用for...of循环遍历它的成员
const arr = ['red', 'green', 'blue'];
for(let v of arr) {
console.log(v); // red green blue
}
const obj = {};
obj[Symbol.iterator] = arr[Symbol.iterator].bind(arr);
// 此时这个对象就能够被for ... of 循环
for(let v of obj) {
console.log(v); // red green blue
}
在遍历数组时，for...in循环读取键名，for...of循环读取键值。
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"
}
Map 和 Set
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]
}
var engines = new Set(["Gecko", "Trident", "Webkit", "Webkit"]);
for (var e of engines) {
console.log(e);
}
// Gecko
// Trident
// Webkit
对象
普通的对象，for...in循环可以遍历键名，for...of循环会报错。
可以使用Object.keys方法将对象的键名生成一个数组，然后遍历这个数组。
for (var key of Object.keys(someObject)) {
console.log(key + ': ' + someObject[key]);
}
与其他遍历语法的比较
最原始的写法就是for循环，但是太麻烦，所以提供了forEach方法，但是forEach无法中途跳出，break命令或return命令都不能奏效。
for...in 遍历数组以字符串作为键名“0”、“1”、“2”，而且不仅遍历数字键名，还会遍历手动添加的其他键，甚至包括原型链上的键。
for...of循环相比上面几种做法，有一些显著的优点。
有着同for...in一样的简洁语法，但是没有for...in那些缺点。不同于forEach方法，它可以与break、continue和return配合使用。提供了遍历所有数据结构的统一操作接口。
网友评论