代码干燥计划

# async 函数

  • 含义
  • 基本用法
  • 语法
  • async 函数的实现原理
  • 与其他异步处理方法的比较
  • 实例：按顺序完成异步操作
  • 顶层 await

# 1. 含义

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);
    });
  });
};

// Generator 版本
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());
};
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26

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

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

（1）内置执行器。

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

asyncReadFile();
1

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

（2）更好的语义。

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

（3）更广的适用性。

co模块约定，yield命令后面只能是 Thunk 函数或 Promise 对象，而async函数的await命令后面，可以是 Promise 对象和原始类型的值（数值、字符串和布尔值，但这时会自动转成立即 resolved 的 Promise 对象）。

（4）返回值是 Promise。

async函数的返回值是 Promise 对象，这比 Generator 函数的返回值是 Iterator 对象方便多了。你可以用then方法指定下一步的操作。

进一步说，async函数完全可以看作多个异步操作，包装成的一个 Promise 对象，而await命令就是内部then命令的语法糖。

# 2. 基本用法

async函数返回一个 Promise 对象，可以使用then方法添加回调函数。

async function fn () {
  return 1
}

console.log(fn()) // Promise { 1 }

fn().then(res => {
  console.log(res)
})
1
2
3
4
5
6
7
8
9
10

当函数执行的时候，一旦遇到await就会先返回，等到异步操作完成，再接着执行函数体内后面的语句。

// 异步操作变同步操作，抛出后用 then 接收
async function fn () {
  return await new Promise((resolve) => {
    setTimeout(() => {
      resolve(99)
    }, 1000);
  })
}

fn().then(res => {
  console.log(res) // 1000ms 之后输出 99
})
1
2
3
4
5
6
7
8
9
10
11
12
13
// 异步操作变同步操作，在 await 后写后续操作
async function fn () {
  let res = await new Promise((resolve) => {
    setTimeout(() => {
      resolve(99)
    }, 1000);
  })
  console.log(res)
}

fn()
1
2
3
4
5
6
7
8
9
10
11
12

下面是一个例子。

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

getStockPriceByName('goog').then(function (result) {
  console.log(result);
});
1
2
3
4
5
6
7
8
9

上面代码是一个获取股票报价的函数，函数前面的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); // 指定 50 毫秒以后，输出hello world。
1
2
3
4
5
6
7
8
9
10
11
12

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

async function timeout(ms) {
  await new Promise((resolve) => {
    setTimeout(resolve, ms);
  });
}

async function asyncPrint(value, ms) {
  await timeout(ms);
  console.log(value);
}

asyncPrint('hello world', 50);
1
2
3
4
5
6
7
8
9
10
11
12

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 () => {};
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27

# 3. 语法

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

# (1) async 函数整体会返回 Promise 对象

async函数返回一个 Promise 对象。

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

async函数内的 return xxValue ，会传入 resolve(xxValue) ，throw xxError 会传入 reject(xxError)， 不写 return 的话，通常会默认返回一个 undefined，并传入 resolve(undefined)

async function f() {
  return 'hello world'; // 相当于 return Promise.resolve('hello world')
}

f().then(v => console.log(v))
// "hello world"
1
2
3
4
5
6

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

async function f() {
  throw new Error('出错了'); // 相当于 return Promise.reject(new Error('出错了'))
}

f().then(
  v => console.log(v),
  e => console.log(e)
)
// Error: 出错了
1
2
3
4
5
6
7
8
9

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

function asyncFn (num) {
  return new Promise(resolve => {
    setTimeout(() => {
      console.log(num)
      resolve()
    }, 1000);
  })
}
async function f() {
  await asyncFn(1)
  await asyncFn(2)
  await asyncFn(3)
  return 4
}

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

// 1000ms 后 输出 1
// 再过 1000ms 后 输出 2
// 再过 1000ms 后 输出 3
// 输出3后 立即往后执行 输出 4
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22

# (2) await 命令

  • await命令后面应该为一个 Promise 对象，返回该Promise对象的执行结果。如果不是 Promise 对象，就直接返回对应的值。

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

  • 如果await命令后面是一个thenable对象（含有then()方法），await会将其视为 Promise对象。

    await 会自动执行这个对象的 then() 方法

    class Sleep {
  constructor(timeout) {
    this.timeout = timeout;
  }
  then(resolve, reject) {
    setTimeout(
      () => resolve(this.timeout),
      this.timeout
    );
  }
}

(async () => {
  // new Sleep() 生成一个含有 then() 方法的对象，await 会执行这个 then() 方法
  const sleepTime = await new Sleep(1000);  // 传入想让程序休眠的时间 1000
  console.log(sleepTime); // 1000ms 之后，输出让程序休眠的时间 1000
})();
    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18

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

    async function f() {
  // rejected 状态会被async函数自动 return 出去，等同于 return await Promise.reject('出错了')
  await Promise.reject('出错了');
  return await Promise.resolve('1'); // rejected 状态之后的语句都不会执行
}

f()
.then(v => console.log(v))
.catch(e => console.log(e)) // 出错了
    1
    2
    3
    4
    5
    6
    7
    8
    9

    async 函数中任何一个 await 语句后的 Promise 对象变为reject状态，那么整个async函数都会中断执行。

    async 函数中断执行的解决办法：

    // 方法一：放入 try...catch 中，在内部就被 catch 捕获错误
async function f() {
  try {
    await Promise.reject('出错了');
  } catch (error) {
    console.log(error)
  }
  return await Promise.resolve('1'); // 继续执行
}

f()
.then(v => console.log(v)) // 1
.catch(e => console.log(e))

// 方法二：在 await 后的 Promise 对象后用 .catch 直接捕获错误
async function f() {
  await Promise.reject('出错了').catch(e => console.log(e)); // 出错了
  return await Promise.resolve('1'); // 继续执行
}

f()
.then(v => console.log(v)) // 1
.catch(e => console.log(e))
    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23

# (3) 错误处理

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

async function f() {
  await new Promise(function (resolve, reject) {
    throw new Error('出错了');
  });
}

f()
.then(v => console.log(v))
.catch(e => console.log('outerCatch', e)) // outerCatch Error: 出错了
1
2
3
4
5
6
7
8
9
10

防止出错的方法，也是将其放在try...catch代码块之中，或者在 await 后的Promise后直接catch。

// 方法一：
async function f() {
  try { // 多个 await 命令，也可以统一放在 try...catch 结构中一并捕获。
    await new Promise(function (resolve, reject) {
      throw new Error('出错了');
    });
  } catch(e) {
    console.log('innerCatch', err); // innerCatch Error: 出错了
  }
  return await('hello world');
}

// 方法二：
async function f() {
  await new Promise(function (resolve, reject) {
    throw new Error('出错了');
  }).catch(err => console.log('innerCatch', err)); // innerCatch Error: 出错了
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

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

const superagent = require('superagent');
const NUM_RETRIES = 3;

async function test() {
  let i;
  for (i = 0; i < NUM_RETRIES; ++i) {
    try {
      await superagent.get('http://google.com/this-throws-an-error');
      break;
    } catch(err) {}
  }
  console.log(i); // 3
}

test();
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

如果await操作成功，就会使用break语句退出循环；如果失败，会被catch语句捕捉，然后进入下一轮循环。

# 注意

await命令后面的Promise对象，运行结果可能是rejected，所以最好把await命令放在try...catch代码块中。

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

// 写法一：await 用在了普通函数中
async function dbFuc(db) {
  let docs = [{}, {}, {}];
  docs.forEach(function (doc) {
    await db.post(doc); // 报错 await 不是用在 async 函数中
  });
}

// 写法二：也有问题

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

  // 可能得到错误结果，循环的三个操作将是并发执行，也就是同时执行，而不是继发执行。
  docs.forEach(async function (doc) {
    await db.post(doc);
  });
}

// 正确写法：使用 for 循环，让 await 直接属于 async 函数中

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

  for (let doc of docs) {
    await db.post(doc); // 依然是在 async 函数中使用
  }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29

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

async function dbFuc(db) {
  let docs = [{}, {}, {}];
  let promises = docs.map((doc) => db.post(doc));

  let results = await Promise.all(promises);
  console.log(results);
}

// 或者使用下面的写法

async function dbFuc(db) {
  let docs = [{}, {}, {}];
  let promises = docs.map((doc) => db.post(doc));

  let results = [];
  for (let promise of promises) {
    results.push(await promise);
  }
  console.log(results);
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

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

// 继发关系：后一个要等前一个执行完毕
let foo = await getFoo();
let bar = await getBar();

// 改成同时触发：
// 写法一
let [foo, bar] = await Promise.all([getFoo(), getBar()]);

// 写法二
let fooPromise = getFoo();
let barPromise = getBar();
let foo = await fooPromise;
let bar = await barPromise;
1
2
3
4
5
6
7
8
9
10
11
12
13
14

async 函数可以保留运行堆栈。

const a = () => {
  b().then(() => c());
};
1
2
3

上面代码中，函数a内部运行了一个异步任务b()。当b()运行的时候，函数a()不会中断，而是继续执行。等到b()运行结束，可能a()早就运行结束了，b()所在的上下文环境已经消失了。如果b()或c()报错，错误堆栈将不包括a()。

现在将这个例子改成async函数。

const a = async () => {
  await b();
  c();
};
1
2
3
4

上面代码中，b()运行的时候，a()是暂停执行，上下文环境都保存着。一旦b()或c()报错，错误堆栈将包括a()。

# 4. async 函数的实现原理

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

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

// 等同于

function fn(args) {
  return spawn(function* () {
    // ...
  });
}
1
2
3
4
5
6
7
8
9
10
11

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

下面给出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); });
  });
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22

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

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

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

首先是 Promise 的写法。

function chainAnimationsPromise(elem, animations) {

  // 变量ret用来保存上一个动画的返回值
  let ret = null;

  // 新建一个空的Promise
  let p = Promise.resolve();

  // 使用then方法，添加所有动画
  for(let anim of animations) {
    p = p.then(function(val) {
      ret = val;
      return anim(elem);
    });
  }

  // 返回一个部署了错误捕捉机制的Promise
  return p.catch(function(e) {
    /* 忽略错误，继续执行 */
  }).then(function() {
    return ret;
  });

}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24

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

接着是 Generator 函数的写法。

function chainAnimationsGenerator(elem, animations) {

  return spawn(function*() {
    let ret = null;
    try {
      for(let anim of animations) {
        ret = yield anim(elem);
      }
    } catch(e) {
      /* 忽略错误，继续执行 */
    }
    return ret;
  });

}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

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

最后是 async 函数的写法。

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

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

# 6. 实例：按顺序完成异步操作

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

Promise 的写法如下。

function logInOrder(urls) {
  // 远程读取所有URL
  const textPromises = urls.map(url => {
    return fetch(url).then(response => response.text());
  });

  // 按次序输出
  textPromises.reduce((chain, textPromise) => {
    return chain.then(() => textPromise)
      .then(text => console.log(text));
  }, Promise.resolve());
}
1
2
3
4
5
6
7
8
9
10
11
12

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

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

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

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

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);
  }
}
1
2
3
4
5
6
7
8
9
10
11
12

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

# 7. 顶层 await

根据语法规格，await命令只能出现在 async 函数内部，否则都会报错。

目前，有一个语法提案，允许在模块的顶层独立使用await命令。这个提案的目的，是借用await解决模块异步加载的问题。

# (1) 模块异步加载的问题

// awaiting.js

let output;
(async function () {
  const dynamic = await import(someMission);
  const data = await fetch(url);
  output = someProcess(dynamic.default, data);
})();

// 导出 output ，但 output 是异步操作获取的值，若异步操作未完成，output 值则为 undefined
export { output };
1
2
3
4
5
6
7
8
9
10
11

下面是加载这个模块awaiting.js的写法。

// usage.js

import { output } from "./awaiting.js";

function outputPlusValue(value) { return output + value }

console.log(outputPlusValue(100)); // 立即执行，output 值为 undefined

// 1000ms 后执行，此时无法确定 output 是否有值，因为异步操作不确定是否执行完毕
setTimeout(() => console.log(outputPlusValue(100), 1000);
1
2
3
4
5
6
7
8
9
10
11

# (2) 使用 Promise 解决，导出者和导入者需要配合

目前的解决方法：原始模块输出一个 Promise 对象，然后在需要加载的模块中，从这个 Promise 对象的状态判断异步操作有没有结束。

// awaiting.js

let output;
export default (async function main() {
  const dynamic = await import(someMission);
  const data = await fetch(url);
  output = someProcess(dynamic.default, data);
})(); // 执行完毕后返回一个 Promise 对象，然后 export default 这个对象
export { output };
1
2
3
4
5
6
7
8
9

加载这个模块的新的写法：

// usage.js

// 加载 原始模块导出的 output 和 默认导出的 promise 对象
import promise, { output } from "./awaiting.js";

function outputPlusValue(value) { return output + value }

// 根据 promise 对象的状态，异步完成后在 .then() 中读取 output 的值
promise.then(() => {
  console.log(outputPlusValue(100));
  setTimeout(() => console.log(outputPlusValue(100), 1000);
});
1
2
3
4
5
6
7
8
9
10
11
12

此方法的缺点：

  • 要求模块的使用者遵守一个额外的使用协议，按照特殊的方法使用这个模块。
  • 如果忘了要在 Promise.then() 中加载，只使用正常的加载方法，依赖这个模块的代码就可能出错。
  • 如果上面的usage.js又有对外的输出，这个依赖链的所有模块都要使用 Promise.then() 加载。

解决办法：顶层的await命令，就是为了解决这个问题。它保证只有异步操作完成，模块才会输出值。

# (3) 使用 await 解决，导出者解决，导入者不需要任何变化

// awaiting.js
const dynamic = import(someMission);
const data = fetch(url);

// 输出的时候，都加上await命令。只有等到所有异步操作完成，这个模块才会输出值。
export const output = someProcess((await dynamic).default, await data);
1
2
3
4
5
6

加载这个模块的写法：与普通的模块加载完全一样，正常加载使用即可。

// usage.js

import { output } from "./awaiting.js";
function outputPlusValue(value) { return output + value }

console.log(outputPlusValue(100));
setTimeout(() => console.log(outputPlusValue(100), 1000);
1
2
3
4
5
6
7

这时，模块的加载会等待依赖模块（上例是awaiting.js）的异步操作完成，才执行后面的代码，有点像暂停在那里。所以，它总是会得到正确的output，不会因为加载时机的不同，而得到不一样的值。

# (4) 顶层await的一些使用场景

// import() 方法加载
const strings = await import(`/i18n/${navigator.language}`);

// 数据库操作
const connection = await dbConnector();

// 依赖回滚
let jQuery;
try {
  jQuery = await import('https://cdn-a.com/jQuery');
} catch {
  jQuery = await import('https://cdn-b.com/jQuery');
}
1
2
3
4
5
6
7
8
9
10
11
12
13

注意，如果加载多个包含顶层await命令的模块，加载命令是并发执行的。

// x.js
console.log("X1");
await new Promise(r => setTimeout(r, 1000));
console.log("X2");
1
2
3
4
// y.js
console.log("Y");
1
2
// z.js

// 加载多个模块，这些模块是并发执行的，也就是加载不分先后顺序。后加载不会等待前加载的执行完。
import "./x.js";
import "./y.js";
console.log("Z");

// 打印结果说明，并没有等待 x.js 加载完成，再去加载 y.js。
// X1
// Y
// X2
// Z
1
2
3
4
5
6
7
8
9
10
11
12

顶层的await命令有点像，交出代码的执行权给其他的模块加载，等异步操作完成后，再拿回执行权，继续向下执行。

← /JavaScript/ES6/ES6_21&22_Class.html →