iterator(遍历器)原理、用法和问题集锦

起因

JavaScript 原有的表示“集合”的数据结构，主要是数组（Array）和对象（Object），ES6 又添加了Map和Set。用户还可以组合使用它们，定义自己的数据结构，比如数组的成员是Map，Map的成员是对象。需要一种统一的接口机制，来处理所有不同的数据结构。

iterator概念

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

iterator原理

（1）创建一个指针对象（也就是内存地址。下例为array[0] ），指向当前数据结构的起始位置。也就是说，遍历器对象本质上，就是一个指针对象。

（2）第一次调用指针对象的next方法，可以将指针指向数据结构的第一个成员。

（3）第二次调用指针对象的next方法，指针就指向数据结构的第二个成员。

（4）不断调用指针对象的next方法，直到它指向数据结构的结束位置。

每一次调用next方法，都会返回数据结构的当前成员的信息。就是返回一个包含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() { // next方法，用来移动指针
      return nextIndex < array.length ?
        {value: array[nextIndex++], done: false} : // done: false可以省略(默认值)
        {value: undefined, done: true}; // value: undefined可以省略(默认值)
    }
  };
}

由于 Iterator 只是把接口规格加到数据结构之上（将数据结构里的数据，放入next方法返回的{value：...，done:...}接口规格中），所以，遍历器与它所遍历的那个数据结构，实际上是分开的，完全可以写出没有对应数据结构的遍历器对象，或者说用遍历器对象模拟出数据结构。下面是一个无限运行的遍历器对象的例子。

var it = idMaker();

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

function idMaker() { //遍历器生成函数idMaker，返回一个遍历器对象（即指针对象）。
                     // 但是并没有对应的数据结构，或者说，遍历器对象自己描述了一个数据结构出来。
  var index = 0;

  return {
    next: function() {
      return {value: index++, done: false};
    }
  };
}

默认的 Iterator 接口

当使用for...of循环遍历某种数据结构时，该循环会自动去寻找 Iterator 接口。

ES6 规定，一个数据结构只要具有Symbol.iterator属性，就可以认为是“可遍历的”（iterable）。Symbol.iterator属性本身是一个函数，就是当前数据结构默认的遍历器生成函数。执行这个函数，就会返回一个遍历器。

const obj = { // obj是可遍历的（iterable），因为具有Symbol.iterator属性。
  [Symbol.iterator] : function () { // Symbol.iterator，它是一个表达式，返回Symbol对象的iterator属性，
                                    //这是一个预定义好的、类型为 Symbol 的特殊值，所以要放在方括号内
    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](); // 返还一个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接口

其他数据结构（主要是对象）的 Iterator 接口，都需要自己在Symbol.iterator属性上面部署，这样才会被for...of循环遍历。

对象（Object）之所以没有默认部署 Iterator 接口，是因为对象的哪个属性先遍历，哪个属性后遍历是不确定的，需要开发者手动指定。本质上，遍历器是一种线性处理，对于任何非线性的数据结构，部署遍历器接口，就等于部署一种线性转换。不过，严格地说，对象部署遍历器接口并不是很必要，因为这时对象实际上被当作 Map 结构使用，ES5 没有 Map 结构，而 ES6 原生提供了。（对象（Object）不可以直接for...of循环，但for...in循环依然可以用来遍历键名。）

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

class RangeIterator {
  constructor(start, stop) {
    this.value = start;
    this.stop = stop;
  }

  [Symbol.iterator]() { return this; } // 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); // 0, 1, 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
          };
        } else {
          return { value: undefined, done: true };
        }
      }
    };
  }
};

/**
*复杂方法
*/
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;   // 更改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; // 给obj对象的next属性赋值
two.next = three;

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

对于类似数组的对象（存在数值键名和length属性），部署 Iterator 接口，有一个简便方法

NodeList.prototype[Symbol.iterator] = Array.prototype[Symbol.iterator];
// 或者
NodeList.prototype[Symbol.iterator] = [][Symbol.iterator]; //Symbol.iterator方法直接引用数组的 Iterator 接口

[...document.querySelectorAll('div')] // 可以执行了

字符串的 Iterator 接口

Set 和 Map 的Iterator 接口

iterator的方法

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

function readLinesSync(file) {
  return {
    [Symbol.iterator]() {
      return {
        next() {
          return { done: false };
        },
        return() { // return方法必须返回一个对象，这是 Generator 规格决定的。
          file.close();
          return { done: true }; 
        }
      };
    },
  };
}

// return使用
for (let line of readLinesSync(fileName)) {
  console.log(line);
  break; // break会执行return方法，关闭这个文件
}

// throw 使用
for (let line of readLinesSync(fileName)) {
  console.log(line);
  throw new Error();  // 会在执行return方法关闭文件之后，再抛出错误。
                      // throw方法主要是配合 Generator 函数使用，一般的遍历器对象用不到这个方法
}

iterator作用

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

利用iterator为原理的场景

（1）解构赋值

对数组和 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'];

（2）扩展运算符（单层级为深拷贝，多层级为浅拷贝）

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

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

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

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

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

let arr = [...iterable];

（3）yield*

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

let generator = function* () {
  yield 1;
  yield* [2,3,4];  // yield* 遍历后面的数组
  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()（比如new Map([['a',1],['b',2]])）
• Promise.all()
• Promise.race()

for...of跟其他遍历比较

1比for循环写法简单

2比foreach相比，中途跳出forEach循环，break命令或return命令都能奏效。

for (var n of fibonacci) {
  if (n > 1000)
    break;   // 跳出循环
  console.log(n);
}

3比for...in

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

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

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

计算生成的数据结构（不同方法遍历后产生不同的数据结构）

有些数据结构是在现有数据结构的基础上，计算生成的。比如，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']

问题集锦

1如果Symbol.iterator方法对应的不是遍历器生成函数（即会返回一个遍历器对象）会怎样？

解释引擎将会报错。

var obj = {};

obj[Symbol.iterator] = () => 1;  // Symbol.iterator方法对应的不是遍历器生成函数

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

 

2普通对象部署数组的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
}

3for...in与for...of的区别。

// 区别1
var arr = ['a', 'b', 'c', 'd'];

for (let a in arr) {
  console.log(a); // 0 1 2 3 for...in循环读取键名
}

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

// 区别2
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"  // 数组的遍历器接口只返回具有数字索引的属性
}

4遍历数据的其他方法？