Iterator遍历器、for...of

发表于 | 分类于

Iterator 遍历器

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

Iterator 的遍历过程：

  1. 创建一个指针对象，指向当前数据结构的起始位置。遍历器对象本质上，就是一个指针对象。
  2. 每一次调用next方法，都会返回数据结构的当前成员的信息。
  3. 也就是返回包含value和done两个属性的对象。value属性是当前成员的值，done属性是一个布尔值，表示遍历是否结束。

当使用for…of循环遍历某种数据结构时，该循环会自动去寻找 Iterator 接口。

一种数据结构只要部署了 Iterator 接口，我们就称这种数据结构是“可遍历的”（iterable）。

ES6 规定，默认的 Iterator 接口部署在数据结构的Symbol.iterator属性，或者说，一个数据结构只要具有Symbol.iterator属性，就可以认为是“可遍历的”（iterable）。Symbol.iterator属性本身是一个函数，就是当前数据结构默认的遍历器生成函数。执行这个函数，就会返回一个遍历器。

至于属性名Symbol.iterator，它是一个表达式，返回Symbol对象的iterator属性，这是一个预定义好的、类型为 Symbol 的特殊值，所以要放在方括号内

1
2
3
4
5
6
7
8
9
10
11
12
const obj = {
  [Symbol.iterator] : function () { // 返回遍历器对象
    return {
      next: function () {   // 该对象具有next方法
        return {
          value: 1,
          done: true
        };
      }
    };
  }
};

上面代码中，对象obj是可遍历的（iterable），因为具有Symbol.iterator属性。执行这个属性，会返回一个遍历器对象。该对象的根本特征就是具有next方法。每次调用next方法，都会返回一个代表当前成员的信息对象，具有value和done两个属性。

ES6 的有些数据结构原生具备 Iterator 接口（比如数组），即不用任何处理，就可以被for…of循环遍历。原因在于，这些数据结构原生部署了Symbol.iterator属性，另外一些数据结构没有（比如对象）。凡是部署了Symbol.iterator属性的数据结构，就称为部署了遍历器接口。调用这个接口，就会返回一个遍历器对象。

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

原生部署了Symbol.iterator属性的数据结构。

Array、Set、Map、String、函数arguments对象、Generator 对象、NodeList对象、TypedArray

Symbol.iterator属性本身是一个函数，就是当前数据结构默认的遍历器生成函数。执行这个函数，就会返回一个遍历器。

1
2
3
4
let arr = ['a', 'b', 'c'];
let iter = arr[Symbol.iterator]();

iter.next() // { value: 'a', done: false }

对于原生部署 Iterator 接口的数据结构，不用自己写遍历器生成函数，for…of循环会自动遍历它们。除此之外，其他数据结构（主要是对象）的 Iterator 接口，都需要自己在Symbol.iterator属性上面部署，这样才会被for…of循环遍历。

对象（Object）之所以没有默认部署 Iterator 接口，是因为对象的哪个属性先遍历，哪个属性后遍历是不确定的，需要开发者手动指定。本质上，遍历器是一种线性处理，对于任何非线性的数据结构，部署遍历器接口，就等于部署一种线性转换。不过，严格地说，对象部署遍历器接口并不是很必要，因为这时对象实际上被当作 Map 结构使用，ES5 没有 Map 结构，而 ES6 原生提供了。

如果Symbol.iterator方法对应的不是遍历器生成函数（即会返回一个遍历器对象），解释引擎将会报错。

默认调用Iterator接口

  1. 数组和Set进行解构赋值时，会默认调用Symbol.iterator方法
1
2
3
4
5
6
7
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'];
  1. 拓展运算符：只要某个数据结构部署了 Iterator 接口，就可以对它使用扩展运算符，将其转为数组。
1
let arr = [...iterable];
  1. yield*：任何数据对象只要有Iterator接口，就可以被yield*遍历
  2. 由于数组的遍历会调用遍历器接口，所以任何接受数组作为参数的场合，其实都调用了遍历器接口
  • for…of
  • Array.from()
  • Map()、Set()、WeakMap()、WeakSet()
  • Promise.all()
  • Promise.race()

也可以将 Generator 函数返回的 Iterator 对象，作为参数。不用手动调用next方法

字符串的Iterator接口

字符串是一个类似数组的对象，也原生具有 Iterator 接口。

iterater与generater函数

Symbol.iterater的简单实现，可以利用generater函数

1
2
3
4
5
6
7
8
9
10
11
12
13
let obj = {
  [Symbol.iterator]: function* () {
    yield 'hello';
    yield 'world';
  }
}

let obj = {
  * [Symbol.iterator]() {
    yield 'hello';
    yield 'world';
  }
};

遍历器对象的return、throw方法

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

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

throw一般配合generater函数使用

for…of

一个数据结构只要部署了Symbol.iterator属性，就被视为具有 iterator 接口，就可以用for…of循环遍历它的成员。也就是说，for…of循环内部调用的是数据结构的Symbol.iterator方法。

Array、Set、Map、String、函数arguments对象、Generator 对象、NodeList对象、TypedArray
都是原生默认有Symbol.Iterator属性

1
2
3
4
5
6
7
8
9
10
11
12
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(let v of obj) {
  console.log(v); // red green blue
}

for…of循环可以代替数组实例的forEach()

for…of遍历Set、Map

遍历的顺序是按照各个成员被添加进数据结构的顺序。

Set 结构遍历时，返回的是一个值，而 Map 结构遍历时，返回的是一个数组，该数组的两个成员分别为当前 Map 成员的键名和键值。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
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

计算生成的数据结构

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

  • entries() 返回一个遍历器对象，用来遍历[键名, 键值]组成的数组。对于数组，键名就是索引值；对于Set，键名与键值相同。Map 结构的 Iterator 接口，默认就是调用entries方法。
  • keys() 返回一个遍历器对象，用来遍历所有的键名。
  • values() 返回一个遍历器对象，用来遍历所有的键值。
1
2
3
4
5
6
7
let arr = ['a', 'b', 'c'];
for (let pair of arr.entries()) {
  console.log(pair);
}
// [0, 'a']
// [1, 'b']
// [2, 'c']

类似数组的对象

字符串、DOM NodeList 对象、arguments对象：

  • 对于字符串来说，for…of循环还有一个特点，就是会正确识别 32 位 UTF-16 字符。
  • 并不是所有类似数组的对象都具有 Iterator 接口，一个简便的解决方法，就是使用Array.from方法将其转为数组。
1
2
3
4
5
6
7
8
9
10
11
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循环依然可以用来遍历键名。

  1. 使用Object.keys方法将对象的键名生成一个数组，然后遍历这个数组。
1
2
3
for (var key of Object.keys(someObject)) {
  console.log(key + ': ' + someObject[key]);
}
  1. 使用generater将对象包装
1
2
3
4
5
6
7
8
9
10
11
12
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

与其他遍历语法比较

对于数组：

  1. 最原始的：for循环遍历
  2. 内置的forEach()：无法中途跳出循环（break、return都不行）
  3. for…in可以遍历数组的键名key
  • 数组的键名是数字，但是for…in是以number对应字符作为索引遍历的
  • for…in不仅遍历数字键名，还会遍历手动添加的所有键，甚至包括原型上的键
  • 某些情况下，for…in会以任意顺序遍历

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

  1. for…of：可以与break、continue和return配合使用。

for…of和for…in的区别

  1. for…in循环，只能获得对象或数组的键名key，不能直接获取键值
  2. for…of循环，允许遍历获得键值value
  3. for…in不仅遍历数字键名，还会遍历手动添加的所有键，甚至包括原型上的键。for…of只能遍历数字键名
  4. for…of可以配合contine、break、return使用

如果要通过for…of循环，获取数组的索引，可以借助数组实例的entries方法和keys方法