4. ES6 Iterator 遍历器或迭代器

博主简介：知名前端工程师！
✒️ 出没地点：重庆-沙坪坝
交流扣群：559658154，欢迎您的加入！
———————————————————————————————————————————
版权声明：本文为 CSDN 博主「Lady Marry」的原创文章，转载请附上原文出处链接及本声明。

一. 概述

JavaScript 原有的表示“集合”的数据结构，主要是数组（Array）和对象（Object），ES6 又添加了 Map 和 Set。这样就有了四种数据集合，就需要一种统一的接口机制，来处理所有不同的数据结构。

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

Iterator 的作用：

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

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

• Array
• Map
• Set
• String
• TypedArray
• 函数的 arguments 对象
• NodeList 对象

二. 遍历过程

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

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

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

4. 不断调用指针对象的 next 方法，直到它指向数据结构的结束位置。

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

三. 默认 Iterator 接口示例

let arr = ['a', 'b', 'c'];
let it = arr[Symbol.iterator]();
console.log(it.next());// { value: 'a', done: false }
console.log(it.next());// { value: 'b', done: false }
console.log(it.next());// { value: 'c', done: false }
console.log(it.next());// { value: undefined, done: true }

上面代码中，变量 arr 是一个数组，原生就具有遍历器接口，部署在 arr 的 Symbol.iterator 属性上面。所以，调用这个属性，就得到遍历器对象。

对于原生部署 Iterator 接口的数据结构，不用自己写遍历器生成函数，for…of循环会自动遍历它们。

let arr = ['a', 'b', 'c'];
for (const item of arr) {
  console.log(item);
}

四. 为对象添加 Iterator 接口

一个对象如果要具备可被 for…of 循环调用的 Iterator 接口，就必须在 Symbol.iterator 的属性上部署遍历器生成方法（原型链上的对象具有该方法也可）。

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
          };
        }
        return { value: undefined, done: true };
      }
    };
  }
};
for (const it of obj) {
  console.log(it);
}

如果不在 obj 对象的 Symbol.iterator 的属性上部署遍历器生成方法，对象类型默认是不能被 for-of 遍历的

五. 类似数组的对象调用数组的 Symbol.iterator 方法

类数组是个对象，结构类似数组

let obj = {
  0: 'a',
  1: 'b',
  2: 'c',
  length: 3,
  [Symbol.iterator]: Array.prototype[Symbol.iterator]
};
for (let item of obj) {
  console.log(item); // 'a', 'b', 'c'
}

注意：普通对象部署数组的 Symbol.iterator 方法，并无效果。

有了遍历器接口，数据结构就可以用 for…of 循环遍历，也可以使用 while 循环遍历。

let obj = {
  0: 'a',
  1: 'b',
  2: 'c',
  length: 3,
  [Symbol.iterator]: Array.prototype[Symbol.iterator]
};
// for (let item of obj) {
//   console.log(item); // 'a', 'b', 'c'
// }
let it = obj[Symbol.iterator]();
let temp;
while (!(temp = it.next()).done) {
  console.log(temp);// 'a', 'b', 'c'
}

六. 默认调用 Iterator 接口的场合

有一些场合会默认调用 Iterator 接口（即 Symbol.iterator 方法）

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. 扩展运算符

扩展运算符（…）也会调用默认调用 Symbol.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 str = "hello";
console.log(typeof str[Symbol.iterator]); // "function"
//获取字符串迭代器
var it = str[Symbol.iterator]();
console.log(it.next()); // { value: "h", done: false }
console.log(it.next()); // { value: "e", done: false }
console.log(it.next()); // { value: "l", done: false }
console.log(it.next()); // { value: "l", done: false }
console.log(it.next()); // { value: "o", done: false }
console.log(it.next()); // { value: undefined, done: true }

可以覆盖原生的 Symbol.iterator 方法，达到修改遍历器行为的目的。

var str = new String("hello");
//获取字符串迭代器
str[Symbol.iterator] = function () {
  return {
    next: function () {
      if (this._first) {
        this._first = false;
        return { value: "bye", done: false }
      }
      return { done: true }
    },
    _first: true
  }
}
var it = str[Symbol.iterator]();
console.log(it.next()); // {value: 'bye', done: false}
console.log(it.next()); // {done: true}
console.log([...str]); // ['bye']

八. 遍历器对象的 return() 和 throw()

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

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

var str = new String("hello");
//获取字符串迭代器
str[Symbol.iterator] = function () {
  let i = 0;
  return {
    next: function () {
      if (i < str.length) {
        let ch = str[i];
        i++;
        return {
          value: ch, done: false
        }
      }
      return { done: true };
    },
    return: function () {
      console.log("return方法被执行了");
      return { done: true };
    }
  }
}
for (const i of str) {
  if (i == "l") {
    break;
  }
  // throw new Error(); 或者抛出异常
  console.log(i);
}

如上代码就是，当 for-of 循环执行到一半提前结束循环，就会自动执行 return() 方法