generator

Mr.Hope ... 2019-10-07 JavaScript 大约 4 分钟

# generator

generator (生成器)是 ES6 标准引入的新的数据类型。一个 generator 看上去像一个函数,但可以返回多次。

ES6 定义 generator 标准的哥们借鉴了 Python 的 generator 的概念和语法,如果您对 Python 的 generator 很熟悉,那么 ES6 的 generator 就是小菜一碟了。

我们先复习函数的概念。一个函数是一段完整的代码,调用一个函数就是传入参数,然后返回结果:

const foo = (x) => x + x;

const r = foo(1); // 调用foo函数
1
2
3

函数在执行过程中,如果没有遇到 return 语句(函数末尾如果没有 return,就是隐含的 return undefined;),控制权无法交回被调用的代码。

generator 跟函数很像,定义如下:

function* foo(x) {
  yield x + 1;
  yield x + 2;
  return x + 3;
}
1
2
3
4
5

generator 和函数不同的是,generatorfunction* 定义(注意多出的 * 号),并且,除了 return 语句,还可以用 yield 返回多次。

大多数同学立刻就晕了,generator 就是能够返回多次的“函数”?返回多次有啥用?

还是举个栗子吧。

我们以一个著名的斐波那契数列为例,它由 0,1 开头:

0 1 1 2 3 5 8 13 21 34 ...

要编写一个产生斐波那契数列的函数,可以这么写:

function fib(max) {
  let a = 0;
  let b = 1;
  const arr = [0, 1];

  while (arr.length < max) {
    [a, b] = [b, a + b];
    arr.push(b);
  }

  return arr;
}

// 测试:
fib(5); // [0, 1, 1, 2, 3]
fib(10); // [0, 1, 1, 2, 3, 5, 8, 13, 21, 34]
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

函数只能返回一次,所以必须返回一个 Array。但是,如果换成 generator,就可以一次返回一个数,不断返回多次。用 generator 改写如下:

function* fib(max) {
  let a = 0;
  let b = 1;
  let n = 0;

  while (n < max) {
    yield a;
    [a, b] = [b, a + b];
    n++;
  }

  return;
}
1
2
3
4
5
6
7
8
9
10
11
12
13

直接调用试试:

fib(5); // fib {[[GeneratorStatus]]: "suspended", [[GeneratorReceiver]]: Window}
1

直接调用一个 generator 和调用函数不一样,fib(5) 仅仅是创建了一个 generator 对象,还没有去执行它。

调用 generator 对象有两个方法,一是不断地调用 generator 对象的 next() 方法:

const f = fib(5);
f.next(); // {value: 0, done: false}
f.next(); // {value: 1, done: false}
f.next(); // {value: 1, done: false}
f.next(); // {value: 2, done: false}
f.next(); // {value: 3, done: false}
f.next(); // {value: undefined, done: true}
1
2
3
4
5
6
7

next() 方法会执行 generator 的代码,然后,每次遇到 yield x; 就返回一个对象 {value: x, done: true/false},然后“暂停”。返回的value 就是 yield 的返回值,done 表示这个 generator 是否已经执行结束了。如果 donetrue,则 value 就是 return 的返回值。

当执行到 donetrue 时,这个 generator 对象就已经全部执行完毕,不要再继续调用 next() 了。

第二个方法是直接用for ... of循环迭代 generator 对象,这种方式不需要我们自己判断 done:

"use strict";

function* fib(max) {
  let a = 0;
  let b = 1;
  let n = 0;

  while (n < max) {
    yield a;
    [a, b] = [b, a + b];
    n++;
  }
}

for (let x of fib(10)) {
  console.log(x); // 依次输出0, 1, 1, 2, 3, ...
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

generator 和普通函数相比,有什么用?

因为 generator 可以在执行过程中多次返回,所以它看上去就像一个可以记住执行状态的函数,利用这一点,写一个 generator 就可以实现需要用面向对象才能实现的功能。例如,用一个对象来保存状态,得这么写:

const fib = {
  a: 0,
  b: 1,
  n: 0,
  max: 5,
  next() {
    let r = this.a;
    let t = this.a + this.b;

    this.a = this.b;
    this.b = t;
    if (this.n < this.max) {
      this.n++;
      return r;
    } else return undefined;
  },
};
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

用对象的属性来保存状态,相当繁琐。

generator 还有另一个巨大的好处,就是把异步回调代码变成“同步”代码。这个好处要等到后面学了 AJAX 以后才能体会到。

没有 generator 之前的黑暗时代,用 AJAX 时需要这么写代码:

ajax('https://url-1', data1, (err, result) => {
  if (err) return handle(err);

  ajax('https://url-2', data2, (err, result) => {
    if (err) return handle(err);

    ajax('https://url-3', data3, (err, result) =>
      err? handle(err): success(result);
    });
  });
});
1
2
3
4
5
6
7
8
9
10
11

回调越多,代码越难看。

有了 generator 的美好时代,用 AJAX 时可以这么写:

try {
  r1 = yield ajax('https://url-1', data1);
  r2 = yield ajax('https://url-2', data2);
  r3 = yield ajax('https://url-3', data3);
  success(r3);
} catch (err) {
  handle(err);
}
1
2
3
4
5
6
7
8

看上去是同步的代码,实际执行是异步的。