迭代器

迭代器的概念

迭代器就是一种接口，为各种不同的数据结构提供统一的访问机制。任何的数据结构只要部署了Inerator接口，就可以完成遍历操作（即依次处理该数据结构的所有成员），所有的迭代器都有一个next方法，该方法会返回一个对象，表示当前数据成员的信息。这个对象具有value和done两个属性，value属性返回当前位置的成员，done属性是一个布尔值，表示遍历是否结束，即是否还有必要再一次调用next方法。

迭代器的主要作用有三个：

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

迭代器的遍历过程是这样的：

1. 创建一个指针对象，指向当前数据结构的起始位置。
2. 第一次调用指针对象的next方法，可以将指针指向数据结构的第一个成员
3. 第二次调用指针对象的next方法，可以将指针指向数据结构的第二个成员
4. 不断调用指针对象的next方法，直到它指向数据结构的结束位置

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

var it = makeIterator(['1', '2','3']);

it.next() // { value: "1", done: false }
it.next() // { value: "2", done: false }
it.next() // { value: '3', done: false }
it.next() // { value: undefined, done: true}
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};
    }
  };
}

如果是使用TypeScript的写法，迭代器接口(Iterable)、指针对象（Iterator）和next方法返回值的规格如下：

interface Iterable {
  [Symbol.iterator]() : Iterator,
}

interface Iterator {
  next(value?: any) : IterationResult,
}

interface IterationResult {
  value: any,
  done: boolean,
}

默认Iterator接口

一种数据结构只要部署了Iterator接口，我们就称这种数据结构是“可遍历的”，默认的Iterator接口部署在数据结构的Symbol.iterator属性，或者说一个数据结构只要具有Symbol.iterator属性，就可以认为是可遍历的。

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

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

实例(数组的Symbol.iterator属性)

let arr = ['1','2','3'];
let iter = arr[Symbol.iterator]();

iter.next() // { value: "1", done: false }
iter.next() // { value: "2", done: false }
iter.next() // { value: '3', done: false }
iter.next() // { value: undefined, done: true}
iter.next() // { value: undefined, done: true}

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

调用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'];
  

• 扩展运算符

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

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

• 其他场合

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

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

Iterator接口与Generator函数

Symbol.iterator方法的最简单实现，还是使用生成器函数（Generator）

var arr = {};

arr[Symbol.iterator] = function* () {
  yield 1;
  yield 2;
  yield 3;
};

[...arr]   //[1,2,3]

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

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

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

迭代器对象的return(), throw()

迭代器除了有next方法，还可以具有return和throw方法，如果自定义迭代器对象生成函数，那么next方法是必须部署的。

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

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

上面代码中，函数readLinesSync接受一个文件对象作为参数，返回一个遍历器对象，其中除了next方法，还部署了return方法。下面的三种情况，都会触发执行return方法。

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

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

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

上面代码中，情况一输出文件的第一行以后，就会执行return方法，关闭这个文件；情况二输出所有行以后，执行return方法，关闭该文件；情况三会在执行return方法关闭文件之后，再抛出错误。

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