Iterator 和 for...of 循环

作者: 了凡和纤风 | 来源:发表于2019-10-13 16:33 被阅读0次

一、Iterator（遍历器）的概念

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

Iterator 的作用有3个：

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

Iterator 的遍历过程如下:

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

每次调用 next 方法都会返回数据结构的当前成员信息。具体来说就是返回一个包含 value 和 done 两个属性的对象。其中，value 属性时当前成员的值，done 属性时一个布尔值，表示遍历是否结束

模拟 next 方法返回值的例子

var it = makeIterator(['a', 'b'])

function makeIterator(array) {
  var nextIndex = 0
  return {
    next() {
      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}

对于遍历器来说，done: false 和 value: undefined 属性都是可以省略的，因此上面的 makeIterator 函数可以简写成下面的形式

function makeIterator(array) {
  var nextIndex = 0
  return {
    next() {
      return nextIndex < array.length ?
        {value: array[nextIndex++] } :
        { done: true }
    }
  }
}

由于 Iterator 只是把接口规格加到了数据结构上，所以，遍历器与所遍历的数据结构实际上是分开的。

var it = idMaker()

function idMaker() {
  var index = 0
  
  return {
    next() {
      return {value: index++, done: false}
    }
  }
}

it.next().value // '0'
it.next().value // '1'
// ...

遍历器生成函数 idMaker 返回一个遍历器对象(即指针对象)。但是并没有对应的数据结构，或者说，遍历器对象自己描述了一个数据结构。

二、默认 Iterator 接口

当使用 for...of 循环遍历某种数据结构时，该循环会自动去寻找 Iterator 接口。数据结构只要部署了Iterator 接口，我们就称这种数据结构为“可遍历”(iterable) 的。
ES6规定，默认的Iterator接口部署在数据结构的 Symbol.iterator 属性，一个数据结构只要具有 Symbol.iterator 属性，就可以认为是“可遍历的”（iterable）

const obj = {
  [Symbol.itear]() {
    return {
      next() {
        return { value: 1, done: true }
      }
    }
  }
}

所有部署了 Symbol.iterator 属性的数据结构都称为部署了遍历器接口。调用这个接口就会返回一个遍历器对象

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

Array
Map
Set
String
TypeArray
函数的 arguments 对象
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}

arr 具有遍历器接口，部署在 arr 的 Symbol.iterator属性上。所以，调用这个属性就会得到遍历器对象。

对象(Object) 没有部署Iterator 接口，是因为对象属性的遍历先后顺序是不正确的，本质上，遍历器是一种线性处理，对于任何非线性的数据结构，部署遍历器接口就等于部署一种线性转换。严格地说，对象部署遍历器接口并不是很必要，因为这时对象实际上被当作 Map 结构使用，ES5 没有 Map 结构，而 ES6 原生提供了。

一个对象如果要具备可被 for...of 循环调用的 Iterator 接口，就必须再 Symbol.iterator 的属性上部署遍历器生成方法(原型链上的对象具有改方法也可)

类部署 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 }
    }
    return { done: true, value: undefined }
  }
}

function range(start, stop) {
  return new RangeIterator(start, stop)
}

for (var value of range(0, 3)) {
  console.log(value)
}

下面是通过遍历器实现指针结构的例子

function Obj(value) {
  this.value = value
  this.next = null
}

Obj.prototype[Symbol.iterator] = function() {
  var iterator = { next: next }

  var current = this

  function next() {
    if (current) {
      var value = current.value
      current = current.next
      return { done: false, value: value }
    } else {
      return { done: true }
    }
  }
  return iterator
}

var one = new Obj(1)
var two = new Obj(2)
var three = new Obj(3)

one.next = two
two.next = three

for (var i of one) {
  console.log(i) // 1, 2, 3
 }

首先再构造函数的原型链上部署 Symbol.iterator 方法，调用改方法会返回遍历器对象 iterator，调用该对象的 next 方法，在返回一个值的同时自动将内部指针移到下一个实例。

下面是另一个为对象添加 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')] // 可以执行

NodeList 对象是类似数组的对象，本来就具有遍历接口，将它的遍历接口改成数组的 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 方法并无效果。

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

var obj = {}

obj[Symbol.iterator] = () => 1

[...obj] // TypeError: [] is not a function

三、调用 Iterator 接口的场合

有一些场合会默认调用 Iterator 接口（即 Symbol.iterator 方法），除了 for...of 循环还有几个别的场合

1. 解构赋值
对数组和 Set 结构进行结构赋值时，会调用 Symbol.iterator 方法

let set = new Set().add('a').add('b').add('c')

let [x, y] = set
// x = 'a'; b = 'b'

let [first, ...rest] = set
//first = 'a'; rest = ['b', 'c']

2. 扩展运算符

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

var str = 'hello';
[...str] //  ["h", "e", "l", "l", "o"]

这提供了一种简便机制，只要某个数据结构部署了 Iterator 接口，就可以对它使用扩展运算符，将其转为数组

let arr = [...iterable]

3. yield*

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

let generator = function* () {
  yield 1
  yield* [2, 3, 4]
  yield 5
}
var 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}

4. 其他场合
由于数组的遍历会调用遍历器接口，所以任何接受数组作为参数的场合其实都调用了遍历器接口。

for...of
Array.from()
Map()、Set()、WeakMap()、WeakSet()
Promise.all()
Promise.race()

四、字符串的 Iterator 接口

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

var someString = 'hi'
typeof someString[Symbol.iterator]
// 'function'

var iterator = someString[Symbol.iterator]()

iterator.next()
// {value: "h", done: false}
iterator.next()
// {value: "i", done: false}
iterator.next()
// {value: undefined, done: true}

可以覆盖原生的 Symbol.iterator 方法达到修改遍历器行为的目的。

var str = new String('hi');

[...str] // ['h', 'i']

str[Symbol.iterator] = function() {
  return {
    next() {
      if (this._first) {
        this._first = false
        return { value: 'bye', done: false }
      } else {
        return { done: true }
      }
    }, 
    _first: true
  }
};

[...str] // ['bye']
str // 'hi'

上面的代码中，字符串 str 的 Symbol.iterator 方法被修改了，所以扩展运算符(...) 返回的值变成了 bye，而字符串本身还是 hi。

五、Iterator 接口与 Generator 函数

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

var myIterable = {}

myIterable[Symbol.iterator] = function* () {
  yield 1
  yield 2
  yield 3
}
[...myIterable] // [1, 2, 3]

// 或者采用下面的简洁写法

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

for (let x of obj) {
  console.log(x)
}
// hello
// world

Symbol.iterator 方法几乎不用部署任何代码，只要用 yield 命令给出每一步的返回值即可

六、遍历器对象 return()、throw()

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

return 方法的使用场合是，如果 for...of 循环提前退出(常常是因为出错，或者有 break 语句或 continue 语句)，就会调用 return 方法；

function readLinesSync(file) {
  return {
    next() {
      return { done: true }
    },
    return() {
      file.close()
      return { done: true }
    }
  }
}

函数 readLinesSync 接受一个文件对象作为参数，返回一个遍历器对象。

让文件的变量提前返回，这样就会触发执行 return 方法

for (let line of readLinesSync(fileName)) {
  console.log(line)
  break;
}

注意：return 方法必须返回一个对象，这是 Generator 规格决定的

throw 方法主要配合 Generator 函数使用，一般的遍历器对象用不到这个方法。

七、for...of 循环

ES6 引入了 for...of 循环作为遍历所有数据结构的统一方法。for...of 循环内部调用的是数据结构的 Symbol.iterator 方法。
for...of 循环可以使用的范围包括数组、Set 和 Map 结构、某些类似数组的对象（比如 arguments 对象、DOM NodeList 对象）、Generator 对象，以及字符串

7.1、数组

数组原生具备 iterator 接口（即默认部署了 Symbol.iterator 属性），for...of 循环本质上就是调用这个接口产生的遍历器。

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
}

空对象 obj 部署了数组 arr 的 Symbol.iterator 属性，结果 obj 的 for...of 循环产生了与 arr 完全一样的效果

for...of 循环可以代替数组实例的 forEach 方法。

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

let arr = ['a', 'b', 'c', 'd', 'e'];

for (let a in arr) {
  console.log(a) // 0 1 2 3 4
}

for (let a of arr) {
  console.log(a) // a b c d e
}

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

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

let arr = [3, 5, 7]
arr.foo = 'hello'

for (let i in arr) {
  console.log(i) // 0 1 2 foo
}

for (let i of arr) {
  console.log(i) // 3 5 7
}

for...of 循环不会返回数组 arr 的 foo 属性

7.2、Set 和 Map 结构

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

var engines = new Set(['Gecko', 'Trident', '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

上面演示了如何遍历Set结构和Map 结构，值得注意的地方有两个：

遍历的顺序时按照各个成员被添加进数据结构的顺序
Set 结构遍历时返回的是一个值，而 Map 结构遍历时返回的是一个数组，该数组的两个成员分别为当前Map成员的键名和键值

let map = new Map().set('a', 1).set('b', 2)
for(let pair of map) {
  console.log(pair)
}
// ["a", 1]
// ["b", 2]

for (lett [key, value] of map) {
  console.log(key + ': ' + value)
}
// a: 1
// b: 2

7.3、计算生成的数据结构

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

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

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

let arr = ['a', 'b', 'c']
for (let pair of arr.entries()) {
  console.log(pair)
}
// [0, "a"]
// [1, "b"]
// [2, "c"]

7.4、类似数组的结构

类似数组的对象包括好几类。下面是 for...of 循环用于字符串、DOM NodeList 对象 arguments 对象的例子

// 字符串
let str = 'hello'
for (let s of str) {
  console.log(s) // h e l l o
}

// DOM NodeList 对象
let paras = document,querySelectorAll('p')

for(let p of paras) {
  p.classList.add('test')
}

// arguments 对象
function printArgs() {
  for (let x of arguments) {
    console.log(x)
  }
}
printArgs(1, 2, 3)// 1 2 3

对于字符串来说，for...of 循环还有一个特点，就是可以正确识别 32 位 UTF-16 字符。

并不是所有类似数组的对象都具有 Iterator 接口，一个简便的解决方法就是使用 Array.from 方法将其转为数组。

let arrayLike = {
  0: 'a',
  1: 'b',
  length: 2
}

// 报错
for (let x of arrayLike) {
  console.log(x)
}

// 正确
for(let x of Array.from(arrayLike)) {
  console.log(x) // a b
}

7.5、对象

对于普通的对象，for...of 结构不能直接使用，否则会报错，必须部署了 Iterator 接口才能使用。但是，这样的情况下，for...in 循环依然可用于遍历键名

let es6 = {
  edition: 6,
  committee: 'TC39',
  standard: 'ECMA-262'
}

for(let e in es6) {
  console.log(e)
}
// edition
// committee
// standard

for (let e of es6) {
  console.log(e)
}
// TypeError: es6 is not iterable

解决方法是，使用 Object.keys 方法将对象的键名生成一个数组，然后遍历这个数组

for(var key of Object.keys(someObject)) {
  console.log(key + ': ' + someObject[key])
}

另一个方法是使用 Generator 函数将对象重新包装一下。

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)
}

7.6、与其他遍历语法的比较

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

for (var index = 0; index < myArray.length; index++) {
  console.log(myArray[index])
}

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

myArray.forEach( value => {
  console.log(value)
})

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

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

for (var index in myArray) {
  console.log(myArray[index])
}

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

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

总之，for...in 寻魂主要视为遍历对象而设计的，不适合遍历数组

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

for (let value of myArray) {
  console.log(value)
}

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

Iterator 和 for...of 循环

一、Iterator（遍历器）的概念

二、默认 Iterator 接口

三、调用 Iterator 接口的场合

四、字符串的 Iterator 接口

五、Iterator 接口与 Generator 函数

六、遍历器对象 return()、throw()

七、for...of 循环

7.1、数组

7.2、Set 和 Map 结构

7.3、计算生成的数据结构

7.4、类似数组的结构

7.5、对象

7.6、与其他遍历语法的比较

相关文章

网友评论

延伸阅读

深度阅读

栏目导航

热点阅读

Iterator 和 for...of 循环

一、Iterator（遍历器）的概念

二、默认 Iterator 接口

三、调用 Iterator 接口的场合

四、字符串的 Iterator 接口

五、Iterator 接口 与 Generator 函数

六、遍历器对象 return()、throw()

七、for...of 循环

7.1、数组

7.2、Set 和 Map 结构

7.3、计算生成的数据结构

7.4、类似数组的结构

7.5、对象

7.6、与其他遍历语法的比较

相关文章

网友评论

延伸阅读

深度阅读

栏目导航

热点阅读

五、Iterator 接口与 Generator 函数