程序员scholar 程序员scholar
首页
  • Java 基础

    • JavaSE
    • JavaIO
    • JavaAPI速查
  • Java 高级

    • JUC
    • JVM
    • Java新特性
    • 设计模式
  • Web 开发

    • Servlet
    • Java网络编程
  • Web 标准

    • HTML
    • CSS
    • JavaScript
  • 前端框架

    • Vue2
    • Vue3
    • Vue3 + TS
    • 微信小程序
    • uni-app
  • 工具与库

    • jQuery
    • Ajax
    • Axios
    • Webpack
    • Vuex
    • WebSocket
    • 第三方登录
  • 后端与语言扩展

    • ES6
    • Typescript
    • node.js
  • Element-UI
  • Apache ECharts
  • 数据结构
  • HTTP协议
  • HTTPS协议
  • 计算机网络
  • Linux常用命令
  • Windows常用命令
  • SQL数据库

    • MySQL
    • MySQL速查
  • NoSQL数据库

    • Redis
    • ElasticSearch
  • 数据库

    • MyBatis
    • MyBatis-Plus
  • 消息中间件

    • RabbitMQ
  • 服务器

    • Nginx
  • Spring框架

    • Spring6
    • SpringMVC
    • SpringBoot
    • SpringSecurity
  • SpringCould微服务

    • SpringCloud基础
    • 微服务之DDD架构思想
  • 日常必备

    • 开发常用工具包
    • Hutoll工具包
    • IDEA常用配置
    • 开发笔记
    • 日常记录
    • 项目部署
    • 网站导航
    • 产品学习
    • 英语学习
  • 代码管理

    • Maven
    • Git教程
    • Git小乌龟教程
  • 运维工具

    • Docker
    • Jenkins
    • Kubernetes
  • 算法笔记

    • 算法思想
    • 刷题笔记
  • 面试问题常见

    • 十大经典排序算法
    • 面试常见问题集锦
关于
GitHub (opens new window)
首页
  • Java 基础

    • JavaSE
    • JavaIO
    • JavaAPI速查
  • Java 高级

    • JUC
    • JVM
    • Java新特性
    • 设计模式
  • Web 开发

    • Servlet
    • Java网络编程
  • Web 标准

    • HTML
    • CSS
    • JavaScript
  • 前端框架

    • Vue2
    • Vue3
    • Vue3 + TS
    • 微信小程序
    • uni-app
  • 工具与库

    • jQuery
    • Ajax
    • Axios
    • Webpack
    • Vuex
    • WebSocket
    • 第三方登录
  • 后端与语言扩展

    • ES6
    • Typescript
    • node.js
  • Element-UI
  • Apache ECharts
  • 数据结构
  • HTTP协议
  • HTTPS协议
  • 计算机网络
  • Linux常用命令
  • Windows常用命令
  • SQL数据库

    • MySQL
    • MySQL速查
  • NoSQL数据库

    • Redis
    • ElasticSearch
  • 数据库

    • MyBatis
    • MyBatis-Plus
  • 消息中间件

    • RabbitMQ
  • 服务器

    • Nginx
  • Spring框架

    • Spring6
    • SpringMVC
    • SpringBoot
    • SpringSecurity
  • SpringCould微服务

    • SpringCloud基础
    • 微服务之DDD架构思想
  • 日常必备

    • 开发常用工具包
    • Hutoll工具包
    • IDEA常用配置
    • 开发笔记
    • 日常记录
    • 项目部署
    • 网站导航
    • 产品学习
    • 英语学习
  • 代码管理

    • Maven
    • Git教程
    • Git小乌龟教程
  • 运维工具

    • Docker
    • Jenkins
    • Kubernetes
  • 算法笔记

    • 算法思想
    • 刷题笔记
  • 面试问题常见

    • 十大经典排序算法
    • 面试常见问题集锦
关于
GitHub (opens new window)
npm

(进入注册为作者充电)

  • ES6

    • ECMAScript 6 简介
    • let 和 const 命令
    • 变量的解构赋值
    • 字符串的扩展
    • 字符串的新增方法
    • 正则的扩展
    • 数值的扩展
    • 函数的扩展
    • 数组的扩展
    • 对象的扩展
    • 对象的新增方法
    • Symbol
    • Set 和 Map 数据结构
    • Proxy
    • Reflect
    • Promise 对象
    • Iterator 和 for-of 循环
    • Generator 函数的语法
      • 1. 简介
        • 基本概念
        • yield 表达式
        • 与 Iterator 接口的关系
      • 2. next 方法的参数
      • 3. for...of 循环
      • 4. Generator.prototype.throw()
      • 5. Generator.prototype.return()
      • 6. next()、throw()、return() 的共同点
      • 7. yield* 表达式
      • 8. 作为对象属性的 Generator 函数
      • 9. Generator 函数的this
      • 10. 含义
        • Generator 与状态机
        • Generator 与协程
        • Generator 与上下文
      • 11. 应用
        • (1)异步操作的同步化表达
        • (2)控制流管理
        • (3)部署 Iterator 接口
        • (4)作为数据结构
    • Generator 函数的异步应用
    • async 函数
    • Class 的基本语法
    • Class 的继承
    • Module 的语法
    • Module 的加载实现
    • 编程风格
    • 读懂 ECMAScript 规格
    • 异步遍历器
    • ArrayBuffer
    • 最新提案
    • 装饰器
    • 函数式编程
    • Mixin
    • SIMD
    • 参考链接
  • ES6
  • ES6
scholar
2024-07-26
目录

Generator 函数的语法

# Generator 函数的语法

# 1. 简介

# 基本概念

Generator 函数是 ES6 提供的一种异步编程解决方案,语法行为与传统函数完全不同。Generator 函数有多种理解角度。语法上,可以把它理解成,Generator 函数是一个状态机,封装了多个内部状态。

执行 Generator 函数会返回一个遍历器对象,也就是说,Generator 函数除了状态机,还是一个遍历器对象生成函数。返回的遍历器对象,可以依次遍历 Generator 函数内部的每一个状态。

形式上,Generator 函数是一个普通函数,但是有两个特征。一是,function关键字与函数名之间有一个星号;二是,函数体内部使用yield表达式,定义不同的内部状态(yield在英语里的意思就是“产出”)。

function* helloWorldGenerator() {
  yield 'hello'; // 第一个状态
  yield 'world'; // 第二个状态
  return 'ending'; // 返回语句
}

var hw = helloWorldGenerator(); // 调用 Generator 函数,返回遍历器对象
1
2
3
4
5
6
7

上面代码定义了一个 Generator 函数helloWorldGenerator,它内部有两个yield表达式(hello和world),即该函数有三个状态:hello,world 和 return 语句(结束执行)。

然后,Generator 函数的调用方法与普通函数一样,也是函数名后面加上一对圆括号。不同的是,调用 Generator 函数后,该函数并不执行,返回的也不是函数运行结果,而是一个指向内部状态的指针对象,也就是遍历器对象(Iterator Object)。

下一步,必须调用遍历器对象的next方法,使得指针移向下一个状态。每次调用next方法,内部指针就从函数头部或上一次停下来的地方开始执行,直到遇到下一个yield表达式(或return语句)为止。Generator 函数是分段执行的,yield表达式是暂停执行的标记,而next方法可以恢复执行。

hw.next()
// { value: 'hello', done: false }

hw.next()
// { value: 'world', done: false }

hw.next()
// { value: 'ending', done: true }

hw.next()
// { value: undefined, done: true }
1
2
3
4
5
6
7
8
9
10
11

上面代码一共调用了四次next方法。

第一次调用,Generator 函数开始执行,直到遇到第一个yield表达式为止。next方法返回一个对象,它的value属性就是当前yield表达式的值hello,done属性的值false,表示遍历还没有结束。

第二次调用,Generator 函数从上次yield表达式停下的地方,一直执行到下一个yield表达式。next方法返回的对象的value属性就是当前yield表达式的值world,done属性的值false,表示遍历还没有结束。

第三次调用,Generator 函数从上次yield表达式停下的地方,一直执行到return语句(如果没有return语句,就执行到函数结束)。next方法返回的对象的value属性,就是紧跟在return语句后面的表达式的值(如果没有return语句,则value属性的值为undefined),done属性的值true,表示遍历已经结束。

第四次调用,此时 Generator 函数已经运行完毕,next方法返回对象的value属性为undefined,done属性为true。以后再调用next方法,返回的都是这个值。

总结一下,调用 Generator 函数,返回一个遍历器对象,代表 Generator 函数的内部指针。以后,每次调用遍历器对象的next方法,就会返回一个有着value和done两个属性的对象。value属性表示当前的内部状态的值,是yield表达式后面那个表达式的值;done属性是一个布尔值,表示是否遍历结束。

ES6 没有规定,function关键字与函数名之间的星号,写在哪个位置。这导致下面的写法都能通过。

function * foo(x, y) { /* ... */ }
function *foo(x, y) { /* ... */ }
function* foo(x, y) { /* ... */ }
function*foo(x, y) { /* ... */ }
1
2
3
4

由于 Generator 函数仍然是普通函数,所以一般的写法是上面的第三种,即星号紧跟在function关键字后面。

# yield 表达式

由于 Generator 函数返回的遍历器对象,只有调用next方法才会遍历下一个内部状态,所以其实提供了一种可以暂停执行的函数。yield表达式就是暂停标志。

遍历器对象的next方法的运行逻辑如下:

(1)遇到yield表达式,就暂停执行后面的操作,并将紧跟在yield后面的那个表达式的值,作为返回的对象的value属性值。

(2)下一次调用next方法时,再继续往下执行,直到遇到下一个yield表达式。

(3)如果没有再遇到新的yield表达式,就一直运行到函数结束,直到return语句为止,并将return语句后面的表达式的值,作为返回的对象的value属性值。

(4)如果该函数没有return语句,则返回的对象的value属性值为undefined。

需要注意的是,yield表达式后面的表达式,只有当调用next方法、内部指针指向该语句时才会执行,因此等于为 JavaScript 提供了手动的“惰性求值”(Lazy Evaluation)的语法功能。

function* gen() {
  yield 123 + 456; // 该表达式不会立即求值
}
1
2
3

上面代码中,yield后面的表达式123 + 456,不会立即求值,只会在next方法将指针移到这一句时,才会求值。

yield表达式与return语句既有相似之处,也有区别。相似之处在于,都能返回紧跟在语句后面的那个表达式的值。区别在于每次遇到yield,函数暂停执行,下一次再从该位置继续向后执行,而 return语句不具备位置记忆的功能 。一个函数里面,只能执行一次(或者说一个)return语句,但是可以执行多次(或者说多个)yield表达式。正常函数只能返回一个值,因为只能执行一次return;Generator 函数可以返回一系列的值,因为可以有任意多个yield。从另一个角度看,也可以说 Generator 生成了一系列的值,这也就是它的名称的来历(英语中,generator 这个词是“生成器”的意思)。

Generator 函数可以不用yield表达式,这时就变成了一个单纯的暂缓执行函数。

function* f() {
  console.log('执行了!');
}

var generator = f();

setTimeout(function () {
  generator.next(); // 调用 next 方法,Generator 函数才会执行
}, 2000);
1
2
3
4
5
6
7
8
9

上面代码中,函数f如果是普通函数,在为变量generator赋值时就会执行。但是,函数f是一个 Generator 函数,就变成只有调用next方法时,函数f才会执行。

另外需要注意,yield表达式只能用在 Generator 函数里面,用在其他地方都会报错。

(function (){
  yield 1;
})()
// SyntaxError: Unexpected number
1
2
3
4

上面代码在一个普通函数中使用yield表达式,结果产生一个句法错误。

下面是另外一个例子。

var arr = [1, [[2, 3], 4], [5, 6]];

var flat = function* (a) {
  a.forEach(function (item) {
    if (typeof item !== 'number') {
      yield* flat(item); // 使用 yield* 表达式
    } else {
      yield item; // 使用 yield 表达式
    }
  });
};

for (var f of flat(arr)){
  console.log(f);
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

上面代码也会产生句法错误,因为forEach方法的参数是一个普通函数,但是在里面使用了yield表达式(这个函数里面还使用了yield*表达式,详细介绍见后文)。一种修改方法是改用for循环。

var arr = [1, [[2, 3], 4], [5, 

6]];

var flat = function* (a) {
  var length = a.length;
  for (var i = 0; i < length; i++) {
    var item = a[i];
    if (typeof item !== 'number') {
      yield* flat(item); // 使用 yield* 表达式
    } else {
      yield item; // 使用 yield 表达式
    }
  }
};

for (var f of flat(arr)) {
  console.log(f);
}
// 1, 2, 3, 4, 5, 6
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

另外,yield表达式如果用在另一个表达式之中,必须放在圆括号里面。

function* demo() {
  console.log('Hello' + yield); // SyntaxError
  console.log('Hello' + yield 123); // SyntaxError

  console.log('Hello' + (yield)); // OK
  console.log('Hello' + (yield 123)); // OK
}
1
2
3
4
5
6
7

yield表达式用作函数参数或放在赋值表达式的右边,可以不加括号。

function* demo() {
  foo(yield 'a', yield 'b'); // OK
  let input = yield; // OK
}
1
2
3
4

# 与 Iterator 接口的关系

任意一个对象的Symbol.iterator方法,等于该对象的遍历器生成函数,调用该函数会返回该对象的一个遍历器对象。

由于 Generator 函数就是遍历器生成函数,因此可以把 Generator 赋值给对象的Symbol.iterator属性,从而使得该对象具有 Iterator 接口。

var myIterable = {};
myIterable[Symbol.iterator] = function* () {
  yield 1;
  yield 2;
  yield 3;
};

[...myIterable] // [1, 2, 3]
1
2
3
4
5
6
7
8

上面代码中,Generator 函数赋值给Symbol.iterator属性,从而使得myIterable对象具有了 Iterator 接口,可以被...运算符遍历。

Generator 函数执行后,返回一个遍历器对象。该对象本身也具有Symbol.iterator属性,执行后返回自身。

function* gen(){
  // some code
}

var g = gen();

g[Symbol.iterator]() === g
// true
1
2
3
4
5
6
7
8

上面代码中,gen是一个 Generator 函数,调用它会生成一个遍历器对象g。它的Symbol.iterator属性,也是一个遍历器对象生成函数,执行后返回它自己。

# 2. next 方法的参数

yield表达式本身没有返回值,或者说总是返回undefined。next方法可以带一个参数,该参数就会被当作上一个yield表达式的返回值。

function* f() {
  for (var i = 0; true; i++) {
    var reset = yield i; // 每次调用 next 方法时会暂停在这里
    if (reset) { i = -1; } // 如果 reset 为 true,则重置 i 为 -1
  }
}

var g = f();

console.log(g.next()); // { value: 0, done: false }
console.log(g.next()); // { value: 1, done: false }
console.log(g.next(true)); // { value: 0, done: false } // 参数 true 传给了上面的变量 reset
1
2
3
4
5
6
7
8
9
10
11
12

上面代码定义了一个可以无限运行的 Generator 函数f,如果next方法没有参数,每次运行到yield表达式,变量reset的值总是undefined。当next方法带一个参数true时,变量reset就被重置为这个参数(即true),因此i会等于-1,下一轮循环就会从-1开始递增。

这个功能有很重要的语法意义。Generator 函数从暂停状态到恢复运行,它的上下文状态(context)是不变的。通过next方法的参数,就有办法在 Generator 函数开始运行之后,继续向函数体内部注入值。也就是说,可以在 Generator 函数运行的不同阶段,从外部向内部注入不同的值,从而调整函数行为。

再看一个例子。

function* foo(x) {
  var y = 2 * (yield (x + 1)); // (yield (x + 1)) 会暂停执行,并返回 x + 1 的值
  var z = yield (y / 3); // (yield (y / 3)) 会暂停执行,并返回 y / 3 的值
  return (x + y + z); // 返回 x + y + z 的值
}

var a = foo(5);
console.log(a.next()); // { value: 6, done: false }
console.log(a.next()); // { value: NaN, done: false }
console.log(a.next()); // { value: NaN, done: true }

var b = foo(5);
console.log(b.next()); // { value: 6, done: false }
console.log(b.next(12)); // { value: 8, done: false }
console.log(b.next(13)); // { value: 42, done: true }
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

上面代码中,第二次运行next方法的时候不带参数,导致 y 的值等于2 * undefined(即NaN),除以 3 以后还是NaN,因此返回对象的value属性也等于NaN。第三次运行next方法的时候不带参数,所以z等于undefined,返回对象的value属性等于5 + NaN + undefined,即NaN。

如果向next方法提供参数,返回结果就完全不一样了。上面代码第一次调用b的next方法时,返回x + 1的值6;第二次调用next方法,将上一次yield表达式的值设为12,因此y等于24,返回y / 3的值8;第三次调用next方法,将上一次yield表达式的值设为13,因此z等于13,这时x等于5,y等于24,所以return语句的值等于42。

注意,由于next方法的参数表示上一个yield表达式的返回值,所以在第一次使用next方法时,传递参数是无效的。V8 引擎直接忽略第一次使用next方法时的参数,只有从第二次使用next方法开始,参数才是有效的。从语义上讲,第一个next方法用来启动遍历器对象,所以不用带有参数。

再看一个通过next方法的参数,向 Generator 函数内部输入值的例子。

function* dataConsumer() {
  console.log('Started');
  console.log(`1. ${yield}`); // 第一次暂停,yield 表达式的值为 undefined
  console.log(`2. ${yield}`); // 第二次暂停,yield 表达式的值为传入的参数
  return 'result'; // 最终返回值
}

let genObj = dataConsumer();
genObj.next(); // 启动遍历器对象
// Started
genObj.next('a') // 恢复执行,并将 'a' 作为上一个 yield 表达式的值
// 1. a
genObj.next('b') // 恢复执行,并将 'b' 作为上一个 yield 表达式的值
// 2. b
1
2
3
4
5
6
7
8
9
10
11
12
13
14

上面代码是一个很直观的例子,每次通过next方法向 Generator 函数输入值,然后打印出来。

如果想要第一次调用next方法时,就能够输入值,可以在 Generator 函数外面再包一层。

function wrapper(generatorFunction) {
  return function (...args) {
    let generatorObject = generatorFunction(...args);
    generatorObject.next(); // 预先调用一次 next 方法
    return generatorObject;
  };
}

const wrapped = wrapper(function* () {
  console.log(`First input: ${yield}`); // 第一次暂停,yield 表达式的值为传入的参数
  return 'DONE'; // 最终返回值
});

wrapped().next('hello!')
// First input: hello!
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

上面代码中,Generator 函数如果不用wrapper先包一层,是无法第一次调用next方法,就输入参数的。

# 3. for...of 循环

for...of循环可以自动遍历 Generator 函数运行时生成的Iterator对象,且此时不再需要调用next方法。

function* foo() {
  yield 1; // 暂停执行并返回 1
  yield 2; // 暂停执行并返回 2
  yield 3; // 暂停执行并返回 3
  yield 4; // 暂停执行并返回 4
  yield 5; // 暂停执行并返回 5
  return 6; // 返回 6,但不会在 for...of 中显示
}

for (let v of foo()) {
  console.log(v); // 依次打印 1, 2, 3, 4, 5
}
// 输出:1 2 3 4 5
1
2
3
4
5
6
7
8
9
10
11
12
13

上面代码使用for...of循环,依次显示 5 个yield表达式的值。这里需要注意,一旦next方法的返回对象的done属性为true,for...of循环就会中止,且不包含该返回对象,所以上面代码的return语句返回的6,不包括在for...of循环之中。

下面是一个利用 Generator 函数和for...of循环,实现斐波那契数列的例子。

function* fibonacci() {
  let [prev, curr] = [0, 1];
  for (;;) { // 无限循环
    yield curr; // 暂停执行并返回当前的斐波那契数
    [prev, curr] = [curr, prev + curr]; // 更新前一个数和当前数
  }
}

for (let n of fibonacci()) {
  if (n > 1000) break; // 当斐波那契数超过 1000 时退出循环
  console.log(n); // 打印斐波那契数
}
// 输出:1 1 2 3 5 8 13 21 34 55 89 144 233 377 610 987
1
2
3
4
5
6
7
8
9
10
11
12
13

从上面代码可见,使用for...of语句时不需要使用next方法。

利用for...of循环,可以写出遍历任意对象(object)的方法。原生的 JavaScript 对象没有遍历接口,无法使用for...of循环,通过 Generator 函数为它加上这个接口,就可以用了。

function* objectEntries(obj) {
  let propKeys = Reflect.ownKeys(obj); // 获取对象的所有属性名

  for (let propKey of propKeys) {
    yield [propKey, obj[propKey]]; // 暂停执行并返回一个数组,包含属性名和属性值
  }
}

let jane = { first: 'Jane', last: 'Doe' };

for (let [key, value] of objectEntries(jane)) {
  console.log(`${key}: ${value}`); // 打印属性名和属性值
}
// 输出:
// first: Jane
// last: Doe
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

上面代码中,对象jane原生不具备 Iterator 接口,无法用for...of遍历。这时,我们通过 Generator 函数objectEntries为它加上遍历器接口,就可以用for...of遍历了。加上遍历器接口的另一种写法是,将 Generator 函数加到对象的Symbol.iterator属性上面。

function* objectEntries() {
  let propKeys = Object.keys(this); // 获取对象的可枚举属性名

  for (let propKey of propKeys) {
    yield [propKey, this[propKey]]; // 暂停执行并返回一个数组,包含属性名和属性值
  }
}

let jane = { first: 'Jane', last: 'Doe' };

jane[Symbol.iterator] = objectEntries; // 将 Generator 函数赋值给对象的 Symbol.iterator 属性

for (let [key, value] of jane) {
  console.log(`${key}: ${value}`); // 打印属性名和属性值
}
// 输出:
// first: Jane
// last: Doe
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

除了for...of循环以外,扩展运算符(...)、解构赋值和Array.from方法内部调用的,都是遍历器接口。这意味着,它们都可以将 Generator 函数返回的 Iterator 对象,作为参数。

function* numbers () {
  yield 1; // 暂停执行并返回 1
  yield 2; // 暂停执行并返回 2
  return 3; // 返回 3,但不会在解构赋值和扩展运算符中显示
  yield 4; // 不会执行到这一步
}

// 扩展运算符
console.log([...numbers()]); // [1, 2]

// Array.from 方法
console.log(Array.from(numbers())); // [1, 2]

// 解构赋值
let [x, y] = numbers();
console.log(x); // 1
console.log(y); // 2

// for...of 循环
for (let n of numbers()) {
  console.log(n); // 依次打印 1, 2
}
// 输出:
// 1
// 2
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25

在上面的示例中,Generator 函数numbers返回的迭代器对象被用在不同的上下文中:扩展运算符、Array.from 方法、解构赋值和 for...of 循环。它们都只显示 yield 返回的值,而忽略 return 返回的值。

# 4. Generator.prototype.throw()

Generator 函数返回的遍历器对象,都有一个throw方法,可以在函数体外抛出错误,然后在 Generator 函数体内捕获。

var g = function* () {
  try {
    yield; // 暂停执行,等待外部调用 next 方法
  } catch (e) {
    console.log('内部捕获', e); // 捕获内部抛出的错误
  }
};

var i = g();
i.next(); // 启动 Generator 函数

try {
  i.throw('a'); // 第一次抛出错误,被内部捕获
  i.throw('b'); // 第二次抛出错误,没有被内部捕获
} catch (e) {
  console.log('外部捕获', e); // 捕获外部抛出的错误
}
// 输出:
// 内部捕获 a
// 外部捕获 b
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

上面代码中,遍历器对象i连续抛出两个错误。第一个错误被 Generator 函数体内的catch语句捕获。i第二次抛出错误,由于 Generator 函数内部的catch语句已经执行过了,不会再捕捉到这个错误了,所以这个错误就被抛出了 Generator 函数体,被函数体外的catch语句捕获。

throw方法可以接受一个参数,该参数会被catch语句接收,建议抛出Error对象的实例。

var g = function* () {
  try {
    yield; // 暂停执行,等待外部调用 next 方法
  } catch (e) {
    console.log(e); // 捕获内部抛出的错误
  }
};

var i = g();
i.next(); // 启动 Generator 函数
i.throw(new Error('出错了!')); // 抛出一个错误
// 输出:
// Error: 出错了!
1
2
3
4
5
6
7
8
9
10
11
12
13

注意,不要混淆遍历器对象的throw方法和全局的throw命令。上面代码的错误,是用遍历器对象的throw方法抛出的,而不是用throw命令抛出的。后者只能被函数体外的catch语句捕获。

var g = function* () {
  while (true) {
    try {
      yield; // 暂停执行,等待外部调用 next 方法
    } catch (e) {
      if (e != 'a') throw e; // 如果错误不是 'a',则重新抛出
      console.log('内部捕获', e); // 捕获内部抛出的错误
    }
  }
};

var i = g();
i.next(); // 启动 Generator 函数

try {
  throw new Error('a'); // 抛出一个错误
  throw new Error('b'); // 抛出另一个错误
} catch (e) {
  console.log('外部捕获', e); // 捕获外部抛出的错误
}
// 输出:
// 外部捕获 [Error: a]
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22

上面代码之所以只捕获了a,是因为函数体外的catch语句块,捕获了抛出的a错误以后,就不会再继续try代码块里面剩余的语句了。

如果 Generator 函数内部没有部署try...catch代码块,那么throw方法抛出的错误,将被外部try...catch代码块捕获。

var g = function* () {
  while (true) {
    yield; // 暂停执行,等待外部调用 next 方法
  }
};

var i = g();
i.next(); // 启动 Generator 函数

try {
  i.throw('a'); // 抛出一个错误
  i.throw('b'); // 抛出另一个错误
} catch (e) {
  console.log('外部捕获', e); // 捕获外部抛出的错误
}
// 输出:
// 外部捕获 a
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

上面代码中,Generator 函数g内部没有部署try...catch代码块,所以抛出的错误直接被外部catch代码块捕获。

如果 Generator 函数内部和外部,都没有部署try...catch代码块,那么程序将报错,直接中断执行。

var gen = function* gen(){
  yield console.log('hello'); // 暂停执行,并输出 'hello'
  yield console.log('world'); // 暂停执行,并输出 'world'
}

var g = gen();
g.next(); // 启动 Generator 函数,输出 'hello'
g.throw(); // 抛出一个错误
// 输出:
// hello
// Uncaught undefined
1
2
3
4
5
6
7
8
9
10
11

上面代码中,g.throw抛出错误以后,没有任何try...catch代码块可以捕获这个错误,导致程序报错,中断执行。

throw方法抛出的错误要被内部捕获,前提是必须至少执行过一次next方法。

function* gen() {
  try {
    yield 1; // 暂停执行,并返回 1
  } catch (e) {
    console.log('内部捕获'); // 捕获内部抛出的错误
  }
}

var g = gen();
g.throw(1); // 抛出一个错误
// 输出:
// Uncaught 1
1
2
3
4
5
6
7
8
9
10
11
12

上面代码中,g.throw(1)执行时,next方法一次都没有执行过。这时,抛出的错误不会被内部捕获,而是直接在外部抛出,导致程序出错。这种行为其实很好理解,因为第一次执行next方法,等同于启动执行 Generator 函数的内部代码,否则 Generator 函数还没有开始执行,这时throw方法抛错只可能抛出在函数外部。

throw方法被捕获以后,会附带执行下一条yield表达式。也就是说,会附带执行一次next方法。

var gen = function* gen(){
  try {
    yield console.log('a'); // 暂停执行,并输出 'a'
  } catch (e) {
    // ...
  }
  yield console.log('b'); // 暂停执行,并输出 'b'
  yield console.log('c'); // 暂停执行,并输出 'c'
}

var g = gen();
g.next(); // a
g.throw() // b
g.next() // c
1
2
3
4
5
6
7
8
9
10
11
12
13
14

上面代码中,g.throw方法被捕获以后,自动执行了一次next方法,所以会打印b。另外,也可以看到,只要 Generator 函数内部部署了try...catch代码块,那么遍历器的throw方法抛出的错误,不影响下一次遍历。

另外,throw命令与g.throw方法是无关的,两者互不影响。

var gen = function* gen(){
  yield console.log('hello'); // 暂停执行,并输出 'hello'
  yield console.log('world'); // 暂停执行,并输出 'world'
}

var g = gen();
g.next(); // 启动 Generator 函数,输出 'hello'

try {
  throw new Error(); // 抛出一个错误
} catch (e) {
  g.next(); // 捕获错误,继续执行 Generator 函数,输出 'world'
}
// 输出:
// hello
// world
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

上面代码中,throw命令抛出的错误不会影响到遍历器的状态,所以两次执行next方法,都进行了正确的操作。

这种函数体内捕获错误的机制,大大方便了对错误的处理。多个yield表达式,可以只用一个try...catch代码块来捕获错误。如果使用回调函数的写法,想要捕获多个错误,就不得不为每个函数内部写一个错误处理语句,现在只在 Generator 函数内部写一次catch语句就可以了。

Generator 函数体外抛出的错误,可以在函数体内捕获;反过来,Generator 函数体内抛出的错误,也可以被函数体外的catch捕获。

function* foo() {
  var x = yield 3; // 暂停执行,并返回 3
  var y = x.toUpperCase(); // 尝试将 x 转为大写,可能会抛出错误
  yield y; // 暂停执行,并返回 y
}

var it = foo();

it.next(); // { value: 3, done: false }

try {
  it.next(42); // 尝试将 42 转为大写,抛出错误
} catch (err) {
  console.log(err); // 捕获错误
}
// 输出:
// TypeError: x.toUpperCase is not a function
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

上面代码中,第二个next方法向函数体内传入一个参数 42,数值是没有toUpperCase方法的,所以会抛出一个 TypeError 错误,被函数体外的catch捕获。

一旦 Generator 执行过程中抛出错误,且没有被内部捕获,就不会再执行下去了。如果此后还调用

next方法,将返回一个value属性等于undefined、done属性等于true的对象,即 JavaScript 引擎认为这个 Generator 已经运行结束了。

function* g() {
  yield 1; // 暂停执行,并返回 1
  console.log('throwing an exception'); // 打印日志
  throw new Error('generator broke!'); // 抛出错误
  yield 2; // 不会执行
  yield 3; // 不会执行
}

function log(generator) {
  var v;
  console.log('starting generator'); // 打印日志
  try {
    v = generator.next(); // 第一次调用 next 方法
    console.log('第一次运行next方法', v); // 打印返回值
  } catch (err) {
    console.log('捕捉错误', v); // 捕捉并打印错误
  }
  try {
    v = generator.next(); // 第二次调用 next 方法
    console.log('第二次运行next方法', v); // 打印返回值
  } catch (err) {
    console.log('捕捉错误', v); // 捕捉并打印错误
  }
  try {
    v = generator.next(); // 第三次调用 next 方法
    console.log('第三次运行next方法', v); // 打印返回值
  } catch (err) {
    console.log('捕捉错误', v); // 捕捉并打印错误
  }
  console.log('caller done'); // 打印日志
}

log(g());
// 输出:
// starting generator
// 第一次运行next方法 { value: 1, done: false }
// throwing an exception
// 捕捉错误 { value: 1, done: false }
// 第三次运行next方法 { value: undefined, done: true }
// caller done
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40

上面代码一共三次运行next方法,第二次运行的时候会抛出错误,然后第三次运行的时候,Generator 函数就已经结束了,不再执行下去了。

# 5. Generator.prototype.return()

Generator 函数返回的遍历器对象,还有一个**return方法,可以返回给定的值,并且终结遍历 Generator 函数。**

function* gen() {
  yield 1;
  yield 2;
  yield 3;
}

var g = gen();

g.next()        // { value: 1, done: false }
g.return('foo') // { value: "foo", done: true }
g.next()        // { value: undefined, done: true }
1
2
3
4
5
6
7
8
9
10
11

上面代码中,遍历器对象g调用return方法后,返回值的value属性就是return方法的参数foo。并且,Generator 函数的遍历就终止了,返回值的done属性为true,以后再调用next方法,done属性总是返回true。

如果return方法调用时,不提供参数,则返回值的value属性为undefined。

function* gen() {
  yield 1;
  yield 2;
  yield 3;
}

var g = gen();

g.next()        // { value: 1, done: false }
g.return()      // { value: undefined, done: true }
1
2
3
4
5
6
7
8
9
10

如果 Generator 函数内部有try...finally代码块,且正在执行try代码块,那么return方法会导致立刻进入finally代码块,执行完以后,整个函数才会结束。

function* numbers() {
  yield 1;
  try {
    yield 2;
    yield 3;
  } finally {
    yield 4;
    yield 5;
  }
  yield 6;
}

var g = numbers();
g.next()         // { value: 1, done: false }
g.next()         // { value: 2, done: false }
g.return(7)      // { value: 4, done: false }
g.next()         // { value: 5, done: false }
g.next()         // { value: 7, done: true }
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

上面代码中,调用return()方法后,就开始执行finally代码块,不执行try里面剩下的代码了,然后等到finally代码块执行完,再返回return()方法指定的返回值。

# 6. next()、throw()、return() 的共同点

next()、throw()、return()这三个方法本质上是同一件事,可以放在一起理解。它们的作用都是让 Generator 函数恢复执行,并且使用不同的语句替换yield表达式。

next()是将yield表达式替换成一个值。

const g = function* (x, y) {
  let result = yield x + y;
  return result;
};

const gen = g(1, 2);
gen.next(); // Object { value: 3, done: false }
gen.next(1); // Object { value: 1, done: true }
// 相当于将 let result = yield x + y
// 替换成 let result = 1;
1
2
3
4
5
6
7
8
9
10

上面代码中,第二个next(1)方法就相当于将yield表达式替换成一个值1。如果next方法没有参数,就相当于替换成undefined。

throw()是将yield表达式替换成一个throw语句。

gen.throw(new Error('出错了')); // Uncaught Error: 出错了
// 相当于将 let result = yield x + y
// 替换成 let result = throw(new Error('出错了'));
1
2
3

return()是将yield表达式替换成一个return语句。

gen.return(2); // Object { value: 2, done: true }
// 相当于将 let result = yield x + y
// 替换成 let result = return 2;
1
2
3

通过这三种方法,Generator 函数可以灵活地控制函数内部的执行过程。

# 7. yield* 表达式

如果在 Generator 函数内部,调用另一个 Generator 函数,需要在前者的函数体内部,自己手动完成遍历。

function* foo() {
  yield 'a';
  yield 'b';
}

function* bar() {
  yield 'x';
  // 手动遍历 foo(),遍历 foo 生成的每个值
  for (let i of foo()) {
    console.log(i); // 输出 'a' 和 'b'
  }
  yield 'y';
}

for (let v of bar()) {
  console.log(v); // 输出 'x', 'a', 'b', 'y'
}
// 输出:
// x
// a
// b
// y
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22

上面代码中,foo和bar都是 Generator 函数,在bar里面调用foo,就需要手动遍历foo。如果有多个 Generator 函数嵌套,写起来就非常麻烦。

ES6 提供了yield*表达式,作为解决办法,用来在一个 Generator 函数里面执行另一个 Generator 函数。

function* foo() {
  yield 'a';
  yield 'b';
}

function* bar() {
  yield 'x';
  yield* foo(); // 使用 yield* 语句遍历 foo()
  yield 'y';
}

// 等同于
function* bar() {
  yield 'x';
  yield 'a';
  yield 'b';
  yield 'y';
}

// 等同于
function* bar() {
  yield 'x';
  for (let v of foo()) {
    yield v; // 将 foo 生成的值逐个产出
  }
  yield 'y';
}

for (let v of bar()){
  console.log(v); // 输出 'x', 'a', 'b', 'y'
}
// 输出:
// x
// a
// b
// y
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36

再来看一个对比的例子。

function* inner() {
  yield 'hello!';
}

function* outer1() {
  yield 'open';
  yield inner(); // 返回一个遍历器对象
  yield 'close';
}

let gen1 = outer1();
console.log(gen1.next().value); // "open"
console.log(gen1.next().value); // 返回一个遍历器对象
console.log(gen1.next().value); // "close"

function* outer2() {
  yield 'open';
  yield* inner(); // 返回 'hello!'
  yield 'close';
}

let gen2 = outer2();
console.log(gen2.next().value); // "open"
console.log(gen2.next().value); // "hello!"
console.log(gen2.next().value); // "close"
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25

上面例子中,outer2使用了yield*,outer1没使用。结果就是,outer1返回一个遍历器对象,outer2返回该遍历器对象的内部值。

从语法角度看,如果yield表达式后面跟的是一个遍历器对象,需要在yield表达式后面加上星号,表明它返回的是一个遍历器对象。这被称为yield*表达式。

let delegatedIterator = (function* () {
  yield 'Hello!';
  yield 'Bye!';
}());

let delegatingIterator = (function* () {
  yield 'Greetings!';
  yield* delegatedIterator; // 使用 yield* 代理 delegatedIterator
  yield 'Ok, bye.';
}());

for (let value of delegatingIterator) {
  console.log(value); // 输出 'Greetings!', 'Hello!', 'Bye!', 'Ok, bye.'
}
// 输出:
// "Greetings!
// "Hello!"
// "Bye!"
// "Ok, bye."
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

上面代码中,delegatingIterator是代理者,delegatedIterator是被代理者。由于yield* delegatedIterator语句得到的值,是一个遍历器,所以要用星号表示。运行结果就是使用一个遍历器,遍历了多个 Generator 函数,有递归的效果。

yield*后面的 Generator 函数(没有return语句时),等同于在 Generator 函数内部,部署一个for...of循环。

function* concat(iter1, iter2) {
  yield* iter1; // 代理 iter1
  yield* iter2; // 代理 iter2
}

// 等同于

function* concat(iter1, iter2) {
  for (let value of iter1) {
    yield value; // 产出 iter1 中的值
  }
  for (let value of iter2) {
    yield value; // 产出 iter2 中的值
  }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

上面代码说明,yield*后面的 Generator 函数(没有return语句时),不过是for...of的一种简写形式,完全可以用后者替代前者。反之,在有return语句时,则需要用var value = yield* iterator的形式获取return语句的值。

如果yield*后面跟着一个数组,由于数组原生支持遍历器,因此就会遍历数组成员。

function* gen() {
  yield* ['a', 'b', 'c']; // 代理数组的遍历
}

gen().next(); // { value: "a", done: false }
1
2
3
4
5

上面代码中,yield命令后面如果不加星号,返回的是整个数组,加了星号就表示返回的是数组的遍历器对象。

实际上,任何数据结构只要有 Iterator 接口,就可以被yield*遍历。

let read = (function* () {
  yield 'hello';
  yield* 'hello'; // 代理字符串的遍历
})();

read.next().value; // "hello"
read.next().value; // "h"
1
2
3
4
5
6
7

上面代码中,yield表达式返回整个字符串,yield*语句返回单个字符。因为字符串具有 Iterator 接口,所以被yield*遍历。

如果被代理的 Generator 函数有return语句,那么就可以向代理它的 Generator 函数返回数据。

function* foo() {
  yield 2;
  yield 3;
  return "foo"; // 返回值
}

function* bar() {
  yield 1;
  let v = yield* foo(); // 获取 foo 的返回值
  console.log("v: " + v);
  yield 4;
}

let it = bar();

console.log(it.next()); // { value: 1, done: false }
console.log(it.next()); // { value: 2, done: false }
console.log(it.next()); // { value: 3, done: false }
console.log(it.next()); // "v: foo" { value: 4, done: false }
console.log(it.next()); // { value: undefined, done: true }
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

上面代码在第四次调用next方法的时候,屏幕上会有输出,这是因为函数foo的return语句,向函数bar提供了返回值。

再看一个例子。

function* genFuncWithReturn() {
  yield 'a';
  yield 'b';
  return 'The result'; // 返回值
}

function* logReturned(genObj) {
  let result = yield* genObj; // 获取返回值
  console.log(result); // 输出返回值
}

[...logReturned(genFuncWithReturn())];
// 输出:
// The result
// 值为 [ 'a', 'b' ]
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

上面代码中,存在两次遍历。第一次是扩展运算符遍历函数logReturned返回的遍历器对象,第二次是yield*语句遍历函数genFuncWithReturn返回的遍历器对象。这两次遍历的效果是叠加的,最终表现为扩展运算符遍历函数genFuncWithReturn返回的遍历器对象。所以,最后的数据表达式得到的值等于[ 'a', 'b' ]。但是,函数genFuncWithReturn的return语句的返回值The result,会返回给函数logReturned内部的result变量,因此会有终端输出。

yield*命令可以很方便地取出嵌套数组的所有成员。

function* iterTree(tree) {
  if (Array.isArray(tree)) { // 判断是否为数组
    for (let i = 0; i < tree.length; i++) {
      yield* iterTree(tree[i]); // 递归遍历子数组
    }
  } else {
    yield tree; // 产出当前值
  }
}

const tree = ['a', ['b', 'c'], ['d', 'e']];

for (let x of iterTree(tree)) {
  console.log(x); // 输出每个成员
}
// 输出:
// a
// b
// c
// d
// e
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21

由于扩展运算符...默认调用 Iterator 接口,所以上面这个函数也可以用于嵌套数组的平铺。

[...iterTree(tree)]; // ["a", "b", "c", "d", "e"]
1

下面是一个稍

微复杂的例子,使用yield*语句遍历完全二叉树。

// 下面是二叉树的构造函数,
// 三个参数分别是左树、当前节点和右树
function Tree(left, label, right) {
  this.left = left;   // 左子树
  this.label = label; // 当前节点
  this.right = right; // 右子树
}

// 下面是中序(inorder)遍历函数。
// 由于返回的是一个遍历器,所以要用 generator 函数。
// 函数体内采用递归算法,所以左树和右树要用 yield* 遍历
function* inorder(t) {
  if (t) { // 如果树非空
    yield* inorder(t.left);   // 遍历左子树
    yield t.label;            // 产出当前节点
    yield* inorder(t.right);  // 遍历右子树
  }
}

// 下面生成二叉树
function make(array) {
  // 判断是否为叶节点
  if (array.length === 1) {
    return new Tree(null, array[0], null); // 单节点树
  }
  // 否则递归生成子树
  return new Tree(make(array[0]), array[1], make(array[2]));
}
let tree = make([[['a'], 'b', ['c']], 'd', [['e'], 'f', ['g']]]);

// 遍历二叉树
let result = [];
for (let node of inorder(tree)) {
  result.push(node); // 收集遍历结果
}

result; // ['a', 'b', 'c', 'd', 'e', 'f', 'g']
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37

上面代码生成了一棵二叉树,然后使用yield*语句对其进行中序遍历,最终得到遍历结果。

# 8. 作为对象属性的 Generator 函数

如果一个对象的属性是 Generator 函数,可以简写成下面的形式。

let obj = {
  // 这是一个 Generator 函数,前面有一个星号
  * myGeneratorMethod() {
    yield 'hello'; // 暂停点,返回 'hello'
    yield 'world'; // 暂停点,返回 'world'
  }
};
1
2
3
4
5
6
7

上面代码中,myGeneratorMethod属性前面有一个星号,表示这个属性是一个 Generator 函数。

它的完整形式如下,与上面的写法是等价的。

let obj = {
  // Generator 函数的完整形式
  myGeneratorMethod: function* () {
    yield 'hello'; // 暂停点,返回 'hello'
    yield 'world'; // 暂停点,返回 'world'
  }
};
1
2
3
4
5
6
7

# 9. Generator 函数的this

Generator 函数总是返回一个遍历器,ES6 规定这个遍历器是 Generator 函数的实例,也继承了 Generator 函数的prototype对象上的方法。

function* g() {}

// 在 Generator 函数的原型上添加方法
g.prototype.hello = function () {
  return 'hi!';
};

let obj = g();

console.log(obj instanceof g); // true,证明 obj 是 g 的实例
console.log(obj.hello()); // 'hi!',证明 obj 继承了 g.prototype 的方法
1
2
3
4
5
6
7
8
9
10
11

上面代码表明,Generator 函数g返回的遍历器obj,是g的实例,而且继承了g.prototype。但是,如果把g当作普通的构造函数,并不会生效,因为g返回的总是遍历器对象,而不是this对象。

function* g() {
  this.a = 11; // 尝试在 this 上添加属性
}

let obj = g();
obj.next(); // 启动 Generator 函数
console.log(obj.a); // undefined,说明 this.a 没有被添加
1
2
3
4
5
6
7

上面代码中,Generator 函数g在this对象上面添加了一个属性a,但是obj对象拿不到这个属性。

Generator 函数也不能跟new命令一起用,会报错。

function* F() {
  yield this.x = 2; // 尝试在 this 上添加属性
  yield this.y = 3;
}

new F();
// TypeError: F is not a constructor
1
2
3
4
5
6
7

上面代码中,new命令跟构造函数F一起使用,结果报错,因为F不是构造函数。

那么,有没有办法让 Generator 函数返回一个正常的对象实例,既可以用next方法,又可以获得正常的this?

下面是一个变通方法。首先,生成一个空对象,使用call方法绑定 Generator 函数内部的this。这样,构造函数调用以后,这个空对象就是 Generator 函数的实例对象了。

function* F() {
  this.a = 1; // 在 this 上添加属性
  yield this.b = 2;
  yield this.c = 3;
}

let obj = {};
let f = F.call(obj); // 将 obj 作为 F 内部的 this

console.log(f.next());  // { value: 2, done: false },Generator 函数运行到第一个 yield
console.log(f.next());  // { value: 3, done: false },Generator 函数运行到第二个 yield
console.log(f.next());  // { value: undefined, done: true },Generator 函数运行结束

console.log(obj.a); // 1,属性 a 已经添加到 obj 上
console.log(obj.b); // 2,属性 b 已经添加到 obj 上
console.log(obj.c); // 3,属性 c 已经添加到 obj 上
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

上面代码中,首先是F内部的this对象绑定obj对象,然后调用它,返回一个遍历器对象。这个对象执行三次next方法(因为F内部有两个yield表达式),完成F内部所有代码的运行。这时,所有内部属性都绑定在obj对象上了,因此obj对象也就成了F的实例。

上面代码中,执行的是遍历器对象f,但是生成的对象实例是obj,有没有办法将这两个对象统一呢?

一个办法就是将obj换成F.prototype。

function* F() {
  this.a = 1; // 在 this 上添加属性
  yield this.b = 2;
  yield this.c = 3;
}

let f = F.call(F.prototype); // 将 F.prototype 作为 F 内部的 this

console.log(f.next());  // { value: 2, done: false },Generator 函数运行到第一个 yield
console.log(f.next());  // { value: 3, done: false },Generator 函数运行到第二个 yield
console.log(f.next());  // { value: undefined, done: true },Generator 函数运行结束

console.log(f.a); // 1,属性 a 已经添加到 f 上
console.log(f.b); // 2,属性 b 已经添加到 f 上
console.log(f.c); // 3,属性 c 已经添加到 f 上
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

再将F改成构造函数,就可以对它执行new命令了。

function* gen() {
  this.a = 1; // 在 this 上添加属性
  yield this.b = 2;
  yield this.c = 3;
}

function F() {
  return gen.call(gen.prototype); // 将 gen.prototype 作为 gen 内部的 this
}

let f = new F(); // 生成 F 的实例

console.log(f.next());  // { value: 2, done: false },Generator 函数运行到第一个 yield
console.log(f.next());  // { value: 3, done: false },Generator 函数运行到第二个 yield
console.log(f.next());  // { value: undefined, done: true },Generator 函数运行结束

console.log(f.a); // 1,属性 a 已经添加到 f 上
console.log(f.b); // 2,属性 b 已经添加到 f 上
console.log(f.c); // 3,属性 c 已经添加到 f 上
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

上面代码中,我们将 Generator 函数gen包装成构造函数F,通过new命令生成f对象。这样既可以使用 Generator 函数的遍历功能,又能获得普通对象实例的this。

# 10. 含义

# Generator 与状态机

Generator 是实现状态机的最佳结构。比如,下面的clock函数就是一个状态机。

// 定义一个布尔变量,用于表示当前状态
var ticking = true;

// 定义一个状态机函数
var clock = function() {
  if (ticking)
    console.log('Tick!');
  else
    console.log('Tock!');
  ticking = !ticking; // 切换状态
}
1
2
3
4
5
6
7
8
9
10
11

上面代码的clock函数一共有两种状态(Tick和Tock),每运行一次,就改变一次状态。这个函数如果用 Generator 实现,就是下面这样。

// 定义一个 Generator 函数,用于实现状态机
var clock = function* () {
  while (true) {
    console.log('Tick!');
    yield; // 暂停,返回控制权
    console.log('Tock!');
    yield; // 暂停,返回控制权
  }
};
1
2
3
4
5
6
7
8
9

上面的 Generator 实现与 ES5 实现对比,可以看到少了用来保存状态的外部变量ticking,这样就更简洁,更安全(状态不会被非法篡改)、更符合函数式编程的思想,在写法上也更优雅。Generator 之所以可以不用外部变量保存状态,是因为它本身就包含了一个状态信息,即目前是否处于暂停态。

# Generator 与协程

协程(coroutine)是一种程序运行的方式,可以理解成“协作的线程”或“协作的函数”。协程既可以用单线程实现,也可以用多线程实现。前者是一种特殊的子例程,后者是一种特殊的线程。

(1)协程与子例程的差异

传统的“子例程”(subroutine)采用堆栈式“后进先出”的执行方式,只有当调用的子函数完全执行完毕,才会结束执行父函数。协程与其不同,多个线程(单线程情况下,即多个函数)可以并行执行,但是只有一个线程(或函数)处于正在运行的状态,其他线程(或函数)都处于暂停态(suspended),线程(或函数)之间可以交换执行权。也就是说,一个线程(或函数)执行到一半,可以暂停执行,将执行权交给另一个线程(或函数),等到稍后收回执行权的时候,再恢复执行。这种可以并行执行、交换执行权的线程(或函数),就称为协程。

从实现上看,在内存中,子例程只使用一个栈(stack),而协程是同时存在多个栈,但只有一个栈是在运行状态,也就是说,协程是以多占用内存为代价,实现多任务的并行。

(2)协程与普通线程的差异

不难看出,协程适合用于多任务运行的环境。在这个意义上,它与普通的线程很相似,都有自己的执行上下文、可以分享全局变量。它们的不同之处在于,同一时间可以有多个线程处于运行状态,但是运行的协程只能有一个,其他协程都处于暂停状态。此外,普通的线程是抢先式的,到底哪个线程优先得到资源,必须由运行环境决定,但是协程是合作式的,执行权由协程自己分配。

由于 JavaScript 是单线程语言,只能保持一个调用栈。引入协程以后,每个任务可以保持自己的调用栈。这样做的最大好处,就是抛出错误的时候,可以找到原始的调用栈。不至于像异步操作的回调函数那样,一旦出错,原始的调用栈早就结束。

Generator 函数是 ES6 对协程的实现,但属于不完全实现。Generator 函数被称为“半协程”(semi-coroutine),意思是只有 Generator 函数的调用者,才能将程序的执行权还给 Generator 函数。如果是完全执行的协程,任何函数都可以让暂停的协程继续执行。

如果将 Generator 函数当作协程,完全可以将多个需要互相协作的任务写成 Generator 函数,它们之间使用yield表达式交换控制权。

# Generator 与上下文

JavaScript 代码运行时,会产生一个全局的上下文环境(context,又称运行环境),包含了当前所有的变量和对象。然后,执行函数(或块级代码)的时候,又会在当前上下文环境的上层,产生一个函数运行的上下文,变成当前(active)的上下文,由此形成一个上下文环境的堆栈(context stack)。

这个堆栈是“后进先出”的数据结构,最后产生的上下文环境首先执行完成,退出堆栈,然后再执行完成它下层的上下文,直至所有代码执行完成,堆栈清空。

Generator 函数不是这样,它执行产生的上下文环境,一旦遇到yield命令,就会暂时退出堆栈,但是并不消失,里面的所有变量和对象会冻结在当前状态。等到对它执行next命令时,这个上下文环境又会重新加入调用栈,冻结的变量和对象恢复执行。

// 定义一个简单的 Generator 函数
function* gen() {
  yield 1; // 暂停点,返回 1
  return 2; // 返回 2,Generator 函数结束
}

// 创建 Generator 函数的实例
let g = gen();

console.log(
  g.next().value, // { value: 1, done: false }
  g.next().value, // { value: 2, done: true }
);
1
2
3
4
5
6
7
8
9
10
11
12
13

上面代码中,第一次执行g.next()时,Generator 函数gen的上下文会加入堆栈,即开始运行gen内部的代码。等遇到yield 1时,gen上下文退出堆栈,内部状态冻结。第二次执行g.next()时,gen上下文重新加入堆栈,变成当前的上下文,重新恢复执行。

# 11. 应用

Generator 可以暂停函数执行,返回任意表达式的值。这种特点使得 Generator 有多种应用场景。

# (1)异步操作的同步化表达

Generator 函数的暂停执行的效果,意味着可以把异步操作写在yield表达式里面,等到调用next方法时再往后执行。这实际上等同于不需要写回调函数了,因为异步操作的后续操作可以放在yield表达式下面,反正要等到调用next方法时再执行。所以,Generator 函数的一个重要实际意义就是用来处理异步操作,改写回调函数。

function* loadUI() {
  showLoadingScreen(); // 显示加载界面
  yield loadUIDataAsynchronously(); // 异步加载数据
  hideLoadingScreen(); // 隐藏加载界面
}

var loader = loadUI(); // 创建 Generator 对象

// 加载 UI
loader.next(); // 执行到第一个 yield,显示加载界面并暂停

// 卸载 UI
loader.next(); // 继续执行,数据加载完成后隐藏加载界面
1
2
3
4
5
6
7
8
9
10
11
12
13

上面代码中,第一次调用loadUI函数时,该函数不会执行,仅返回一个遍历器。下一次对该遍历器调用next方法,则会显示Loading界面(showLoadingScreen),并且异步加载数据(loadUIDataAsynchronously)。等到数据加载完成,再一次使用next方法,则会隐藏Loading界面。可以看到,这种写法的好处是所有Loading界面的逻辑,都被封装在一个函数,按部就班非常清晰。

Ajax 是典型的异步操作,通过 Generator 函数部署 Ajax 操作,可以用同步的方式表达。

function* main() {
  var result = yield request("http://some.url"); // 异步请求数据
  var resp = JSON.parse(result); // 解析 JSON 数据
  console.log(resp.value); // 输出解析结果
}

function request(url) {
  makeAjaxCall(url, function(response) {
    it.next(response); // 异步操作完成后继续执行 Generator 函数
  });
}

var it = main(); // 创建 Generator 对象
it.next(); // 开始执行 Generator 函数
1
2
3
4
5
6
7
8
9
10
11
12
13
14

上面代码的main函数,就是通过 Ajax 操作获取数据。可以看到,除了多了一个yield,它几乎与同步操作的写法完全一样。注意,makeAjaxCall函数中的next方法,必须加上response参数,因为yield表达式,本身是没有值的,总是等于undefined。

下面是另一个例子,通过 Generator 函数逐行读取文本文件。

function* numbers() {
  let file = new FileReader("numbers.txt"); // 打开文件
  try {
    while (!file.eof) { // 判断是否到达文件末尾
      yield parseInt(file.readLine(), 10); // 逐行读取文件内容并解析为整数
    }
  } finally {
    file.close(); // 关闭文件
  }
}
1
2
3
4
5
6
7
8
9
10

上面代码打开文本文件,使用yield表达式可以手动逐行读取文件。

# (2)控制流管理

如果有一个多步操作非常耗时,采用回调函数,可能会写成下面这样。

step1(function (value1) {
  step2(value1, function(value2) {
    step3(value2, function(value3) {
      step4(value3, function(value4) {
        // Do something with value4
      });
    });
  });
});
1
2
3
4
5
6
7
8
9

采用 Promise 改写上面的代码。

Promise.resolve(step1)
  .then(step2)
  .then(step3)
  .then(step4)
  .then(function (value4) {
    // Do something with value4
  }, function (error) {
    // Handle any error from step1 through step4
  })
  .done();
1
2
3
4
5
6
7
8
9
10

上面代码已经把回调函数,改成了直线执行的形式,但是加入了大量 Promise 的语法。Generator 函数可以进一步改善代码运行流程。

function* longRunningTask(value1) {
  try {
    var value2 = yield step1(value1); // 第一步
    var value3 = yield step2(value2); // 第二步
    var value4 = yield step3(value3); // 第三步
    var value5 = yield step4(value4); // 第四步
    // Do something with value4
  } catch (e) {
    // Handle any error from step1 through step4
  }
}
1
2
3
4
5
6
7
8
9
10
11

然后,使用一个函数,按次序自动执行所有步骤。

scheduler(longRunningTask(initialValue));

function scheduler(task) {
  var taskObj = task.next(task.value);
  // 如果 Generator 函数未结束,就继续调用
  if (!taskObj.done) {
    task.value = taskObj.value;
    scheduler(task);
  }
}
1
2
3
4
5
6
7
8
9
10

注意,上面这种做法,只适合同步操作,即所有的task都必须是同步的,不能有异步操作。因为这里的代码一得到返回值,就继续往下执行,没有判断异步操作何时完成。如果要控制异步的操作流程,详见后面的《异步操作》一章。

下面,利用for...of循环会自动依次执行yield命令的特性,提供一种更一般的控制流管理的方法。

let steps = [step1Func, step2Func, step3Func];

function* iterateSteps(steps) {
  for (var i = 0; i < steps.length; i++) {
    var step = steps[i];
    yield step(); // 执行每一步操作
  }
}
1
2
3
4
5
6
7
8

上面代码中,数组steps封装了一个任务的多个步骤,Generator 函数iterateSteps则是依次为这些步骤加上yield命令。

将任务分解成步骤之后,还可以将项目分解成多个依次执行的任务。

let jobs = [job1, job2, job3];

function* iterateJobs(jobs) {
  for (var i = 0; i < jobs.length; i++) {
    var job = jobs[i];
    yield* iterateSteps(job.steps); // 执行每个任务的步骤
  }
}
1
2
3
4
5
6
7
8

上面代码中,数组jobs封装了一个项目的多个任务,Generator 函数iterateJobs则是依次为这些任务加上yield*命令。

最后,就可以用for...of循环一次性依次执行所有任务的所有步骤。

for (var step of iterateJobs(jobs)) {
  console.log(step.id); // 输出每个步骤的 ID
}
1
2
3

再次提醒,上面的做法只能用于所有步骤都是同步操作的情况,不能有异步操作的步骤。如果想要依次执行异步的步骤,必须使用后面的《异步操作》一章介绍的方法。

for...of的本质是一个while循环,所以上面的代码实质上执行的是下面的逻辑。

var it = iterateJobs(jobs);
var res = it.next();

while (!res.done) {
  var result = res.value;
  // 处理结果
  res = it.next();
}
1
2
3
4
5
6
7
8

# (3)部署 Iterator 接口

利用 Generator 函数,可以在任意对象上部署 Iterator 接口。

function* iterEntries(obj) {
  let keys = Object.keys(obj); // 获取对象的所有键
  for (let i = 0; i < keys.length; i++) {
    let key = keys[i];
    yield [key, obj[key]]; // 依次返回键值对
  }
}

let myObj = { foo: 3, bar: 7 };

for (let [key, value] of iterEntries(myObj)) {
  console.log(key, value); // 输出每个键值对
}

// foo 3
// bar 7
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

image-20240728193933715

上述代码中,myObj是一个普通对象,通过iterEntries函数,就有了 Iterator 接口。也就是说,可以在任意对象上部署next方法。

下面是一个对数组部署 Iterator 接口的例子,尽管数组原生具有这个接口。

function* makeSimpleGenerator(array) {
  var nextIndex = 0;

  while (nextIndex < array.length) {
    yield array[nextIndex++]; // 依次返回数组的每个元素
  }
}

var gen = makeSimpleGenerator(['yo', 'ya']);

gen.next().value // 'yo'
gen.next().value // 'ya'
gen.next().done  // true
1
2
3
4
5
6
7
8
9
10
11
12
13

# (4)作为数据结构

Generator 可以看作是数据结构,更确切地说,可以看作是一个数组结构,因为 Generator 函数可以返回一系列的值,这意味着它可以对任意表达式,提供类似数组的接口。

function* doStuff() {
  yield fs.readFile.bind(null, 'hello.txt'); // 读取 hello.txt 文件
  yield fs.readFile.bind(null, 'world.txt'); // 读取 world.txt 文件
  yield fs.read

File.bind(null, 'and-such.txt'); // 读取 and-such.txt 文件
}
1
2
3
4
5
6
7

上面代码就是依次返回三个函数,但是由于使用了 Generator 函数,导致可以像处理数组那样,处理这三个返回的函数。

for (task of doStuff()) {
  // task 是一个函数,可以像回调函数那样使用它
}
1
2
3

实际上,如果用 ES5 表达,完全可以用数组模拟 Generator 的这种用法。

function doStuff() {
  return [
    fs.readFile.bind(null, 'hello.txt'), // 读取 hello.txt 文件
    fs.readFile.bind(null, 'world.txt'), // 读取 world.txt 文件
    fs.readFile.bind(null, 'and-such.txt') // 读取 and-such.txt 文件
  ];
}
1
2
3
4
5
6
7

上面的函数,可以用一模一样的for...of循环处理!两相一比较,就不难看出 Generator 使得数据或者操作,具备了类似数组的接口。

编辑此页 (opens new window)
上次更新: 2024/12/28, 18:32:08
Iterator 和 for-of 循环
Generator 函数的异步应用

← Iterator 和 for-of 循环 Generator 函数的异步应用→

Theme by Vdoing | Copyright © 2019-2025 程序员scholar
  • 跟随系统
  • 浅色模式
  • 深色模式
  • 阅读模式