ES6_Iterator 和 for...of 循环

一：Iterator（遍历器）的概念

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

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

1：原生具备 Iterator 接口的数据结构如下

（1）：Array

（2）：Map

（3）：Set

（4）：String

（5）：TypedArray

（6）：函数的 arguments 对象

（7）：NodeList 对象

2：Iterator 的作用有三个

（1）：是为各种数据结构，提供一个统一的、简便的访问接口；

（2）：是使得数据结构的成员能够按某种次序排列；

（3）：是 ES6 创造了一种新的遍历命令for...of循环，Iterator 接口主要供for...of消费。

3：Iterator 的遍历过程

（1）创建一个指针对象，指向当前数据结构的起始位置。也就是说，遍历器对象本质上，就是一个指针对象。

（2）第一次调用指针对象的next方法，可以将指针指向数据结构的第一个成员。

（3）第二次调用指针对象的next方法，指针就指向数据结构的第二个成员。

（4）不断调用指针对象的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: true};

    }

  };

}

上面代码定义了一个makeIterator函数，它是一个遍历器生成函数，作用就是返回一个遍历器对象。对数组['a', 'b']执行这个函数，就会返回该数组的遍历器对象（即指针对象）it。

指针对象的next方法，用来移动指针。开始时，指针指向数组的开始位置。然后，每次调用next方法，指针就会指向数组的下一个成员。第一次调用，指向a；第二次调用，指向b。

next方法返回一个对象，表示当前数据成员的信息。这个对象具有value和done两个属性，value属性返回当前位置的成员，done属性是一个布尔值，表示遍历是否结束，即是否还有必要再一次调用next方法。总之，调用指针对象的next方法，就可以遍历事先给定的数据结构。:

4：遍历器对象的 return()，throw()

遍历器对象除了具有next方法，还可以具有return方法和throw方法。如果你自己写遍历器对象生成函数，那么next方法是必须部署的，return方法和throw方法是否部署是可选的。

return方法的使用场合是，如果for...of循环提前退出（通常是因为出错，或者有break语句或continue语句），就会调用return方法。如果一个对象在完成遍历前，需要清理或释放资源，就可以部署return方法。

function readLinesSync(file) {

  return {

    [Symbol.iterator]() {

      return {

        next() {

          return { done: false };

        },

        return() {

          file.close();

          return { done: true };

        }

      };

    },

  };

}

上面代码中，函数readLinesSync接受一个文件对象作为参数，返回一个遍历器对象，其中除了next方法，还部署了return方法。
注意：return方法必须返回一个对象，这是 Generator 规格决定的。

throw方法主要是配合 Generator 函数使用，一般的遍历器对象用不到这个方法

二：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 对象）、后文的 Generator 对象，以及字符串。

1：数组

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

const arr = ['red', 'green', 'blue'];

for(let v of arr) {

  console.log(v); // red green blue

}

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

});

（1）JavaScript 原有的for...in循环，只能获得对象的键名，不能直接获取键值。ES6 提供for...of循环，允许遍历获得键值。

（2）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"

}

上面代码中，for...of循环不会返回数组arr的foo属性。

（2）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 成员的键名和键值。

（3）计算生成的数据结构

有些数据结构是在现有数据结构的基础上，计算生成的。比如，ES6 的数组、Set、Map 都部署了以下三个方法，调用后都返回遍历器对象。

entries() 返回一个遍历器对象，用来遍历[键名, 键值]组成的数组。对于数组，键名就是索引值；对于 Set，键名与键值相同。Map 结构的 Iterator 接口，默认就是调用entries方法。

keys() 返回一个遍历器对象，用来遍历所有的键名。

values() 返回一个遍历器对象，用来遍历所有的键值。

这三个方法调用后生成的遍历器对象，所遍历的都是计算生成的数据结构。

let arr = ['a', 'b', 'c'];

for (let pair of arr.entries()) {

  console.log(pair);

}

// [0, 'a']

// [1, 'b']

// [2, 'c']

（4）类似数组的对象

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

类似数组的对象包括好几类。下面是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);

}

（5）对象

对于普通的对象，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[Symbol.iterator] is not a function
上面代码表示，对于普通的对象，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

三：for...of与其他遍历语法的比较

以数组为例，JavaScript 提供多种遍历语法。

1：for循环

for (var index = 0; index < myArray.length; index++) {

  console.log(myArray[index]);

}

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

2：forEach循环

myArray.forEach(function (value) {

  console.log(value);

});

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

3：for...in循环可以遍历数组的键名。

for (var index in myArray) {

  console.log(myArray[index]);

}

for...in循环有几个缺点。

数组的键名是数字，但是for...in循环是以字符串作为键名“0”、“1”、“2”等等。

for...in循环不仅遍历数字键名，还会遍历手动添加的其他键，甚至包括原型链上的键。

某些情况下，for...in循环会以任意顺序遍历键名。

总之，for...in循环主要是为遍历对象而设计的，不适用于遍历数组。

4：for...of循环相比上面几种做法，有一些显著的优点。

for (let value of myArray) {

  console.log(value);

}

有着同for...in一样的简洁语法，但是没有for...in那些缺点。

不同于forEach方法，它可以与break、continue和return配合使用。

提供了遍历所有数据结构的统一操作接口。

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

for (var n of fibonacci) {

  if (n > 1000)

    break;

  console.log(n);

}

上面的例子，会输出斐波纳契数列小于等于 1000 的项。如果当前项大于 1000，就会使用break语句跳出for...of循环。