picture

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

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

上面 👆 代码的函数gen可以写成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模块，而async函数自带执行器。也就是说，async函数的执行，与普通函数一模一样，只要一行。
• （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对象，而async命令就是内部then命令的语法糖。

2、基本用法

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

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

getStockPriceByName('good').then(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);

上面 👆 代码指定50毫秒后，输出hello world。

由于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, ms);
}

asyncPrint('hello world', 50);

使用async函数的多种形式。

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

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

// 对象的方法
let obj = {
    async foo() {}
};
obj.foo().then(...)
class Storage {}
// Class 的方法
class Storage {
    constructor () {
        this.catchPromise = caches.open('avatars');
    }

    async getAvatar(name) {
        const cache = await this.catchProise;
        return catch.match('/avatars/${name}.jpg');
    }
}
const storage = new Storage();
storage.getAvatar('jack').then(() => {...});

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

3、语法

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

3.1、返回 Promise 对象

我们知道，async函数返回一个Promise对象。
而且async函数内部return语句返回的值，会成为then方法回调函数的参数。

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

上面 👆 代码中，函数f内部return命令返回的值，会被then方法回调函数接收到。
命令async函数内部抛出错误，会导致返回的Promise对象变为reject状态。抛出的错误对象会被catch方法回调函数接收到。

async function f() {
  throw new Error('出错了');
}

f().then((v, e) => {
  console.log(v);
  console.log(e);
});
// Error: 出错了

3.2、Promise 对象的状态变化

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

下面 👇 是一个例子。

async function getTitle(url) {
  let response = await fetch(url);
  let html = await response.text();
  return html.match(/<title>([\s\S]+)<\/title>/i)[1];
}
getTitle('http://es6.ruanyifeng.com/#docs/async#%E8%AF%AD%E6%B3%95').then(
  res => {
    console.log(res); // ECMAScript 6入门
  }
);

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

3.3、await 命令

正常情况下，await命令后面是一个Promise对象，返回该对象的结果。如果不是Promise对象，就直接返回对应的值。

async function f() {
  // 等同于
  // return 123;
  return await 123;
}

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

上面 👆 代码中，await命令的参数是数值123，这时等同于return 123。
另一种情况是，await命令后面是一个thenable对象（即定义then方法的对象），那么await会将其等同于Promise对象。

class Sleep {
  constructor(timeout) {
    this.timeout = timeout;
  }
  then(resolve, reject) {
    const startTime = Date.now();
    setTimeout(() => resolve(Date.now() - startTime), this.timeout);
  }
}

(async () => {
  const sleepTime = await new Sleep(2000);
  console.log(sleepTime);
})();
// 1000

上面 👆 代码中，await命令后面是一个Sleep对象的实例。这个实例不是Promise对象，因为定义了then方法，await会将其视为Promise对象处理。
这个例子还演示了如何实现休眠效果。Javascript一直没有休眠的语法，但是借助await命令就可以让程序停顿指定的时间。下面给出了一个简化的sleep实现。

function sleep(interval) {
  return new Promise(resolve => {
    setTimeout(resolve, interval);
  });
}

async function one2FiveInAsync() {
  for (let i = 1; i <= 5; i++) {
    console.log(i);
    await sleep(1000);
  }
}

one2FiveInAsync(); // 1 2 3 4 5

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命令前面加上return，效果是一样的。

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

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

上面 👆 代码中，第二个await语句是不会执行的，因为第一个await语句状态变成了reject。
有时，我们希望即使前一个异步操作失败，也不要中断后面的异步操作。这时可以将第一个await放在try...catch结构里面，这样不管这个异步操作是否成功，第二个异步操作都会执行。

async function f() {
  try {
    await Promise('出错了');
  } 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

3.4、错误处理

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

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

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

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

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

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

async function main() {
  try {
    const val1 = await firstStep();
    const val2 = await secondStep(val1);
    const val3 = await thirdStep(val1, val2);

    console.log('Final：' + val3);
  } catch (e) {
    console.log(e);
  }
}

下面 👇 的例子 🌰 使用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();

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

3.5、使用注意点

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

async function myFunction() {
  try {
    await somethingThatReturnsAPromise();
  } catch (err) {
    console.log(err);
  }
}

// 另一种写法
async function myFunction() {
  await somethingThatReturnsAPromise().catch(err => console.log(err));
}

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

let foo = await getFoo();
let bar = await getBar();

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

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

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

上面 👆 两种写法，getFoo和getBar都是同时触发，这样就会缩短程序的执行时间。

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

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

  docs.forEach(function (doc) => {
    await db.post(doc);
  });
  // Uncaught SyntaxError: await is only valid in async function
}

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

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

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

async function dbFunc(db) {
  let docs = [{}, {}, {}];
  for (let doc of docs) {
    await db.post(doc);
  }
}

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

async function dbFuc(db) {
  let docs = [{}, {}, {}];
  let promise = docs.map(doc => db.post(doc));
  let results = await Promise.all(promise);
  console.log(results);
}
// 或者使用下面的写法
async function dbFuc(db) {
  let docs = [{}, {}, {}];
  let peomises = docs.map(doc => db.post(doc));

  let results = [];
  for (let promise of promises) {
    results.push(await promise);
  }
  console.log(results);
}

3.6、async 函数可以保留堆栈

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

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

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

const a = async () => {
  await b();
  c();
};

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

4、async 函数的实现原理

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

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

所有的async函数都可以写成上面的第二种形式，其中的spawn函数就是自动执行器。
下面给出spawn函数的实现，基本就是前文自动执行器的翻版。

function spawn(genF) {
  return new Promise((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(
        v => {
          step(() => {
            return gen.next(v);
          });
        },
        e => {
          step(() => {
            return gen.throw(e);
          });
        }
      );
    }
    step(() => {
      return gen.next(undefined);
    });
  });
}

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

我们通过一个例子，来看async函数与Generator与Promise函数的比较。
假定某个DOM元素上面，部署了一系列的动画，前一个动画结束，才能开始下一个。如果当中有一个动画出错，返回上一个成功执行的动画的返回值。

首先是Promise的写法。

function chainAnimationsPromise(elem, animations) {
  // 变量 ret 用来保存上一个动画的返回值
  let ret = null;

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

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

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

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

接着是Generator函数的写法。

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

上面 👆 代码使用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;
}

可以看到，async

本文参考来源 阮一峰博客 async。