Iterator(迭代器)

204 阅读8分钟

携手创作,共同成长!这是我参与「掘金日新计划 · 8 月更文挑战」的第1天,点击查看活动详情

Iterator(迭代器)模式又称Cursor(游标)模式,用于提供一种方法顺序访问一个聚合对象中各个元素, 而又不需暴露该对象的内部表示。

为什么需要Iterator

JavaScript原有的表示'集合'的数据结构,主要是数组(Array)和对象(Object),ES6又添加了MapSet。这样就有了四种数据集合,用户还可以组合使用它们,定义自己的数据结构,比如数组的成员是MapMap的成员是对象。这样就需要一种统一的接口机制来处理所有不同的数据结构。

遍历器(Iterator)  就是这样一种机制。它是一种接口,为各种不同的数据结构提供统一的访问机制。任何数据结构只要部署Iterator接口,就可以完成遍历操作(即依次处理该数据结构的所有成员)。

Iterator的作用

Iterator的作用有三个:

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

Iterator遍历过程

  1. 创建一个指针对象,指向当前数据结构的起始位置。也就是说,遍历器对象本质上就是一个指针对象。
  2. 第一次调用指针对象的next方法,可以将指针指向数据结构的第一个成员。
  3. 第二次调用指针对象的next方法,指针就指向数据结构的第二个成员。
  4. 不断调用指针对象next方法,直到它指向数据结构的结束位置。

每一次调用next方法,都会返回数据结构当前成员信息。

{value:'',done:ture}

value 属性是当前成员的值,done属性是一个布尔值,表示遍历是否结束。

111.png

默认Iterator接口

Iterator接口的目的就是为所有的数据结构提供了一种统一的访问机制,即for...of循环。当使用for...of循环遍历某种数据结构时,该循环会自动寻找Iterator接口。

一种数据结构只要部署了Iterator接口,我们就称这种数据结构是"可遍历的"(iterable)。 ES6规定,默认的Iterator接口部署在数据结构的Symbol.iterator属性,或者说,一个数据结构只要具有Symbol.iterator属性,就可以认为是"可遍历的"(iterable)。Symbol.iterator属性本身是一个函数,就是当数据结构默认的遍历器生成函数。执行这个函数就会返回一个遍历器。至于属性名Symbol.iterator,它是一个表达式,返回Symbol对象的iterator属性,这是一个预定义好的类型为Symbol的特殊值,所以要放在方括号内。

const obj = {
  [Symbol.iterator]:function(){
    return {
      next: function(){
          return {
            value:1,
            done:false
          }
        }
    }
  }
}

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

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

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

数组的Symbol.iterator属性:

111.png

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

调用 Iterator 接口的场合

有一些场合会默认调用Iterator接口(即Symbol.iterator方法),除了下文会介绍的for...of,还有几个别的场合。

解构赋值

对数组和Set结构进行解构赋值时,会默认调用Symbol.iterator方法。

111.png

扩展运算符

扩展运算符(...) 也会调用默认的Iterator接口。

111.png

上面代码的扩展运算符内部就调用Iterator接口。

实际上,这提供了一种简便机制,可以将任何部署了Iterator接口的数据结构,转为数组。也就是说,只要某个数据结构部署了Iterator接口,就可以对它使用扩展运算符,将其转为数组。

yield*

yield*后面跟的是一个可遍历的结构,它会调用该结构的遍历器接口。

111.png

其他场合

由于数组的遍历会调用遍历器接口,所以任何接收数组作为参数的场合,其实都调用了遍历器接口。下面是一些例子。

  • for...of
  • Array.from()
  • Map(),Set(),WeakMap(),WeakSet() (比如new Map([['a',1],['b',2]]))
  • Promise.all()
  • Promise.reace()

字符串的Iterator接口

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

111.png

上面代码中,调用Symbol.iterator方法返回一个遍历器对象,在这个遍历器上可以调用next方法,实现对于字符串的遍历。

Iterator接口与Generator函数

Symbol.iterator方法的最简单实现,还是使用一下Generator函数。

111.png

for...of 循环

ES6借鉴 C++、Java、C# 和Python 语法,引入了for...of循环,作为遍历所有数据结构的统一方法。

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

for...of循环可以使用的范围包括

  • 数组
  • Set
  • Map
  • 类数组对象 arguments/DOM NodeList对象
  • Generator对象
  • String

数组

数组原生具备iterator接口(即默认部署了Symbol.iterator属性),for...of循环本质上就是调用这个接口产生遍历器,可以用下面的代码证明 111.png

上面的代码中,空对象obj部署了数组arr的Symbol.iterator属性,结果obj的for...of循环,产生了与arr完全一样的结果。

Javascript原有的for...in循环,只能获得对象的键名,不能直接获取键值。ES6提供for...of循环,允许遍历获得键值。

111.png

for...of循环调用遍历器接口,数组的遍历器接口只发挥具有数字索引的属性,这点跟for...in循环也不一样。

111.png

Set和Map结构

Set和Map结构 原生具有Itrator接口,可以直接使用for...of循环。

111.png

上面代码演示了如何遍历Set结构和Map结构。值得注意的地方有两个,首先,遍历的顺序是按照各个成员被添加进数据结构的顺序。其次,Set结构遍历时,返回的是一个值,而Map结构遍历时,返回的是一个数组,该数组的两个成员分别为当前Map成员的键名和键值。

111.png

计算生成的数据结构

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

  • entries() 返回一个遍历器对象,用来遍历[键名,键值]组成的数组。对于数组,键名就是索引值;对于Set,键名与键值相同。Map结构的Iterator接口,默认就是调用entries方法.
  • keys() 返回一个遍历器对象,用来遍历所有的键名。
  • values() 返回一个遍历器对象,用来遍历所有的键值。

这三个方法调用后生成的遍历器对象,所遍历的都是计算生成的数据结构。

类似数组的对象包括好几类。

  • 字符串
  • DOM NodeList对象
  • arguments对象

111.png

对象

对于普通的对象,for...of循环不能直接使用,会报错,必须部署了Itrator接口后才能使用。但是,这样情况下,for...in 循环依然可以用来遍历键名。

111.png

上面代码表示,对于普通的对象,for...in循环可以遍历键名,for...of循环会报错。

与其他遍历语法的比较

以数组为例,JavaScript提供多种遍历语法。最原始的写法就是for循环。

111.png

这种写法比较麻烦,因此数组提供内置的forEach方法。

111.png

这种写法的问题在于,无法中途跳出forEach循环,break命令或return命令都不能。

for...in循环可以遍历数组的键名。

111.png

for...in循环有几个缺点:

  • 数组的键名是数字,但是for...in循环是以字符串作为键名'0'、'1'、'2'等等。
  • for...in循环不仅遍历数字的键名,还会遍历手动添加的其他键,甚至包括原型链上的键。
  • 某些情况下,for...in循环会以任意顺序遍历键名。

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

for...of循环相比上面几种做法,有一些显著的优点:

111.png

  • 有着同for...in一样的简洁语法,但是没有for...in那些缺点。
  • 不同于forEach方法,它可以与breakcontinuereturn配合使用。
  • 提供了遍历所有数据结构的统一操作接口。

使用break语句跳出for...of循环的例子:

111.png