起源

一段标准的 for 循环代码:

  1. var colors = ["red", "green", "blue"];
  2. for (var i = 0, len = colors.length; i < len; i++) {
  3. console.log(colors[i]);
  4. }

看着很简单,但是再回顾这段代码,实际上我们仅仅是需要数组中元素的值,但是却需要提前获取数组长度,声明索引变量等,尤其当多个循环嵌套的时候,更需要使用多个索引变量,代码的复杂度就会大大增加,比如我们使用双重循环进行去重:

  1. function unique(array) {
  2. var res = [];
  3. for (var i = 0, arrayLen = array.length; i < arrayLen; i++) {
  4. for (var j = 0, resLen = res.length; j < resLen; j++) {
  5. if (array[i] === res[j]) {
  6. break;
  7. }
  8. }
  9. if (j === resLen) {
  10. res.push(array[i]);
  11. }
  12. }
  13. return res;
  14. }

为了消除这种复杂度以及减少循环中的错误(比如错误使用其他循环中的变量),ES6 提供了迭代器和 for of 循环共同解决这个问题。

迭代器

所谓迭代器,其实就是一个具有 next() 方法的对象,每次调用 next() 都会返回一个结果对象,该结果对象有两个属性,value 表示当前的值,done 表示遍历是否结束。
我们直接用 ES5 的语法创建一个迭代器:

  1. function createIterator(items) {
  2. var i = 0;
  3. return {
  4. next: function() {
  5. var done = i >= item.length;
  6. var value = !done ? items[i++] : undefined;
  7. return {
  8. done: done,
  9. value: value
  10. };
  11. }
  12. };
  13. }
  14. // iterator 就是一个迭代器对象
  15. var iterator = createIterator([1, 2, 3]);
  16. console.log(iterator.next()); // { done: false, value: 1 }
  17. console.log(iterator.next()); // { done: false, value: 2 }
  18. console.log(iterator.next()); // { done: false, value: 3 }
  19. console.log(iterator.next()); // { done: true, value: undefined }

for of

除了迭代器之外,我们还需要一个可以遍历迭代器对象的方式,ES6 提供了 for of 语句,我们直接用 for of 遍历一下我们上节生成的遍历器对象试试:

  1. var iterator = createIterator([1, 2, 3]);
  2. for (let value of iterator) {
  3. console.log(value);
  4. }

结果报错 TypeError: iterator is not iterable,表明我们生成的 iterator 对象并不是 iterable(可遍历的)。
那什么才是可遍历的呢?
其实一种数据结构只要部署了 Iterator 接口,我们就称这种数据结构是“可遍历的”(iterable)。
ES6 规定,默认的 Iterator 接口部署在数据结构的 Symbol.iterator 属性,或者说,一个数据结构只要具有 Symbol.iterator 属性,就可以认为是”可遍历的”(iterable)。
举个例子:

  1. const obj = {
  2. value: 1
  3. };
  4. for (value of obj) {
  5. console.log(value);
  6. }
  7. // TypeError: iterator is not iterable

我们直接 for of 遍历一个对象,会报错,然而如果我们给该对象添加 Symbol.iterator 属性:

  1. const obj = {
  2. value: 1
  3. };
  4. obj[Symbol.iterator] = function() {
  5. return createIterator([1, 2, 3]);
  6. };
  7. for (value of obj) {
  8. console.log(value);
  9. }
  10. // 1
  11. // 2
  12. // 3

由此,我们也可以发现 for of 遍历的其实是对象的 Symbol.iterator 属性。

默认可遍历对象

然而如果我们直接遍历一个数组对象:

  1. const colors = ["red", "green", "blue"];
  2. for (let color of colors) {
  3. console.log(color);
  4. }
  5. // red
  6. // green
  7. // blue

尽管我们没有手动添加 Symbol.iterator 属性,还是可以遍历成功,这是因为 ES6 默认部署了 Symbol.iterator 属性,当然我们也可以手动修改这个属性:

  1. var colors = ["red", "green", "blue"];
  2. colors[Symbol.iterator] = function() {
  3. return createIterator([1, 2, 3]);
  4. };
  5. for (let color of colors) {
  6. console.log(color);
  7. }
  8. // 1
  9. // 2
  10. // 3

除了数组之外,还有一些数据结构默认部署了 Symbol.iterator 属性。
所以 for…of 循环可以使用的范围包括:

  1. 数组
  2. Set
  3. Map
  4. 类数组对象,如 arguments 对象、DOM NodeList 对象
  5. Generator 对象
  6. 字符串

    模拟实现 for of

    其实模拟实现 for of 也比较简单,基本就是通过 Symbol.iterator 属性获取迭代器对象,然后使用 while 遍历一下:

    1. function forOf(obj, cb) {
    2. let iterable, result;
    3. if (typeof obj[Symbol.iterator] !== "function")
    4. throw new TypeError(result + " is not iterable");
    5. if (typeof cb !== "function") throw new TypeError("cb must be callable");
    6. iterable = obj[Symbol.iterator]();
    7. result = iterable.next();
    8. while (!result.done) {
    9. cb(result.value);
    10. result = iterable.next();
    11. }
    12. }

    内建迭代器

    为了更好的访问对象中的内容,比如有的时候我们仅需要数组中的值,但有的时候不仅需要使用值还需要使用索引,ES6 为数组、Map、Set 集合内建了以下三种迭代器:

  7. entries() 返回一个遍历器对象,用来遍历[键名, 键值]组成的数组。对于数组,键名就是索引值。

  8. keys() 返回一个遍历器对象,用来遍历所有的键名。
  9. values() 返回一个遍历器对象,用来遍历所有的键值。

以数组为例:

  1. var colors = ["red", "green", "blue"];
  2. for (let index of colors.keys()) {
  3. console.log(index);
  4. }
  5. // 0
  6. // 1
  7. // 2
  8. for (let color of colors.values()) {
  9. console.log(color);
  10. }
  11. // red
  12. // green
  13. // blue
  14. for (let item of colors.entries()) {
  15. console.log(item);
  16. }
  17. // [ 0, "red" ]
  18. // [ 1, "green" ]
  19. // [ 2, "blue" ]

Map 类型与数组类似,但是对于 Set 类型需要注意以下:

  1. var colors = new Set(["red", "green", "blue"]);
  2. for (let index of colors.keys()) {
  3. console.log(index);
  4. }
  5. // red
  6. // green
  7. // blue
  8. for (let color of colors.values()) {
  9. console.log(color);
  10. }
  11. // red
  12. // green
  13. // blue
  14. for (let item of colors.entries()) {
  15. console.log(item);
  16. }
  17. // [ "red", "red" ]
  18. // [ "green", "green" ]
  19. // [ "blue", "blue" ]

Set 类型的 keys() 和 values() 返回的是相同的迭代器,这也意味着在 Set 这种数据结构中键名与键值相同。
而且每个集合类型都有一个默认的迭代器,在 for-of 循环中,如果没有显式指定则使用默认的迭代器。数组和 Set 集合的默认迭代器是 values() 方法,Map 集合的默认迭代器是 entries() 方法。
这也就是为什么直接 for of 遍历 Set 和 Map 数据结构,会有不同的数据结构返回:

  1. const values = new Set([1, 2, 3]);
  2. for (let value of values) {
  3. console.log(value);
  4. }
  5. // 1
  6. // 2
  7. // 3
  1. const values = new Map([["key1", "value1"], ["key2", "value2"]]);
  2. for (let value of values) {
  3. console.log(value);
  4. }
  5. // ["key1", "value1"]
  6. // ["key2", "value2"]

遍历 Map 数据结构的时候可以顺便结合解构赋值:

  1. const valuess = new Map([["key1", "value1"], ["key2", "value2"]]);
  2. for (let [key, value] of valuess) {
  3. console.log(key + ":" + value);
  4. }
  5. // key1:value1
  6. // key2:value2

Babel 是如何编译 for of 的

我们可以在 Babel 的 Try it out 中查看编译的结果:

  1. const colors = new Set(["red", "green", "blue"]);
  2. for (let color of colors) {
  3. console.log(color);
  4. }

对于这样一段代码,编译的结果如下:

  1. "use strict";
  2. var colors = new Set(["red", "green", "blue"]);
  3. var _iteratorNormalCompletion = true;
  4. var _didIteratorError = false;
  5. var _iteratorError = undefined;
  6. try {
  7. for (
  8. var _iterator = colors[Symbol.iterator](), _step;
  9. !(_iteratorNormalCompletion = (_step = _iterator.next()).done);
  10. _iteratorNormalCompletion = true
  11. ) {
  12. var color = _step.value;
  13. console.log(color);
  14. }
  15. } catch (err) {
  16. _didIteratorError = true;
  17. _iteratorError = err;
  18. } finally {
  19. try {
  20. if (!_iteratorNormalCompletion && _iterator.return) {
  21. _iterator.return();
  22. }
  23. } finally {
  24. if (_didIteratorError) {
  25. throw _iteratorError;
  26. }
  27. }
  28. }

至少由编译的结果可以看出,使用 for of 循环的背后,还是会使用 Symbol.iterator 接口。
而这段编译的代码稍微复杂的地方有两段,一段是 for 循环这里:

  1. for (
  2. var _iterator = colors[Symbol.iterator](), _step;
  3. !(_iteratorNormalCompletion = (_step = _iterator.next()).done);
  4. _iteratorNormalCompletion = true
  5. ) {
  6. var color = _step.value;
  7. console.log(color);
  8. }

跟标准的 for 循环写法有些差别,我们看下 for 语句的语法:

  1. for (initialize; test; increment) statement;

initialize、test 和 increment 三个表达式之间用分号分割,它们分别负责初始化操作、循环条件判断和计数器变量的更新。
for 语句其实就相当于:

  1. initialize; while (test) { statement; increment; }

代码的逻辑为:先进行初始化,然后每次循环执行之前会执行 test 表达式,并判断表达式的结果来决定是否执行循环体,如果 test 计算结果为真值,则执行循环体中的 statement。最后,执行 increment 表达式。
而且值得注意的是,其实 for 循环中的三个表达式中任意一个都可以被忽略,不过分号还是要写的。
比如 for(;;),不过这就是一个死循环……
比如:

  1. var i = 0,
  2. len = colors.length;
  3. for (; i < len; i++) {
  4. console.log(colors[i]);
  5. }

又比如:

  1. var i = 0,
  2. len = colors.length;
  3. for (; i < len; ) {
  4. i++;
  5. }

然后我们再来看 Babel 编译的这个 for 循环表达式:

  1. for (
  2. var _iterator = colors[Symbol.iterator](), _step;
  3. !(_iteratorNormalCompletion = (_step = _iterator.next()).done);
  4. _iteratorNormalCompletion = true ) {
  5. var color = _step.value;
  6. console.log(color);
  7. }

用 while 的写法相当于:

  1. var _iterator = colors[Symbol.iterator](), _step;
  2. while (!(_iteratorNormalCompletion = (_step = _iterator.next()).done)) {
  3. var color = _step.value;
  4. console.log(color);
  5. _iteratorNormalCompletion = true;
  6. }

是不是就好懂了很多呢,然后你就会发现,其实 _iteratorNormalCompletion = true 这句是完全没有必要的……
另外一段稍微复杂的代码是:

  1. try {
  2. ... } catch (err) {
  3. ... } finally {
  4. try {
  5. if (!_iteratorNormalCompletion && _iterator.return) {
  6. _iterator.return();
  7. } }
  8. finally { ... }
  9. }

因为 _iteratorNormalCompletion = (_step = _iterator.next()).done,所以 _iteratorNormalCompletion 表示的就是是否完成了一次完整的迭代过程,如果没有正常的迭代完成,并且迭代器有 return 方法时,就会执行该方法。
而之所以这么做,就要提到迭代器的 return 方法。
引用阮一峰老师的 ECMAScript 6 入门:
遍历器对象除了具有 next 方法,还可以具有 return 方法和 throw 方法。如果你自己写遍历器对象生成函数,那么 next 方法是必须部署的,return 方法和 throw 方法是否部署是可选的。
return 方法的使用场合是,如果 for…of 循环提前退出(通常是因为出错,或者有 break 语句或 continue 语句),就会调用 return 方法。如果一个对象在完成遍历前,需要清理或释放资源,就可以部署 return 方法。
我们可以举个例子:

  1. function createIterator(items) {
  2. var i = 0;
  3. return {
  4. next: function() {
  5. var done = i >= items.length;
  6. var value = !done ? items[i++] : undefined;
  7. return {
  8. done: done,
  9. value: value
  10. };
  11. },
  12. return: function() {
  13. console.log("执行了 return 方法");
  14. return {
  15. value: 23333,
  16. done: true
  17. };
  18. }
  19. };
  20. }
  21. var colors = ["red", "green", "blue"];
  22. var iterator = createIterator([1, 2, 3]);
  23. colors[Symbol.iterator] = function() {
  24. return iterator;
  25. };
  26. for (let color of colors) {
  27. if (color == 1) break;
  28. console.log(color);
  29. }
  30. // 执行了 return 方法

不过正如你在编译后的代码中看到,仅仅是在有 return 函数的时候执行了 return 函数而已,return 函数中返回的值其实并不生效……
但是你不返回值或者返回一个基本类型的值的话,结果又会报错……

  1. TypeError: Iterator result undefined is not an object

这是因为 return 方法必须返回一个对象,而这又是 Generator 规范决定的……
总之如果是在浏览器中使用的话,return 函数的返回值其实并不生效 T^T