Iterator

Iterator(遍历器)的概念

遍历器(Iterator)是一种接口，为各种不同的数据结构提供统一的访问机制。

Iterator的作用

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

Iterator的遍历过程

1. 创建一个指针对象，指向当前数据结构的起始位置(即遍历器对象本质是一个指针对象)
2. 第一次调用用指针对象的next方法，可以将指针指向数据结构的第一个成员
   • 返回成员格式为包含value和done两个属性的对象。其中value是当前成员的值，done属性是布尔值，标示遍历是否结束。
3. 第二次调用指针对象的next方法，可以将指针指向数据结构的第二个成员
4. 不断调用指针对象的next方法，直到它指向数据结构的结束位置

// 模拟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: function() {
      return nextIndex < array.length ?
        {value: array[nextIndex++], done: false} :
        {value: undefined, done: true};
    }
  };
}

备注:

• 对于遍历器对象来说，done: false和value: undefined属性都是可以省略的
• 在ES6中，有些数据结构原生具备Iterator接口(比如数组)，即不用任何处理，就可以被for...of循环遍历，有些就不行(比如对象)
  • 原生具备Iterator接口的是因为这些数据结构原生部署了Symbol.iterator属性
  • 凡是部署了Symbol.iterator属性的数据结构就称为部署了遍历器接口，调用这个接口就会返回一个遍历器对象

数据结构的默认Iterator接口

• Iterator接口的目的，就是为所有数据结构，提供了一种统一的访问机制，即for...of循环。
• 当使用for...of循环遍历某种数据结构时，该循环会自动去寻找Iterator接口
• ES6规定，默认的Iterator接口部署在数据结构的Symbol.iterator属性，即一个数据结构只要具有Symbol.iterator属性，就可以认为是“可遍历的”（iterable）
• Symbol.iterator本身是一个表达式，返回Symbol对象的iterator属性，这是一个预定义好的、类型为Symbol的特殊值，所以要放在方括号内（请参考Symbol一章）
• 调用Symbol.iterator方法，就会得到当前数据结构默认的遍历器生成函数
• 在ES6中，有三类数据结构原生具备Iterator接口：数组、某些类似数组的对象(arguments和NodeList等)、Set和Map结构

let arr = ['a', 'b', 'c'];
// arr数组具有遍历器接口，部署在arr的Symbol.iterator属性上
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 }

• 原生部署Iterator接口的三类数据结构，不用自己写遍历器生成函数，for...of循环会自动遍历它们
• 其他数据结构（主要是对象）的Iterator接口，都需要自己在Symbol.iterator属性上面部署，这样才会被for...of循环遍历。
• 对象（Object）之所以没有默认部署Iterator接口，是因为对象的哪个属性先遍历，哪个属性后遍历是不确定的
• 本质上，遍历器是一种线性处理，对于任何非线性的数据结构，部署遍历器接口，就等于部署一种线性转换
• 一个对象如果要有可被for...of循环调用的Iterator接口，就必须在Symbol.iterator的属性上部署遍历器生成方法（原型链上的对象具有该方法也可以）

// 类部署Iterator接口的写法。
class RangeIterator{
    constructor(start, stop){
        this.value = start;
        this.stop = stop;
    }
    // Symbol.iterator属性对应一个函数，执行后返回当前对象的遍历器对象
    [Symbol.iterator](){ return this; }
    next(){
        var value = this.value;
        if( value < this.stop ){
            this.value ++;
            return {done: false, value: value };
        } else {
            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
}
// 通过遍历器实现指针结构
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;
            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，undefined
}
// 为对象添加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 };
                }
            }
        }
    }
};
for(o of obj){
    console.log(o); // 依次输出hello、world、undefined
}

• 对于类似数组的对象，部署Iterator接口，使用Symbol.iterator方法直接引用数组的Iterator接口

NodeList.prototype[Symbol.iterator] = Array.prototype[Symbol.iterator];
// 或者
NodeList.prototype[Symbol.iterator] = [][Symbol.iterator];
// 类数组对象调用数组的Symbol.iterator方法
let iterable = {
  0: 'a',
  1: 'b',
  2: 'c',
  length: 3,

};
for (let item of iterable) {
  console.log(item); // 'a', 'b', 'c'
}
// 若没有[Symbol.iterator]属性，则会报错

• 注意普通对象部署数组的Symbol.iterator方法，并无效果
• 如果Symbol.iterator方法对应的不是遍历器生成函数（即会返回一个遍历器对象），解释引擎将会报错。

var obj = {};
obj[Symbol.iterator] = () => 1;
[...obj] // TypeError: obj[Symbol.iterator] is not a function

• 有了遍历器接口，数据结构就可以用for...of循环遍历，也可以使用while循环遍历

var $iterator = ITERABLE[Symbol.iterator]();
var $result = $iterator.next();
while (!$result.done) {
  var x = $result.value;
  // ...
  $result = $iterator.next();
}

调用Iterator接口的场合

一些场合会默认调用Iterator接口（即Symbol.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接口
  • 可以将任何部署了Iterator接口的数据结构，转为数组

var str = 'hello';
[...str]; //  ['h','e','l','l','o']
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()
  • Promise.all()
  • Promise.race()

字符串的Iterator接口

• 字符串是一个类似数组的对象，也原生具有Iterator接口

var someString = "hi";
typeof someString[Symbol.iterator];   // "function"
var iterator = someString[Symbol.iterator]();
iterator.next()  // { value: "h", done: false }
iterator.next()  // { value: "i", done: false }
iterator.next()  // { value: undefined, done: true }

• 可以覆盖原生的Symbol.iterator方法，达到修改遍历器行为的目的

var str = new String("hi");
[...str] // ["h", "i"]
str[Symbol.iterator] = function() {
  return {
    next: function() {
      if (this._first) {
        this._first = false;
        return { value: "bye", done: false };
      } else {
        return { done: true };
      }
    },
    _first: true
  };
};
[...str] // ["bye"]

Iterator接口与Generator函数

• Symbol.iterator方法的最简单实现,使用Generator函数

// 使用generator
var myIterable = {};
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
}

遍历器对象的return()和throw()方法

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

return

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

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 };
                }
            },
            return(){
                console.log('return');
                return { done: true };
            }
        }
    }
};
for(o of obj){
    console.log(o); // 依次输出hello、return
    break;
}

throw

throw方法主要是配合Generator函数使用，一般的遍历器对象用不到这个方法

for...of循环

• for...of循环内部调用的是数据结构的Symbol.iterator方法
• for...of循环可以使用的范围包括数组、Set和Map结构、类数组对象(arguments对象、DOM NodeList对象)、Generator对象、字符串

数组

• 数组原生具备iterator接口，for...of循环本质上就是调用这个接口产生的遍历器

const arr = ['red', 'green', 'blue'];
let iterator  = arr[Symbol.iterator]();
for(let v of arr) {
  console.log(v); // red green blue
}
// 同上for...of方法
for(let v of iterator) {
  console.log(v); // red green blue
}

• for...of循环可以代替数组实例的forEach方法

const arr = ['red', 'green', 'blue'];
arr.forEach(function (element, index) {
  console.log(element); // red green blue
  console.log(index);   // 0 1 2
});

• for...in循环，只能获得对象的键名，不能直接获取键值。ES6提供for...of循环，允许遍历获得键值
  • 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
}

• for...of循环调用遍历器接口，数组的遍历器接口只返回具有数字索引的属性

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

Set和Map结构

Set和Map结构也原生具有Iterator接口，可以直接使用for...of循环

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); // edition: 6;committee: TC39;standard: ECMA-262
}

• 遍历的顺序是按照各个成员被添加进数据结构的顺序
• Set结构遍历时，返回的是一个值，而Map结构遍历时，返回的是一个数组，该数组的两个成员分别为当前Map成员的键名和键值

类似数组的对象

DOM NodeList

//  DOM NodeList对象
let h3s = document.querySelectorAll("h3");
for (let h of h3s) {
   h.style.color = 'red';
}

arguments

// arguments对象
function printArgs() {
  for (let x of arguments) {
    console.log(x);
  }
}
printArgs('a', 'b');

并不是所有的类数组对象都具有iterator接口，因此最简单的方法就是使用Array.from方法将其转换为数组

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);
}

对象

对于普通对象，for...of结构不能直接使用，会报错，必须部署了iterator接口后才能使用。

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

var someObject = {
  edition: 6,
  committee: "TC39",
  standard: "ECMA-262"
};
for (var key of Object.keys(someObject)) {
  console.log(key + ": " + someObject[key]);
}

• 部分特殊对象可以将数组的Symbol.iterator属性直接赋值给其Symbol.iterator属性
• 使用Generator函数将对象重新包装

function* entries(someObject) {
  for (let key of Object.keys(someObject)) {
    yield [key, someObject[key]];
  }
}
for (let [key, value] of entries(someObject)) {
  console.log(key, "->", value);
  //edition -> 6; committee -> TC39;standard -> ECMA-262
}

与其它遍历语法的比较

• for: 比较麻烦
• forEach: 中途无法跳出forEach循环，break或者return命令失效
• for...in:只能遍历数组得到键名,for...in循环主要是为遍历对象而设计
  • 数组的键名是数字，但是for...in循环是以字符串作为键名“0”、“1”、“2”等等
  • for...in循环不仅遍历数字键名，还会遍历手动添加的其他键，甚至包括原型链上的键
  • 某些情况下，for...in循环会以任意顺序遍历键名
• for...of
  • 有着同for...in一样的简洁语法
  • 不同用于forEach方法，它可以与break、continue和return配合使用。
  • 提供了遍历所有数据结构的统一操作接口

参考文献

1. ECMAScript 6 入门