一文掌握生成器 Generator,利用 Generator 实现异步编程

理解 Generator

Generator 是 ES6 提供的一个新的数据类型,可以叫做 Generator 函数,但跟普通函数又有些不同。

其最大特点就是可以交出函数的执行权(即暂停执行)

  • 定义时在 function 后面有一个 *
  • 可以使用关键字 yield 进行多次返回
  • 调用后并不立即执行,而是返回一个指向内部状态的指针对象,该对象是一个遍历器(Iterator)对象
  • 调用返回遍历器对象的 next 方法,会移动内部指针,使得指针指向下一个状态。会返回一个对象,表示当前阶段的信息。其中 value 属性是 yield 语句后面表达式的值,表示当前阶段的值;done 属性表示 Generator 函数是否执行完毕,即是否还有下一个阶段
  • 返回遍历器对象有个 throw 方法可以抛出错误,抛出的错误可以被函数体内的 try/catch 代码块捕获

备注:yield 只能在 Generator 中使用,在其他地方使用会报错

以下用一段代码作为示例说明

function* genDemo() {
  console.log('hello before')
  const hello = yield 'hello'
  console.log('hello after', hello)
  yield 'world'
  return 'end'
}

运行结果如下

图一.png
  1. 执行 genDemo 这个 Generator 函数,返回的 g 是一个指针。这个时候没有任何打印,函数体内代码没有执行
  2. 执行 g.next() 运行到第一个 yield 处停止运行,返回 { value: 'hello', done: false }。value 值表示的是 yield 后面的运行结果,done 表示的是整个 Generator 是否执行完毕
  3. 继续执行 g.next(),到第二个 yield 处停止运行,后面还有代码,所以done 为false
  4. 继续执行 g.next(), 执行到 return 了,代码执行完毕,所以 done 为 true
  5. 继续执行 g.next(), 因为已经执行完毕了,继续执行的话,都会返回 { value: undefined, done: true }

注意:以上结果中,变量 hello 打印出来的值为 undefined。说明没有被赋值。那么该怎么给赋值呢?

应该在执行 next 方法的时候传参来赋值。通过这种方法向 Generator 函数体内输入数据

以下是运行示例

二.png
  1. 第一次执行 g.next,运行到第一个 yield 处停止运行。这个时候 hello 变量还没有被赋值
  2. 第二次执行 g.next 时,传一个参数 ’wmm66’,会先将这个传入的参数赋值给上一次暂停时 yield 前面要赋值的变量,即上面代码中的 hello 变量。赋值完成后再往下运行代码,运行到下一个 yield 处

Generator 函数内部还可以部署错误处理代码,捕获函数体外抛出的错误。以下是示例代码和运行结果

function* genDemo() {
  try {
    console.log('hello before')
    const hello = yield 'hello'
    console.log('hello after', hello)
    yield 'world'
    return 'end'
  } catch(err) {
    console.warn(err)
  }
}

运行 g.throw 抛出错误。Generator 函数内部的 try/catch 就可以捕获到错误。发生错误后, Generator 函数就结束运行了,返回 { value: undefined, done: true }

Generator 实现异步编程

相对于异步,我们的思维更容易理解同步代码。异步编程的语法目标是让代码变得更像同步代码

比如以下代码(这里假设逻辑上要求读取完 test1.txt,然后再读取 test2.txt)

const fs = require('fs')

fs.readFile('./test1.txt', function(err, data1) {
  if (err) return err
  console.log(data1.toString())
  fs.readFile('./test2.txt', function(err, data2) {
    if (err) return err
    console.log(data2.toString())
  })
})

该代码是回调函数的方式。这种有先后顺序的时候,会出现多个函数嵌套,造成阅读和理解上的障碍。也就是常说的“回调地狱”

我们把它改成 promise 的写法

const fs = require('fs')

const promiseReadFile = (file) => {
  return new Promise((resolve, reject) => {
    fs.readFile(file, function(err, data) {
      if (err) return reject(err)
      resolve(data)
    })
  })
}
promiseReadFile('./test1.txt')
  .then(data1 => {
    console.log(data1.toString())
  })
  .then(() => {
    return promiseReadFile('./test2.txt')
  })
  .then(data2 => {
    console.log(data2.toString())
  }).catch(err => {
    console.error(err)
  })

这种链式调用的方式,逻辑上清晰了不少

我们计划使用 Generator 函数,通过如下编码实现异步

const genReadFile = function* (){
  const data1 = yield readFile('./test1.txt')
  console.log(data1.toString())
  const data2 = yield readFile('./test2.txt')
  console.log(data2.toString())
}

Generator 函数和 yield 本身跟异步没有关系。yield 是对函数的执行流程进行变更,是控制函数执行流程用的,而恰好这个控制流程的机制能够简化回调函数和 promise 的调用

我们现在要做的就是写一个方法,用来自动控制 Generator 函数的流程,接收和交还程序的执行权

在这之前,先了解一下 thunk 函数

thunk函数介绍

最早的 thunk 函数起源于 “传值调用” 和 “传名调用” 之争

let x = 1
function fn(m) {
  return m * 2
}
fn(x + 1)
  • 传值调用的主张:执行前就进行计算。先计算 x + 1 = 2,然后将值2传入fn 方法中:m * 2
  • 传名调用的主张:只在执行的时候才进行计算。将 x + 1 直接传入到fn方法中:(x + 1) * 2

Javascript 是 “传值调用”。在 JavaScript 语言中,Thunk 函数替换的不是表达式,而是多参数函数,将其替换成单参数的版本,且只接受回调函数作为参数

// 正常版本的readFile
const fn = fs.readFile(file, callback)

// thunk版本的readFile
function Thunk(file) {
  return function(callback) {
    return fn(file, callback)
  }
}
const thunkReadFile = Thunk(file)
thunkReadFile(callback)

该代码中的 thunkReadFile 函数,只接受回调函数作为参数。这个单参数版本,就叫做 Thunk 函数

任何函数只要存在回调就可以 thunk 转换,下面是一个简单的 thunk 转换器

const Thunk = function(fn) {
  return function() {
    const args = Array.prototype.slice.call(arguments)
    return function(callback) {
      args.push(callback)
      return fn.apply(this, args)
    }
  }
}

使用上面的转换器,生成 fs.readFile 的 Thunk 函数。

const readFileThunk = Thunk(fs.readFile)
readFileThunk(file)(callback)

有个插件 thunkify 可以直接转换

const fs = require('fs')
const thunkify = require('thunkify')

const readFile = thunkify(fs.readFile)
readFile('./test1.txt')(function(err, str) {
  // ...
})

实现回调函数的异步

Thunk 函数现在可以用于 Generator 函数的自动流程管理。我们让 Generator 函数的 yield 后面都执行 Thunk 函数。就改造出了我们想要的代码

const fs = require('fs')
const thunkify = require('thunkify')

const readFile = thunkify(fs.readFile)

const genReadFile = function* (){
  const data1 = yield readFile('./test1.txt')
  console.log(data1.toString())
  const data2 = yield readFile('./test2.txt')
  console.log(data2.toString())
}

那么应该怎么执行呢?我们先来分析一下

  1. 第一次执行 next 方法,会返回对象中的 value 是一个函数,该函数可以传入一个callback,这个 callback 里面能够获取到 ./test1.txt 文件读出来的数据
  2. 读出来 ./test1.txt 文件的数据后,我们需要继续执行 next,此时需要传入从 ./test1.txt 文件读出来的数据,这样才能将该数据赋值给 Generator 函数中的 data1 变量。
  3. 然后同上...

所以执行方法如下

const g = genReadFile()
const r1 = g.next()
r1.value(function(err, data1){
  if (err) throw err
  const r2 = g.next(data1)
  r2.value(function(err, data2){
    if (err) throw err
    g.next(data2)
  })
})

我们写一个 Generator 自动执行器,用来执行 Generator 函数

function run(gen) {
  const g = gen()
  function next(err, data) {
    const result = g.next(data)
    if (result.done) return
    result.value(next)
  }
  next()
}
run(genReadFile)

实现 Promise 的异步

思路与回调函数相同,具体代码如下

const fs = require('fs')

const readFile = (file) = >{
  return new Promise((resolve, reject) = >{
    fs.readFile(file, function(err, data) {
      if (err) return reject(err)
      resolve(data)
    })
  })
}

const genReadFile = function * () {
  const data1 = yield readFile('./test1.txt')
  console.log(data1.toString())
  const data2 = yield readFile('./test2.txt')
  console.log(data2.toString())
}

手动执行代码如下

const g = genReadFile()
g.next().value.then(function(data1) {
  g.next(data1).value.then(function(data2) {
    g.next(data2)
  })
})

Generator 自动执行器代码如下

function run(gen) {
  const g = gen()
  function next(data) {
    const { value, done } = g.next(data)
    if (done) return value
    value.then(function(data) {
      next(data)
    })
  }
  next()
}

run(genReadFile)

co函数

有个成熟的函数库 co。该函数库接受 Generator 函数作为参数,返回一个 Promise 对象

Thunk 函数示例

const fs = require('fs')
const thunkify = require('thunkify')
const co = require('co')

const readFile = thunkify(fs.readFile)

const genReadFile = function * () {
  const data1 = yield readFile('./test1.txt')
  console.log(data1.toString())
  const data2 = yield readFile('./test2.txt')
  console.log(data2.toString())
}

co(genReadFile)

Promise 对象示例

const fs = require('fs')
const co = require('co')

const readFile = (file) = >{
  return new Promise((resolve, reject) = >{
    fs.readFile(file, function(err, data) {
      if (err) return reject(err)
      resolve(data)
    })
  })
}

const genReadFile = function * () {
  const data1 = yield readFile('./test1.txt')
  console.log(data1.toString())
  const data2 = yield readFile('./test2.txt')
  console.log(data2.toString())
}

co(genReadFile)

Async/await 对比

ES7 引入了 async 函数。一句话,async 函数就是 Generator 函数的语法糖

Generator 函数封装的异步代码示例

const genReadFile = function* () {
  const data1 = yield readFile('./test1.txt')
  console.log(data1.toString())
  const data2 = yield readFile('./test2.txt')
  console.log(data2.toString())
}
co(genReadFile)

改写成 async 函数写法

const asyncReadFile = async function() {
  const data1 = await readFile('./test1.txt')
  console.log(data1.toString())
  const data2 = await readFile('./test2.txt')
  console.log(data2.toString())
}
asyncReadFile()

以上两段代码对比,async 函数就是将 Generator 函数的星号 * 替换成 async,放在 function 关键字前面,将 yield 替换成 await

async 函数对 Generator 函数的改进,体现在以下几点

  1. 内置执行器:Generator 函数的执行必须靠执行器(以上代码就是使用 co 模块执行),而 async 函数自带执行器。async 函数的执行,与普通函数一模一样
  2. 更好的语义:async 表示函数里有异步操作,await 表示紧跟在后面的表达式需要等待结果。语义更清晰
  3. 更广的适用性:co 模块约定,yield 命令后面只能是 Thunk 函数或 Promise 对象,而 async 函数的 await 命令后面,可以是 Promise 对象和原始类型的值
  4. 返回值是 Promise:async 函数的返回值是 Promise 对象,这比 Generator 函数的返回值是 Iterator 对象方便多了。可以用 then 方法指定下一步的操作
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 214,658评论 6 496
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,482评论 3 389
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 160,213评论 0 350
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,395评论 1 288
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,487评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,523评论 1 293
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,525评论 3 414
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,300评论 0 270
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,753评论 1 307
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,048评论 2 330
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,223评论 1 343
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,905评论 5 338
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,541评论 3 322
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,168评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,417评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,094评论 2 365
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,088评论 2 352

推荐阅读更多精彩内容