迭代器与生成器学习笔记

date
Oct 20, 2021
slug
iterators-and-generators
status
Published
tags
JavaScript
summary
学习迭代器与生成器时的笔记
type
Post

前言

给复习时的自己看,快速回顾

迭代器快速回顾

  1. 迭代器是一个可以由任意对象实现的接口,支持连续获取对象产出的每一个值。
  1. 任何实现Iterable接口的对象都有一个Symbol.iterator属性,这个属性引用默认迭代器。
  1. 默认迭代器就像一个迭代器工厂,也就是一个函数,调用之后会产生一个实现Iterator接口的对象
    1. 这个接口可以通过手动反复调用next()方法来消费,也可以通过原生消费者,比如for-of循环来自动消费。
  1. 迭代器必须通过连续调用next()方法才能连续取得值,这个方法返回一个IteratorObject
  1. 这个对象包含一个done属性和一个value属性。
    1. 前者是一个布尔值,表示是否还有更多值可以访问,后者包含迭代器返回的当前值
自定义迭代器:
class Counter {
  constructor(limit) {
    this.limit = limit;
  }

  // -  Iterable 接口
  [Symbol.iterator]() {
    let count = 1,
        limit = this.limit;

    // - 返回 Iterator(迭代器)
    return {
      next() {
        if (count <= limit) {
          // - 返回 IteratorResult 对象
          return { done: false, value: count++ };
        } else {
          // - 返回 IteratorResult 对象
          return { done: true, value: undefined };
        }
      },
      // - Iterator(迭代器) 返回 迭代器本身
      [Symbol.iterator]() {
          return this
      }
    };
  }
}

let counter = new Counter(3);

for (let i of counter) { console.log(i); }
// 1
// 2
// 3

for (let i of counter) { console.log(i); }
// 1
// 2
// 3

let iter1 = counter[Symbol.iterator]();
let iter2 = iter1[Symbol.iterator]();
console.log(iter1 === iter2);         // true
接收可迭代对象的原生语言特性:
  • for-of循环
  • 数组解构
  • 扩展操作符
  • Array.from()
  • 创建集合
  • 创建映射
  • Promise.all()接收由期约组成的可迭代对象
  • Promise.race()接收由期约组成的可迭代对象
  • yield*操作符,在生成器中使用
这些原生语言结构会在后台调用提供的可迭代对象的这个工厂函数(也就是Symbol.iterator),从而创建一个迭代器:
let arr = ['foo', 'bar', 'baz'];

// for-of循环
for (let el of arr) {
  console.log(el);
}
// foo
// bar
// baz

// 数组解构
let [a, b, c] = arr;
console.log(a, b, c); // foo, bar, baz

// 扩展操作符
let arr2 = [...arr];
console.log(arr2); // ['foo', 'bar', 'baz']

// Array.from()
let arr3 = Array.from(arr);
console.log(arr3); // ['foo', 'bar', 'baz']

// Set构造函数
let set = new Set(arr);
console.log(set); // Set(3) {'foo', 'bar', 'baz'}

// Map构造函数
let pairs = arr.map((x, i) => [x, i]);
console.log(pairs); // [['foo', 0], ['bar', 1], ['baz', 2]]
let map = new Map(pairs);
console.log(map); // Map(3) { 'foo'=>0, 'bar'=>1, 'baz'=>2 }

生成器快速回顾

  1. 生成器是一种特殊的函数,调用之后会返回一个生成器对象。
  1. 生成器对象实现了Iterable接口,因此可用在任何消费可迭代对象的地方。
  1. 生成器的独特之处在于支持yield关键字,这个关键字能够暂停执行生成器函数
  1. 使用yield关键字还可以通过next()方法接收输入和产生输出。
  1. 在加上星号之后,yield关键字可以将跟在它后面的可迭代对象序列化为一连串值(让权执行另一个迭代器)。
表现形式:
function* generatorFn() {
  yield 1;
  yield 2;
  yield 3;
}

for (const x of generatorFn()) {
  console.log(x);
}
// 1
// 2
// 3

迭代器

What

迭代器模式和迭代协议是什么?

  1. 迭代器模式是什么?
    1. 迭代器模式是GoF设计模式中的一种行为型模式,提供一个对象来顺序访问聚合对象中的一系列数据,而不暴露聚合对象的内部表示。
      在这里(ECMAScript)的具体表现为分离Iterable(可迭代对象)和Iterator(迭代器)
      迭代器无须了解与其关联的可迭代对象的结构,只需要知道如何取得连续的值(下一个值)
  1. 迭代协议是什么?
    1. ECMAScript 2015 的一组补充规范,迭代协议并不是新的内置实现或语法,而是协议。这些协议可以被任何遵循某些约定的对象来实现。
      迭代协议具体分为两个协议:可迭代协议迭代器协议

可迭代对象/iterable 是什么?

把满足特定条件的结构称为“可迭代对象”(iterable),例如数组或集合这样的集合类型的对象,也可以是自定义的对象。
// 数组的元素是有限的
// 递增索引可以按序访问每个元素
let arr = [3, 1, 4];

// 集合的元素是有限的
// 可以按插入顺序访问每个元素
let set = new Set().add(3).add(1).add(4);
特定的条件有两个:
  1. 实现了正式的Iterable接口
  1. 实现的Iterable接口可以通过迭代器Iterator迭代

可迭代协议 与 Iterable 接口 是什么?

  1. 可迭代协议是什么?
    1. 可迭代协议并不是新的内置实现或语法,而是协议,这个协议可以被任何遵循某些约定的对象来实现,当某个对象实现了Iterable接口可以视为实现了可迭代协议。
  1. Iterable接口是什么?
    1. Iterable接口指的是对象上使用Symbol.iterator作为键的一个属性,这个属性是一个迭代器工厂函数,调用这个工厂函数必须返回一个新迭代器

迭代器协议 与 Iterator(迭代器) 是什么?

  1. 迭代器协议 是什么?
    1. 迭代器协议定义了产生一系列值(无论是有限个还是无限个)的标准方式。当值为有限个时,所有的值都被迭代完毕后,则会返回一个默认返回值。
      实现了Iterator就相当于实现了迭代器协议。
  1. Iterator(迭代器) 是什么?
    1. 其实就是指一个对象,这个对象包含着next()return()(可选)两个方法。 调用Iterable(可迭代协议接口)返回Iterator(迭代器),这是一种一次性使用的对象,用于迭代,其上有两个方法:

IteratorResult对象 是什么?

包含以下两个属性的对象:
例子
// 可迭代对象
let arr = ['foo', 'bar'];

// 迭代器工厂函数
console.log(arr[Symbol.iterator]); // f values() { [native code] }

// 迭代器
let iter = arr[Symbol.iterator]();
console.log(iter); // ArrayIterator {}

// 执行迭代
console.log(iter.next()); // { done: false, value: 'foo' }
console.log(iter.next()); // { done: false, value: 'bar' }
console.log(iter.next()); // { done: true, value: undefined }

提前终止迭代器与return() 分别是什么?

  1. 提前终止迭代器是什么?
    1. 讲的是当迭代器还能继续迭代但是需要提前退出迭代的一种情况
      执行迭代的结构在想让迭代器知道它不想遍历到可迭代对象耗尽时,就可以“关闭”迭代器
      可能的情况包括:
      • for-of循环通过breakcontinuereturnthrow提前退出
      • 解构操作没有用到全部的值
  1. return()是什么?
    1. Iterator(迭代器)上的一个可选方法,用于指定在迭代器提前关闭时执行的逻辑
      内置语言结构在发现还有更多值可以迭代,但不会消费这些值时,会自动调用return()方法
      return()方法必须返回一个有效的IteratorResult对象,简单的情况下,可以只返回{ done: true }
例子
class Counter {
  constructor(limit) {
    this.limit = limit;
  }

  [Symbol.iterator]() {
    let count = 1,
      limit = this.limit;
    return {
      next() {
        if (count <= limit) {
          return { done: false, value: count++ };
        } else {
          return { done: true };
        }
      },
      return() {
        console.log('Exiting early');
        return { done: true };
      }
    };
  }
}


let counter1 = new Counter(5);

for (let i of counter1) {
  if (i > 2) {
    break;
  }
  console.log(i);
}
// 1
// 2
// Exiting early


let counter2 = new Counter(5);

try {
  for (let i of counter2) {
    if (i > 2) {
      throw 'err';
    }
    console.log(i);
  }
} catch(e) {}
// 1
// 2
// Exiting early


let counter3 = new Counter(5);

let [a, b] = counter3;
// Exiting early
补充
  1. 如果迭代器没有关闭,则还可以继续从上次离开的地方继续迭代
  1. 不是所有迭代器都是可关闭的,仅仅给一个不可关闭的迭代器增加return()方法并不能让它变成可关闭的
    1. 这是因为调用return()不会强制迭代器进入关闭状态,即便如此,return()方法还是会被调用
例子1:
// - 继续执行未关闭的迭代器
let a = [1, 2, 3, 4, 5];
let iter = a[Symbol.iterator]();

for (let i of iter) {
  console.log(i);
  if (i > 2) {
    break
  }
}
// 1
// 2
// 3

for (let i of iter) {
  console.log(i);
}
// 4
// 5
例子2:
// - 尝试关闭数组的迭代器,失败
let a = [1, 2, 3, 4, 5];
let iter = a[Symbol.iterator]();

iter.return = function() {
  console.log('Exiting early');
  return { done: true };
};

for (let i of iter) {
  console.log(i);
  if (i > 2) {
    break
  }
}
// 1
// 2
// 3
// 提前退出

for (let i of iter) {
  console.log(i);
}
// 4
// 5

其他

  1. 每个迭代器都表示对可迭代对象的一次性有序遍历
    1. 不同迭代器的实例相互之间没有联系,只会独立地遍历可迭代对象
      let arr = ['foo', 'bar'];
      let iter1 = arr[Symbol.iterator]();
      let iter2 = arr[Symbol.iterator]();
      
      console.log(iter1.next()); // { done: false, value: 'foo' }
      console.log(iter2.next()); // { done: false, value: 'foo' }
      console.log(iter2.next()); // { done: false, value: 'bar' }
      console.log(iter1.next()); // { done: false, value: 'bar' }
  1. 如果对象原型链上的父类实现了Iterable接口,那这个对象也就实现了这个接口
    1. class FooArray extends Array {}
      let fooArr = new FooArray('foo', 'bar', 'baz');
      
      for (let el of fooArr) {
        console.log(el);
      }
      // foo
      // bar
      // baz

How

自定义迭代器

要点:
  1. [Symbol.iterator]是一个工厂函数,要实现闭包
  1. iterator(迭代器)也要实现Iterable[Symbol.iterator])接口
class Counter {
  constructor(limit) {
    this.limit = limit;
  }

  [Symbol.iterator]() {
    let count = 1,
        limit = this.limit;

    return {
      next() {
        if (count <= limit) {
          return { done: false, value: count++ };
        } else {
          return { done: true, value: undefined };
        }
      },
      [Symbol.iterator]() {
          return this
      }
    };
  }
}

let counter = new Counter(3);

for (let i of counter) { console.log(i); }
// 1
// 2
// 3

for (let i of counter) { console.log(i); }
// 1
// 2
// 3

let iter1 = counter[Symbol.iterator]();
let iter2 = iter1[Symbol.iterator]();
console.log(iter1 === iter2);         // true

一些实现了Iterable接口的内置类型

  • 字符串
  • 数组
  • 映射
  • 集合
  • TypedArray
  • arguments对象
  • NodeList等DOM集合类型

迭代器的应用

使用迭代器遍历二维数组并转换成一维数组

function* iterArr(arr) {            //迭代器返回一个迭代器对象
  if (Array.isArray(arr)) {         // 内节点
      for(let i=0; i < arr.length; i++) {
          yield* iterArr(arr[i]);   // (*)递归
      }
  } else {                          // 离开
      yield arr;
  }
}
// 使用 for-of 遍历:
var arr = ['a', ['b', 'c'], ['d', 'e']];
for(var x of iterArr(arr)) {
        console.log(x);               // a  b  c  d  e
 }

// 或者直接将迭代器展开:
var arr = [ 'a', ['b',[ 'c', ['d', 'e']]]];
var gen = iterArr(arr);
arr = [...gen];                        // ["a", "b", "c", "d", "e"]

生成器

What

什么是生成器?

  1. 生成器能做什么?
    1. 拥有在一个函数块内暂停和恢复代码执行的能力,使用生成器可以自定义迭代器和实现协程。
  1. 怎么创建生成器?
    1. 生成器的形式是一个函数,函数名称前面加一个星号(*)表示它是一个生成器,可以给生成器传参
      只要是可以定义函数的地方,就可以定义生成器。
      // 生成器函数声明
      function* generatorFn() {}
      
      // 生成器函数表达式
      let generatorFn = function* () {}
      
      // 作为对象字面量方法的生成器函数
      let foo = {
        * generatorFn() {}
      }
      
      // 作为类实例方法的生成器函数
      class Foo {
        * generatorFn() {}
      }
      
      // 作为类静态方法的生成器函数
      class Bar {
        static * generatorFn() {}
      }
  1. 什么是生成器对象?
    1. 调用生成器函数会产生一个生成器对象,生成器对象一开始处于暂停执行(suspended)的状态
      生成器对象也实现了Iterator接口,因此具有next()方法,调用这个方法会让生成器开始或恢复执行。

yield关键字有什么用?

yield是生成器中才能使用的一个关键字,有五个作用:
  1. 暂停:yield关键字可以让生成器暂停执行
  1. 输出:通过yield返回数据(调用next()返回的数据)
  1. 输入:通过yield获取next()传入的数据
  1. 序列化:通过yield*将可迭代对象序列化为一连串值
  1. 让步:通过yield*将执行权移交给另一个生成器

暂停:让生成器停止执行

yield让生成器进入暂停状态,只能通过调用next()恢复执行
通过yield关键字退出的生成器函数会处在done: false状态;
通过return关键字退出的生成器函数会处于done: true状态。
function* generatorFn() {
  yield;
}

let generatorObject = generatorFn();

console.log(generatorObject.next());  // { done: false, value: undefined }
console.log(generatorObject.next());  // { done: true, value: undefined }

输出:通过yield返回数据

function* generatorFn() {
  yield 'foo';
  yield 'bar';
  return 'baz';
}

let generatorObject = generatorFn();

console.log(generatorObject.next());  // { done: false, value: 'foo' }
console.log(generatorObject.next());  // { done: false, value: 'bar' }
console.log(generatorObject.next());  // { done: true, value: 'baz' }

输入:作为函数的中间参数使用

上一次让生成器函数暂停的yield关键字会接收到传给next()方法的第一个值。这里有个地方不太好理解——第一次调用next()传入的值不会被使用,因为这一次调用是为了开始执行生成器函数:
function* generatorFn(initial) {
  console.log(initial);
  console.log(yield);
  console.log(yield);
}

let generatorObject = generatorFn('foo');

generatorObject.next('bar');  // foo
generatorObject.next('baz');  // baz
generatorObject.next('qux');  // qu

序列化:通过yield*将可迭代对象序列化为一连串值

// 等价的generatorFn:
// function* generatorFn() {
//   for (const x of [1, 2, 3]) {
//     yield x;
//   }
// }
function* generatorFn() {
  yield* [1, 2, 3];
}

let generatorObject = generatorFn();

for (const x of generatorFn()) {
  console.log(x);
}
// 1
// 2
// 3
与生成器函数的星号类似,yield星号两侧的空格不影响其行为:
function* generatorFn() {
  yield* [1, 2];
  yield *[3, 4];
  yield * [5, 6];
}

for (const x of generatorFn()) {
  console.log(x);
}
// 1
// 2
// 3
// 4
// 5
// 6
因为yield*实际上只是将一个可迭代对象序列化为一连串可以单独产出的值,所以这跟把yield放到一个循环里没什么不同。下面两个生成器函数的行为是等价的:
function* generatorFnA() {
  for (const x of [1, 2, 3]) {
    yield x;
  }
}

for (const x of generatorFnA()) {
  console.log(x);
}
// 1
// 2
// 3

function* generatorFnB() {
  yield* [1, 2, 3];
}

for (const x of generatorFnB()) {
  console.log(x);
}
// 1
// 2
// 3
yield*的值是关联迭代器返回done: true时的value属性。对于普通迭代器来说,这个值是undefined
function* generatorFn() {
  console.log('iter value:', yield* [1, 2, 3]);
}

for (const x of generatorFn()) {
  console.log('value:', x);
}
// value: 1
// value: 2
// value: 3
// iter value: undefined
对于生成器函数产生的迭代器来说,这个值就是生成器函数返回的值:
function* innerGeneratorFn() {
  yield 'foo';
  return 'bar';
}
function* outerGeneratorFn(genObj) {
  console.log('iter value:', yield* innerGeneratorFn());
}

for (const x of outerGeneratorFn()) {
  console.log('value:', x);
}
// value: foo
// iter value: bar

让步:通过yield*将执行权移交给另一个生成器

function* anotherGenerator(i) {
  yield i + 1;
  yield i + 2;
  yield i + 3;
}

function* generator(i){
  yield i;
  yield* anotherGenerator(i);// 移交执行权
  yield i + 10;
}

var gen = generator(10);

console.log(gen.next().value); // 10
console.log(gen.next().value); // 11
console.log(gen.next().value); // 12
console.log(gen.next().value); // 13
console.log(gen.next().value); // 20

补充

  1. yield关键字可以同时用于输入和输出,如下例所示:
    1. // example1
      function* generatorFn() {
        return yield 'foo';
      }
      
      let generatorObject = generatorFn();
      
      console.log(generatorObject.next());       // { done: false, value: 'foo' }
      console.log(generatorObject.next('bar'));  // { done: true, value: 'bar' }
      
      // example2
      function *createIterator() {
          let first = yield 1;
          let second = yield first + 2; // 4 + 2
                                        // first =4 是next(4)将参数赋给上一条的
          yield second + 3;             // 5 + 3
      }
      
      let iterator = createIterator();
      
      console.log(iterator.next());    // "{ value: 1, done: false }"
      console.log(iterator.next(4));   // "{ value: 6, done: false }"
      console.log(iterator.next(5));   // "{ value: 8, done: false }"
      console.log(iterator.next());    // "{ value: undefined, done: true }"
      因为函数必须对整个表达式求值才能确定要返回的值,所以它在遇到yield关键字时暂停执行并计算出要产生的值:"foo"。下一次调用next()传入了"bar",作为交给同一个yield的值。然后这个值被确定为本次生成器函数要返回的值。
  1. 生成器函数内部的执行流程会针对每个生成器对象区分作用域
    1. function* generatorFn() {
        yield 'foo';
        yield 'bar';
        return 'baz';
      }
      
      let generatorObject1 = generatorFn();
      let generatorObject2 = generatorFn();
      
      
      console.log(generatorObject1.next()); // { done: false, value: 'foo' }
      console.log(generatorObject2.next()); // { done: false, value: 'foo' }
      console.log(generatorObject2.next()); // { done: false, value: 'bar' }
      console.log(generatorObject1.next()); // { done: false, value: 'bar' }
  1. yield关键字只能在生成器函数内部使用,用在其他地方会抛出错误
    1. 类似函数的return关键字,yield关键字必须直接位于生成器函数定义中,出现在嵌套的非生成器函数中会抛出语法错误
      // 有效
      function* validGeneratorFn() {
        yield;
      }
      
      // 无效
      function* invalidGeneratorFnA() {
        function a() {
          yield;
        }
      }
      
      // 无效
      function* invalidGeneratorFnB() {
        const b = () => {
          yield;
        }
      }
      
      // 无效
      function* invalidGeneratorFnC() {
        (() => {
          yield;
        })();
      }
  1. 检查是否存在默认迭代器属性
    1. let num = 1;
      let obj = {};
      
      // 这两种类型没有实现迭代器工厂函数
      console.log(num[Symbol.iterator]); // undefined
      console.log(obj[Symbol.iterator]); // undefined
      
      let str = 'abc';
      let arr = ['a', 'b', 'c'];
      let map = new Map().set('a', 1).set('b', 2).set('c', 3);
      let set = new Set().add('a').add('b').add('c');
      let els = document.querySelectorAll('div');
      
      // 这些类型都实现了迭代器工厂函数
      console.log(str[Symbol.iterator]); // f values() { [native code] }
      console.log(arr[Symbol.iterator]); // f values() { [native code] }
      console.log(map[Symbol.iterator]); // f values() { [native code] }
      console.log(set[Symbol.iterator]); // f values() { [native code] }
      console.log(els[Symbol.iterator]); // f values() { [native code] }
      
      // 调用这个工厂函数会生成一个迭代器
      console.log(str[Symbol.iterator]()); // StringIterator {}
      console.log(arr[Symbol.iterator]()); // ArrayIterator {}
      console.log(map[Symbol.iterator]()); // MapIterator {}
      console.log(set[Symbol.iterator]()); // SetIterator {}
      console.log(els[Symbol.iterator]()); // ArrayIterator {}

提前终止生成器

与迭代器类似,生成器也支持“可关闭”的概念。一个实现Iterator接口的对象一定有next()方法,还有一个可选的return()方法用于提前终止迭代器。生成器对象除了有这两个方法,还有第三个方法:throw()
function* generatorFn() {}

const g = generatorFn();

console.log(g);         // generatorFn {<suspended>}
console.log(g.next);    // f next() { [native code] }
console.log(g.return);  // f return() { [native code] }
console.log(g.throw);   // f throw() { [native code] }
return()throw()方法都可以用于强制生成器进入关闭状态。
  1. return()
    1. return()方法会强制生成器进入关闭状态。提供给return()方法的值,就是终止迭代器对象的值:
      function* generatorFn() {
        for (const x of [1, 2, 3]) {
          yield x;
        }
      }
      
      const g = generatorFn();
      
      console.log(g);            // generatorFn {<suspended>}
      console.log(g.return(4));  // { done: true, value: 4 }
      console.log(g);            // generatorFn {<closed>}
      与迭代器不同,所有生成器对象都有return()方法,只要通过它进入关闭状态,就无法恢复了。后续调用next()会显示done: true状态,而提供的任何返回值都不会被存储或传播:
      function* generatorFn() {
        for (const x of [1, 2, 3]) {
          yield x;
        }
      }
      
      const g = generatorFn();
      
      console.log(g.next());     // { done: false, value: 1 }
      console.log(g.return(4));  // { done: true, value: 4 }
      console.log(g.next());     // { done: true, value: undefined }
      console.log(g.next());     // { done: true, value: undefined }
      console.log(g.next());     // { done: true, value: undefined }
      for-of循环等内置语言结构会忽略状态为done: trueIteratorObject内部返回的值。
      function* generatorFn() {
        for (const x of [1, 2, 3]) {
          yield x;
        }
      }
      
      const g = generatorFn();
      
      for (const x of g) {
        if (x > 1) {
          g.return(4);
        }
        console.log(x);
      }
      // 1
      // 2
  1. throw()
    1. throw()方法会在暂停的时候将一个提供的错误注入到生成器对象中。如果错误未被处理,生成器就会关闭:
      function* generatorFn() {
        for (const x of [1, 2, 3]) {
          yield x;
        }
      }
      
      const g = generatorFn();
      
      console.log(g);   // generatorFn {<suspended>}
      try {
        g.throw('foo');
      } catch (e) {
        console.log(e); // foo
      }
      console.log(g);   // generatorFn {<closed>}
      不过,假如生成器函数内部处理了这个错误,那么生成器就不会关闭,而且还可以恢复执行。错误处理会跳过对应的yield,因此在这个例子中会跳过一个值。比如:
      function* generatorFn() {
        for (const x of [1, 2, 3]) {
          try {
            yield x;
          } catch(e) {}
        }
      }
      
      const g = generatorFn();
      
      console.log(g.next()); // { done: false, value: 1}
      g.throw('foo');
      console.log(g.next()); // { done: false, value: 3}
      在这个例子中,生成器在try/catch块中的yield关键字处暂停执行。在暂停期间,throw()方法向生成器对象内部注入了一个错误:字符串"foo"。这个错误会被yield关键字抛出。因为错误是在生成器的try/catch块中抛出的,所以仍然在生成器内部被捕获。可是,由于yield抛出了那个错误,生成器就不会再产出值2。此时,生成器函数继续执行,在下一次迭代再次遇到yield关键字时产出了值3
      注意 如果生成器对象还没有开始执行,那么调用throw()抛出的错误不会在函数内部被捕获,因为这相当于在函数块外部抛出了错误。

How

实践

生成器对象作为可迭代对象

在生成器对象上显式调用next()方法的用处并不大。其实,如果把生成器对象当成可迭代对象,那么使用起来会更方便:
function* generatorFn() {
  yield 1;
  yield 2;
  yield 3;
}

for (const x of generatorFn()) {
  console.log(x);
}
// 1
// 2
// 3

使用yield*实现递归算法

yield*最有用的地方是实现递归操作,此时生成器可以产生自身。看下面的例子:
function* nTimes(n) {
  if (n > 0) {
    yield* nTimes(n - 1);
    yield n - 1;
  }
}

for (const x of nTimes(3)) {
  console.log(x);
}
// 0
// 1
// 2

应用

生成器作为默认迭代器

因为生成器对象实现了Iterable接口,而且生成器函数和默认迭代器被调用之后都产生迭代器,所以生成器格外适合作为默认迭代器。下面是一个简单的例子,这个类的默认迭代器可以用一行代码产出类的内容:
class Foo {
  constructor() {
    this.values = [1, 2, 3];
  }
  * [Symbol.iterator]() {
    yield* this.values;
  }
}

const f = new Foo();
for (const x of f) {
  console.log(x);
}
// 1
// 2
// 3
这里,for-of循环调用了默认迭代器(它恰好又是一个生成器函数)并产生了一个生成器对象。这个生成器对象是可迭代的,所以完全可以在迭代中使用。

无穷计数生成器函数

function* generatorFn() {
  for (let i = 0;;++i) {
    yield i;
  }
}

let generatorObject = generatorFn();

console.log(generatorObject.next().value);  // 0
console.log(generatorObject.next().value);  // 1
console.log(generatorObject.next().value);  // 2
console.log(generatorObject.next().value);  // 3
console.log(generatorObject.next().value);  // 4
console.log(generatorObject.next().value);  // 5

实现范围和填充数组

function* range(start, end) {
  while(end > start) {
    yield start++;
  }
}

for (const x of range(4, 7)) {
  console.log(x);
}
// 4
// 5
// 6

function* zeroes(n) {
  while(n--) {
    yield 0;
  }
}

console.log(Array.from(zeroes(8))); // [0, 0, 0, 0, 0, 0, 0, 0]

递归遍历图

在这个例子中,每个生成器首先都会从新创建的生成器对象产出每个值,然后再产出一个整数。结果就是生成器函数会递归地减少计数器值,并实例化另一个生成器对象。从最顶层来看,这就相当于创建一个可迭代对象并返回递增的整数。
使用递归生成器结构和yield*可以优雅地表达递归算法。下面是一个图的实现,用于生成一个随机的双向图:
class Node {
  constructor(id) {
    this.id = id;
    this.neighbors = new Set();
  }

  connect(node) {
    if (node !== this) {
      this.neighbors.add(node);
      node.neighbors.add(this);
    }
  }
}

class RandomGraph {
  constructor(size) {
    this.nodes = new Set();

    // 创建节点
    for (let i = 0; i < size; ++i) {
      this.nodes.add(new Node(i));
    }

    // 随机连接节点
    const threshold = 1 / size;
    for (const x of this.nodes) {
      for (const y of this.nodes) {
        if (Math.random() < threshold) {
          x.connect(y);
        }
      }
    }
  }

  // 这个方法仅用于调试
  print() {
    for (const node of this.nodes) {
      const ids = [...node.neighbors]
                      .map((n) => n.id)
                      .join(',');

      console.log(`${node.id}: ${ids}`);
    }
  }
}

const g = new RandomGraph(6);

g.print();
// 示例输出:
// 0: 2,3,5
// 1: 2,3,4,5
// 2: 1,3
// 3: 0,1,2,4
// 4: 2,3
// 5: 0,4
图数据结构非常适合递归遍历,而递归生成器恰好非常合用。为此,生成器函数必须接收一个可迭代对象,产出该对象中的每一个值,并且对每个值进行递归。这个实现可以用来测试某个图是否连通,即是否没有不可到达的节点。只要从一个节点开始,然后尽力访问每个节点就可以了。结果就得到了一个非常简洁的深度优先遍历:
class Node {
  constructor(id) {
    ...
  }

  connect(node) {
    ...
  }
}

class RandomGraph {
  constructor(size) {
    ...
  }

  print() {
    ...
  }

  isConnected() {
    const visitedNodes = new Set();

    function* traverse(nodes) {
      for (const node of nodes) {
        if (!visitedNodes.has(node)) {
          yield node;
          yield* traverse(node.neighbors);
        }
      }
    }

    // 取得集合中的第一个节点
    const firstNode = this.nodes[Symbol.iterator]().next().value;

    // 使用递归生成器迭代每个节点
    for (const node of traverse([firstNode])) {
      visitedNodes.add(node);
    }

    return visitedNodes.size === this.nodes.size;
  }
}

学习资料

  • 《JavaScript高级程序设计(第4版)》

待学习资料

 

© Hooyu 2015 - 2022