es6-Generator

Generator
函数是2个一般性函数,但是有两性景况。一是,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,表示遍历还并未终止。

其3次调用,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属性是3个布尔值,表示是不是遍历甘休。

ES6没有分明,function关键字与函数名之间的星号,写在哪些岗位。那致使下边的写法都能透过。

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

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

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

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

由于Generator函数依旧是日常函数,所以一般的写法是地方的第二种,即星号紧跟在function主要字背后。本书也利用那种写法。

yield语句

出于Generator函数重临的遍历器对象,唯有调用next办法才会遍历下3个里边景况,所以实际上提供了一种能够暂停实施的函数。yield话语正是暂停标志。

遍历器对象的next主意的运维逻辑如下。

(1)遇到yield话语,就暂停实施后边的操作,并将紧跟在yield背后的不胜表明式的值,作为再次来到的靶子的value属性值。

(2)下贰遍调用next方法时,再持续往下执行,直到碰到下1个yield语句。

(3)假设没有再境遇新的yield说话,就直接运转到函数甘休,直到return言语截止,并将return说话前面包车型地铁表明式的值,作为再次回到的指标的value属性值。

(4)假使该函数没有return言辞,则赶回的靶子的value属性值为undefined

内需专注的是,yield言辞前边的表明式,只有当调用next艺术、内部指针指向该语句时才会履行,因而等于为JavaScript提供了手动的“惰性求值”(Lazy
伊娃luation)的语法功能。

function* gen() {
  yield  123 + 456;
}

上边代码中,yield后边的表明式123 + 456,不会立马求值,只会在next办法将指针移到这一句时,才会求值。

yield语句与return言辞既有相似之处,也有分别。相似之处在于,都能回来紧跟在说话前面的万分表明式的值。不同在于每一趟遭逢yield,函数暂停实施,下3回再从该岗位一连向后执行,而return语句不持有地点记念的意义。2个函数里面,只好实行三次(或许说1个)return话语,可是足以推行多次(或然说五个)yield言辞。通常函数只好回去1个值,因为只好执行3次return;Generator函数能够回到一多重的值,因为能够有自由五个yield。从另四个角度看,也得以说Generator生成了一密密麻麻的值,那也便是它的称谓的来历(在葡萄牙语中,generator这几个词是“生成器”的情致)。

Generator函数能够不用yield言辞,那时就改为了1个一味的暂缓执行函数。

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

地点代码在3个平日函数中运用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 接口的涉及

上一章说过,任意3个对象的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属性,也是3个遍历器对象生成函数,执行后回到它本人。

next方法的参数

yield句笔者并未重回值,或然说总是回到undefinednext形式能够带一个参数,该参数就会被作为上1个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艺术带1个参数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方法提供参数,重返结果就全盘差别了。上面代码第3回调用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循环,依次呈现多少个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格局还不错3个参数,该参数会被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代码块来捕获错误。假设运用回调函数的写法,想要捕获多个谬误,就不得不为每一个函数内部写1个错误处理语句,今后只在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措施的,所以会抛出3个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 函数内部,调用另2个 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*说话,用来在3个 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"

再来看2个比较的事例。

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再次回到2个遍历器对象,outer2回来该遍历器对象的内部值。

从语法角度看,借使yield一声令下后边跟的是2个遍历器对象,必要在yield一声令下前边加上星号,表明它回到的是3个遍历器对象。这被称之为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}

地点代码在第5次调用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' ]

地点代码中,存在一遍遍历。第1遍是扩大运算符遍历函数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属性前边有3个星号,表示这几个性情是三个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对象方面添加了2脾品质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函数正是1个状态机。

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

地点代码的clock函数一共有三种状态(Tick和Tock),每运营二次,就改变3遍状态。这一个函数就算用Generator落成,正是上面那样。

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

地点的Generator完成与ES5兑现相比较,能够看出少了用于保存情形的表面变量ticking,那样就更精简,更安全(状态不会被违规篡改)、更符合函数式编制程序的合计,在写法上也更优雅。Generator之所以能够毫无外部变量保存意况,是因为它本身就隐含了二个场地音信,即当前是还是不是处于暂停态。

Generator与协程

协程(coroutine)是一种程序运营的不二法门,能够领略成“同盟的线程”或“同盟的函数”。协程既能够用单线程实现,也得以用二十多线程完成。前者是一种分外的子例程,后者是一种十分的线程。

(1)协程与子例程的反差

历史观的“子例程”(subroutine)接纳堆栈式“后进先出”的施行格局,惟有当调用的子函数完全实施达成,才会终止执行父函数。协程与其差别,八个线程(单线程景况下,即八个函数)能够并行执行,不过唯有多个线程(或函数)处黄浩然在运行的情景,别的线程(或函数)都处在暂停态(suspended),线程(或函数)之间能够交流执行权。也正是说,2个线程(或函数)执行到二分一,能够暂停实施,将执行权交给另3个线程(或函数),等到稍后收回执行权的时候,再过来执行。那种能够并行执行、沟通执行权的线程(或函数),就叫做协程。

从达成上看,在内部存储器中,子例程只利用2个栈(stack),而协程是还要设有多少个栈,但唯有3个栈是在运作状态,也便是说,协程是以多占用内部存储器为代价,落成多任务的互相。

(2)协程与平常线程的异样

简单看出,协程适合用来多任务运转的条件。在这些意思上,它与常见的线程很一般,都有谈得来的进行上下文、能够享受全局变量。它们的差别之处在于,同临时间能够有多少个线程处于运营情状,可是运维的协程只好有三个,其余协程都处在停顿状态。其余,普通的线程是当先式的,到底哪些线程优先获得能源,必须由运营条件控制,但是协程是同盟式的,执行权由协程本人分配。

出于ECMAScript是单线程语言,只好维持二个调用栈。引入协程今后,每一个任务能够维持团结的调用栈。那样做的最大益处,就是抛出荒谬的时候,能够找到原来的调用栈。不至于像异步操作的回调函数那样,一旦出错,原始的调用栈早就终止。

Generator函数是ECMAScript
6对协程的兑现,但属于不完全落到实处。Generator函数被誉为“半协程”(semi-coroutine),意思是唯有Generator函数的调用者,才能将次第的执行权还给Generator函数。假如是一心执行的协程,任何函数都得以让暂停的协程继续执行。

借使将Generator函数当作家组织程,完全能够将四个须求相互协作的天职写成Generator函数,它们中间利用yield语句调换控制权。

应用

Generator能够暂停函数执行,重返任意表明式的值。这种特性使得Generator有各个接纳场景。

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

Generator函数的间歇实施的法力,意味着能够把异步操作写在yield语句里面,等到调用next方法时再以往举办。那实际如出一辙不供给写回调函数了,因为异步操作的持续操作能够放在yield语句上边,反正要等到调用next方法时再实践。所以,Generator函数的3个首要实际意义正是用来拍卖异步操作,改写回调函数。

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
  }
}

接下来,使用1个函数,按程序自动执行全部手续。

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打包了2个职务的多少个步骤,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循环3次性依次执行全部任务的享有手续。

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使得数据只怕操作,具备了近似数组的接口。