什么是迭代器

• 迭代器（iterator） 是确使用户可在容器对象（container，例如链表或数组）上遍访的对象，使用该接口无需关心对象的内部实现细节。

  • 其行为像数据库中的光标，迭代器最早出现在 1974 年设计的 CLU 编程语言中；
  • 在各种编程语言的实现中，迭代器的实现方式各不相同，但是基本都有迭代器，比如 Java、Python 等；

• 从迭代器的定义我们可以看出来，迭代器是帮助我们对某个数据结构进行遍历的对象。

• 在 JavaScript 中，迭代器也是一个具体的对象，这个对象需要符合迭代器协议（iterator protocol）：

  • 迭代器协议定义了产生一系列值（无论是有限还是无限个）的标准方式；
  • 那么在 js 中这个标准就是一个特定的next方法；

next 方法有如下的要求：

• 一个无参数或者一个参数的函数，返回一个应当拥有以下两个属性的对象：
• done（boolean）
  • 如果迭代器可以产生序列中的下一个值，则为false。（这等价于没有指定done这个属性。）
  • 如果迭代器已将序列迭代完毕，则为true。这种情况下，value是可选的，如果它依然存在，即为迭代结束之后的默认返回值。
• value
  • 迭代器返回的任何JavaScript值。done为true时可省略。

迭代器的代码练习

const friends = ['lilei', 'kobe', 'james'];

let index = 0;
const friendsIterator = {
  next: function () {
    if (index < friends.length) {
      return { done: false, value: friends[index++] };
    } else {
      return { done: true, value: undefined };
    }
  }
};

console.log(friendsIterator.next()); // { done: false, value: 'lilei' }
console.log(friendsIterator.next()); // { done: false, value: 'kobe' }
console.log(friendsIterator.next()); // { done: false, value: 'james' }
console.log(friendsIterator.next()); // { done: true, value: undefined }

但是上面的代码整体来说看起来是有点奇怪的：

• 我们获取一个数组的时候，需要自己创建一个index变量，再创建一个所谓的迭代器对象；
• 事实上我们可以对上面的代码进行进一步的封装，让其变成一个可迭代对象；

什么又是可迭代对象呢？

• 它和迭代器是不同的概念；
• 当一个对象实现了iterable protocol协议时，它就是一个可迭代对象；
• 这个对象的要求是必须实现@@iterator方法，在代码中我们使用Symbol.iterator访问该属性；

我们转成这样的一个东西有什么好处呢？

• 当一个对象变成一个可迭代对象的时候，进行某些迭代操作，比如for...of操作时，其实就会调用它的@@iterator方法；

可迭代对象的代码

const info = {
  friends: ['lilei', 'kobe', 'james'],
  [Symbol.iterator]: function () {
    let index = 0;
    return {
      next: () => {
        if (index < friends.length) {
          return { done: false, value: friends[index++] };
        } else {
          return { done: true, value: undefined };
        }
      }
    };
  }
};

原生迭代器对象

• 事实上我们平时创建的很多原生对象已经实现了可迭代协议，会生成一个迭代器对象的：
  • String、Array、Map、Set、arguments 对象、NodeList 集合；

const str = 'Hello World';
for (const s of str) {
  console.log(s);
}

const arr = ['abc', 'cba', 'nba'];
for (const item of arr) {
  console.log(item);
}

function foo(x, y, z) {
  for (const arg of arguments) {
    console.log(arg);
  }
}
foo(20, 30, 40);

可迭代对象的应用

• 那么这些东西可以被用在哪里呢？
  • JavaScript中语法：for ...of、展开语法（spread syntax）、yield*（生成器）、解构赋值（Destructuring_assignment）；
  • 创建一些对象时：new Map([Iterable])、new WeakMap([iterable])、new Set([iterable])、new WeakSet([iterable]);
  • 一些方法的调用：Promise.all(iterable)、Promise.race(iterable)、Array.from(iterable);

自定义类的迭代

• 在前面我们看到 Array、Set、String、Map 等类创建出来的对象都是可迭代对象：

  • 在面向对象开发中，我们可以通过class定义一个自己的类，这个类可以创建很多的对象：
  • 如果我们也希望自己的类创建出来的对象默认是可迭代的，那么在设计类的时候我们就可以添加上@@iterator方法；

• 案例：创建一个 classroom 的类

  • 教室中有自己的位置、名称、当前教室的学生；
  • 这个教室可以进来新学生（push）；
  • 创建的教室对象是可迭代对象；

自定义类的迭代实现

class ClassRoom {
  constructor(address, name, students) {
    this.address = address;
    this.name = name;
    this.students = students;
  }

  entry(newStudent) {
    this.students.push(newStudent);
  }

  [Symbol.iterator]() {
    let index = 0;
    return {
      next: () => {
        if (index < this.students.length) {
          return { done: false, value: this.students[index++] };
        } else {
          return { done: true, value: undefined };
        }
      }
    };
  }
}

const classroom = new ClassRoom('8号楼102', '计算机教室', ['james', 'kobe', 'curry']);
classroom.entry('frank');

for (const stu of classroom) {
  console.log(stu);
  if (stu == 'curry') break;
}

迭代器的中断

• 迭代器在某些情况下会在没有完全迭代的情况下中断：

  • 比如遍历的过程中通过break、continue、return、throw中断了循环操作；
  • 比如在解构的时候，没有解构所有的值；

• 那么这个时候我们想要监听中断的话，可以添加 return 方法：

[Symbol.iterator]() {
  let index = 0;
  return {
    next: () => {
      if (index < this.students.length) {
        return { done: false, value: this.students[index++] };
      } else {
        return { done: true, value: undefined };
      }
    },
    return: () => { 
      console.log('迭代器提前终止了~'); 
      return { done: true, value: undefined }; 
    } 
  };
}