Iterator(遍历器)的概念
javascript原有的表示"集合"的数据结构主要是数组和对象,ES6又添加了Map和Set,这样就需要一种统一的接口机制来处理所有不同的数据结构。
遍历器就是这样一种机制,它是一种接口,为各种不同的数据结构提供统一的访问机制。任何数据结构,只要部署Iterator接口,就可以完成遍历操作(即依次处理该数据结构的所有成员)。
Iterator的作用有3个:一是为各种数据结构访问自身成员提供统一的、简便的访问接口(方法);二是使得数据结构的成员能够按某种次序排列;三是ES6创造了一种新的遍历命令---for...of循环,Iterator接口主要用于for...of循环。
Iterator的遍历过程如下
1.创建一个指针对象,指向当前数据结构的起始位置。也就是说,遍历器对象本质上就是一个指针对象。
2.第一次调用指针对象的next方法,可以将指针指向数据结构的第一个成员。
3.第二次调用指针对象的next方法,指针就指向数据结构的第二个成员。
4.不断调用指针对象的next方法,直到它指向数据结构的结束位置。
每次调用next方法都会返回数据结构的当前成员信息。具体来说就是返回一个包含value和done两个属性的对象。其中,value属性是当前成员的值,done属性是一个布尔值,表示遍历是否结束。
下面是一个模拟next方法返回值的例子。
let it = makeInterator(['a', 'b'])
function makeInterator(array) {
let nextIndex = 0
return {
next: function () {
return nextIndex < array.length ?
{value: array[nextIndex++], done: false} :
{value: undefined, done: true}
}
}
}
it.next() // {value: 'a', done: false}
it.next() // {value: 'b', done: false}
it.next() // {value: undefined, done: true}
上面的代码定义了一个makeInterator函数,它是一个遍历器生成函数,作用就是返回一个遍历器对象。对数组['a', 'b']执行这个函数,就会返回该数组的遍历器对象(即指针对象)it。
指针对象的next方法用于移动指针。不断调用这个方法就会依次指向数组的成员,next方法返回一个对象,表示当前数据成员的信息。总之,调用指针对象的next方法就可以遍历事先给定的数据结构。
由于Iterator只是把接口规格加到了数据结构上,所以遍历器与所遍历的数据结构实现上是分开的,完全可以写出没有对应数据结构的遍历器对象。
默认Iterator接口
Iterator接口的目的是为所有数据结构提供一种统一的访问机制,即具有Iterator接口的数据都可以被for...of循环。当使用for...of循环遍历某种数据结构时,该循环会自动去寻找Iterator接口。数据结构只要部署了Iterator接口,我们就称这种数据结构为"可遍历"(iterable)的。
ES6规定,默认的Iterator接口部署在数据结构的Symbol.iterator属性,或者说,一个数据结构只要具有Symbol.iterator属性,就可以认为是"可遍历"(iterable)。调用Symbol.iterator方法,我们就会得到当前数据结构默认的遍历器生成函数。Symbol.iterator本身是一个表达式,返回Symbol对象的iterator属性,这是一个预定义好的、类型为Symbol的特殊值,所以要放在方括号中。用for...of遍历数据,实际上就是调用Symbol.iterator属性。
const obj = {
[Symbol.iterator]: function () {
return {
next: function () {
return {
value: 1,
done: true
}
}
}
}
}
上面的代码中,对象obj是可遍历的,因为其具有Symbol.iterator属性。执行这个属性会返回一个遍历器对象。
ES6的有些数据结构原生具备Iterator接口,即不用任何处理就可以被for...of循环遍历。原因在于,这些数据结构原生部署了Symbol.iterator属性,原生具备Iterator接口的数据结构如下:
- Array
- Map
- Set
- String
- 函数的arguments对象
- DOM和NodeList对象
下面的例子是数组的Symbol.iterator属性
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}
其他数据结构(主要是对象)的Iterator接口都需要自己在Symbol.iterator属性上面部署,对象之所以没有默认部署Iterator接口,是因为对象属性的遍历先后顺序是不确定的,需要开发者手动指定。对象部署遍历器并不是很必要,因为这时对象可以用Map替代。
对于类数组的对象(存在数值键名和length属性),部署Iterator接口有一个简便方法,即使用Symbol.iterator方法直接引用数组的Iterator接口。
NodeList.prototype[Symbol.iterator] = Array.prototype[Symbol.iterator]
// 或者
NodeList.prototype[Symbol.iterator] = [].prototype[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
上面代码中因为iterable不是一个类数组对象,所以用Array.prototype的Symbol.iterator方法没有效果。
遍历器就是一个遍历器对象,里面是一个指针方法,不断调用这个方法就会依次指向当前数据结构的所有成员
调用Iterator接口的场合
除了for...of,有一些地方会默认调用Iterator接口(即Symbol.iterator方法)。
解构赋值
对数组和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']
扩展运算符
扩展运算符也会默认调用Iterator接口
let str = 'hello'
[...str] // ['h', 'e', 'l', 'l', 'o']
let arr = ['b', 'c']
console.log(['a', ...arr, 'd'])
// ['a', 'b', 'c', 'd']
只要某个数据结构部署了Iterator接口,就可以将其转为数组。
yield*
yield*后面跟的是一个可遍历的结构,它会调用该结构的遍历器接口。
let generator = function* () {
yield 1;
yield* [2, 3, 4];
yield 5;
}
let 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}
其他场合
由于数组的遍历会调用遍历器接口,所以任何接受数组作为参数的场合其实都调用了遍历器接口。下面是一些例子:
- for...of
- Array.from()
- Map()、Set()、WeakMap()和WeakSet()(比如new Map([['a', 1], ['b', 2]]))
- Promise.all()
- Promise.race()
字符串的Iterator接口
字符串是一个类数组的对象,也具有原生Iterator接口。
let someString = 'hi'
let iterator = someString[Symbol.iterator]()
iterator.next() // {value: 'h', done: false}
iterator.next() // {value: 'i', done: false}
iterator.next() // {value: undefined, done: true}
可以覆盖原生的Symbol.iterator方法达到修改遍历器行为的目的。
Iterator接口与Generator函数
遍历器对象的return()、throw()
遍历器对象除了具有next方法,还可以具有return方法和throw方法。如果自己写遍历器对象生成函数,那么next方法是必须部署的,return方法和throw方法则是可选部署的。
return方法的使用场合是,如果for...of循环提前退出(通常是因为出错或者有break语句或continue语句),就会调用return方法;如果一个对象在完成遍历前需要清理或释放资源,就可以部署return方法。
function readLinesSync (file) {
return {
next() {
return {done: true}
},
return () {
file.close()
return {done: true}
}
}
}
上面代码中遍历器除了部署了next方法还部署了return方法,当循环因为出错或者有break语句或continue语句就会触发return方法。
注意:return方法必须返回一个对象,这是Generator规格决定的。
throw方法主要配合Generator函数使用,一般的遍历器对象用不到这个方法。
for...of循环
一个数据结构只要部署了Symbol.iterator属性,就被视为具有Iterator接口,就可以用for...of循环遍历它的成员。也就是说,for...of循环内部调用的是数据结构的Symbol.iterator方法。
for...of循环可以使用的范围包括数组、Set和Map结构、某些类似数据的对象(比如arguments对象、DOM NodeList对象)、后文的Generator对象以及字符串。
类似数组的对象
不是所有类似数组的对象都具有Iterator接口,一个简便的解决方法就是使用Array.from方法将其转为数组。
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)
}
// 正确
总结:这一篇讲了遍历器,为了解决不同数据结构可以用统一的方法去遍历,如果每种数据结构都需要不同的方法去处理,就会造成代码复杂度上升,大量代码不可复用,不利于维护和开发。解决方案就是在某些数据结构的原型上添加一个Symbol.iterator属性,某些数据结构在用某些方法循环遍历的时候,该循环会自动寻找Iterator接口。
const obj = {
[Symbol.iterator]: function () {
return {
next: function () {
return {
value: 1,
done: true
}
}
}
}
}
上面代码中obj是可遍历的数据结构,具有Iterator接口的数据结构原型上都有一个特殊属性Symbol.iterator,右边的函数是Iterator接口(遍历器生成函数),里面的对象是遍历器对象(指针对象),next方法用于移动指针,指针应该是下标,最里面的对象是成员信息。
内容:遍历器的概念还有遍历器的使用场景以及如何修改遍历器。
网友评论