Iterator(遍历器)

概念

表示"集合"的数据结构,主要是原有的Array和Object,ES6增加的Map和Set.需要一个统一的接口机制来处理所有不同的数据结构
任何数据结构只要部署Iterator接口,就可以完成遍历操作(即依次处理该数据结构的所有成员)
作用主要有三点:

1. 为各种数据结构提供一个统一的,简便的访问接口
2. 使得数据结构的成员能够按照某种次序排列
3. 方便使用for...of使用
   遍历原理主要是创建一个指针对象,指向当前数据结构的起始位置,不断调用指针对象的next方法,每次调用next方法,都会返回数据结构的当前成员的信息.具体来说就是返回一个包含value和done两个属性的对象,其中,value属性是当前成员的值,done属性是一个布尔值,表示遍历是否结束

默认Iterator接口

一个数据结构只要部署了Iterator接口,我们就称这种数据结构是"可遍历的"
ES6规定,默认的Iterator接口部署在数据结构的Symbol.iterator属性,Symbol.iterator熟悉本身就是一个函数,就是当前数据结构默认的遍历器生成函数.执行这个函数,就会返回一个遍历器.至于属性名Symbol.iterator,它是一个表达式,返回Symbol对象的iterator属性,这是一个预定义好的,类型为Symbol的特殊值,所以要放在方括号内

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

ES6的有些数据结构原生具备Iterator接口,即不用任何处理,就可以被for...of循环遍历
原生具备Iterator接口的数据结构如下:

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

下面的例子是数组的Symbol.iterator属性

let arr = ['a', 'b', 'c'];
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接口的数据结构之外,其它数据结构(主要是对象)的Iterator接口,都需要在Symbol.iterator属性上面部署
对象之所以没有默认部署,是因为对象的哪个属性先遍历,哪个属性后遍历是不确定的.本质上,遍历器是一种线性处理,对于任何非线性的数据接口,都必须部署遍历器接口,就等于部署一种线性转换.(对象部署遍历器接口不是很必要,因为此时对象实际上被当做Map结构使用)

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

  [Symbol.iterator]() { return 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
}

下面是为一个对象增加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 };
        }
      }
    };
  }
};

对于类似数组的对象(存在数值键名和length属性),部署Iterator接口,有一个简便方法,就是Symbol.iterator方法直接引用数组的Iterator接口

NodeList.prototype[Symbol.iterator] = Array.prototype[Symbol.iterator];
// 或者
NodeList.prototype[Symbol.iterator] = [][Symbol.iterator];

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

注意,普通对象部署数组的Symbol.iterator方法,并无效果
如果Symbol.iterator方法对应的不是遍历器生成函数,解释引擎将会报错

调用Iterator接口的场合

有一些场合默认调用Iterator接口

1. 解构赋值
   对数组和Set解构进行解构赋值时
2. 拓展运算符
   只要某个数据结构部署了Iterator接口,就可以对它使用拓展运算符,将其转为数组
3. yield*
4. 其它场合
   又要数组的遍历会调用遍历器接口,所以任何接受数组作为参数的场合,其实都调用了遍历器接口
   • for...of
   • Array.from
   • Map,Set,WeakMap,WeakSet
   • Promise.all
   • Promise.race

Iterator接口与Generator函数

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"

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

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

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

注意:return方法必须返回一个对象
throw方法主要配合Generator函数使用,一般的遍历器对象用不到这个方法

for...of循环

概念

引入for...of循环作为遍历所有数据结构的统一方法
JavaScript原有的for...in循环,只能获得对象的键名,不能直接获取键值.ES6提供for...of循环,允许遍历获得键值
for...of循环调用遍历接口,数组的遍历器接口只返回具有数字索引的属性.这一点跟for...in循环不一样

Set和Map结构

遍历Set结构和Map结构,注意的地方有两点:首先,遍历的顺序是按照各个成员被添加进数据结构的顺序.其次,Set结构遍历时,返回的是一个值,而Map结构遍历时,返回的是一个数组

计算生成的数据结构

ES6的数组,Set,Map都部署了以下三个方法,调用后都返回遍历器对象

• entries():遍历器对象用来遍历[键名,键值]组成的数组.对于数组,键名就是索引值;对于Set,键名与键值相同;Map结构的Iterator接口,默认就是调用该方法.
• keys()
• values()

类似数组的对象

对于字符串来说,for...of有一个特点,就是会正确识别32位UTF-16字符
可以使用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方法将对象的键名生成一个数组

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

另一个方法是使用Generator函数将对象重新包装一下

function* entries(obj) {
  for (let key of Object.keys(obj)) {
    yield [key, obj[key]];
  }
}

for (let [key, value] of entries(obj)) {
  console.log(key, '->', value);
}
// a -> 1
// b -> 2
// c -> 3

与其他遍历语法的比较

forEach无法中途跳出循环
for...in有几个缺点:
1.以字符串作为键名"0","1","2"等
2.不仅遍历数组键名,还会遍历手动添加的其他键,甚至包括原型链上的键
3.某些情况下,会以任意顺序遍历键名
for...of有一些显著的优点:
1.没有for...in那些缺点
2.不同于forEach方法,它可以与break,continue,return配合使用
3.提供了遍历所有数据结构的统一操作接口