es6 javascript的Iterator 和 for...of 循环

ゞ浴缸里的玫瑰 2022-05-16 01:59 207阅读 0赞

1 Iterator（ 遍历器） 的概念

JavaScript 原有的表示“ 集合” 的数据结构， 主要是数组（ Array） 和对象（ Object）， ES6 又添加了 Map 和 Set。 这样就有了四种数据集合， 用户还可以组合使用它们， 定义自己的数据结构， 比如数组的成员是 Map， Map 的成员是对象。 这样就需要一种统一的接口机制， 来处理所有不同的数据结构。  
遍历器（ Iterator） 就是这样一种机制。 它是一种接口， 为各种不同的数据结构提供统一的访问机制。 任何数据结构只要部署 Iterator 接口， 就可以完成遍历操作（ 即依次处理该数据结构的所有成员）。  
Iterator 的作用有三个：   
一是为各种数据结构， 提供一个统一的、 简便的访问接口。  
二是使得数据结构的成员能够按某种次序排列；   
三是 ES6 创造了一种新的遍历命令for…of循环， Iterator 接口主要供for…of消费。  
Iterator 的遍历过程是这样的。  
（ 1） 创建一个指针对象， 指向当前数据结构的起始位置。 也就是说， 遍历器对象本质上， 就是一个指针对象。  
（ 2） 第一次调用指针对象的next方法， 可以将指针指向数据结构的第一个成员。  
（ 3） 第二次调用指针对象的next方法， 指针就指向数据结构的第二个成员。  
（ 4） 不断调用指针对象的next方法， 直到它指向数据结构的结束位置。  
每一次调用next方法， 都会返回数据结构的当前成员的信息。 具体来说， 就是返回一个包含value和done两个属性的对象。 其中， value属性是当前成员的值， done属性是一个布尔值， 表示遍历是否结束。  
下面是一个模拟next方法返回值的例子。

上面代码定义了一个makeIterator函数， 它是一个遍历器生成函数， 作用就是返回一个遍历器对象。 对数组\[‘a’, ‘b’\] 执行这个函数， 就会返回该数组的遍历器对象（ 即指针对象） it。  
指针对象的next方法， 用来移动指针。 开始时， 指针指向数组的开始位置。 然后， 每次调用next方法， 指针就会指向数组的下一个成员。 第一次调用， 指向a； 第二次调用， 指向b。  
next方法返回一个对象， 表示当前数据成员的信息。 这个对象具有value和done两个属性， value属性返回当前位置的成员， done属性是一个布尔值，表示遍历是否结束， 即是否还有必要再一次调用next方法。  
总之， 调用指针对象的next方法， 就可以遍历事先给定的数据结构。  
对于遍历器对象来说， done: false和value: undefined属性都是可以省略的， 因此上面的makeIterator函数可以简写成下面的形式。

由于 Iterator 只是把接口规格加到数据结构之上， 所以， 遍历器与它所遍历的那个数据结构， 实际上是分开的， 完全可以写出没有对应数据结构的遍历器对象， 或者说用遍历器对象模拟出数据结构。 下面是一个无限运行的遍历器对象的例子。

上面的例子中， 遍历器生成函数idMaker， 返回一个遍历器对象（ 即指针对象）。 但是并没有对应的数据结构， 或者说， 遍历器对象自己描述了一个数据结构出来。  
在 ES6 中， 有些数据结构原生具备 Iterator 接口（ 比如数组）， 即不用任何处理， 就可以被for…of循环遍历， 有些就不行（ 比如对象）。 原因在于，这些数据结构原生部署了Symbol.iterator属性（ 详见下文）， 另外一些数据结构没有。 凡是部署了Symbol.iterator属性的数据结构， 就称为部署了遍历器接口。 调用这个接口， 就会返回一个遍历器对象。  
如果使用 TypeScript 的写法， 遍历器接口（ Iterable）、 指针对象（ Iterator） 和 next 方法返回值的规格可以描述如下。

interface Iterable { 
         [ Symbol.iterator](): Iterator, 
         } 
         interface Iterator { 
         next(value ? : any): IterationResult, 
         } 
         interface IterationResult { 
         value: any, 
         done: boolean, 
         }

2 数据结构的默认 Iterator 接口

Iterator 接口的目的， 就是为所有数据结构， 提供了一种统一的访问机制， 即for…of循环（ 详见下文）。 当使用for…of循环遍历某种数据结构时，该循环会自动去寻找 Iterator 接口。  
ES6 规定， 默认的 Iterator 接口部署在数据结构的Symbol.iterator属性， 或者说， 一个数据结构只要具有Symbol.iterator属性， 就可以认为是“ 可遍历的”（ iterable）。 调用Symbol.iterator方法， 就会得到当前数据结构默认的遍历器生成函数。 Symbol.iterator本身是一个表达式， 返回 Symbol 对象的iterator属性， 这是一个预定义好的、 类型为 Symbol 的特殊值， 所以要放在方括号内（ 请参考 Symbol 一章）。  
在 ES6 中， 有三类数据结构原生具备 Iterator 接口： 数组、 某些类似数组的对象、 Set 和 Map 结构。

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 }

上面代码中， 变量arr是一个数组， 原生就具有遍历器接口， 部署在arr的Symbol.iterator属性上面。 所以， 调用这个属性， 就得到遍历器对象。  
上面提到， 原生就部署 Iterator 接口的数据结构有三类， 对于这三类数据结构， 不用自己写遍历器生成函数，for…of循环会自动遍历它们。 除此之外， 其他数据结构（ 主要是对象） 的 Iterator 接口， 都需要自己在Symbol.iterator属性上面部署， 这样才会被for…of循环遍历。  
对象（ Object） 之所以没有默认部署 Iterator 接口， 是因为对象的哪个属性先遍历， 哪个属性后遍历是不确定的， 需要开发者手动指定。 本质上， 遍历器是一种线性处理， 对于任何非线性的数据结构， 部署遍历器接口， 就等于部署一种线性转换。 不过， 严格地说， 对象部署遍历器接口并不是很必要， 因为这时对象实际上被当作 Map 结构使用， ES5 没有 Map 结构， 而 ES6 原生提供了。  
一个对象如果要有可被for…of循环调用的 Iterator 接口， 就必须在Symbol.iterator的属性上部署遍历器生成方法（ 原型链上的对象具有该方法也可）。

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 
         }; 
         } else { 
         return { 
         done: true, 
         value: undefined 
         }; 
         } 
         } 
         } 
         
         function range(start, stop) { 
         return new RangeIterator(start, stop); 
         } 
         for( var value of range( 0, 3)) { 
         console.log(value); 
         }

上面代码是一个类部署 Iterator 接口的写法。 Symbol.iterator属性对应一个函数， 执行后返回当前对象的遍历器对象。  
下面是通过遍历器实现指针结构的例子。

上面代码首先在构造函数的原型链上部署Symbol.iterator方法， 调用该方法会返回遍历器对象iterator， 调用该对象的next方法， 在返回一个值的同时， 自动将内部指针移到下一个实例。  
下面是另一个为对象添加 Iterator 接口的例子。

下面是另一个为对象添加 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 
         }; 
         } else { 
         return { 
         value: undefined, 
         done: true 
         }; 
         } 
         } 
         }; 
         } 
         };

对于类似数组的对象（ 存在数值键名和 length 属性）， 部署 Iterator 接口， 有一个简便方法， 就是Symbol.iterator方法直接引用数组的 Iterator 接口。

NodeList.prototype[ Symbol.iterator] = Array.prototype[ Symbol.iterator]; 
         // 或者 
         NodeList.prototype[ Symbol.iterator] = [][ Symbol.iterator]; 
         [...document.querySelectorAll( 'div')] // 可以执行了

下面是类似数组的对象调用数组的Symbol.iterator方法的例子。

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方法， 并无效果。

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

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

var obj = {}; 
         obj[ Symbol.iterator] = () => 1; 
         [...obj] // TypeError: [] is not a function

上面代码中， 变量 obj 的 Symbol.iterator 方法对应的不是遍历器生成函数， 因此报错。  
有了遍历器接口， 数据结构就可以用for…of循环遍历（ 详见下文）， 也可以使用while循环遍历