Iterator 和 for...of 循环

healerhe
106 阅读2分钟

遍历器（Iterator）

（1）Iterator 定义

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

（2）Iterator 作用

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

（3）Iterator 的遍历过程

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

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

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

例：模拟遍历器实现的逻辑

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

it.next() // { value: "a", done: false }
it.next() // { value: "b", done: false }
it.next() // { value: undefined, done: true }

function makeIterator(array) { //作用就是返回一个遍历器对象， 遍历数组，返回遍历数组的指针对象。
  var nextIndex = 0;
  return {
    next: function() {
      return nextIndex < array.length ?
        {value: array[nextIndex++], done: false} :
        {value: undefined, done: true};
    }
  };
}

ES6 规定，默认的 Iterator 接口部署在数据结构的**Symbol.iterator**属性，或者说，一个数据结构只要具有Symbol.iterator属性，就可以认为是“可遍历的”（iterable）。

Symbol.iterator属性本身是一个函数，就是当前数据结构默认的遍历器生成函数。执行这个函数，就会返回一个遍历器。

以下是定义：obj是一个遍历器， 最明显的特征就是它具有next方法。

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

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

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

例：数组采用遍历器遍历。

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 }

（4）调用 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 接口。

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

// 例二
let arr = ['b', 'c'];
['a', ...arr, 'd']
// ['a', 'b', 'c', 'd']

也就是说：可以将任何部署了 Iterator 接口的数据结构，转为数组。也就是说，只要某个数据结构部署了 Iterator 接口，就可以对它使用扩展运算符，将其转为数组。

let arr = [...iterable];

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 }
  • 其他场合

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

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

（5）Iterator 接口与 Generator 函数 

Symbol.iterator方法的最简单实现， 使用Generator，和yield

let myIterable = {
  [Symbol.iterator]: function* () {
    yield 1;
    yield 2;
    yield 3; //yield 命令给出每一步的返回值即可。
  }
}
[...myIterable] // [1, 2, 3]

// 或者采用下面的简洁写法
let obj = {
  * [Symbol.iterator]() {
    yield 'hello';
    yield 'world';
  }
};
for (let x of obj) {
  console.log(x);
}
// "hello"
// "world"

（6）遍历器对象的 return()，throw() 

遍历器对象的方法：

  • next：必选

获取下一个指针指向的值。

  • return：可选，

 如果for...of循环提前退出（通常是因为出错，或者有break语句），就会调用return方法。如果一个对象在完成遍历前，需要清理或释放资源，就可以部署return方法

  • throw： 可选 ，含义待定

    function readLinesSync(file) { return { Symbol.iterator { return { next() { return { done: false }; }, return() { file.close(); return { done: true }; } }; }, }; }

示例：下面两种情况都会触发执行遍历器的result方法

// 情况一
for (let line of readLinesSync(fileName)) {
  console.log(line);
  break;
}

// 情况二
for (let line of readLinesSync(fileName)) {
  console.log(line);
  throw new Error();
}

for...of 循环

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

**for...of**循环内部调用的是数据结构的**Symbol.iterator**方法。

for...of循环可以使用的范围包括数组、Set 和 Map 结构、某些类似数组的对象（比如arguments对象、DOM NodeList 对象）、后文的 Generator 对象，以及字符串。

实例：遍历数组

const arr = ['red', 'green', 'blue'];

for(let v of arr) {
  console.log(v); // red green blue
}

for...in...与for...of...

var arr = ['a', 'b', 'c', 'd'];

for (let a in arr) {
  console.log(a); // 0 1 2 3 获取键名，索引
}

for (let a of arr) {
  console.log(a); // a b c d 获取键值
}

计算生成的数据结构

ES6 的数组、Set、Map 都部署了以下三个方法，调用后都返回遍历器对象。

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

例：获取数组的键值对（索引， 值）

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

类似于数组的对象

字符串、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('a', 'b');
// 'a'
// 'b'

对于非数组的对象，可以通过Array.form()方法转化为具有遍历器属性的数组。

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

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

对象

对于普通的对象，for...of结构不能直接使用（或报错），可以使用for...in遍历

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

let es6 = {
  edition: 6,
  committee: "TC39",
  standard: "ECMA-262"
};
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);
}
// a -> 1
// b -> 2
// c -> 3

与其他遍历语法的比较 

  • 数组提供内置的forEach方法：无法中途跳出forEach循环，break命令或return命令都不能奏效。
  • for...in： 只适合遍历对象， 遍历数组的下标。还会将下标转化为字符串输出。
  • for...of：它可以与break、continue和return配合使用。
avatar
文章
阅读
粉丝