generator

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

ES6定义generator标准的哥们借鉴了Python的generator的概念和语法，如果你对Python的generator很熟悉，那么ES6的generator就是小菜一碟了。如果你对Python还不熟，赶快恶补Python教程！。

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

  1. function foo(x) {
  2.     return x + x;
  3. }
  5. var r = foo(1); // 调用foo函数

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

generator跟函数很像，定义如下：

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

generator和函数不同的是，generator由function*定义（注意多出的*号），并且，除了return语句，还可以用yield返回多次。

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

还是举个栗子吧。

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

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

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

  1. function fib(max) {
  2.     var
  3.         t,
  4.         a = 0,
  5.         b = 1,
  6.         arr = [0, 1];
  7.     while (arr.length < max) {
  8.         [a, b] = [b, a + b];
  9.         arr.push(b);
  10.     }
  11.     return arr;
  12. }
  14. // 测试:
  15. fib(5); // [0, 1, 1, 2, 3]
  16. fib(10); // [0, 1, 1, 2, 3, 5, 8, 13, 21, 34]

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

  1. function* fib(max) {
  2.     var
  3.         t,
  4.         a = 0,
  5.         b = 1,
  6.         n = 0;
  7.     while (n < max) {
  8.         yield a;
  9.         [a, b] = [b, a + b];
  10.         n ++;
  11.     }
  12.     return;
  13. }

直接调用试试：

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

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

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

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

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

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

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

generator - 图1

generator和普通函数相比，有什么用？

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

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

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

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

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

  1. ajax('http://url-1', data1, function (err, result) {
  2.     if (err) {
  3.         return handle(err);
  4.     }
  5.     ajax('http://url-2', data2, function (err, result) {
  6.         if (err) {
  7.             return handle(err);
  8.         }
  9.         ajax('http://url-3', data3, function (err, result) {
  10.             if (err) {
  11.                 return handle(err);
  12.             }
  13.             return success(result);
  14.         });
  15.     });
  16. });

回调越多，代码越难看。

有了generator的美好时代，用AJAX时可以这么写：

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

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

练习

要生成一个自增的ID，可以编写一个next_id()函数：

  1. var current_id = 0;
  3. function next_id() {
  4.     current_id ++;
  5.     return current_id;
  6. }

由于函数无法保存状态，故需要一个全局变量current_id来保存数字。

不用闭包，试用generator改写：

generator - 图2

读后有收获可以支付宝请作者喝咖啡，读后有疑问请加微信群讨论：

generator - 图3 generator - 图4