第十八章 async函数

含义

  ES7标准引入了async函数，使得异步操作变得更加方便。async是Generator函数的语法糖。
  Generator函数和async函数读取文件

let fs = require('fs')
let readFile = function (fileName) {
    return new Promise(function (resolve, reject)) {
       fs.readFile(fileName, function(error, data) {
           if (error) return reject(error)
           resolve(data)
        }) 
    }
}
let gen = function* () {
    let f1 = yield readFile('/etc/fstab')
    let f2 = yield readFile('etc/shells')
}
将上面的代码写成async函数的形式
let asyncReadFile = async function () {
    let f1 = await readFile('/etc/fstab')
    let f2 = await readFile('etc/shells')
}

  通过比较就会发现，async函数就是将Generator函数的星号(*)替换成async，将yield替换成await，仅此而已。
  async函数对Generator函数的改进体现在以下4点。

1.内置执行器

  Generator函数的执行必须靠执行器，所以才有了co模块，而async函数和自带执行器。也就是说，async函数的执行与普通函数一模一样，只要一行。上面代码调用了asyncReadFile函数，然后它就会自动执行，而不是像Generator函数需要next方法或co模块才能执行。

2.更好的语义

  async和await比起星号和yield，语义更清楚了。async表示函数里有异步操作，await表示紧跟在后面的表达式需要等待结果。

3.更广的适用性

  co模块约定，yield命令后面只能是Thunk函数或Promise对象，而async函数的await命令后面，可以是Promise对象和原始类型的值(数值、字符串和布尔值，但这时等同于同步操作)。

4.返回值是Promise

  async函数的返回值是Promise对象，这比Generator函数的返回值是Iterator对象方便了许多。可以用then方法指定下一步的操作。进一步说，async函数完全可以看作由多个异步操作包装成的一个Promise对象，而await命令就是内部then命令的语法糖。

用法

  async函数返回一个Promise对象，可以使用then方法添加回调函数。当函数执行的时候，一旦遇到await就会先返回，等到异步操作完成，再接着执行函数体内后面的语句。

async function getStock (name) {
    let symbol = await getSymbol(name)
    let stockPrice = await getStockPrice(symbol)
    return stockPrice
}
getStock('goog').then(function(result) {
     console.log(result)
})

函数前面的async关键字表明该函数内部有异步操作。调用该函数会立即返回一个Promise对象。
下面是另一个例子，指定多少毫秒后输出一个值

function timeout (ms) {
    return new Promise((resolve) => {
        setTimeout(resolve, ms)
    })
}
async function asyncPrint(value, ms) {
     await timeout(ms)
     console.log(value)
}
asyncPrint('hello world', 50)
上面的代码指定50ms以后输出hello world

语法

返回Promise对象

async函数返回一个Promise对象。async函数内部return语句返回的值会成为then方法回调函数的参数。

async function f() {
    return 'hello world'
}
f().then(v => console.log(v))
// hello world

async函数内部抛出错误会导致返回的Promise对象变为reject状态。抛出的错误对象会被catch方法回调函数接收到。

async function f () {
    throw new Error('出错了')
}
f().then(v => console.log(v), e => console.log(e))
// Error: 出错了

Promise对象的状态变化

async函数返回的Promise对象必须等到内部所有await命令后面的Promise对象执行完才会发生状态改变，除非遇到return语句或者抛出错误。

await命令

  正常情况下，await命令后面是一个Promise对象，如果不是，会被转成一个立即resolve的Promise对象。

async function f () {
    return await 123
}
f().then(v=>console.log(v))
// 123

  上面的代码中，await命令的参数是数值123，它被转成Promise对象并立即resolve。await命令后面的Promise对象如果变为reject状态，则reject的参数会被catch方法的回调函数接收到。

async function f() {
   await Promise.reject('出错了')
}
f().then(v => console.log(v)).catch(e => console.log(e))
// 出错了

  上面的代码中，await语句前面没有return，但是reject方法的参数依然传入了catch方法的回调函数。这里如果在await前面加上catch，效果是一样的，如果是resolve方法则必须return。
  只要一个await语句后面的Promise变为reject，那么整个async函数都会中断执行。有时我们希望即使前一个异步操作失败，也不要中断后面的异步操作。这时可以将第一个await放在try...catch结构里面，这样不管这个异步操作是否成功，第二个await都会执行。

catch会将reject状态转为resolve状态，所以可以继续执行。

async function f () {
    try {
        await Promise.reject('出错了')
    } catch (e) {}
    return await Promise.resolve('hello world')
}
f().then(v => console.log(v))
// 'hello world'

另一种方法是在await后面的Promise对象后添加一个catch方法，处理前面可能出现的错误。

async function f () {
    await Promise.reject('出错了').catch(e => console.log(e))
    return await Promise.resolve('hello world')
}
f().then(v => console.log(v))
// 出错了
// 'hello world'

使用注意点

第一点，await命令后面的Promise对象的运行结果可能是rejected，所以最好把await命令放在try...catch代码块中。
第二点，多个await命令后面的异步操作如果不存在继发关系，最好让它们同时触发，利用Promise.all。

let [foo, bar] = await Promise.all([getFoo(), getBar()])

上面代码中getFoo和getBar是并发触发，这样子就会缩短程序的执行时间。
第三点，await命令只能用在async函数之中，如果用在普通函数当中就会报错。

async函数的实现原理

async函数的实现原理就是将Generator函数和自动执行器包装在一个函数里。

async function fn(args) {
   // ...
}
// 等同于
function fn(args) {
    return spawn(function* () {
         //  ...
    })
}

所有的async函数都可以写成上面的第二种形式，其中的spawn函数就是自动执行器。

for await...of

  for...of循环用于遍历同步的Iterator接口。新引入的for await...of循环则用于遍历异步的Iterator接口。

async function f() {
   for await (const x of creatIterator(['a', 'b'])) {
        console.log(x)
   }
}
// a b

  上面代码中creatIterator()返回一个异步遍历器，for...of循环自动调用这个遍历器的next方法会得到一个Promise对象。await用来处理这个Promise对象，一旦resolve，就把得到的值(x)传入for...of的循环体中。
  for await...of循环的一个用途是部署了asyncIterator操作的异步接口，可以直接放入这个循环中。注意，for await...of也可以用于同步遍历器。

异步Generator函数

  就像Generator函数返回一个同步遍历器对象一样，异步Generator函数的作用是返回一个异步遍历器对象。
  在语法上，异步Generator函数就是async函数与Generator函数的结合。

async function* gen() {
   yield 'hello'
}
const genObj = gen()
genObj.next().then(x => console.log(x))
// {value: 'hello', done: false}

上面代码中，gen是一个异步的Generator函数，执行后返回一个异步Iterator对象。对该对象调用next方法返回一个Promise对象。异步遍历器的设计目的之一就是使Generator函数处理同步操作和异步操作时能够使用同一套接口。