ECMAScript 6 异步操作和Async函数


异步编程对JavaScript语言太重要。Javascript语言的执行环境是“单线程”的,如果没有异步编程,根本没法用,非卡死不可。

ES6诞生以前,异步编程的方法,大概有下面四种。

  • 回调函数
  • 事件监听
  • 发布/订阅
  • Promise 对象

ES6将JavaScript异步编程带入了一个全新的阶段,ES7的Async函数更是提出了异步编程的终极解决方案。

基本概念

异步

所谓"异步",简单说就是一个任务分成两段,先执行第一段,然后转而执行其他任务,等做好了准备,再回过头执行第二段。

比如,有一个任务是读取文件进行处理,任务的第一段是向操作系统发出请求,要求读取文件。然后,程序执行其他任务,等到操作系统返回文件,再接着执行任务的第二段(处理文件)。这种不连续的执行,就叫做异步。

相应地,连续的执行就叫做同步。由于是连续执行,不能插入其他任务,所以操作系统从硬盘读取文件的这段时间,程序只能干等着。

回调函数

JavaScript语言对异步编程的实现,就是回调函数。所谓回调函数,就是把任务的第二段单独写在一个函数里面,等到重新执行这个任务的时候,就直接调用这个函数。它的英语名字callback,直译过来就是"重新调用"。

读取文件进行处理,是这样写的。

  1. fs.readFile('/etc/passwd', function (err, data) {
  2. if (err) throw err;
  3. console.log(data);
  4. });

上面代码中,readFile函数的第二个参数,就是回调函数,也就是任务的第二段。等到操作系统返回了/etc/passwd这个文件以后,回调函数才会执行。

一个有趣的问题是,为什么Node.js约定,回调函数的第一个参数,必须是错误对象err(如果没有错误,该参数就是null)?原因是执行分成两段,在这两段之间抛出的错误,程序无法捕捉,只能当作参数,传入第二段。

Promise

回调函数本身并没有问题,它的问题出现在多个回调函数嵌套。假定读取A文件之后,再读取B文件,代码如下。

  1. fs.readFile(fileA, function (err, data) {
  2. fs.readFile(fileB, function (err, data) {
  3. // ...
  4. });
  5. });

不难想象,如果依次读取多个文件,就会出现多重嵌套。代码不是纵向发展,而是横向发展,很快就会乱成一团,无法管理。这种情况就称为"回调函数噩梦"(callback hell)。

Promise就是为了解决这个问题而提出的。它不是新的语法功能,而是一种新的写法,允许将回调函数的嵌套,改成链式调用。采用Promise,连续读取多个文件,写法如下。

  1. var readFile = require('fs-readfile-promise');
  2. readFile(fileA)
  3. .then(function(data){
  4. console.log(data.toString());
  5. })
  6. .then(function(){
  7. return readFile(fileB);
  8. })
  9. .then(function(data){
  10. console.log(data.toString());
  11. })
  12. .catch(function(err) {
  13. console.log(err);
  14. });

上面代码中,我使用了fs-readfile-promise模块,它的作用就是返回一个Promise版本的readFile函数。Promise提供then方法加载回调函数,catch方法捕捉执行过程中抛出的错误。

可以看到,Promise 的写法只是回调函数的改进,使用then方法以后,异步任务的两段执行看得更清楚了,除此以外,并无新意。

Promise 的最大问题是代码冗余,原来的任务被Promise 包装了一下,不管什么操作,一眼看去都是一堆 then,原来的语义变得很不清楚。

那么,有没有更好的写法呢?

Generator函数

协程

传统的编程语言,早有异步编程的解决方案(其实是多任务的解决方案)。其中有一种叫做"协程"(coroutine),意思是多个线程互相协作,完成异步任务。

协程有点像函数,又有点像线程。它的运行流程大致如下。

  • 第一步,协程A开始执行。
  • 第二步,协程A执行到一半,进入暂停,执行权转移到协程B。
  • 第三步,(一段时间后)协程B交还执行权。
  • 第四步,协程A恢复执行。

上面流程的协程A,就是异步任务,因为它分成两段(或多段)执行。

举例来说,读取文件的协程写法如下。

  1. function *asyncJob() {
  2. // ...其他代码
  3. var f = yield readFile(fileA);
  4. // ...其他代码
  5. }

上面代码的函数asyncJob是一个协程,它的奥妙就在其中的yield命令。它表示执行到此处,执行权将交给其他协程。也就是说,yield命令是异步两个阶段的分界线。

协程遇到yield命令就暂停,等到执行权返回,再从暂停的地方继续往后执行。它的最大优点,就是代码的写法非常像同步操作,如果去除yield命令,简直一模一样。

Generator函数的概念

Generator函数是协程在ES6的实现,最大特点就是可以交出函数的执行权(即暂停执行)。

整个Generator函数就是一个封装的异步任务,或者说是异步任务的容器。异步操作需要暂停的地方,都用yield语句注明。Generator函数的执行方法如下。

  1. function* gen(x){
  2. var y = yield x + 2;
  3. return y;
  4. }
  5. var g = gen(1);
  6. g.next() // { value: 3, done: false }
  7. g.next() // { value: undefined, done: true }

上面代码中,调用Generator函数,会返回一个内部指针(即遍历器)g 。这是Generator函数不同于普通函数的另一个地方,即执行它不会返回结果,返回的是指针对象。调用指针g的next方法,会移动内部指针(即执行异步任务的第一段),指向第一个遇到的yield语句,上例是执行到x + 2为止。

换言之,next方法的作用是分阶段执行Generator函数。每次调用next方法,会返回一个对象,表示当前阶段的信息(value属性和done属性)。value属性是yield语句后面表达式的值,表示当前阶段的值;done属性是一个布尔值,表示Generator函数是否执行完毕,即是否还有下一个阶段。

Generator函数的数据交换和错误处理

Generator函数可以暂停执行和恢复执行,这是它能封装异步任务的根本原因。除此之外,它还有两个特性,使它可以作为异步编程的完整解决方案:函数体内外的数据交换和错误处理机制。

next方法返回值的value属性,是Generator函数向外输出数据;next方法还可以接受参数,这是向Generator函数体内输入数据。

  1. function* gen(x){
  2. var y = yield x + 2;
  3. return y;
  4. }
  5. var g = gen(1);
  6. g.next() // { value: 3, done: false }
  7. g.next(2) // { value: 2, done: true }

上面代码中,第一个next方法的value属性,返回表达式x + 2的值(3)。第二个next方法带有参数2,这个参数可以传入 Generator 函数,作为上个阶段异步任务的返回结果,被函数体内的变量y接收。因此,这一步的 value 属性,返回的就是2(变量y的值)。

Generator 函数内部还可以部署错误处理代码,捕获函数体外抛出的错误。

  1. function* gen(x){
  2. try {
  3. var y = yield x + 2;
  4. } catch (e){
  5. console.log(e);
  6. }
  7. return y;
  8. }
  9. var g = gen(1);
  10. g.next();
  11. g.throw('出错了');
  12. // 出错了

上面代码的最后一行,Generator函数体外,使用指针对象的throw方法抛出的错误,可以被函数体内的try …catch代码块捕获。这意味着,出错的代码与处理错误的代码,实现了时间和空间上的分离,这对于异步编程无疑是很重要的。

异步任务的封装

下面看看如何使用 Generator 函数,执行一个真实的异步任务。

  1. var fetch = require('node-fetch');
  2. function* gen(){
  3. var url = 'https://api.github.com/users/github';
  4. var result = yield fetch(url);
  5. console.log(result.bio);
  6. }

上面代码中,Generator函数封装了一个异步操作,该操作先读取一个远程接口,然后从JSON格式的数据解析信息。就像前面说过的,这段代码非常像同步操作,除了加上了yield命令。

执行这段代码的方法如下。

  1. var g = gen();
  2. var result = g.next();
  3. result.value.then(function(data){
  4. return data.json();
  5. }).then(function(data){
  6. g.next(data);
  7. });

上面代码中,首先执行Generator函数,获取遍历器对象,然后使用next 方法(第二行),执行异步任务的第一阶段。由于Fetch模块返回的是一个Promise对象,因此要用then方法调用下一个next 方法。

可以看到,虽然 Generator 函数将异步操作表示得很简洁,但是流程管理却不方便(即何时执行第一阶段、何时执行第二阶段)。

Thunk函数

参数的求值策略

Thunk函数早在上个世纪60年代就诞生了。

那时,编程语言刚刚起步,计算机学家还在研究,编译器怎么写比较好。一个争论的焦点是"求值策略",即函数的参数到底应该何时求值。

  1. var x = 1;
  2. function f(m){
  3. return m * 2;
  4. }
  5. f(x + 5)

上面代码先定义函数f,然后向它传入表达式x + 5。请问,这个表达式应该何时求值?

一种意见是"传值调用"(call by value),即在进入函数体之前,就计算x + 5的值(等于6),再将这个值传入函数f 。C语言就采用这种策略。

  1. f(x + 5)
  2. // 传值调用时,等同于
  3. f(6)

另一种意见是"传名调用"(call by name),即直接将表达式x + 5传入函数体,只在用到它的时候求值。Haskell语言采用这种策略。

  1. f(x + 5)
  2. // 传名调用时,等同于
  3. (x + 5) * 2

传值调用和传名调用,哪一种比较好?回答是各有利弊。传值调用比较简单,但是对参数求值的时候,实际上还没用到这个参数,有可能造成性能损失。

  1. function f(a, b){
  2. return b;
  3. }
  4. f(3 * x * x - 2 * x - 1, x);

上面代码中,函数f的第一个参数是一个复杂的表达式,但是函数体内根本没用到。对这个参数求值,实际上是不必要的。因此,有一些计算机学家倾向于"传名调用",即只在执行时求值。

Thunk函数的含义

编译器的"传名调用"实现,往往是将参数放到一个临时函数之中,再将这个临时函数传入函数体。这个临时函数就叫做Thunk函数。

  1. function f(m){
  2. return m * 2;
  3. }
  4. f(x + 5);
  5. // 等同于
  6. var thunk = function () {
  7. return x + 5;
  8. };
  9. function f(thunk){
  10. return thunk() * 2;
  11. }

上面代码中,函数f的参数x + 5被一个函数替换了。凡是用到原参数的地方,对Thunk函数求值即可。

这就是Thunk函数的定义,它是"传名调用"的一种实现策略,用来替换某个表达式。

JavaScript语言的Thunk函数

JavaScript语言是传值调用,它的Thunk函数含义有所不同。在JavaScript语言中,Thunk函数替换的不是表达式,而是多参数函数,将其替换成单参数的版本,且只接受回调函数作为参数。

  1. // 正常版本的readFile(多参数版本)
  2. fs.readFile(fileName, callback);
  3. // Thunk版本的readFile(单参数版本)
  4. var readFileThunk = Thunk(fileName);
  5. readFileThunk(callback);
  6. var Thunk = function (fileName){
  7. return function (callback){
  8. return fs.readFile(fileName, callback);
  9. };
  10. };

上面代码中,fs模块的readFile方法是一个多参数函数,两个参数分别为文件名和回调函数。经过转换器处理,它变成了一个单参数函数,只接受回调函数作为参数。这个单参数版本,就叫做Thunk函数。

任何函数,只要参数有回调函数,就能写成Thunk函数的形式。下面是一个简单的Thunk函数转换器。

  1. // ES5版本
  2. var Thunk = function(fn){
  3. return function (){
  4. var args = Array.prototype.slice.call(arguments);
  5. return function (callback){
  6. args.push(callback);
  7. return fn.apply(this, args);
  8. }
  9. };
  10. };
  11. // ES6版本
  12. var Thunk = function(fn) {
  13. return function (...args) {
  14. return function (callback) {
  15. return fn.call(this, ...args, callback);
  16. }
  17. };
  18. };

使用上面的转换器,生成fs.readFile的Thunk函数。

  1. var readFileThunk = Thunk(fs.readFile);
  2. readFileThunk(fileA)(callback);

下面是另一个完整的例子。

  1. function f(a, cb) {
  2. cb(a);
  3. }
  4. let ft = Thunk(f);
  5. let log = console.log.bind(console);
  6. ft(1)(log) // 1

Thunkify模块

生产环境的转换器,建议使用Thunkify模块。

首先是安装。

  1. $ npm install thunkify

使用方式如下。

  1. var thunkify = require('thunkify');
  2. var fs = require('fs');
  3. var read = thunkify(fs.readFile);
  4. read('package.json')(function(err, str){
  5. // ...
  6. });

Thunkify的源码与上一节那个简单的转换器非常像。

  1. function thunkify(fn){
  2. return function(){
  3. var args = new Array(arguments.length);
  4. var ctx = this;
  5. for(var i = 0; i < args.length; ++i) {
  6. args[i] = arguments[i];
  7. }
  8. return function(done){
  9. var called;
  10. args.push(function(){
  11. if (called) return;
  12. called = true;
  13. done.apply(null, arguments);
  14. });
  15. try {
  16. fn.apply(ctx, args);
  17. } catch (err) {
  18. done(err);
  19. }
  20. }
  21. }
  22. };

它的源码主要多了一个检查机制,变量called确保回调函数只运行一次。这样的设计与下文的Generator函数相关。请看下面的例子。

  1. function f(a, b, callback){
  2. var sum = a + b;
  3. callback(sum);
  4. callback(sum);
  5. }
  6. var ft = thunkify(f);
  7. var print = console.log.bind(console);
  8. ft(1, 2)(print);
  9. // 3

上面代码中,由于thunkify只允许回调函数执行一次,所以只输出一行结果。

Generator 函数的流程管理

你可能会问, Thunk函数有什么用?回答是以前确实没什么用,但是ES6有了Generator函数,Thunk函数现在可以用于Generator函数的自动流程管理。

Generator函数可以自动执行。

  1. function* gen() {
  2. // ...
  3. }
  4. var g = gen();
  5. var res = g.next();
  6. while(!res.done){
  7. console.log(res.value);
  8. res = g.next();
  9. }

上面代码中,Generator函数gen会自动执行完所有步骤。

但是,这不适合异步操作。如果必须保证前一步执行完,才能执行后一步,上面的自动执行就不可行。这时,Thunk函数就能派上用处。以读取文件为例。下面的Generator函数封装了两个异步操作。

  1. var fs = require('fs');
  2. var thunkify = require('thunkify');
  3. var readFile = thunkify(fs.readFile);
  4. var gen = function* (){
  5. var r1 = yield readFile('/etc/fstab');
  6. console.log(r1.toString());
  7. var r2 = yield readFile('/etc/shells');
  8. console.log(r2.toString());
  9. };

上面代码中,yield命令用于将程序的执行权移出Generator函数,那么就需要一种方法,将执行权再交还给Generator函数。

这种方法就是Thunk函数,因为它可以在回调函数里,将执行权交还给Generator函数。为了便于理解,我们先看如何手动执行上面这个Generator函数。

  1. var g = gen();
  2. var r1 = g.next();
  3. r1.value(function(err, data){
  4. if (err) throw err;
  5. var r2 = g.next(data);
  6. r2.value(function(err, data){
  7. if (err) throw err;
  8. g.next(data);
  9. });
  10. });

上面代码中,变量g是Generator函数的内部指针,表示目前执行到哪一步。next方法负责将指针移动到下一步,并返回该步的信息(value属性和done属性)。

仔细查看上面的代码,可以发现Generator函数的执行过程,其实是将同一个回调函数,反复传入next方法的value属性。这使得我们可以用递归来自动完成这个过程。

Thunk函数的自动流程管理

Thunk函数真正的威力,在于可以自动执行Generator函数。下面就是一个基于Thunk函数的Generator执行器。

  1. function run(fn) {
  2. var gen = fn();
  3. function next(err, data) {
  4. var result = gen.next(data);
  5. if (result.done) return;
  6. result.value(next);
  7. }
  8. next();
  9. }
  10. function* g() {
  11. // ...
  12. }
  13. run(g);

上面代码的run函数,就是一个Generator函数的自动执行器。内部的next函数就是Thunk的回调函数。next函数先将指针移到Generator函数的下一步(gen.next方法),然后判断Generator函数是否结束(result.done属性),如果没结束,就将next函数再传入Thunk函数(result.value属性),否则就直接退出。

有了这个执行器,执行Generator函数方便多了。不管内部有多少个异步操作,直接把Generator函数传入run函数即可。当然,前提是每一个异步操作,都要是Thunk函数,也就是说,跟在yield命令后面的必须是Thunk函数。

  1. var g = function* (){
  2. var f1 = yield readFile('fileA');
  3. var f2 = yield readFile('fileB');
  4. // ...
  5. var fn = yield readFile('fileN');
  6. };
  7. run(g);

上面代码中,函数g封装了n个异步的读取文件操作,只要执行run函数,这些操作就会自动完成。这样一来,异步操作不仅可以写得像同步操作,而且一行代码就可以执行。

Thunk函数并不是Generator函数自动执行的唯一方案。因为自动执行的关键是,必须有一种机制,自动控制Generator函数的流程,接收和交还程序的执行权。回调函数可以做到这一点,Promise 对象也可以做到这一点。

co模块

基本用法

co模块是著名程序员TJ Holowaychuk于2013年6月发布的一个小工具,用于Generator函数的自动执行。

比如,有一个Generator函数,用于依次读取两个文件。

  1. var gen = function* (){
  2. var f1 = yield readFile('/etc/fstab');
  3. var f2 = yield readFile('/etc/shells');
  4. console.log(f1.toString());
  5. console.log(f2.toString());
  6. };

co模块可以让你不用编写Generator函数的执行器。

  1. var co = require('co');
  2. co(gen);

上面代码中,Generator函数只要传入co函数,就会自动执行。

co函数返回一个Promise对象,因此可以用then方法添加回调函数。

  1. co(gen).then(function (){
  2. console.log('Generator 函数执行完成');
  3. });

上面代码中,等到Generator函数执行结束,就会输出一行提示。

co模块的原理

为什么co可以自动执行Generator函数?

前面说过,Generator就是一个异步操作的容器。它的自动执行需要一种机制,当异步操作有了结果,能够自动交回执行权。

两种方法可以做到这一点。

(1)回调函数。将异步操作包装成Thunk函数,在回调函数里面交回执行权。

(2)Promise 对象。将异步操作包装成Promise对象,用then方法交回执行权。

co模块其实就是将两种自动执行器(Thunk函数和Promise对象),包装成一个模块。使用co的前提条件是,Generator函数的yield命令后面,只能是Thunk函数或Promise对象。

上一节已经介绍了基于Thunk函数的自动执行器。下面来看,基于Promise对象的自动执行器。这是理解co模块必须的。

基于Promise对象的自动执行

还是沿用上面的例子。首先,把fs模块的readFile方法包装成一个Promise对象。

  1. var fs = require('fs');
  2. var 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. var gen = function* (){
  11. var f1 = yield readFile('/etc/fstab');
  12. var f2 = yield readFile('/etc/shells');
  13. console.log(f1.toString());
  14. console.log(f2.toString());
  15. };

然后,手动执行上面的Generator函数。

  1. var g = gen();
  2. g.next().value.then(function(data){
  3. g.next(data).value.then(function(data){
  4. g.next(data);
  5. });
  6. });

手动执行其实就是用then方法,层层添加回调函数。理解了这一点,就可以写出一个自动执行器。

  1. function run(gen){
  2. var g = gen();
  3. function next(data){
  4. var result = g.next(data);
  5. if (result.done) return result.value;
  6. result.value.then(function(data){
  7. next(data);
  8. });
  9. }
  10. next();
  11. }
  12. run(gen);

上面代码中,只要Generator函数还没执行到最后一步,next函数就调用自身,以此实现自动执行。

co模块的源码

co就是上面那个自动执行器的扩展,它的源码只有几十行,非常简单。

首先,co函数接受Generator函数作为参数,返回一个 Promise 对象。

  1. function co(gen) {
  2. var ctx = this;
  3. return new Promise(function(resolve, reject) {
  4. });
  5. }

在返回的Promise对象里面,co先检查参数gen是否为Generator函数。如果是,就执行该函数,得到一个内部指针对象;如果不是就返回,并将Promise对象的状态改为resolved。

  1. function co(gen) {
  2. var ctx = this;
  3. return new Promise(function(resolve, reject) {
  4. if (typeof gen === 'function') gen = gen.call(ctx);
  5. if (!gen || typeof gen.next !== 'function') return resolve(gen);
  6. });
  7. }

接着,co将Generator函数的内部指针对象的next方法,包装成onFulfilled函数。这主要是为了能够捕捉抛出的错误。

  1. function co(gen) {
  2. var ctx = this;
  3. return new Promise(function(resolve, reject) {
  4. if (typeof gen === 'function') gen = gen.call(ctx);
  5. if (!gen || typeof gen.next !== 'function') return resolve(gen);
  6. onFulfilled();
  7. function onFulfilled(res) {
  8. var ret;
  9. try {
  10. ret = gen.next(res);
  11. } catch (e) {
  12. return reject(e);
  13. }
  14. next(ret);
  15. }
  16. });
  17. }

最后,就是关键的next函数,它会反复调用自身。

  1. function next(ret) {
  2. if (ret.done) return resolve(ret.value);
  3. var value = toPromise.call(ctx, ret.value);
  4. if (value && isPromise(value)) return value.then(onFulfilled, onRejected);
  5. return onRejected(new TypeError('You may only yield a function, promise, generator, array, or object, '
  6. + 'but the following object was passed: "' + String(ret.value) + '"'));
  7. }

上面代码中,next 函数的内部代码,一共只有四行命令。

第一行,检查当前是否为 Generator 函数的最后一步,如果是就返回。

第二行,确保每一步的返回值,是 Promise 对象。

第三行,使用 then 方法,为返回值加上回调函数,然后通过 onFulfilled 函数再次调用 next 函数。

第四行,在参数不符合要求的情况下(参数非 Thunk 函数和 Promise 对象),将 Promise 对象的状态改为 rejected,从而终止执行。

处理并发的异步操作

co支持并发的异步操作,即允许某些操作同时进行,等到它们全部完成,才进行下一步。

这时,要把并发的操作都放在数组或对象里面,跟在yield语句后面。

  1. // 数组的写法
  2. co(function* () {
  3. var res = yield [
  4. Promise.resolve(1),
  5. Promise.resolve(2)
  6. ];
  7. console.log(res);
  8. }).catch(onerror);
  9. // 对象的写法
  10. co(function* () {
  11. var res = yield {
  12. 1: Promise.resolve(1),
  13. 2: Promise.resolve(2),
  14. };
  15. console.log(res);
  16. }).catch(onerror);

下面是另一个例子。

  1. co(function* () {
  2. var values = [n1, n2, n3];
  3. yield values.map(somethingAsync);
  4. });
  5. function* somethingAsync(x) {
  6. // do something async
  7. return y
  8. }

上面的代码允许并发三个somethingAsync异步操作,等到它们全部完成,才会进行下一步。

async函数

含义

ES7提供了async函数,使得异步操作变得更加方便。async函数是什么?一句话,async函数就是Generator函数的语法糖。

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

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

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

  1. var asyncReadFile = async function (){
  2. var f1 = await readFile('/etc/fstab');
  3. var 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. var result = 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函数的语法规则总体上比较简单,难点是错误处理机制。

(1)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: 出错了

(2)async函数返回的Promise对象,必须等到内部所有await命令的Promise对象执行完,才会发生状态改变。也就是说,只有async函数内部的异步操作执行完,才会执行then方法指定的回调函数。

下面是一个例子。

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

(3)正常情况下,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命令,可以统一放在try…catch结构中。

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

(4)如果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. }

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. var gen = genF();
  4. function step(nextF) {
  5. try {
  6. var next = nextF();
  7. } catch(e) {
  8. return reject(e);
  9. }
  10. if(next.done) {
  11. return resolve(next.value);
  12. }
  13. Promise.resolve(next.value).then(function(v) {
  14. step(function() { return gen.next(v); });
  15. }, function(e) {
  16. step(function() { return gen.throw(e); });
  17. });
  18. }
  19. step(function() { return gen.next(undefined); });
  20. });
  21. }

async函数是非常新的语法功能,新到都不属于 ES6,而是属于 ES7。目前,它仍处于提案阶段,但是转码器Babelregenerator都已经支持,转码后就能使用。

async 函数的用法

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

下面是一个例子。

  1. async function getStockPriceByName(name) {
  2. var symbol = await getStockSymbol(name);
  3. var 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函数有多种使用形式。

  1. // 函数声明
  2. async function foo() {}
  3. // 函数表达式
  4. const foo = async function () {};
  5. // 对象的方法
  6. let obj = { async foo() {} };
  7. // 箭头函数
  8. const foo = async () => {};

注意点

第一点,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. async function dbFuc(db) {
  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方法。

  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. }

ES6将await增加为保留字。使用这个词作为标识符,在ES5是合法的,在ES6将抛出SyntaxError。

与Promise、Generator的比较

我们通过一个例子,来看Async函数与Promise、Generator函数的区别。

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

首先是Promise的写法。

  1. function chainAnimationsPromise(elem, animations) {
  2. // 变量ret用来保存上一个动画的返回值
  3. var ret = null;
  4. // 新建一个空的Promise
  5. var p = Promise.resolve();
  6. // 使用then方法,添加所有动画
  7. for(var 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(then、catch等等),操作本身的语义反而不容易看出来。

接着是Generator函数的写法。

  1. function chainAnimationsGenerator(elem, animations) {
  2. return spawn(function*() {
  3. var ret = null;
  4. try {
  5. for(var 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. var ret = null;
  3. try {
  4. for(var anim of animations) {
  5. ret = await anim(elem);
  6. }
  7. } catch(e) {
  8. /* 忽略错误,继续执行 */
  9. }
  10. return ret;
  11. }

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