Generator 函数的语法

Generator 函数的语法

  1. 简介
  2. next方法的参数
  3. for…of循环
  4. Generator.prototype.throw())
  5. Generator.prototype.return())
  6. yield*
    语句
  7. 作为靶子属性之Generator函数
  8. Generator函数的this
  9. 含义
  10. 应用

简介

基本概念

Generator 函数是 ES6
提供的一样栽异步编程解决方案,语法行为跟民俗函数完全不同。本章详细介绍Generator
函数的语法和 API,它的异步编程应用请看《Generator 函数的异步应用》一章。

Generator 函数有多知情角度。从语法上,首先可以将她掌握成,Generator
函数是一个状态机,封装了大半独里面状态。

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

款式达到,Generator
函数是一个通常函数,但是发生个别单特点。一凡,function着重字与函数称呼中发生一个星号;二凡,函数体内部以yield话语,定义不同的其中状态(yield于英语里的意思就是是“产出”)。

function* helloWorldGenerator() {
  yield 'hello';
  yield 'world';
  return 'ending';
}

var hw = helloWorldGenerator();

点代码定义了一个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 }

方代码一共调用了季不成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主意,就会见回到一个享有valuedone点滴只属性之对象。value性能表示即之里边状态的值,是yield说话后面那个表达式的价值;done属性是一个布尔值,表示是否遍历结束。

ES6没有确定,function重在字和函数叫做以内的星号,写以谁位置。这招下面的写法都能由此。

function * foo(x, y) { ··· }

function *foo(x, y) { ··· }

function* foo(x, y) { ··· }

function*foo(x, y) { ··· }

鉴于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;
}

点代码中,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()
}, 2000);

地方代码中,函数f若果是屡见不鲜函数,在为变量generator赋值时即便见面实行。但是,函数f凡是一个Generator函数,就变成只有调用next方法时,函数f才会实施。

此外需要注意,yield喻句子不可知用在普通函数中,否则会报错。

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

地方代码在一个平常函数中利用yield谈,结果产生一个句法错误。

下面是另外一个例证。

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

var flat = function* (a) {
  a.forEach(function (item) {
    if (typeof item !== 'number') {
      yield* flat(item);
    } else {
      yield item;
    }
  }
};

for (var f of flat(arr)){
  console.log(f);
}

地方代码也会见起句法错误,因为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);
    } else {
      yield item;
    }
  }
};

for (var f of flat(arr)) {
  console.log(f);
}
// 1, 2, 3, 4, 5, 6

另外,yield语词如果用当一个表达式之中,必须放在圆括号内部。

console.log('Hello' + yield); // SyntaxError
console.log('Hello' + yield 123); // SyntaxError

console.log('Hello' + (yield)); // OK
console.log('Hello' + (yield 123)); // OK

yield言用作函数参数或赋值表达式的右,可以免加括号。

foo(yield 'a', yield 'b'); // OK
let input = yield; // OK

同Iterator接口的涉

齐一致节说了,任意一个靶的Symbol.iterator办法,等于该目标的遍历器生成函数,调用该函数会返回该对象的一个遍历器对象。

由Generator函数就是遍历器生成函数,因此好管Generator赋值给目标的Symbol.iterator特性,从而使得该对象拥有Iterator接口。

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

[...myIterable] // [1, 2, 3]

地方代码中,Generator函数赋值给Symbol.iterator性能,从而让myIterable对象有了Iterator接口,可以被...运算符遍历了。

Generator函数执行后,返回一个遍历器对象。该目标自我为有Symbol.iterator特性,执行后回来自己。

function* gen(){
  // some code
}

var g = gen();

g[Symbol.iterator]() === g
// true

点代码中,gen凡是一个Generator函数,调用它会生成一个遍历器对象g。它的Symbol.iterator特性,也是一个遍历器对象十分成函数,执行后回到她自己。

next方法的参数

yield句我没有回来值,或者说总是回到undefinednext方好拉动一个参数,该参数就会被当做上一个yield说话的归值。

function* f() {
  for(var i = 0; true; i++) {
    var reset = yield i;
    if(reset) { i = -1; }
  }
}

var g = f();

g.next() // { value: 0, done: false }
g.next() // { value: 1, done: false }
g.next(true) // { value: 0, done: false }

方代码先定义了一个得无限运行的 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));
  var z = yield (y / 3);
  return (x + y + z);
}

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

var b = foo(5);
b.next() // { value:6, done:false }
b.next(12) // { value:8, done:false }
b.next(13) // { value:42, done:true }

上面代码中,第二不善运行next方式的上不带来参数,导致y的值等于2 * undefined(即NaN),除以3自此或NaN,因此归对象的value性能为等NaN。第三不成运行Next法的时刻不带来参数,所以z等于undefined,返回对象的value性能等5 + NaN + undefined,即NaN

如果向next计供参数,返回结果虽全盘不等同了。上面代码第一浅调用bnext方法时,返回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 wrapper(generatorFunction) {
  return function (...args) {
    let generatorObject = generatorFunction(...args);
    generatorObject.next();
    return generatorObject;
  };
}

const wrapped = wrapper(function* () {
  console.log(`First input: ${yield}`);
  return 'DONE';
});

wrapped().next('hello!')
// First input: hello!

面代码中,Generator函数如果不用wrapper先确保一重叠,是力不从心第一蹩脚调用next道,就输入参数的。

还拘留一个透过next措施的参数,向Generator函数内部输入值的事例。

function* dataConsumer() {
  console.log('Started');
  console.log(`1. ${yield}`);
  console.log(`2. ${yield}`);
  return 'result';
}

let genObj = dataConsumer();
genObj.next();
// Started
genObj.next('a')
// 1. a
genObj.next('b')
// 2. b

地方代码是一个怪直观的例证,每次通过next办法为Generator函数输入值,然后打印出。

for…of循环

for...of巡回可以自行遍历Generator函数时别的Iterator对象,且这不再要调用next方法。

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

for (let v of foo()) {
  console.log(v);
}
// 1 2 3 4 5

方代码用for...of循环,依次显示5个yield谈的价。这里要注意,一旦next艺术的回到对象的done属性为truefor...of循环就会见半途而废,且未含有该归对象,所以地方代码的return喻句子返回的6,不包括于for...of循环之中。

脚是一个采用Generator函数和for...of巡回,实现斐波那契数列的例证。

function* fibonacci() {
  let [prev, curr] = [0, 1];
  for (;;) {
    [prev, curr] = [curr, prev + curr];
    yield curr;
  }
}

for (let n of fibonacci()) {
  if (n > 1000) break;
  console.log(n);
}

于点代码可见,使用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

点代码中,对象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;

for (let [key, value] of jane) {
  console.log(`${key}: ${value}`);
}
// first: Jane
// last: Doe

除了for...of循环外,扩展运算符(...)、解构赋值和Array.from道中调用的,都是全部历器接口。这象征,它们都得以用Generator函数返回的Iterator对象,作为参数。

function* numbers () {
  yield 1
  yield 2
  return 3
  yield 4
}

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

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

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

// for...of 循环
for (let n of numbers()) {
  console.log(n)
}
// 1
// 2

Generator.prototype.throw()

Generator函数返回的遍历器对象,都起一个throw办法,可以于函数体外抛来荒唐,然后在Generator函数体内破获。

var g = function* () {
  try {
    yield;
  } catch (e) {
    console.log('内部捕获', e);
  }
};

var i = g();
i.next();

try {
  i.throw('a');
  i.throw('b');
} catch (e) {
  console.log('外部捕获', e);
}
// 内部捕获 a
// 外部捕获 b

点代码中,遍历器对象i连丢来片只错误。第一独错为Generator函数体内的catch告句捕获。i第二涂鸦抛来左,由于Generator函数内部的catch说话已经执行过了,不见面又捕捉到者似是而非了,所以是错误就是被抛弃来了Generator函数体,被函数体外的catch晓句捕获。

throw道可以接受一个参数,该参数会给catch言语接收,建议抛出Error靶的实例。

var g = function* () {
  try {
    yield;
  } catch (e) {
    console.log(e);
  }
};

var i = g();
i.next();
i.throw(new Error('出错了!'));
// Error: 出错了!(…)

专注,不要混淆遍历器对象的throw方法及全局的throw一声令下。上面代码的错误,是因此任何历器对象的throw方抛来的,而无是为此throw令抛出的。后者只能为函数体外的catch告知句子捕获。

var g = function* () {
  while (true) {
    try {
      yield;
    } catch (e) {
      if (e != 'a') throw e;
      console.log('内部捕获', e);
    }
  }
};

var i = g();
i.next();

try {
  throw new Error('a');
  throw new Error('b');
} catch (e) {
  console.log('外部捕获', e);
}
// 外部捕获 [Error: a]

地方代码用只有捕获了a,是以函数体外的catch语句块,捕获了丢来之a荒谬后,就无见面又持续try代码块里面剩余的告诉句了。

如若Generator函数内部没有配备try...catch代码块,那么throw术抛来之荒唐,将吃外表try...catch代码块捕获。

var g = function* () {
  while (true) {
    yield;
    console.log('内部捕获', e);
  }
};

var i = g();
i.next();

try {
  i.throw('a');
  i.throw('b');
} catch (e) {
  console.log('外部捕获', e);
}
// 外部捕获 a

方代码中,Generator函数g内从不配备try...catch代码块,所以抛出的缪直接给标catch代码块捕获。

要是Generator函数内部与外部,都无配备try...catch代码块,那么程序将报错,直接中断执行。

var gen = function* gen(){
  yield console.log('hello');
  yield console.log('world');
}

var g = gen();
g.next();
g.throw();
// hello
// Uncaught undefined

点代码中,g.throw抛弃来左后,没有其他try...catch代码块好捕获这个荒唐,导致程序报错,中断执行。

throw艺术给擒获以后,会顺手执行下一样条yield言辞。也就是说,会有意无意执行同样糟next方法。

var gen = function* gen(){
  try {
    yield console.log('a');
  } catch (e) {
    // ...
  }
  yield console.log('b');
  yield console.log('c');
}

var g = gen();
g.next() // a
g.throw() // b
g.next() // c

方代码中,g.throw主意吃擒获以后,自动执行了同样不好next法,所以会见打印b。另外,也可看来,只要Generator函数内部布置了try...catch代码块,那么所有历器的throw艺术抛来底错误,不影响下同样涂鸦遍历。

另外,throw命令与g.throw方法是井水不犯河水的,两者互不影响。

var gen = function* gen(){
  yield console.log('hello');
  yield console.log('world');
}

var g = gen();
g.next();

try {
  throw new Error();
} catch (e) {
  g.next();
}
// hello
// world

面代码中,throw命令抛出的荒唐不会见潜移默化及周历器的状态,所以片次施行next道,都进展了科学的操作。

这种函数体内破获错误的机制,大大便利了针对性不当的拍卖。多单yield话,可以只用一个try...catch代码片来捕获错误。如果采用回调函数的写法,想要捕获多独谬误,就只好为每个函数内部写一个错误处理语句,现在不过于Generator函数内部写一不成catch话就好了。

Generator函数体外抛来的荒唐,可以于函数体内破获;反过来,Generator函数体内扔来底荒谬,也可给函数体外的catch捕获。

function *foo() {
  var x = yield 3;
  var y = x.toUpperCase();
  yield y;
}

var it = foo();

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

try {
  it.next(42);
} catch (err) {
  console.log(err);
}

面代码中,第二只next道向函数体内传出一个参数42,数值是没有toUpperCase措施的,所以会丢来一个TypeError错误,被函数体外的catch捕获。

比方Generator执行进程被丢掉来荒唐,且尚未让间捕获,就未会见还实行下去了。如果以后还调用next道,将回来一个value性能等undefineddone性能等true的目标,即JavaScript引擎认为这个Generator已经运行了了。

function* g() {
  yield 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();
    console.log('第一次运行next方法', v);
  } catch (err) {
    console.log('捕捉错误', v);
  }
  try {
    v = generator.next();
    console.log('第二次运行next方法', v);
  } catch (err) {
    console.log('捕捉错误', v);
  }
  try {
    v = generator.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

地方代码一共叔软运行next主意,第二破运行的时段会扔来左,然后第三赖运行的时节,Generator函数就早已完结了,不再实行下去了。

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 }

方代码中,遍历器对象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 }

设Generator函数内部发生try...finally代码块,那么return方法会推迟到finally代码块执行了还履行。

function* numbers () {
  yield 1;
  try {
    yield 2;
    yield 3;
  } finally {
    yield 4;
    yield 5;
  }
  yield 6;
}
var g = numbers()
g.next() // { done: false, value: 1 }
g.next() // { done: false, value: 2 }
g.return(7) // { done: false, value: 4 }
g.next() // { done: false, value: 5 }
g.next() // { done: true, value: 7 }

上面代码中,调用return方后,就起来推行finally代码块,然后等及finally代码块执行了,再履行return方法。

yield* 语句

若果当 Generator 函数内部,调用另一个 Generator
函数,默认情况下是从未有过作用的。

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

function* bar() {
  yield 'x';
  foo();
  yield 'y';
}

for (let v of bar()){
  console.log(v);
}
// "x"
// "y"

方代码中,foobar都是 Generator
函数,在bar内调用foo,是匪会见发生作用的。

斯就是需要动用yield*言辞,用来以一个 Generator 函数里面实践另外一个
Generator 函数。

function* bar() {
  yield 'x';
  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;
  }
  yield 'y';
}

for (let v of bar()){
  console.log(v);
}
// "x"
// "a"
// "b"
// "y"

再次来拘禁一个相对而言的例证。

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

function* outer1() {
  yield 'open';
  yield inner();
  yield 'close';
}

var gen = outer1()
gen.next().value // "open"
gen.next().value // 返回一个遍历器对象
gen.next().value // "close"

function* outer2() {
  yield 'open'
  yield* inner()
  yield 'close'
}

var gen = outer2()
gen.next().value // "open"
gen.next().value // "hello!"
gen.next().value // "close"

点例子中,outer2使用了yield*outer1没动用。结果就是,outer1回来一个遍历器对象,outer2回去该整整历器对象的里价。

起语法角度看,如果yield命令后与的是一个遍历器对象,需要在yield一声令下后长星号,表明其回到的是一个遍历器对象。这让号称yield*语句。

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

let delegatingIterator = (function* () {
  yield 'Greetings!';
  yield* delegatedIterator;
  yield 'Ok, bye.';
}());

for(let value of delegatingIterator) {
  console.log(value);
}
// "Greetings!
// "Hello!"
// "Bye!"
// "Ok, bye."

地方代码中,delegatingIterator是代理者,delegatedIterator大凡吃代理者。由于yield* delegatedIterator告诉句得到的价值,是一个遍历器,所以要是用星号表示。运行结果虽是使用一个遍历器,遍历了差不多个Generator函数,有递归的效力。

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

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

// 等同于

function* concat(iter1, iter2) {
  for (var value of iter1) {
    yield value;
  }
  for (var value of iter2) {
    yield value;
  }
}

地方代码说明,yield*后面的Generator函数(没有return语句时),不过是for...of的平栽简写形式,完全可据此后世替代前者。反之,则要用var value = yield* iterator的样式取得return话语的值。

如果yield*背后跟着一个屡次组,由于数组原生支持整个历器,因此便会遍历数组成员。

function* gen(){
  yield* ["a", "b", "c"];
}

gen().next() // { value:"a", done:false }

上面代码中,yield命后要非加以星号,返回的凡百分之百数组,加了星号就表示回去的凡一再组的遍历器对象。

骨子里,任何数据结构只要来Iterator接口,就好吃yield*遍历。

let read = (function* () {
  yield 'hello';
  yield* 'hello';
})();

read.next().value // "hello"
read.next().value // "h"

面代码中,yield告诉句返回整个字符串,yield*报告词返回单个字符。因为字符串具有Iterator接口,所以叫yield*遍历。

如果吃代理的Generator函数有return话语,那么即使可以向代理它的Generator函数返回数据。

function *foo() {
  yield 2;
  yield 3;
  return "foo";
}

function *bar() {
  yield 1;
  var v = yield *foo();
  console.log( "v: " + v );
  yield 4;
}

var it = bar();

it.next()
// {value: 1, done: false}
it.next()
// {value: 2, done: false}
it.next()
// {value: 3, done: false}
it.next();
// "v: foo"
// {value: 4, done: false}
it.next()
// {value: undefined, done: true}

方代码在第四蹩脚调用next方法的当儿,屏幕上会产生出口,这是为函数fooreturn语句,向函数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' ]

点代码中,存在个别差遍历。第一次是扩大运算符遍历函数logReturned归来的遍历器对象,第二浅是yield*谈遍历函数genFuncWithReturn返的遍历器对象。这点儿赖遍历的法力是增大的,最终表现呢扩大运算符遍历函数genFuncWithReturn返回的遍历器对象。所以,最后的数量表达式得到的值等于[ 'a', 'b' ]。但是,函数genFuncWithReturnreturn言的返回值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

下面是一个有点复杂的例证,使用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']]]);

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

result
// ['a', 'b', 'c', 'd', 'e', 'f', 'g']

作目标属性的Generator函数

假如一个靶的性质是Generator函数,可以简写成下面的形式。

let obj = {
  * myGeneratorMethod() {
    ···
  }
};

地方代码中,myGeneratorMethod性前面来一个星号,表示是特性是一个Generator函数。

她的一体化形式如下,与地方的写法是当价格的。

let obj = {
  myGeneratorMethod: function* () {
    // ···
  }
};

Generator函数的this

Generator函数总是回到一个遍历器,ES6确定是遍历器是Generator函数的实例,也累了Generator函数的prototype靶及之措施。

function* g() {}

g.prototype.hello = function () {
  return 'hi!';
};

let obj = g();

obj instanceof g // true
obj.hello() // 'hi!'

方代码表明,Generator函数g返的遍历器obj,是g的实例,而且延续了g.prototype。但是,如果把g作普通的构造函数,并无见面收效,因为g归来的连日遍历器对象,而无是this对象。

function* g() {
  this.a = 11;
}

let obj = g();
obj.a // undefined

面代码中,Generator函数gthis目标方面添加了一个性质a,但是obj靶将不至是特性。

Generator函数也无克与new令并就此,会报错。

function* F() {
  yield this.x = 2;
  yield this.y = 3;
}

new F()
// TypeError: F is not a constructor

点代码中,new命令和构造函数F并行使,结果报错,因为F无是构造函数。

那,有没有发方法给Generator函数返回一个正常的对象实例,既可以为此next主意,又足以获正常的this

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

function* F() {
  this.a = 1;
  yield this.b = 2;
  yield this.c = 3;
}
var obj = {};
var f = F.call(obj);

f.next();  // Object {value: 2, done: false}
f.next();  // Object {value: 3, done: false}
f.next();  // Object {value: undefined, done: true}

obj.a // 1
obj.b // 2
obj.c // 3

点代码中,首先是F内部的this目标绑定obj靶,然后调用她,返回一个Iterator对象。这个目标执行三潮next方法(因为F里面有有限单yield谈),完成F内部所有代码的运作。这时,所有中属性都绑定以obj对象上了,因此obj目标啊便改为了F的实例。

上面代码中,执行之是满历器对象f,但是变化的目标实例是obj,有没来办法用即时点儿个目标统一啊?

一个计就是以obj换成F.prototype

function* F() {
  this.a = 1;
  yield this.b = 2;
  yield this.c = 3;
}
var f = F.call(F.prototype);

f.next();  // Object {value: 2, done: false}
f.next();  // Object {value: 3, done: false}
f.next();  // Object {value: undefined, done: true}

f.a // 1
f.b // 2
f.c // 3

再将F转化构造函数,就好对其执行new命令了。

function* gen() {
  this.a = 1;
  yield this.b = 2;
  yield this.c = 3;
}

function F() {
  return gen.call(gen.prototype);
}

var f = new F();

f.next();  // Object {value: 2, done: false}
f.next();  // Object {value: 3, done: false}
f.next();  // Object {value: undefined, done: true}

f.a // 1
f.b // 2
f.c // 3

含义

Generator以及状态机

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

var ticking = true;
var clock = function() {
  if (ticking)
    console.log('Tick!');
  else
    console.log('Tock!');
  ticking = !ticking;
}

点代码的clock函数一共有零星种植状态(Tick和Tock),每运行一糟糕,就转同样蹩脚状态。这个函数如果用Generator实现,就是下面这样。

var clock = function*() {
  while (true) {
    console.log('Tick!');
    yield;
    console.log('Tock!');
    yield;
  }
};

方的Generator实现同ES5兑现比,可以见到丢失了用于保存状态的表面变量ticking,这样就算再简单,更安全(状态不见面吃私自篡改)、更契合函数式编程的琢磨,在写法上吗再次优雅。Generator之所以可以不要外部变量保存状态,是因其本身就带有了一个态信息,即当前是否处在暂停态。

Generator与协程

协程(coroutine)是均等种程序运行的法子,可以知晓成“协作的线程”或“协作的函数”。协程既可以为此单线程实现,也堪为此多线程实现。前者是同一栽独特的子例程,后者是一样种植奇特之线程。

(1)协程与子例程的距离

风土的“子例程”(subroutine)采用堆栈式“后进先出”的实施方,只有当调用的子函数完全实施了,才会终止执行父函数。协程与那个不同,多单线程(单线程情况下,即多只函数)可以并行执行,但是只生一个线程(或函数)处于正在运转的状态,其他线程(或函数)都地处暂停态(suspended),线程(或函数)之间可以交换执行权。也就是说,一个线程(或函数)执行及一半,可以暂停实施,将执行权交给其他一个线程(或函数),等到稍后收回执行权的下,再回复执行。这种可并行执行、交换执行权的线程(或函数),就叫做协程。

从实现达标看,在内存中,子例程只使一个仓库(stack),而协程是又在多独仓库,但只是来一个仓房是以运作状态,也就是说,协程是盖差不多占用内存也代价,实现多任务的竞相。

(2)协程与平常线程的区别

不难看出,协程适合用来多任务运行的环境。在斯意思及,它跟常见的线程很一般,都发协调的实行上下文、可以大饱眼福全局变量。它们的不同之处在于,同一时间可以生多独线程处于运行状态,但是运行的协程只能发出一个,其他协程都处于停顿状态。此外,普通的线程是抢先式的,到底何许人也线程优先获得资源,必须由运行条件控制,但是协程是合作式的,执行权由协程自己分配。

是因为ECMAScript是单线程语言,只能维持一个调用栈。引入协程以后,每个任务可维持协调之调用栈。这样做的尽老益,就是废来左的时刻,可以找到原来之调用栈。不至于像异步操作的回调函数那样,一旦出错,原始之调用栈早就结。

Generator函数是ECMAScript
6针对协程的兑现,但属于无净实现。Generator函数被名“半协程”(semi-coroutine),意思是独生Generator函数的调用者,才能够用次第的执行权还于Generator函数。如果是一点一滴实施之协程,任何函数都可以于暂停的协程继续执行。

假定以Generator函数当作协程,完全好以大半只待彼此合作的职责写成Generator函数,它们中间用yield语句交换控制权。

应用

Generator可以暂停函数执行,返回任意表达式的价值。这种特征令Generator有强采取场景。

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

Generator函数的中止实施的成效,意味着可以拿异步操作写在yield语句里面,等到调用next方法时重为后行。这实际上等同于未需写回调函数了,因为异步操作的延续操作可以放在yield语句下面,反正要等到调用next方法时更实践。所以,Generator函数的一个着重实际意义就是之所以来拍卖异步操作,改写回调函数。

function* loadUI() {
  showLoadingScreen();
  yield loadUIDataAsynchronously();
  hideLoadingScreen();
}
var loader = loadUI();
// 加载UI
loader.next()

// 卸载UI
loader.next()

面代码表示,第一次于调动用loadUI函数时,该函数不见面履,仅返回一个遍历器。下一致次对该遍历器调用next方法,则会展示Loading界面,并且异步加载数据。等交数加载成功,再同破采取next方法,则会隐藏Loading界面。可以望,这种写法的好处是怀有Loading界面的逻辑,都让封装在一个函数,按部就班非常鲜明。

Ajax是名列前茅的异步操作,通过Generator函数部署Ajax操作,可以为此同的方式发挥。

function* main() {
  var result = yield request("http://some.url");
  var resp = JSON.parse(result);
    console.log(resp.value);
}

function request(url) {
  makeAjaxCall(url, function(response){
    it.next(response);
  });
}

var it = main();
it.next();

面代码的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();
  }
}

点代码打开文本文件,使用yield语句可以手动逐行读取文件。

(2)控制流管理

假使生一个多步操作十分耗时,采用回调函数,可能会见写成下面这样。

step1(function (value1) {
  step2(value1, function(value2) {
    step3(value2, function(value3) {
      step4(value3, function(value4) {
        // Do something with value4
      });
    });
  });
});

行使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();

方代码都把回调函数,改成为了直线执行之款型,但是在了汪洋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
  }
}

然后,使用一个函数,按程序自动执行有手续。

scheduler(longRunningTask(initialValue));

function scheduler(task) {
  var taskObj = task.next(task.value);
  // 如果Generator函数未结束,就继续调用
  if (!taskObj.done) {
    task.value = taskObj.value
    scheduler(task);
  }
}

顾,上面这种做法,只适合同步操作,即有的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();
  }
}

地方代码中,数组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);
  }
}

点代码中,数组jobs包了一个类别之几近只任务,Generator函数iterateJobs虽是逐一为这些任务加上yield *命令。

最终,就可用for...of循环一次性依次执行有任务的具有手续。

for (var step of iterateJobs(jobs)){
  console.log(step.id);
}

重新提醒,上面的做法只能用于所有手续都是同步操作的情形,不可知有异步操作的步骤。如果想要挨个执行异步的步调,必须用后的《异步操作》一回介绍的法子。

for...of的面目是一个while巡回,所以地方的代码实质上实施之是脚的逻辑。

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

while (!res.done){
  var result = res.value;
  // ...
  res = it.next();
}

(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

上述代码中,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

(4)作为数据结构

Generator可以作为是数据结构,更确切地游说,可以看作是一个数组结构,因为Generator函数可以返回一多级的价值,这表示它好对自由表达式,提供类似数组的接口。

function *doStuff() {
  yield fs.readFile.bind(null, 'hello.txt');
  yield fs.readFile.bind(null, 'world.txt');
  yield fs.readFile.bind(null, 'and-such.txt');
}

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

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

骨子里,如果用ES5发挥,完全可就此数组模拟Generator的这种用法。

function doStuff() {
  return [
    fs.readFile.bind(null, 'hello.txt'),
    fs.readFile.bind(null, 'world.txt'),
    fs.readFile.bind(null, 'and-such.txt')
  ];
}

点的函数,可以为此相同型一样的for…of循环处理!两互平等比,就不难看出Generator使得数据要操作,具备了近似数组的接口。