es6-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讲话只能用在 Generator
函数里面,用当另地方都见面报错。

(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晓句如果就此在一个表达式之中,必须放在圆括号内。

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

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

yield话语用作函数参数或坐落赋值表达式的右,可以无加括号。

function* demo() {
  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使得数据要操作,具备了接近数组的接口。