async函数

含义

ES2017标准引入了async函数,使得异步操作变得更加方便.
async函数其实就是Generator函数的语法糖.
Generator函数依次读取两个文件:

const fs = require('fs');

const readFile = function (fileName) {
  return new Promise(function (resolve, reject) {
    fs.readFile(fileName, function(error, data) {
      if (error) return reject(error);
      resolve(data);
    });
  });
};

const gen = function* () {
  const f1 = yield readFile('/etc/fstab');
  const f2 = yield readFile('/etc/shells');
  console.log(f1.toString());
  console.log(f2.toString());
};

协程async函数,如下:

const asyncReadFile = async function () {
  const f1 = await readFile('/etc/fstab');
  const f2 = await readFile('/etc/shells');
  console.log(f1.toString());
  console.log(f2.toString());
};

比较可以发现,async函数就是将Generator函数的星号(*)替换成async,将yield替换成await.
async函数对Generator函数的改进,体现在以下几点:

1. 内置执行器
   Generator函数的执行必须靠执行器,所以才有了co模块,而asnyc函数自带执行器.也就是说,asnyc函数的执行,与普通函数一模一样,只要一行

asyncReadFile();

2. 更好的语义
   async表示函数里有异步操作,await表示紧跟在后面的表达式需要等待结果
3. 更广的适用性
   co模块约定,yield命令后面只能是Thunk函数或Promise对象,而asnyc函数的await命令后面,可以是Promise对象和原始类型的值(数值,字符串和布尔值,但这是等同于同步操作)
4. 返回值是Promise
   asnyc函数的返回值是Promise对象,这比Generator函数的返回值是Iterator对象方便多了.可以使用then方法指定下一步的操作.
   进一步说,asnyc函数完全可以看做多个异步操作,包装成的一个Promise对象,而await命令就是内部then命令的语法糖.

基本用法

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

async function getStockPriceByName(name) {
  const symbol = await getStockSymbol(name);
  const stockPrice = await getStockPrice(symbol);
  return stockPrice;
}

getStockPriceByName('goog').then(function (result) {
  console.log(result);
});

async函数有多种使用形式

// 函数声明
async function foo() {}

// 函数表达式
const foo = async function () {};

// 对象的方法
let obj = { async foo() {} };
obj.foo().then(...)

// Class 的方法
class Storage {
  constructor() {
    this.cachePromise = caches.open('avatars');
  }

  async getAvatar(name) {
    const cache = await this.cachePromise;
    return cache.match(`/avatars/${name}.jpg`);
  }
}

const storage = new Storage();
storage.getAvatar('jake').then(…);

// 箭头函数
const foo = async () => {};

语法

难点是错误处理机制

---

返回Promise对象

async函数内部return语句返回的值,会成为then方法回调函数的参数

async function f() {
  return 'hello world';
}

f().then(v => console.log(v))
// "hello world"

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

---

Promise对象的状态变化

asnyc函数返回的Promise对象,必须等到内部所有await命令后面的Promise对象执行完,才会发生执行状态改变,除非遇到return语句或者抛出错误.也就是说,只有asnyc函数内部的异步操作执行完,才会执行then方法指定的回调函数.

---

await命令

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

async function f() {
  return await 123;
}

f().then(v => console.log(v))
// 123

await命令后面的Promise对象如果变成reject状态,则reject的参数会被catch方法的回调函数接收到.
只要一个await语句后面的Promise变为reject,那么整个async函数都会中断执行
有时我们希望即使前一个异步操作失败,也不要中断后面的异步操作,有两种方法:
1.可以将第一个await放在try...catch结构里面

async function f() {
  try {
    await Promise.reject('出错了');
  } catch(e) {
  }
  return await Promise.resolve('hello world');
}

f()
.then(v => console.log(v))
// hello world

2.await后面的Promise对象再跟一个catch方法,处理前面可能出现的错误

---

错误处理

如果await后面的异步操作出错,那么等同于async函数返回的Promise对象被reject
防止出错的方法,也是将其放在try...catch代码块之中

async function f() {
  try {
    await new Promise(function (resolve, reject) {
      throw new Error('出错了');
    });
  } catch(e) {
  }
  return await('hello world');
}

如果有多个await命令,可以统一放在try...catch结构中.

---

使用注意点

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

// 写法一
let [foo, bar] = await Promise.all([getFoo(), getBar()]);

// 写法二
let fooPromise = getFoo();
let barPromise = getBar();
let foo = await fooPromise;
let bar = await barPromise;

3. await命令只能用在async函数之中

function dbFuc(db) { //这里不需要 async
  let docs = [{}, {}, {}];

  // 可能得到错误结果
  docs.forEach(async function (doc) {
    await db.post(doc);
  });
}

可能不会正常工作的原因是这时三个db.post操作将是并发执行,而不是继发执行.正确的写法是采用for循环

async function dbFuc(db) {
  let docs = [{}, {}, {}];

  for (let doc of docs) {
    await db.post(doc);
  }
}

async函数的实现原理

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

async function fn(args) {
  // ...
}

// 等同于

function fn(args) {
  //spawn函数就是自动执行器
  return spawn(function* () {
    // ...
  });
}

spawn函数的实现

function spawn(genF) {
  return new Promise(function(resolve, reject) {
    const gen = genF();
    function step(nextF) {
      let next;
      try {
        next = nextF();
      } catch(e) {
        return reject(e);
      }
      if(next.done) {
        return resolve(next.value);
      }
      Promise.resolve(next.value).then(function(v) {
        step(function() { return gen.next(v); });
      }, function(e) {
        step(function() { return gen.throw(e); });
      });
    }
    step(function() { return gen.next(undefined); });
  });
}

与其他异步处理方法的比较

async函数实现最简洁,最符合语义,几乎没有语义不相关的代码.它将Generator写法中的自动执行器,改在语言层面提供,不暴露给用户.如果使用Generator函数,自动自行器需要用户自己提供.

实例:按顺序完成异步操作

async function logInOrder(urls) {
  // 并发读取远程URL
  const textPromises = urls.map(async url => {
    const response = await fetch(url);
    return response.text();
  });

  // 按次序输出
  for (const textPromise of textPromises) {
    console.log(await textPromise);
  }
}

上面代码中,虽然map方法的参数是async函数,但它是并发执行的,因为只有async函数内部是继发执行,外包不收影响.后面的for...of循环内部使用了await,因此实现了按顺序输出.

异步遍历器

主要调用遍历器对象的next方法,就会得到一个对象.这里隐含着一个规定,next方法必须是同步的.如果遍历器对象正好指向同步操作就没有问题,但对于异步操作来说就不合适了.只要调用就必须立刻返回值.目前的解决办法是,Generator函数里面的异步操作,返回一个Thunk函数或者Promise对象.
ES2018引入了"异步遍历器",为异步操作提供原生的遍历器接口,即value和done这两个属性都是异步产生.

---

异步遍历的接口

异步遍历器的最大的语法特点,就是调用遍历器的next方法,返回的是一个Promise对象

asyncIterator
  .next()
  .then(
    ({ value, done }) => /* ... */
  );

对象的异步遍历器接口,部署在Symbol.asyncIterator属性上.不管是什么样的对象,只要它的Symbol.asyncIterator属性有值,就表示应该对它进行异步遍历.

const asyncIterable = createAsyncIterable(['a', 'b']);
const asyncIterator = asyncIterable[Symbol.asyncIterator]();

asyncIterator
.next()
.then(iterResult1 => {
  console.log(iterResult1); // { value: 'a', done: false }
  return asyncIterator.next();
})
.then(iterResult2 => {
  console.log(iterResult2); // { value: 'b', done: false }
  return asyncIterator.next();
})
.then(iterResult3 => {
  console.log(iterResult3); // { value: undefined, done: true }
});

由于异步遍历器的next方法,返回的是一个Promise对象,因此可以把它放在await命令后面.

async function f() {
  const asyncIterable = createAsyncIterable(['a', 'b']);
  const asyncIterator = asyncIterable[Symbol.asyncIterator]();
  console.log(await asyncIterator.next());
  // { value: 'a', done: false }
  console.log(await asyncIterator.next());
  // { value: 'b', done: false }
  console.log(await asyncIterator.next());
  // { value: undefined, done: true }
}

注意,异步遍历器的next方法是可以连续调用的,不必等到上一步产生的Promise对象resolve以后在调用.这种情况下,next方法会累计起来,自动按照每一步的顺序运行下去.
1.可以把所有的next方法放在Promise.all方法里面:

const asyncGenObj = createAsyncIterable(['a', 'b']);
const [{value: v1}, {value: v2}] = await Promise.all([
  asyncGenObj.next(), asyncGenObj.next()
]);

console.log(v1, v2); // a b

2.一次性调用所有的next方法,然后await最后一步操作

async function runner() {
  const writer = openFile('someFile.txt');
  writer.next('hello');
  writer.next('world');
  await writer.return();
}

runner();

for await...of

新引入的for await...of用来循环异步的Iterator接口

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

createAsyncIterable()返回一个拥有异步遍历器接口的对象,for...of循环自动调用这个对象的异步遍历器的next方法,会得到一个Promise对象.await用来处理这个Promise对象,一旦resolve,就把得到的值传入for...of的循环体.
for await...of循环的一个用途,是部署了asnycIterable操作的异步接口,可以直接放入这个循环.
如果next方法返回的Promsie对象被reject,for await...of就会报错,要用try...catch捕捉.
注意: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 }

异步遍历器的设计目的之一,就是Generator函数处理同步操作和异步操作时,能够使用同一套接口

// 同步 Generator 函数
function* map(iterable, func) {
  const iter = iterable[Symbol.iterator]();
  while (true) {
    const {value, done} = iter.next();
    if (done) break;
    yield func(value);
  }
}

// 异步 Generator 函数
async function* map(iterable, func) {
  const iter = iterable[Symbol.asyncIterator]();
  while (true) {
    const {value, done} = await iter.next();
    if (done) break;
    yield func(value);
  }
}

异步操作前面使用await关键字标明,应该返回Promise对象.凡是使用yeild关键字的地方,就是next方法停下来的地方,他后面的表达式的值,会作为next()返回对象的value属性,这一点是与同步Generator函数一直的.
异步Generator函数内部,能够同时使用await和yield命令.await命令用于将外部操作产生的值输入函数内部,yield命令用于将函数内部的值输出.
注意:普通asnyc函数返回的是一个Promise对象,而异步Generator函数返回的是一个异步Iterator对象.区别在于,前者自带执行器,后者通过for await...of执行,或者自己编写执行器.
异步Generator函数的执行器:

async function takeAsync(asyncIterable, count = Infinity) {
  const result = [];
  const iterator = asyncIterable[Symbol.asyncIterator]();
  while (result.length < count) {
    const {value, done} = await iterator.next();
    if (done) break;
    result.push(value);
  }
  return result;
}

异步Generator函数出现以后,JavaScript就有了四种函数形式:普通函数,async函数,Generator函数和异步Generator函数.基本上,如果是一系列按照顺序执行的异步操作(比如读取文件,然后写入新内容,再存入硬盘),可以使用async函数;如果是一系列产生相同数据结构的异步操作(比如一行一行读取啥文件),可以使用异步Generator函数.
异步Generator函数也可以通过next方法的参数,接收外部传入的数据:

const writer = openFile('someFile.txt');
writer.next('hello'); // 立即执行
writer.next('world'); // 立即执行
await writer.return(); // 等待写入结束

每次next方法都是同步执行的,最后的await命令用于等待整个写入操作结束.
同步的数据结构,也可以使用异步Generator函数.

yield*语句

yield*语句也可以跟一个异步遍历器.

async function* gen1() {
  yield 'a';
  yield 'b';
  return 2;
}

async function* gen2() {
  // result 最终会等于 2
  const result = yield* gen1();
}

与同步的Generator函数一样,for await...of循环会展开yield*.