Generator 委托

在上一节中,我们展示了从generator内部调用普通函数,和它如何作为一种有用的技术来将实现细节(比如异步Promise流程)抽象出去。但是为这样的任务使用普通函数的缺陷是,它必须按照普通函数的规则行动,也就是说它不能像generator那样用yield来暂停自己。

在你身上可能发生这样的事情:你可能会试着使用我们的run(..)帮助函数,从一个generator中调用另个一generator。比如:

  1. function *foo() {
  2. var r2 = yield request( "http://some.url.2" );
  3. var r3 = yield request( "http://some.url.3/?v=" + r2 );
  4. return r3;
  5. }
  6. function *bar() {
  7. var r1 = yield request( "http://some.url.1" );
  8. // 通过`run(..)`“委托”到`*foo()`
  9. var r3 = yield run( foo );
  10. console.log( r3 );
  11. }
  12. run( bar );

通过再一次使用我们的run(..)工具,我们在*bar()内部运行*foo()。我们利用了这样一个事实:我们早先定义的run(..)返回一个promise,这个promise在generator运行至完成时才解析(或发生错误),所以如果我们从一个run(..)调用中yield出一个promise给另一个run(..),它就会自动暂停*bar()直到*foo()完成。

但这里有一个更好的办法将*foo()调用整合进*bar(),它称为yield委托。yield委托的特殊语法是:yield * __(注意额外的*)。让它在我们前面的例子中工作之前,让我们看一个更简单的场景:

  1. function *foo() {
  2. console.log( "`*foo()` starting" );
  3. yield 3;
  4. yield 4;
  5. console.log( "`*foo()` finished" );
  6. }
  7. function *bar() {
  8. yield 1;
  9. yield 2;
  10. yield *foo(); // `yield`-delegation!
  11. yield 5;
  12. }
  13. var it = bar();
  14. it.next().value; // 1
  15. it.next().value; // 2
  16. it.next().value; // `*foo()` starting
  17. // 3
  18. it.next().value; // 4
  19. it.next().value; // `*foo()` finished
  20. // 5

注意: 在本章早前的一个注意点中,我解释了为什么我偏好function *foo() ..而不是function* foo() ..,相似地,我也偏好——与关于这个话题的其他大多数文档不同——说yield *foo()而不是yield* foo()*的摆放是纯粹的风格问题,而且要看你的最佳判断。但我发现保持统一风格很吸引人。

yield *foo()委托是如何工作的?

首先,正如我们看到过的那样,调用foo()创建了一个 迭代器。然后,yield *将(当前*bar()generator的) 迭代器 的控制委托/传递给这另一个*foo()迭代器

那么,前两个it.next()调用控制着*bar(),但当我们发起第三个it.next()调用时,*foo()就启动了,而且这时我们控制的是*foo()而非*bar()。这就是为什么它称为委托——*bar()将它的迭代控制委托给*foo()

只要it迭代器 的控制耗尽了整个*foo()迭代器,它就会自动地将控制返回到*bar()

那么现在回到前面的三个顺序Ajax请求的例子:

  1. function *foo() {
  2. var r2 = yield request( "http://some.url.2" );
  3. var r3 = yield request( "http://some.url.3/?v=" + r2 );
  4. return r3;
  5. }
  6. function *bar() {
  7. var r1 = yield request( "http://some.url.1" );
  8. // 通过`run(..)`“委托”到`*foo()`
  9. var r3 = yield *foo();
  10. console.log( r3 );
  11. }
  12. run( bar );

这个代码段和前面使用的版本的唯一区别是,使用了yield *foo()而不是前面的yield run(foo)

注意: yield *让出了迭代控制,不是generator控制;当你调用*foo()generator时,你就yield委托给它的 迭代器。但你实际上可以yield委托给任何 迭代器yield *[1,2,3]将会消费默认的[1,2,3]数组值 迭代器

为什么委托?

yield委托的目的很大程度上是为了代码组织,而且这种方式是与普通函数调用对称的。

想象两个分别提供了foo()bar()方法的模块,其中bar()调用foo()。它们俩分开的原因一般是由于为了程序将它们作为分离的程序来调用而进行的恰当组织。例如,可能会有一些情况foo()需要被独立调用,而其他地方bar()来调用foo()

由于这些完全相同的原因,将generator分开可以增强程序的可读性,可维护性,与可调试性。从这个角度讲,yield *是一种快捷的语法,用来在*bar()内部手动地迭代*foo()的步骤。

如果*foo()中的步骤是异步的,这样的手动方式可能会特别复杂,这就是为什么你可能会需要那个run(..)工具来做它。正如我们已经展示的,yield *foo()消灭了使用run(..)工具的子实例(比如run(foo))的需要。

委托消息

你可能想知道,这种yield委托在除了与 迭代器 控制一起工作以外,是如何与双向消息传递一起工作的。仔细查看下面这些通过yield委托进进出出的消息流:

  1. function *foo() {
  2. console.log( "inside `*foo()`:", yield "B" );
  3. console.log( "inside `*foo()`:", yield "C" );
  4. return "D";
  5. }
  6. function *bar() {
  7. console.log( "inside `*bar()`:", yield "A" );
  8. // `yield`-委托!
  9. console.log( "inside `*bar()`:", yield *foo() );
  10. console.log( "inside `*bar()`:", yield "E" );
  11. return "F";
  12. }
  13. var it = bar();
  14. console.log( "outside:", it.next().value );
  15. // outside: A
  16. console.log( "outside:", it.next( 1 ).value );
  17. // inside `*bar()`: 1
  18. // outside: B
  19. console.log( "outside:", it.next( 2 ).value );
  20. // inside `*foo()`: 2
  21. // outside: C
  22. console.log( "outside:", it.next( 3 ).value );
  23. // inside `*foo()`: 3
  24. // inside `*bar()`: D
  25. // outside: E
  26. console.log( "outside:", it.next( 4 ).value );
  27. // inside `*bar()`: 4
  28. // outside: F

特别注意一下it.next(3)调用之后的处理步骤:

  1. 3被传入(通过*bar里的yield委托)在*foo()内部等待中的yield "C"表达式。
  2. 然后*foo()调用return "D",但是这个值不会一路返回到外面的it.next(3)调用。
  3. 相反地,值"D"作为结果被发送到在*bar()内部等待中的yield *foo()表示式——这个yield委托表达式实质上在*foo()被耗尽之前一直被暂停着。所以"D"被送到*bar()内部来让它打印。
  4. yield "E"*bar()内部被调用,而且值"E"被让出到外部作为it.next(3)调用的结果。

从外部 迭代器it)的角度来看,在初始的generator和被委托的generator之间的控制没有任何区别。

事实上,yield委托甚至不必指向另一个generator;它可以仅被指向一个非generator的,一般的 iterable。比如:

  1. function *bar() {
  2. console.log( "inside `*bar()`:", yield "A" );
  3. // `yield`-委托至一个非generator
  4. console.log( "inside `*bar()`:", yield *[ "B", "C", "D" ] );
  5. console.log( "inside `*bar()`:", yield "E" );
  6. return "F";
  7. }
  8. var it = bar();
  9. console.log( "outside:", it.next().value );
  10. // outside: A
  11. console.log( "outside:", it.next( 1 ).value );
  12. // inside `*bar()`: 1
  13. // outside: B
  14. console.log( "outside:", it.next( 2 ).value );
  15. // outside: C
  16. console.log( "outside:", it.next( 3 ).value );
  17. // outside: D
  18. console.log( "outside:", it.next( 4 ).value );
  19. // inside `*bar()`: undefined
  20. // outside: E
  21. console.log( "outside:", it.next( 5 ).value );
  22. // inside `*bar()`: 5
  23. // outside: F

注意这个例子与前一个之间,被接收/报告的消息的不同之处。

最惊人的是,默认的array迭代器 不关心任何通过next(..)调用被发送的消息,所以值23,与4实质上被忽略了。另外,因为这个 迭代器 没有明确的return值(不像前面使用的*foo()),所以yield *表达式在它完成时得到一个undefined

异常也委托!

yield委托在两个方向上透明地传递消息的方式相同,错误/异常也在双向传递:

  1. function *foo() {
  2. try {
  3. yield "B";
  4. }
  5. catch (err) {
  6. console.log( "error caught inside `*foo()`:", err );
  7. }
  8. yield "C";
  9. throw "D";
  10. }
  11. function *bar() {
  12. yield "A";
  13. try {
  14. yield *foo();
  15. }
  16. catch (err) {
  17. console.log( "error caught inside `*bar()`:", err );
  18. }
  19. yield "E";
  20. yield *baz();
  21. // note: can't get here!
  22. yield "G";
  23. }
  24. function *baz() {
  25. throw "F";
  26. }
  27. var it = bar();
  28. console.log( "outside:", it.next().value );
  29. // outside: A
  30. console.log( "outside:", it.next( 1 ).value );
  31. // outside: B
  32. console.log( "outside:", it.throw( 2 ).value );
  33. // error caught inside `*foo()`: 2
  34. // outside: C
  35. console.log( "outside:", it.next( 3 ).value );
  36. // error caught inside `*bar()`: D
  37. // outside: E
  38. try {
  39. console.log( "outside:", it.next( 4 ).value );
  40. }
  41. catch (err) {
  42. console.log( "error caught outside:", err );
  43. }
  44. // error caught outside: F

在这段代码中有一些事情要注意:

  1. 但我们调用it.throw(2)时,它发送一个错误消息2*bar(),而*bar()将它委托至*foo(),然后*foo()catch它并平静地处理。之后,yield "C""C"作为返回的value发送回it.throw(2)调用。
  2. 接下来值"D"被从*foo()内部throw出来并传播到*bar()*bar()catch它并平静地处理。然后yield "E""E"作为返回的value发送回it.next(3)调用。
  3. 接下来,一个异常从*baz()throw出来,而没有被*bar()捕获——我们没在外面catch它——所以*baz()*bar()都被设置为完成状态。这段代码结束后,即便有后续的next(..)调用,你也不会得到值"G"——它们的value将返回undefined

异步委托

最后让我们回到早先的多个顺序Ajax请求的例子,使用yield委托:

  1. function *foo() {
  2. var r2 = yield request( "http://some.url.2" );
  3. var r3 = yield request( "http://some.url.3/?v=" + r2 );
  4. return r3;
  5. }
  6. function *bar() {
  7. var r1 = yield request( "http://some.url.1" );
  8. var r3 = yield *foo();
  9. console.log( r3 );
  10. }
  11. run( bar );

*bar()内部,与调用yield run(foo)不同的是,我们调用yield *foo()就可以了。

在前一个版本的这个例子中,Promise机制(通过run(..)控制的)被用于将值从*foo()中的return r3传送到*bar()内部的本地变量r3。现在,这个值通过yield *机制直接返回。

除此以外,它们的行为是一样的。

“递归”委托

当然,yield委托可以一直持续委托下去,你想连接多少步骤就连接多少。你甚至可以在具有异步能力的generator上“递归”使用yield委托——一个yield委托至自己的generator:

  1. function *foo(val) {
  2. if (val > 1) {
  3. // 递归委托
  4. val = yield *foo( val - 1 );
  5. }
  6. return yield request( "http://some.url/?v=" + val );
  7. }
  8. function *bar() {
  9. var r1 = yield *foo( 3 );
  10. console.log( r1 );
  11. }
  12. run( bar );

注意: 我们的run(..)工具本可以用run( foo, 3 )来调用,因为它支持用额外传递的参数来进行generator的初始化。然而,为了在这里高调展示yield *的灵活性,我们使用了无参数的*bar()

这段代码之后的处理步骤是什么?坚持住,它的细节要描述起来可是十分错综复杂:

  1. run(bar)启动了*bar()generator。
  2. foo(3)*foo(..)创建了 迭代器 并传递3作为它的val参数。
  3. 因为3 > 1foo(2)创建了另一个 迭代器 并传递2作为它的val参数。
  4. 因为2 > 1foo(1)又创建了另一个 迭代器 并传递1作为它的val参数。
  5. 1 > 1false,所以我们接下来用值1调用request(..),并得到一个代表第一个Ajax调用的promise。
  6. 这个promise被yield出来,回到*foo(2)generator实例。
  7. yield *将这个promise传出并回到*foo(3)生成generator。另一个yield *把这个promise传出到*bar()generator实例。而又有另一个yield *把这个promise传出到run(..)工具,而它将会等待这个promise(第一个Ajax请求)再处理。
  8. 当这个promise解析时,它的完成消息会被发送以继续*bar()*bar()通过yield *把消息传递进*foo(3)实例,*foo(3)实例通过yield *把消息传递进*foo(2)generator实例,*foo(2)实例通过yield *把消息传给那个在*foo(3)generator实例中等待的一般的yield
  9. 这第一个Ajax调用的应答现在立即从*foo(3)generator实例中被return,作为*foo(2)实例中yield *表达式的结果发送回来,并赋值给本地val变量。
  10. *foo(2)内部,第二个Ajax请求用request(..)发起,它的promise被yield回到*foo(1)实例,然后一路yield *传播到run(..)(回到第7步)。当promise解析时,第二个Ajax应答一路传播回到*foo(2)generator实例,并赋值到他本地的val变量。
  11. 最终,第三个Ajax请求用request(..)发起,它的promise走出到run(..),然后它的解析值一路返回,最后被return到在*bar()中等待的yield *表达式。

天!许多疯狂的头脑杂技,对吧?你可能想要把它通读几遍,然后抓点儿零食放松一下大脑!