精通ES6系列一（遍历器iterator）

1.Iterator的概念和作用

       iterator的主要目的是为了给JS中的集合如Array、Map、Set或者自定义的一些集合等提供一种统一的、方便的访问和遍历机制。它其实是一个接口，任何数据结构只要部署了iterator接口就可以进行遍历， ES6 创造了一种新的遍历命令for...of循环，Iterator 接口主要供for...of消费。

Iterator 的遍历过程是这样的。

（1）创建一个指针对象，指向当前数据结构的起始位置。也就是说，遍历器对象本质上，就是一个指针对象。

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

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

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

每一次调用next方法，都会返回数据结构的当前成员的信息。具体来说，就是返回一个包含value和done两个属性的对象。其中，value属性是当前成员的值，done属性是一个布尔值，表示遍历是否结束。实际上我们可以模拟一个iterator生成函数，如下：

function myIterator(array) {
  let index = 0;
  return {
    next: () => {
      let length = array.length;
      if(index < length){
        return {
          value: array[index++],
          done: false,
        }
      }else {
        return {
          value: undefined,
          done: true
        }
      }
    }
  }
}
let arr = new Array(1,2);
let iterator = myIterator(arr);
console.log(iterator.next()); //{ value: 1, done: false }
console.log(iterator.next()); //{ value: 2, done: false }
console.log(iterator.next()); //{ value: undefined, done: true}

 2.默认 Iterator 接口

        Iterator 接口的目的，就是为所有数据结构，提供了一种统一的访问机制，即for...of循环（详见下文）。当使用for...of循环遍历某种数据结构时，该循环会自动去寻找 Iterator 接口。一种数据结构只要部署了 Iterator 接口，我们就称这种数据结构是“可遍历的”（iterable）。ES6 规定，默认的 Iterator 接口部署在数据结构的Symbol.iterator属性，或者说，一个数据结构只要具有Symbol.iterator属性，就可以认为是“可遍历的”（iterable）。Symbol.iterator属性本身是一个函数，就是当前数据结构默认的遍历器生成函数。执行这个函数，就会返回一个遍历器。例如下面这个ob就是可遍历的。

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

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

 

  例如一个String类型：

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

let str = '123';
let strIterator = str[Symbol.iterator](); //Symbol.iterator其实是一个方法,return 一个带next方法的对象。

console.log(strIterator.next()); //{ value: '1', done: false }
console.log(strIterator.next()); //{ value: '2', done: false }
console.log(strIterator.next()); //{ value: '3', done: false }
console.log(strIterator.next()); //{ value: undefined, done: true }

实际上，我们可以对默认的遍历进行修改：

String.prototype[Symbol.iterator] = function() {
  let end = false;
  return {
    next: () => {
      if(!end) {
        end = !end
        return {value: 'myIterator', done: false}
      }else {
        return {value: undefined, done: true}
      }
    }
  }
}
let str = '123';
let strIterator = str[Symbol.iterator]();

console.log(strIterator.next()); //{ value: 'myIterator', done: false }
console.log(strIterator.next()); //{ value: undefined, done: true }

 3.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 对象，以及字符串。其实我们也可以通过给对象添加Symbol.iterator方法来遍历对象，但其实没有必要，因为这样的话，还不如直接使用map。

//Map、Set
var engines = new Set(["Gecko", "Trident", "Webkit", "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);
}

//或者
let map = new Map().set('a', 1).set('b', 2);
for (let pair of map) {
  console.log(pair);
}
// ['a', 1]
// ['b', 2]
for (let [key, value] of map) {
  console.log(key + ' : ' + value);
}
// a : 1
// b : 2

 4.使用Iterator接口的场景

（1）解构赋值

        对数组和set进行解构赋值的时候会默认调用Symbol.iterator方法（注意：只有数组和set）

let set = new Set([ 'a', 'b', 'c' ])
let [x, y] = set;
let [a, ...rest] = set;
console.log(x, y); //a b
console.log(a, rest); //a [b,c]

let arr = [1,2,3];
let [x1,y1] = arr;
console.log(x1, y1); //1 2

（2）扩展运算符 （关于扩展运算符和解构的区别参见这里）

let myarr = [1,2,3];
let newarr = [...myarr,4,5];

console.log(newarr); //[1,2,3,4,5]
console.log(myarr); //[1,2,3]

let set = new Set().add('a').add('b').add('c'); 
let setarr = [...set, 1, 2];

console.log(set); //Set { 'a', 'b', 'c' }
console.log(setarr); //[ 'a', 'b', 'c', 1, 2 ]

实际上，这提供了一种简便机制，可以将任何部署了 Iterator 接口的数据结构，转为数组。也就是说，只要某个数据结构部署了 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()（比如new Map([['a',1],['b',2]])）
• Promise.all()
• Promise.race()

5.使用generator函数实现Symbol.iterator方法

let 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 命令给出每一步的返回值即可。

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

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

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

function readLinesSync(file) {
  return {
    [Symbol.iterator]() {
      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);
  throw new Error();
}

上面代码中，情况一输出文件的第一行以后，就会执行return方法，关闭这个文件；情况二会在执行return方法关闭文件之后，再抛出错误。注意，return方法必须返回一个对象，这是 Generator 规格决定的。

 

 

 

 

 

 

 

 

 

•