ES6 - Generator函数

本文已同步至我的个人主页。迎接接见检察更多内容!若有毛病或脱漏,迎接随时斧正讨论!感谢人人的关注与支撑!

一、什么是Generator函数

Generator函数是ES6规范中提出的一种异步编程的解决方案。这类函数与平常函数最大的区分在于它能够停息实行,又能够从停息的位置恢复继承实行。

从语法上看,Generator函数就是一个状况机,封装了很多内部状况。

从本质上看,Generator函数就是一个遍历器对象生成器。(关于遍历器对象,能够参考阮一峰先生的这篇文章Generator函数返回一个遍历器对象,遍历这个对象,就能够顺次获得函数内部的每个状况。

二、基础语法

1、定义Generator函数

定义一个Generator函数和定义一个平常函数的区分在于:

  • function症结字和函数名之间有一个 *(星号)。
  • 函数内部运用yield来定义每个函数内部的状况。
  • 假如函数内部有return语句,那末他就是函数内部的末了一个状况。

来看一个简朴的例子:

// 定义
function* sayHello() {
  yield 'hello';
  yield 'world';
  return 'ending';
}
// 挪用
// 注重,hw猎取到的值是一个遍历器对象
let g = sayHello();

上面的例子,定义了一个名为sayHello的Generator函数,它内部有两个yield表达式和一个return表达式。所以,该函数内部有三个状况:helloworldreturn语句(完毕实行)。末了,挪用这个函数,获得一个遍历器对象并赋值给变量g

Generator函数的挪用要领与平常函数完整一样,函数名()。差别的是:

  • 函数挪用后,内部代码(从第一行最先)都不会马上实行。
  • 函数挪用后会有一个返回值,这个值是一个指向内部状况的指针对象,本质就是一个包括函数内部状况的遍历器对象。

Generator函数挪用后不会马上实行,那末,我们怎样让它最先实行内部的代码呢?又怎样猎取它内部的每个状况呢?此时,我们必需挪用返回的生成器对象的.next()要领,才最先代码的实行,而且使得指针移向下一个状况。

以上面的例子为例:

g.next();
// { value: 'hello', done: false }
g.next();
// { value: 'world', done: false }
g.next();
// { value: 'ending', done: true }
g.next();
// { value: undefined, done: true }

上面的代码中,一共挪用了四次g这个遍历器对象的.next()要领。第一次挪用,sayHello这个Generator函数最先实行,直到碰到第一个yield表达式就会停息实行。.next()要领会返回一个对象,它的value属性就是当前yield表达式的值hellodone属性的值false,示意遍历还没有完毕。

第二次再挪用.next(),就会实行到第二个yield表达式处,并停息实行,返回对应的对象。

第三次挪用.next(),函数实行到末了的return语句,此时标志着遍历器对象g遍历完毕,所以返回的对象中value属性值就是return背面所跟的值endingdone属性值为true,示意遍历已完毕。

第四次以及背面在挪用.next()要领,返回的都会是{value: undefined, done: true }

2、yield表达式

由Generator函数返回的遍历器对象,只要挪用.next()要领才会遍历到下一个内部状况,所以这现实上是供应了一种能够停息实行的函数,yield表达式就是停息标志。

遍历器对象的.next()要领的运转逻辑以下。

  1. 碰到yield表达式,就停息实行背面的操纵,并将紧跟在yield背面的谁人表达式的值,作为返回的对象的value属性值。
  2. 下一次挪用.next()要领时,再继承往下实行,直到碰到下一个yield表达式。
  3. 假如没有再碰到新的yield表达式,就一向运转到函数完毕,直到return语句为止,并将return语句背面的表达式的值,作为返回的对象的value属性值。
  4. 假如该函数没有return语句,则返回的对象的value属性值为undefined

值得注重的是:

  1. yield症结字只能涌现在Generator函数中,涌现在别的函数中会报错。
  // 涌现在平常函数中,报错
  (function () {
    yield 'hello';
  })()

  // forEach不是Generator函数,报错
  [1, 2, 3, 4, 5].forEach(val => {
    yield val
  });
  1. yield症结字背面跟的表达式,是惰性求值的。 只要当挪用.next()要领、内部状况停息到当前yield时,才会盘算其背面跟的表达式的值。这即是为JavaScript供应了手动的“惰性求值”的语法功用。
function* step() {
  yield 'step1';

  // 下面的yield背面的表达式不会马上求值,
  // 只要停息到这一行时,才会盘算表达式的值。
  yield 'step' + 2;

  yield 'setp3';
  return 'end';
}
  1. yield表达式本身是没有返回值的,或许说它的返回值为undefined。运用.next()传参能够为其设置返回值。(背面会讲到)
function* gen() {
  for (let i = 0; i < 5; i++) {
    let res = yield;  // yield表达式本身没有返回值
    console.log(res); // undefined
  }
}
let g = gen();
g.next();   // {value: 0, done: false}
g.next();   // {value: 1, done: false}
g.next();   // {value: 2, done: false}

yield与return的异同:

相同点:

  • 二者都能返回跟在其背面的表达式的值。

差别点:

  • yield表达式只是停息函数向后实行,return是直接完毕函数实行。
  • yield表达式能够涌现屡次,背面还能够有代码。return只能涌现一次,背面的代码不会实行,在一些情况下还会报错。
  • 平常函数只能返回一个值,因为只能实行一次return。Generator函数能够返回一系列的值,因为能够有恣意多个yield。

3、.next()要领传参

前面我们说到过,yield表达式本身没有返回值,或许说返回值永远是undefined。然则,我们能够通过给.next()要领传入一个参数,来设置上一个(是上一个)yield表达式返回值。

来看一个例子:

function* conoleNum() {
  console.log('Started');
  console.log(`data: ${yield}`);
  console.log(`data: ${yield}`);
  return 'Ending';
}
let g = conoleNum();

g.next();      // 控制台输出:'Started'

g.next('a');   // 控制台输出:'data: a'
// 不传入参数'a',就会输出'data: undefined'

g.next('b');   // 控制台输出:'data: b'
// 不传入参数'a',就会输出'data: undefined'

上面的例子,须要强调一个不容易明白的处所。

第一次挪用.next(),此时函数停息在代码第三行的yield表达式处。记得吗?yield会停息函数实行,此时打印它的console.log(),也就是代码第三行的console,因为停息并没有被实行,所以不会打印出结果,只输出了代码第二行的’Started’。

当第二次挪用.next()要领时,传入参数'a',函数停息在代码第四行的yield语句处。此时参数'a'会被当作上一个yield表达式的返回值,也就是代码第三行的yiled表达式的返回值,所以此时控制台输出'data: a'。而代码第四行的console.log()因为停息,没有被输出。

第三次挪用,同理。所以输出'data: b'

4、Generator.prototype.throw()

Generator函数返回的遍历器对象,都有一个.throw()要领,能够在函数体外抛出毛病,然后在Generator函数体内捕捉

function* gen() {
  try {
    yield;
  } catch (e) {
    console.log('内部捕捉', e);
  }
};

var g = gen();
// 下面实行一次.next()
// 是为了让gen函数体实行进入try语句中的yield处
// 如许抛出毛病,gen函数内部的catch语句才捕捉毛病
g.next();

try {
  g.throw('a');
  g.throw('b');
} catch (e) {
  console.log('外部捕捉', e);
}

上面例子中,遍历器对象ggen函数体外一连抛出两个毛病。第一个毛病被gen函数体内的catch语句捕捉。g第二次抛出毛病,因为gen函数内部的catch语句已实行过了,不会再捕捉到这个毛病了,所以这个毛病就会被抛出gen函数体,被函数体外的catch语句捕捉。

值得注重的是:

  • 假如Generator函数内部没有布置try...catch代码块,那末遍历器对象的throw要领抛出的毛病,将被外部try...catch代码块捕捉。
  • 假如Generator函数内部和外部都没有布置try...catch代码块,那末顺序将报错,直接中缀实行。

遍历器对象的throw要领被捕捉今后,会附带实行一次.next()要领,代码实行会停息到下一条yield表达式处。看下面这个例子:

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

g.next();   // 控制台输出:'a'

g.throw('Error');  // 控制台输出:'b'
// throw的毛病被内部catch语句捕捉,
// 会自动在实行一次g.next()

g.next();   // 控制台输出:'c'

5、Generator.prototype.return()

Generator函数返回的遍历器对象,另有一个.return()要领,能够返回给定的值,而且直接完毕对遍历器对象的遍历。

function* gen() {
  yield 1;
  yield 2;
  yield 3;
}
var g = gen();

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

// 提前完毕对g的遍历。只管yield还没有实行完
// 此时done属性值为true,申明遍历完毕
g.return('foo'); // { value: "foo", done: true }

g.next();        // { value: undefined, done: true }

假如.return()要领挪用时,不供应参数,则返回值的value属性为undefined

6、yield* 表达式

yield* 用来在一个Generator函数内里实行另一个Generator函数。

假如在一个Generator函数内部,直接挪用另一个Generator函数,默许情况下是没有结果的。

function* gen1() {
  yield 'a';
  yield 'b';
}
function* gen2() {
  yield 'x';
  // 直接挪用gen1()
  gen1();
  yield 'y';
}
// 遍历器对象能够运用for...of遍历一切状况
for (let v of gen2()){
  只输出了gen1的状况
  console.log(v);   // 'x' 'y'
}

上面的例子中,gen1gen2都是Generator函数,在gen2内里直接挪用gen1,是不会有结果的。

这个就须要用到 yield* 表达式。

function* gen1() {
  yield 'a';
  yield 'b';
}
function* gen2() {
  yield 'x';
  // 用 yield* 挪用gen1()
  yield* gen1();
  yield 'y';
}

for (let v of gen2()){
  输出了gen1、gen2的状况
  console.log(v);   // 'x' 'a' 'b' 'y'
}

小节

本文重要解说Generator函数的基础语法和一些细节,Generator函数的定义、yield表达式、.next()要领及传参、.throw()要领、.return()要领以及 yield* 表达式。

文章开首讲到,Generator函数时ES6提出的异步编程的一种解决方案。在现实运用中,平常在yield症结字背面会追随一个异步操纵,当异步操纵胜利返回后挪用.next()要领,将异步流程交给下一个yield表达式。详细关于Generator函数的异步运用,人人能够参考阮一峰先生的这篇文章,或参考其他网上材料,继承深切进修。

    原文作者:MagicEyes
    原文地址: https://segmentfault.com/a/1190000018700833
    本文转自网络文章,转载此文章仅为分享知识,如有侵权,请联系博主进行删除。
点赞