ES6-Iterator

Posted 2022-11-06

Iterator

介绍

原有的表示集合的数据结构，主要是数组和对象，ES6又添加了Map跟Set，Iterator是一种统一的接口机制，用来处理不同的数据结构

• Iterator是一种接口，为各种不同的数据结构提供统一的访问机制
• 任何数据结构只要部署Iterator接口，就称这种数据结构是可遍历的
• ES6规定，默认的Iterator接口部署在数据结构的Symbol.iterator属性上

 // 数组的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 

作用

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

遍历过程

• 创建一个指针对象，指向当前数据结构的起始位置；也就是说，遍历器对象本质上就是一个指针对象
• 第一次调用指针对象的next方法，可以将指针指向数据结构的第一个成员
• 第二次调用指针对象的next方法，指针就指向数据结构的第二个成员
• 不断调用指针对象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;
    
  ;

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

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

对象（Object）之所以没有默认部署 Iterator 接口，是因为对象的哪个属性先遍历，哪个属性后遍历是不确定的，需要开发者手动指定。本质上，遍历器是一种线性处理，对于任何非线性的数据结构，部署遍历器接口，就等于部署一种线性转换。

一个对象如果要具备可被for...of循环调用的 Iterator 接口，就必须在Symbol.iterator的属性上部署遍历器生成方法

// 是一个类部署 Iterator 接口的写法。Symbol.iterator属性对应一个函数，执行后返回当前对象的遍历器对象
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

// 通过遍历器实现指针结构
// 首先在构造函数的原型链上部署Symbol.iterator方法，调用该方法会返回遍历器对象iterator，调用该对象的next方法，在返回一个值的同时，自动将内部指针移到下一个实例
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

// 另一种添加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 对象是类似数组的对象，本来就具有遍历接口，可以直接遍历
NodeList.prototype[Symbol.iterator] = Array.prototype[Symbol.iterator];
// 或者
NodeList.prototype[Symbol.iterator] = [][Symbol.iterator];

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

// 下面是另一个类似数组的对象调用数组的Symbol.iterator方法的例子
let iterable = 
  0: ‘a‘,
  1: ‘b‘,
  2: ‘c‘,
  length: 3,
  [Symbol.iterator]: Array.prototype[Symbol.iterator]
;
for (let item of iterable) 
  console.log(item); // ‘a‘, ‘b‘, ‘c‘

注: 普通对象部署数组的Symbol.iterator方法，并无效果

let iterable = 
  a: ‘a‘,
  b: ‘b‘,
  c: ‘c‘,
  length: 3,
  [Symbol.iterator]: Array.prototype[Symbol.iterator]
;
for (let item of iterable) 
  console.log(item); // undefined, undefined, undefined

如果Symbol.iterator方法对应的不是遍历器生成函数，解释引擎将会报错

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

调用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 接口的数据结构，转为数组。也就是说，只要某个数据结构部署了 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 

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

1. for...of
2. Array.from()
3. Map(),Set(),WeakMap(),WeakSet()
4. Promise.all()
5. 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 的Symbol.iterator方法被修改了，所以扩展运算符（...）返回的值变成了bye，而字符串本身还是hi
[...str] // ["bye"]
str // "hi"

Iterator接口与Generator函数

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

// Symbol.iterator方法几乎不用部署任何代码，只要用 yield 命令给出每一步的返回值即可
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()

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

---

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

// 函数readLinesSync接受一个文件对象作为参数，返回一个遍历器对象，其中除了next方法，还部署了return方法
function readLinesSync(file) 
  return 
    [Symbol.iterator]() 
      return 
        next() 
          return  done: false ;
        ,
        return() 
          file.close();
          return  done: true ;
        
      ;
    ,
  ;

// 下面的两种情况，都会触发执行return方法
// 输出文件的第一行以后，就会执行return方法，关闭这个文件
for (let line of readLinesSync(fileName)) 
  console.log(line);
  break;


// 会在执行return方法关闭文件之后，再抛出错误
for (let line of readLinesSync(fileName)) 
  console.log(line);
  throw new Error();

注：return方法必须返回一个对象，这是 Generator 规格决定的
throw方法主要是配合 Generator 函数使用，一般的遍历器对象用不到这个方法

for...of循环

• 可以循环数组以及类数组的数据结构
• for...of循环内部调用的是数据结构的Symbol.iterator方法
• 循环允许遍历获得键值

 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
 

• 数组的遍历器接口只返回有数字索引的属性

数组

数组原生具备iterator接口（即默认部署了Symbol.iterator属性），for...of循环本质上就是调用这个接口产生的遍历器

// 空对象obj部署了数组arr的Symbol.iterator属性，结果obj的for...of循环，产生了与arr完全一样的结果
const arr = [‘red‘, ‘green‘, ‘blue‘];

for(let v of arr) 
  console.log(v); // red green blue


const obj = ;
obj[Symbol.iterator] = arr[Symbol.iterator].bind(arr);

for(let v of obj) 
  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
);

javascript 原有的for...in循环，只能获得对象的键名，不能直接获取键值

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"

for...of优点：

• 有着同for...in一样简洁的语法，但没有for...in那些缺点
• 不同于forEach方法，它可以与break，continue，return配合使用
• 提供了遍历器所有数据结构统一操作接口

for...in的缺点

• 数组的键名是数字，但是for...in循环是以字符串作为键名’0’,’1’
• for...in循环不仅遍历数字键名，还会遍历手动添加的其他键，甚至包括原型链上的键
• 某些情况下，for...in循环会以任意顺序遍历键名

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

注：

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

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

计算生成的数据结构

有些数据结构是在现有数据结构的基础上，计算生成的。比如，ES6 的数组、Set、Map 都部署了以下三个方法，调用后都返回遍历器对象:

1. entries() 返回一个遍历器对象，用来遍历[键名, 键值]组成的数组
   对于数组，键名就是索引值；对于 Set，键名与键值相同。Map 结构的 Iterator 接口，默认就是调用entries方法
2. keys() 返回一个遍历器对象，用来遍历所有的键名
3. values() 返回一个遍历器对象，用来遍历所有的键值

这三个方法调用后生成的遍历器对象，所遍历的都是计算生成的数据结构

let arr = [‘a‘, ‘b‘, ‘c‘];
for (let pair of arr.entries()) 
  console.log(pair);

// [0, ‘a‘]
// [1, ‘b‘]
// [2, ‘c‘]

类似数组的对象

类似数组的对象包括好几类:

// 字符串
let str = "hello";

for (let s of str) 
  console.log(s); // h e l l o


// DOM NodeList对象
let paras = document.querySelectorAll("p");

for (let p of paras) 
  p.classList.add("test");


// arguments对象
function printArgs() 
  for (let x of arguments) 
    console.log(x);
  

printArgs(‘a‘, ‘b‘);
// ‘a‘
// ‘b‘

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

for (let x of ‘a\uD83D\uDC0A‘) 
  console.log(x);

// ‘a‘
// ‘\uD83D\uDC0A‘

并不是所有类似数组的对象都具有 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 接口后才能使用。但是，for...in循环依然可以用来遍历键名

let es6 = 
  edition: 6,
  committee: "TC39",
  standard: "ECMA-262"
;

for (let e in es6) 
  console.log(e);

// edition
// committee
// standard

for (let e of es6) 
  console.log(e);

// TypeError: es6[Symbol.iterator] is not a function

一种解决方法是，使用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

与其他遍历语法的比较

以数组为例，JavaScript 提供多种遍历语法。最原始的写法就是for循环

// 这种写法比较麻烦
for (var index = 0; index < myArray.length; index++) 
  console.log(myArray[index]);

因此数组提供内置的forEach方法

// 这种写法的问题在于，无法中途跳出forEach循环，break命令或return命令都不能奏效
myArray.forEach(function (value) 
  console.log(value);
);

for...in循环可以遍历数组的键名

for (var index in myArray) 
  console.log(myArray[index]);

for...in循环的几个缺点：

• 数组的键名是数字，但是for...in循环是以字符串作为键名’0’,’1’
• for...in循环不仅遍历数字键名，还会遍历手动添加的其他键，甚至包括原型链上的键
• 某些情况下，for...in循环会以任意顺序遍历键名

总之，for...in循环主要是为遍历对象而设计的，不适用于遍历数组

for...of循环相比上面几种做法，有一些显著的优点

for (let value of myArray) 
  console.log(value);

• 有着同for...in一样简洁的语法，但没有for...in那些缺点
• 不同于forEach方法，它可以与break，continue，return配合使用
• 提供了遍历器所有数据结构统一操作接口

// 使用 break 语句，跳出for...of循环
// 输出斐波纳契数列小于等于 1000 的项。如果当前项大于 1000，就会使用break语句跳出for...of循环
for (var n of fibonacci) 
  if (n > 1000)
    break;
  console.log(n);