ES6–遍历器(Iterator )
一、Iterator(遍历器)的概念
- JavaScript 原有的表示“集合”的数据结构,主要是数组(Array)和对象(Object),ES6 又添加了Map和Set。这样就有了四种数据集合,用户还可以组合使用它们,定义自己的数据结构,比如数组的成员是Map,Map的成员是对象。这样就需要一种统一的接口机制,来处理所有不同的数据结构。
- 遍历器(Iterator)就是这样一种机制。它是一种接口,为各种不同的数据结构提供统一的访问机制。任何数据结构只要部署 Iterator 接口,就可以完成遍历操作(即依次处理该数据结构的所有成员)。
二、遍历器的作用
- (1)为各种数据结构,提供一个统一的、简便的访问接口;
- (2)使得数据结构的成员能够按某种次序排列;
- (3) ES6 创造了一种新的遍历命令for…of循环,Iterator 接口主要供for…of消费(for of遍历的对象必须存在遍历器接口 才可以遍历)
三、Iterator 的遍历过程
- (1)创建一个指针对象,指向当前数据结构的起始位置。也就是说,遍历器对象本质上,就是一个指针对象。
- (2)第一次调用指针对象的next方法,可以将指针指向数据结构的第一个成员。
- (3)第二次调用指针对象的next方法,指针就指向数据结构的第二个成员。
- (4)不断调用指针对象的next方法,直到它指向数据结构的结束位置。
每一次调用next方法,都会返回数据结构的当前成员的信息。具体来说,就是返回一个包含value和done两个属性的对象。其中,value属性是当前成员的值,done属性是一个布尔值,表示遍历是否结束。
四、自己模拟遍历器接口实现
1. 普通实现
function makeInterator(array){ let startIndex=0; return { next:function(){ return startIndex<array.length?{value:array[startIndex++],done:false}:{value:undefined,done:true} } } } let inter=makeInterator([1,2,3,4]); console.log(inter.next()); console.log(inter.next()); console.log(inter.next()); console.log(inter.next()); console.log(inter.next());
2. 类部署 Iterator 接口的写法(es6 部署遍历器 class,等价es5 函数)
Symbol.iterator属性对应一个函数,执行后返回当前对象的遍历器对象。
{ class Range{ start; end; constructor(start,end){ this.start=start; this.end=end; } [Symbol.iterator](){ return this; } next(){ let startValue=this.start; if(startValue<this.end){ this.start++; return {value:startValue,done:false}; } return {value:undefined,done:true}; } } let range=new Range(0,5); console.log(range.next());//{value: 0, done: false} console.log(range.next());//{value: 1, done: false} console.log(range.next());//{value: 2, done: false} console.log(range.next());//{value: 3, done: false} console.log(range.next());//{value: 4, done: false} console.log(range.next());//{value: undefined, done: true} for(let value of range){ console.log(value);//0 1 2 3 4 } }
3. 模拟es5 的函数类写法 去部署一个遍历器
{ function Range(start,stop){ this.start=start; this.end=stop; } Range.prototype[Symbol.iterator]=function(){ return this; } Range.prototype.next=function(){ let startValue=this.start; if(startValue<this.end){ this.start++; return {value:startValue,done:false}; } return {value:undefined,done:true}; } let range=new Range(0,10); for(let value of range){ console.log(value);//0 1 2 3 4 5 6 7 8 9 } }
- 上面代码定义了一个makeIterator函数,它是一个遍历器生成函数,作用就是返回一个遍历器对象。对数组[1,2,3,4]执行这个函数,就会返回该数组的遍历器对象(即指针对象)inter。
- 指针对象的next方法,用来移动指针。开始时,指针指向数组的开始位置。然后,每次调用next方法,指针就会指向数组的下一个成员。第一次调用,指向1;第二次调用,指向2。
- next方法返回一个对象,表示当前数据成员的信息。这个对象具有value和done两个属性,value属性返回当前位置的成员,done属性是一个布尔值,表示遍历是否结束,即是否还有必要再一次调用next方法。
- 总之,调用指针对象的next方法,就可以遍历事先给定的数据结构。
- 对于遍历器对象来说,done: false和value: undefined属性都是可以省略的
五、默认 Iterator 接口
1. Iterator接口的目的
- Iterator 接口的目的,就是为所有数据结构,提供了一种统一的访问机制,即for…of循环。当使用for…of循环遍历某种数据结构时,该循环会自动去寻找 Iterator 接口。
- 一种数据结构只要部署了 Iterator 接口,我们就称这种数据结构是“可遍历的”(iterable)。
- ES6 规定,默认的 Iterator 接口部署在数据结构的Symbol.iterator属性,或者说,一个数据结构只要具有Symbol.iterator属性,就可以认为是“可遍历的”(iterable)。Symbol.iterator属性本身是一个函数,就是当前数据结构默认的遍历器生成函数。执行这个函数,就会返回一个遍历器。至于属性名Symbol.iterator,它是一个表达式,返回Symbol对象的iterator属性,这是一个预定义好的、类型为 Symbol 的特殊值,所以要放在方括号内。
- ES6 的有些数据结构原生具备 Iterator 接口(比如数组),即不用任何处理,就可以被for…of循环遍历。原因在于,这些数据结构原生部署了Symbol.iterator属性,另外一些数据结构没有(比如对象)。凡是部署了Symbol.iterator属性的数据结构,就称为部署了遍历器接口。调用这个接口,就会返回一个遍历器对象。
2. 原生具备 Iterator 接口的数据结构如下。
- Array
- Map
- Set
- String
- TypedArray
- 函数的 arguments 对象
- NodeList 对象
例子:数组的Symbol.iterator属性
let arr=[1,2,3,4]; let inter=arr[Symbol.iterator](); console.log(inter.next()); console.log(inter.next()); console.log(inter.next()); console.log(inter.next()); console.log(inter.next()); for(let key of arr){ console.log(key);//1 2 3 4 }
- 变量arr是一个数组,原生就具有遍历器接口,部署在arr的Symbol.iterator属性上面。所以,调用这个属性,就得到遍历器对象。
- 对于原生部署 Iterator 接口的数据结构,不用自己写遍历器生成函数,for…of循环会自动遍历它们。除此之外,其他数据结构(主要是对象)的 Iterator 接口,都需要自己在Symbol.iterator属性上面部署,这样才会被for…of循环遍历。
六、部署对象的遍历器接口
1. 为什么对象没有遍历器接口
- 对象(Object)之所以没有默认部署 Iterator 接口,是因为对象的哪个属性先遍历,哪个属性后遍历是不确定的,需要开发者手动指定。本质上,遍历器是一种线性处理,对于任何非线性的数据结构,部署遍历器接口,就等于部署一种线性转换。不过,严格地说,对象部署遍历器接口并不是很必要,因为这时对象实际上被当作 Map 结构使用,ES5 没有 Map 结构,而 ES6 原生提供了。
- 一个对象如果要具备可被for…of循环调用的 Iterator 接口,就必须在Symbol.iterator的属性上部署遍历器生成方法(原型链上的对象具有该方法也可)。
2. 部署对象的遍历器接口
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 }; } }; } }; let iterator=obj[Symbol.iterator](); console.log(iterator.next()); console.log(iterator.next()); console.log(iterator.next()); for(let key of obj){ console.log(key);//hello world }
对于类似数组的对象(存在数值键名和length属性),部署 Iterator 接口,有一个简便方法,就是Symbol.iterator方法直接引用数组的 Iterator 接口。
let obj={ 0:'a', 1:'b', 2:'c', 3:'d', length:4, [Symbol.iterator]:Array.prototype[Symbol.iterator] } for(let value of obj){ console.log(value);//a b c d }
注意,普通对象部署数组的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 }
七、字符串的 Iterator 接口
字符串是一个类似数组的对象,也原生具有 Iterator 接口。
{ let str="Hello world!"; let inter=str[Symbol.iterator](); for(let value of inter){ console.log(value);//H e l l o w o r l d ! } }
八、调用 Iterator 接口的场合
- 有一些场合会默认调用 Iterator 接口(即Symbol.iterator方法),除了下文会介绍的for…of循环,还有几个别的场合。
- (1)解构赋值
对数组和 Set 结构进行解构赋值时,会默认调用Symbol.iterator方法。- (2)扩展运算符
扩展运算符(…)也会调用默认的 Iterator 接口。- (3)yield*
yield*后面跟的是一个可遍历的结构,它会调用该结构的遍历器接口。- (4)其他场合
由于数组的遍历会调用遍历器接口,所以任何接受数组作为参数的场合,其实都调用了遍历器接口。下面是一些例子。
for…of
Array.from()
Map(), Set(), WeakMap(), WeakSet()(比如new Map([[‘a’,1],[‘b’,2]]))
Promise.all()
Promise.race()