ES6学习笔记13 Iterator 和 for...of 循环

Iterator接口简介

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

Iterator 的遍历过程：

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

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

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

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

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

下面是模拟next方法返回值的例子

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方法的遍历器对象
    next: function() {  
      return nextIndex < array.length ?
        {value: array[nextIndex++], done: false} :
        {value: undefined, done: true};
    }
  };
}

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

Symbol.iterator属性本身是一个函数，就是当前数据结构默认的遍历器生成函数。执行这个函数，就会返回一个遍历器。至于属性名Symbol.iterator，它是一个表达式，返回Symbol对象的iterator属性，这是一个预定义好的、类型为 Symbol 的特殊值，所以要放在方括号内

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

原生具备了Iterator接口的数据结构有：Array，Map，Set，String，TypedArray，arguments对象，NodeList对象。除此之外，其他数据结构的Iterator接口都需要自己在Symbol.iterator属性上面部署（或原型链上的对象具有该方法也可），这样才会被for…of循环遍历

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

function Obj(value) {
  this.value = value;
  this.next = null;    //用于指向下一个对象
}

Obj.prototype[Symbol.iterator] = function() {   //在原型对象上部署遍历器接口
  var iterator = { next: 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
}

下面为对象部署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 };
        }
      }
    };
  }
};

如果Symbol.iterator方法对应的不是遍历器生成函数（即会返回一个遍历器对象），解释引擎将会报错。有了遍历器接口，数据结构就可以用for...of循环遍历

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

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"

调用Iterator接口的场合

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

（2）扩展运算符
扩展运算符（…）也会调用默认的 Iterator 接口，可以将任何部署了 Iterator 接口的数据结构，转为数组。

（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()

遍历器对象的 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 };
        }
      };
    },
  };
}

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

遍历器的throw方法用于抛出错误，主要配合 Generator 函数内部捕获错误来使用，一般遍历器对象用不到这个方法

for…of 循环

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

还可以使用其遍历计算生成的数据结构，例如keys()，values()，entries()

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

for...of循环还有一个特点，就是会正确识别 32 位 UTF-16 字符。

for (let x of 'a\uD83D\uDC0A') {
  console.log(x);
}
// 'a'
// '\uD83D\uDC0A'

对于没有Iterator接口的类似数组对象结构，可以使用Array.from方法将其转为数组，在使用for...of遍历

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

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

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

对于普通的对象， 可以使用Object.keys()方法将对象的键名生成一个数组，然后再遍历

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

for...of与其他遍历语法比较

• 数组提供内置的forEach方法可以遍历数组的成员，但是该方法中途无法跳出，break和return命令都无法凑效

myArray.forEach(function (value) {
  console.log(value);
});

• for...in可以用来遍历数组和对象的键名，其无法直接遍历键值，对于数组来说，遍历返回的值是索引的字符串形式，例如”1”，”2”，”3”。除此之外其会遍历手动添加的键名以及原型链上的键。在某些情况下，for...in还会以任意顺序遍历键名
-