含义

ES2017 标准引入了 async 函数,使得异步操作变得更加方便。

async 函数是什么?一句话,它就是 Generator 函数的语法糖。

前文有一个 Generator 函数,依次读取两个文件。

  1. const fs = require('fs');
  2. const readFile = function (fileName) {
  3. return new Promise(function (resolve, reject) {
  4. fs.readFile(fileName, function(error, data) {
  5. if (error) return reject(error);
  6. resolve(data);
  7. });
  8. });
  9. };
  10. const gen = function* () {
  11. const f1 = yield readFile('/etc/fstab');
  12. const f2 = yield readFile('/etc/shells');
  13. console.log(f1.toString());
  14. console.log(f2.toString());
  15. };

写成async函数,就是下面这样。

  1. const asyncReadFile = async function () {
  2. const f1 = await readFile('/etc/fstab');
  3. const f2 = await readFile('/etc/shells');
  4. console.log(f1.toString());
  5. console.log(f2.toString());
  6. };

一比较就会发现,async函数就是将 Generator 函数的星号(*)替换成async,将yield替换成await,仅此而已。

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

(1)内置执行器。

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

  1. asyncReadFile();

上面的代码调用了asyncReadFile函数,然后它就会自动执行,输出最后结果。这完全不像 Generator 函数,需要调用next方法,或者用co模块,才能真正执行,得到最后结果。

(2)更好的语义。

asyncawait,比起星号和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就会先返回,等到异步操作完成,再接着执行函数体内后面的语句。

下面是一个例子。

  1. async function getStockPriceByName(name) {
  2. const symbol = await getStockSymbol(name);
  3. const stockPrice = await getStockPrice(symbol);
  4. return stockPrice;
  5. }
  6. getStockPriceByName('goog').then(function (result) {
  7. console.log(result);
  8. });

上面代码是一个获取股票报价的函数,函数前面的async关键字,表明该函数内部有异步操作。调用该函数时,会立即返回一个Promise对象。

下面是另一个例子,指定多少毫秒后输出一个值。

  1. function timeout(ms) {
  2. return new Promise((resolve) => {
  3. setTimeout(resolve, ms);
  4. });
  5. }
  6. async function asyncPrint(value, ms) {
  7. await timeout(ms);
  8. console.log(value);
  9. }
  10. asyncPrint('hello world', 50);

上面代码指定 50 毫秒以后,输出hello world

由于async函数返回的是 Promise 对象,可以作为await命令的参数。所以,上面的例子也可以写成下面的形式。

  1. async function timeout(ms) {
  2. await new Promise((resolve) => {
  3. setTimeout(resolve, ms);
  4. });
  5. }
  6. async function asyncPrint(value, ms) {
  7. await timeout(ms);
  8. console.log(value);
  9. }
  10. asyncPrint('hello world', 50);

async 函数有多种使用形式。

  1. // 函数声明
  2. async function foo() {}
  3. // 函数表达式
  4. const foo = async function () {};
  5. // 对象的方法
  6. let obj = { async foo() {} };
  7. obj.foo().then(...)
  8. // Class 的方法
  9. class Storage {
  10. constructor() {
  11. this.cachePromise = caches.open('avatars');
  12. }
  13. async getAvatar(name) {
  14. const cache = await this.cachePromise;
  15. return cache.match(`/avatars/${name}.jpg`);
  16. }
  17. }
  18. const storage = new Storage();
  19. storage.getAvatar('jake').then(…);
  20. // 箭头函数
  21. const foo = async () => {};

语法

async函数的语法规则总体上比较简单,难点是错误处理机制。

返回 Promise 对象

async函数返回一个 Promise 对象。

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

  1. async function f() {
  2. return 'hello world';
  3. }
  4. f().then(v => console.log(v))
  5. // "hello world"

上面代码中,函数f内部return命令返回的值,会被then方法回调函数接收到。

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

  1. async function f() {
  2. throw new Error('出错了');
  3. }
  4. f().then(
  5. v => console.log(v),
  6. e => console.log(e)
  7. )
  8. // Error: 出错了

Promise 对象的状态变化

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

下面是一个例子。

  1. async function getTitle(url) {
  2. let response = await fetch(url);
  3. let html = await response.text();
  4. return html.match(/<title>([\s\S]+)<\/title>/i)[1];
  5. }
  6. getTitle('https://tc39.github.io/ecma262/').then(console.log)
  7. // "ECMAScript 2017 Language Specification"

上面代码中,函数getTitle内部有三个操作:抓取网页、取出文本、匹配页面标题。只有这三个操作全部完成,才会执行then方法里面的console.log

await 命令

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

  1. async function f() {
  2. return await 123;
  3. }
  4. f().then(v => console.log(v))
  5. // 123

上面代码中,await命令的参数是数值123,它被转成 Promise 对象,并立即resolve

await命令后面的 Promise 对象如果变为reject状态,则reject的参数会被catch方法的回调函数接收到。

  1. async function f() {
  2. await Promise.reject('出错了');
  3. }
  4. f()
  5. .then(v => console.log(v))
  6. .catch(e => console.log(e))
  7. // 出错了

注意,上面代码中,await语句前面没有return,但是reject方法的参数依然传入了catch方法的回调函数。这里如果在await前面加上return,效果是一样的。

只要一个await语句后面的 Promise 变为reject,那么整个async函数都会中断执行。

  1. async function f() {
  2. await Promise.reject('出错了');
  3. await Promise.resolve('hello world'); // 不会执行
  4. }

上面代码中,第二个await语句是不会执行的,因为第一个await语句状态变成了reject

有时,我们希望即使前一个异步操作失败,也不要中断后面的异步操作。这时可以将第一个await放在try...catch结构里面,这样不管这个异步操作是否成功,第二个await都会执行。

  1. async function f() {
  2. try {
  3. await Promise.reject('出错了');
  4. } catch(e) {
  5. }
  6. return await Promise.resolve('hello world');
  7. }
  8. f()
  9. .then(v => console.log(v))
  10. // hello world

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

  1. async function f() {
  2. await Promise.reject('出错了')
  3. .catch(e => console.log(e));
  4. return await Promise.resolve('hello world');
  5. }
  6. f()
  7. .then(v => console.log(v))
  8. // 出错了
  9. // hello world

错误处理

如果await后面的异步操作出错,那么等同于async函数返回的 Promise 对象被reject

  1. async function f() {
  2. await new Promise(function (resolve, reject) {
  3. throw new Error('出错了');
  4. });
  5. }
  6. f()
  7. .then(v => console.log(v))
  8. .catch(e => console.log(e))
  9. // Error:出错了

上面代码中,async函数f执行后,await后面的 Promise 对象会抛出一个错误对象,导致catch方法的回调函数被调用,它的参数就是抛出的错误对象。具体的执行机制,可以参考后文的“async 函数的实现原理”。

防止出错的方法,也是将其放在try...catch代码块之中。

  1. async function f() {
  2. try {
  3. await new Promise(function (resolve, reject) {
  4. throw new Error('出错了');
  5. });
  6. } catch(e) {
  7. }
  8. return await('hello world');
  9. }

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

  1. async function main() {
  2. try {
  3. const val1 = await firstStep();
  4. const val2 = await secondStep(val1);
  5. const val3 = await thirdStep(val1, val2);
  6. console.log('Final: ', val3);
  7. }
  8. catch (err) {
  9. console.error(err);
  10. }
  11. }

下面的例子使用try...catch结构,实现多次重复尝试。

  1. const superagent = require('superagent');
  2. const NUM_RETRIES = 3;
  3. async function test() {
  4. let i;
  5. for (i = 0; i < NUM_RETRIES; ++i) {
  6. try {
  7. await superagent.get('http://google.com/this-throws-an-error');
  8. break;
  9. } catch(err) {}
  10. }
  11. console.log(i); // 3
  12. }
  13. test();

上面代码中,如果await操作成功,就会使用break语句退出循环;如果失败,会被catch语句捕捉,然后进入下一轮循环。

使用注意点

第一点,前面已经说过,await命令后面的Promise对象,运行结果可能是rejected,所以最好把await命令放在try...catch代码块中。

  1. async function myFunction() {
  2. try {
  3. await somethingThatReturnsAPromise();
  4. } catch (err) {
  5. console.log(err);
  6. }
  7. }
  8. // 另一种写法
  9. async function myFunction() {
  10. await somethingThatReturnsAPromise()
  11. .catch(function (err) {
  12. console.log(err);
  13. });
  14. }

第二点,多个await命令后面的异步操作,如果不存在继发关系,最好让它们同时触发。

  1. let foo = await getFoo();
  2. let bar = await getBar();

上面代码中,getFoogetBar是两个独立的异步操作(即互不依赖),被写成继发关系。这样比较耗时,因为只有getFoo完成以后,才会执行getBar,完全可以让它们同时触发。

  1. // 写法一
  2. let [foo, bar] = await Promise.all([getFoo(), getBar()]);
  3. // 写法二
  4. let fooPromise = getFoo();
  5. let barPromise = getBar();
  6. let foo = await fooPromise;
  7. let bar = await barPromise;

上面两种写法,getFoogetBar都是同时触发,这样就会缩短程序的执行时间。

第三点,await命令只能用在async函数之中,如果用在普通函数,就会报错。

  1. async function dbFuc(db) {
  2. let docs = [{}, {}, {}];
  3. // 报错
  4. docs.forEach(function (doc) {
  5. await db.post(doc);
  6. });
  7. }

上面代码会报错,因为await用在普通函数之中了。但是,如果将forEach方法的参数改成async函数,也有问题。

  1. function dbFuc(db) { //这里不需要 async
  2. let docs = [{}, {}, {}];
  3. // 可能得到错误结果
  4. docs.forEach(async function (doc) {
  5. await db.post(doc);
  6. });
  7. }

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

  1. async function dbFuc(db) {
  2. let docs = [{}, {}, {}];
  3. for (let doc of docs) {
  4. await db.post(doc);
  5. }
  6. }

如果确实希望多个请求并发执行,可以使用Promise.all方法。当三个请求都会resolved时,下面两种写法效果相同。

  1. async function dbFuc(db) {
  2. let docs = [{}, {}, {}];
  3. let promises = docs.map((doc) => db.post(doc));
  4. let results = await Promise.all(promises);
  5. console.log(results);
  6. }
  7. // 或者使用下面的写法
  8. async function dbFuc(db) {
  9. let docs = [{}, {}, {}];
  10. let promises = docs.map((doc) => db.post(doc));
  11. let results = [];
  12. for (let promise of promises) {
  13. results.push(await promise);
  14. }
  15. console.log(results);
  16. }

目前,esm模块加载器支持顶层await,即await命令可以不放在 async 函数里面,直接使用。

  1. // async 函数的写法
  2. const start = async () => {
  3. const res = await fetch('google.com');
  4. return res.text();
  5. };
  6. start().then(console.log);
  7. // 顶层 await 的写法
  8. const res = await fetch('google.com');
  9. console.log(await res.text());

上面代码中,第二种写法的脚本必须使用esm加载器,才会生效。

async 函数的实现原理

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

  1. async function fn(args) {
  2. // ...
  3. }
  4. // 等同于
  5. function fn(args) {
  6. return spawn(function* () {
  7. // ...
  8. });
  9. }

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

下面给出spawn函数的实现,基本就是前文自动执行器的翻版。

  1. function spawn(genF) {
  2. return new Promise(function(resolve, reject) {
  3. const gen = genF();
  4. function step(nextF) {
  5. let next;
  6. try {
  7. next = nextF();
  8. } catch(e) {
  9. return reject(e);
  10. }
  11. if(next.done) {
  12. return resolve(next.value);
  13. }
  14. Promise.resolve(next.value).then(function(v) {
  15. step(function() { return gen.next(v); });
  16. }, function(e) {
  17. step(function() { return gen.throw(e); });
  18. });
  19. }
  20. step(function() { return gen.next(undefined); });
  21. });
  22. }

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

我们通过一个例子,来看 async 函数与 Promise、Generator 函数的比较。

假定某个 DOM 元素上面,部署了一系列的动画,前一个动画结束,才能开始后一个。如果当中有一个动画出错,就不再往下执行,返回上一个成功执行的动画的返回值。

首先是 Promise 的写法。

  1. function chainAnimationsPromise(elem, animations) {
  2. // 变量ret用来保存上一个动画的返回值
  3. let ret = null;
  4. // 新建一个空的Promise
  5. let p = Promise.resolve();
  6. // 使用then方法,添加所有动画
  7. for(let anim of animations) {
  8. p = p.then(function(val) {
  9. ret = val;
  10. return anim(elem);
  11. });
  12. }
  13. // 返回一个部署了错误捕捉机制的Promise
  14. return p.catch(function(e) {
  15. /* 忽略错误,继续执行 */
  16. }).then(function() {
  17. return ret;
  18. });
  19. }

虽然 Promise 的写法比回调函数的写法大大改进,但是一眼看上去,代码完全都是 Promise 的 API(thencatch等等),操作本身的语义反而不容易看出来。

接着是 Generator 函数的写法。

  1. function chainAnimationsGenerator(elem, animations) {
  2. return spawn(function*() {
  3. let ret = null;
  4. try {
  5. for(let anim of animations) {
  6. ret = yield anim(elem);
  7. }
  8. } catch(e) {
  9. /* 忽略错误,继续执行 */
  10. }
  11. return ret;
  12. });
  13. }

上面代码使用 Generator 函数遍历了每个动画,语义比 Promise 写法更清晰,用户定义的操作全部都出现在spawn函数的内部。这个写法的问题在于,必须有一个任务运行器,自动执行 Generator 函数,上面代码的spawn函数就是自动执行器,它返回一个 Promise 对象,而且必须保证yield语句后面的表达式,必须返回一个 Promise。

最后是 async 函数的写法。

  1. async function chainAnimationsAsync(elem, animations) {
  2. let ret = null;
  3. try {
  4. for(let anim of animations) {
  5. ret = await anim(elem);
  6. }
  7. } catch(e) {
  8. /* 忽略错误,继续执行 */
  9. }
  10. return ret;
  11. }

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

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

实际开发中,经常遇到一组异步操作,需要按照顺序完成。比如,依次远程读取一组 URL,然后按照读取的顺序输出结果。

Promise 的写法如下。

  1. function logInOrder(urls) {
  2. // 远程读取所有URL
  3. const textPromises = urls.map(url => {
  4. return fetch(url).then(response => response.text());
  5. });
  6. // 按次序输出
  7. textPromises.reduce((chain, textPromise) => {
  8. return chain.then(() => textPromise)
  9. .then(text => console.log(text));
  10. }, Promise.resolve());
  11. }

上面代码使用fetch方法,同时远程读取一组 URL。每个fetch操作都返回一个 Promise 对象,放入textPromises数组。然后,reduce方法依次处理每个 Promise 对象,然后使用then,将所有 Promise 对象连起来,因此就可以依次输出结果。

这种写法不太直观,可读性比较差。下面是 async 函数实现。

  1. async function logInOrder(urls) {
  2. for (const url of urls) {
  3. const response = await fetch(url);
  4. console.log(await response.text());
  5. }
  6. }

上面代码确实大大简化,问题是所有远程操作都是继发。只有前一个 URL 返回结果,才会去读取下一个 URL,这样做效率很差,非常浪费时间。我们需要的是并发发出远程请求。

  1. async function logInOrder(urls) {
  2. // 并发读取远程URL
  3. const textPromises = urls.map(async url => {
  4. const response = await fetch(url);
  5. return response.text();
  6. });
  7. // 按次序输出
  8. for (const textPromise of textPromises) {
  9. console.log(await textPromise);
  10. }
  11. }

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

异步遍历器

《遍历器》一章说过,Iterator 接口是一种数据遍历的协议,只要调用遍历器对象的next方法,就会得到一个对象,表示当前遍历指针所在的那个位置的信息。next方法返回的对象的结构是{value, done},其中value表示当前的数据的值,done是一个布尔值,表示遍历是否结束。

这里隐含着一个规定,next方法必须是同步的,只要调用就必须立刻返回值。也就是说,一旦执行next方法,就必须同步地得到valuedone这两个属性。如果遍历指针正好指向同步操作,当然没有问题,但对于异步操作,就不太合适了。目前的解决方法是,Generator 函数里面的异步操作,返回一个 Thunk 函数或者 Promise 对象,即value属性是一个 Thunk 函数或者 Promise 对象,等待以后返回真正的值,而done属性则还是同步产生的。

ES2018 引入了”异步遍历器“(Async Iterator),为异步操作提供原生的遍历器接口,即valuedone这两个属性都是异步产生。

异步遍历的接口

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

  1. asyncIterator
  2. .next()
  3. .then(
  4. ({ value, done }) => /* ... */
  5. );

上面代码中,asyncIterator是一个异步遍历器,调用next方法以后,返回一个 Promise 对象。因此,可以使用then方法指定,这个 Promise 对象的状态变为resolve以后的回调函数。回调函数的参数,则是一个具有valuedone两个属性的对象,这个跟同步遍历器是一样的。

我们知道,一个对象的同步遍历器的接口,部署在Symbol.iterator属性上面。同样地,对象的异步遍历器接口,部署在Symbol.asyncIterator属性上面。不管是什么样的对象,只要它的Symbol.asyncIterator属性有值,就表示应该对它进行异步遍历。

下面是一个异步遍历器的例子。

  1. const asyncIterable = createAsyncIterable(['a', 'b']);
  2. const asyncIterator = asyncIterable[Symbol.asyncIterator]();
  3. asyncIterator
  4. .next()
  5. .then(iterResult1 => {
  6. console.log(iterResult1); // { value: 'a', done: false }
  7. return asyncIterator.next();
  8. })
  9. .then(iterResult2 => {
  10. console.log(iterResult2); // { value: 'b', done: false }
  11. return asyncIterator.next();
  12. })
  13. .then(iterResult3 => {
  14. console.log(iterResult3); // { value: undefined, done: true }
  15. });

上面代码中,异步遍历器其实返回了两次值。第一次调用的时候,返回一个 Promise 对象;等到 Promise 对象resolve了,再返回一个表示当前数据成员信息的对象。这就是说,异步遍历器与同步遍历器最终行为是一致的,只是会先返回 Promise 对象,作为中介。

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

  1. async function f() {
  2. const asyncIterable = createAsyncIterable(['a', 'b']);
  3. const asyncIterator = asyncIterable[Symbol.asyncIterator]();
  4. console.log(await asyncIterator.next());
  5. // { value: 'a', done: false }
  6. console.log(await asyncIterator.next());
  7. // { value: 'b', done: false }
  8. console.log(await asyncIterator.next());
  9. // { value: undefined, done: true }
  10. }

上面代码中,next方法用await处理以后,就不必使用then方法了。整个流程已经很接近同步处理了。

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

  1. const asyncGenObj = createAsyncIterable(['a', 'b']);
  2. const [{value: v1}, {value: v2}] = await Promise.all([
  3. asyncGenObj.next(), asyncGenObj.next()
  4. ]);
  5. console.log(v1, v2); // a b

另一种用法是一次性调用所有的next方法,然后await最后一步操作。

  1. async function runner() {
  2. const writer = openFile('someFile.txt');
  3. writer.next('hello');
  4. writer.next('world');
  5. await writer.return();
  6. }
  7. runner();

for await…of

前面介绍过,for...of循环用于遍历同步的 Iterator 接口。新引入的for await...of循环,则是用于遍历异步的 Iterator 接口。

  1. async function f() {
  2. for await (const x of createAsyncIterable(['a', 'b'])) {
  3. console.log(x);
  4. }
  5. }
  6. // a
  7. // b

上面代码中,createAsyncIterable()返回一个拥有异步遍历器接口的对象,for...of循环自动调用这个对象的异步遍历器的next方法,会得到一个 Promise 对象。await用来处理这个 Promise 对象,一旦resolve,就把得到的值(x)传入for...of的循环体。

for await...of循环的一个用途,是部署了 asyncIterable 操作的异步接口,可以直接放入这个循环。

  1. let body = '';
  2. async function f() {
  3. for await(const data of req) body += data;
  4. const parsed = JSON.parse(body);
  5. console.log('got', parsed);
  6. }

上面代码中,req是一个 asyncIterable 对象,用来异步读取数据。可以看到,使用for await...of循环以后,代码会非常简洁。

如果next方法返回的 Promise 对象被rejectfor await...of就会报错,要用try...catch捕捉。

  1. async function () {
  2. try {
  3. for await (const x of createRejectingIterable()) {
  4. console.log(x);
  5. }
  6. } catch (e) {
  7. console.error(e);
  8. }
  9. }

注意,for await...of循环也可以用于同步遍历器。

  1. (async function () {
  2. for await (const x of ['a', 'b']) {
  3. console.log(x);
  4. }
  5. })();
  6. // a
  7. // b

Node v10 支持异步遍历器,Stream 就部署了这个接口。下面是读取文件的传统写法与异步遍历器写法的差异。

  1. // 传统写法
  2. function main(inputFilePath) {
  3. const readStream = fs.createReadStream(
  4. inputFilePath,
  5. { encoding: 'utf8', highWaterMark: 1024 }
  6. );
  7. readStream.on('data', (chunk) => {
  8. console.log('>>> '+chunk);
  9. });
  10. readStream.on('end', () => {
  11. console.log('### DONE ###');
  12. });
  13. }
  14. // 异步遍历器写法
  15. async function main(inputFilePath) {
  16. const readStream = fs.createReadStream(
  17. inputFilePath,
  18. { encoding: 'utf8', highWaterMark: 1024 }
  19. );
  20. for await (const chunk of readStream) {
  21. console.log('>>> '+chunk);
  22. }
  23. console.log('### DONE ###');
  24. }

异步 Generator 函数

就像 Generator 函数返回一个同步遍历器对象一样,异步 Generator 函数的作用,是返回一个异步遍历器对象。

在语法上,异步 Generator 函数就是async函数与 Generator 函数的结合。

  1. async function* gen() {
  2. yield 'hello';
  3. }
  4. const genObj = gen();
  5. genObj.next().then(x => console.log(x));
  6. // { value: 'hello', done: false }

上面代码中,gen是一个异步 Generator 函数,执行后返回一个异步 Iterator 对象。对该对象调用next方法,返回一个 Promise 对象。

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

  1. // 同步 Generator 函数
  2. function* map(iterable, func) {
  3. const iter = iterable[Symbol.iterator]();
  4. while (true) {
  5. const {value, done} = iter.next();
  6. if (done) break;
  7. yield func(value);
  8. }
  9. }
  10. // 异步 Generator 函数
  11. async function* map(iterable, func) {
  12. const iter = iterable[Symbol.asyncIterator]();
  13. while (true) {
  14. const {value, done} = await iter.next();
  15. if (done) break;
  16. yield func(value);
  17. }
  18. }

上面代码中,map是一个 Generator 函数,第一个参数是可遍历对象iterable,第二个参数是一个回调函数funcmap的作用是将iterable每一步返回的值,使用func进行处理。上面有两个版本的map,前一个处理同步遍历器,后一个处理异步遍历器,可以看到两个版本的写法基本上是一致的。

下面是另一个异步 Generator 函数的例子。

  1. async function* readLines(path) {
  2. let file = await fileOpen(path);
  3. try {
  4. while (!file.EOF) {
  5. yield await file.readLine();
  6. }
  7. } finally {
  8. await file.close();
  9. }
  10. }

上面代码中,异步操作前面使用await关键字标明,即await后面的操作,应该返回 Promise 对象。凡是使用yield关键字的地方,就是next方法停下来的地方,它后面的表达式的值(即await file.readLine()的值),会作为next()返回对象的value属性,这一点是与同步 Generator 函数一致的。

异步 Generator 函数内部,能够同时使用awaityield命令。可以这样理解,await命令用于将外部操作产生的值输入函数内部,yield命令用于将函数内部的值输出。

上面代码定义的异步 Generator 函数的用法如下。

  1. (async function () {
  2. for await (const line of readLines(filePath)) {
  3. console.log(line);
  4. }
  5. })()

异步 Generator 函数可以与for await...of循环结合起来使用。

  1. async function* prefixLines(asyncIterable) {
  2. for await (const line of asyncIterable) {
  3. yield '> ' + line;
  4. }
  5. }

异步 Generator 函数的返回值是一个异步 Iterator,即每次调用它的next方法,会返回一个 Promise 对象,也就是说,跟在yield命令后面的,应该是一个 Promise 对象。如果像上面那个例子那样,yield命令后面是一个字符串,会被自动包装成一个 Promise 对象。

  1. function fetchRandom() {
  2. const url = 'https://www.random.org/decimal-fractions/'
  3. + '?num=1&dec=10&col=1&format=plain&rnd=new';
  4. return fetch(url);
  5. }
  6. async function* asyncGenerator() {
  7. console.log('Start');
  8. const result = await fetchRandom(); // (A)
  9. yield 'Result: ' + await result.text(); // (B)
  10. console.log('Done');
  11. }
  12. const ag = asyncGenerator();
  13. ag.next().then(({value, done}) => {
  14. console.log(value);
  15. })

上面代码中,agasyncGenerator函数返回的异步遍历器对象。调用ag.next()以后,上面代码的执行顺序如下。

  1. ag.next()立刻返回一个 Promise 对象。
  2. asyncGenerator函数开始执行,打印出Start
  3. await命令返回一个 Promise 对象,asyncGenerator函数停在这里。
  4. A 处变成 fulfilled 状态,产生的值放入result变量,asyncGenerator函数继续往下执行。
  5. 函数在 B 处的yield暂停执行,一旦yield命令取到值,ag.next()返回的那个 Promise 对象变成 fulfilled 状态。
  6. ag.next()后面的then方法指定的回调函数开始执行。该回调函数的参数是一个对象{value, done},其中value的值是yield命令后面的那个表达式的值,done的值是false

A 和 B 两行的作用类似于下面的代码。

  1. return new Promise((resolve, reject) => {
  2. fetchRandom()
  3. .then(result => result.text())
  4. .then(result => {
  5. resolve({
  6. value: 'Result: ' + result,
  7. done: false,
  8. });
  9. });
  10. });

如果异步 Generator 函数抛出错误,会导致 Promise 对象的状态变为reject,然后抛出的错误被catch方法捕获。

  1. async function* asyncGenerator() {
  2. throw new Error('Problem!');
  3. }
  4. asyncGenerator()
  5. .next()
  6. .catch(err => console.log(err)); // Error: Problem!

注意,普通的 async 函数返回的是一个 Promise 对象,而异步 Generator 函数返回的是一个异步 Iterator 对象。可以这样理解,async 函数和异步 Generator 函数,是封装异步操作的两种方法,都用来达到同一种目的。区别在于,前者自带执行器,后者通过for await...of执行,或者自己编写执行器。下面就是一个异步 Generator 函数的执行器。

  1. async function takeAsync(asyncIterable, count = Infinity) {
  2. const result = [];
  3. const iterator = asyncIterable[Symbol.asyncIterator]();
  4. while (result.length < count) {
  5. const {value, done} = await iterator.next();
  6. if (done) break;
  7. result.push(value);
  8. }
  9. return result;
  10. }

上面代码中,异步 Generator 函数产生的异步遍历器,会通过while循环自动执行,每当await iterator.next()完成,就会进入下一轮循环。一旦done属性变为true,就会跳出循环,异步遍历器执行结束。

下面是这个自动执行器的一个使用实例。

  1. async function f() {
  2. async function* gen() {
  3. yield 'a';
  4. yield 'b';
  5. yield 'c';
  6. }
  7. return await takeAsync(gen());
  8. }
  9. f().then(function (result) {
  10. console.log(result); // ['a', 'b', 'c']
  11. })

异步 Generator 函数出现以后,JavaScript 就有了四种函数形式:普通函数、async 函数、Generator 函数和异步 Generator 函数。请注意区分每种函数的不同之处。基本上,如果是一系列按照顺序执行的异步操作(比如读取文件,然后写入新内容,再存入硬盘),可以使用 async 函数;如果是一系列产生相同数据结构的异步操作(比如一行一行读取文件),可以使用异步 Generator 函数。

异步 Generator 函数也可以通过next方法的参数,接收外部传入的数据。

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

上面代码中,openFile是一个异步 Generator 函数。next方法的参数,向该函数内部的操作传入数据。每次next方法都是同步执行的,最后的await命令用于等待整个写入操作结束。

最后,同步的数据结构,也可以使用异步 Generator 函数。

  1. async function* createAsyncIterable(syncIterable) {
  2. for (const elem of syncIterable) {
  3. yield elem;
  4. }
  5. }

上面代码中,由于没有异步操作,所以也就没有使用await关键字。

yield* 语句

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

  1. async function* gen1() {
  2. yield 'a';
  3. yield 'b';
  4. return 2;
  5. }
  6. async function* gen2() {
  7. // result 最终会等于 2
  8. const result = yield* gen1();
  9. }

上面代码中,gen2函数里面的result变量,最后的值是2

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

  1. (async function () {
  2. for await (const x of gen2()) {
  3. console.log(x);
  4. }
  5. })();
  6. // a
  7. // b