异步操作和async函数详解
1、基本概念
1.1、异步
所谓"异步",简单说就是一个任务分成两段,先执行第一段,然后转而执行其他任务,等做好准备再回过头执行第二段。
比如,有一个任务是读取文件进行处理,任务的第一段是向操作系统发出请求,要求读取文件。然后,程序执行其他任务,等到操作系统返回文件,再接着执行任务的第二段(处理文件)。这种不连续的执行,就叫作异步。
相应地,连续的执行就叫作同步。由于是连续执行,不能插入其他任务,所以操作系统从硬盘读取文件的这段时间,程序只能干等着。
1.2、回调函数
JavaScript语言对异步编程的实现就是回调函数。所谓回调函数,就是把任务的第二段单独写在一个函数中,等到重新执行该任务时直接调用这个函数。其英文名字"callback"直译过来就是"重新调用"。
读取文件进行处理是这样写的。
js
const fs = require('fs');
fs.readFile('package.json', function(err, data) {
if(err)
throw err;
console.log(data);
});
上面的代码中,readFile函数的第二个参数就是回调函数,也就是任务的第二段。等到操作系统返回了/etc/passwd这个文件以后,回调函数才会执行。
一个有趣的问题是,为什么Node.js约定回调函数的第一个参数必须是错误对象err(如果没有错误,该参数就是null)?原因是执行分成两段,在这两段之间抛出的错误程序无法捕捉,只能当作参数传入第二段。
1.3、Promise
回调函数本身并没有问题,问题出在多个回调函数嵌套。假定读取A文件后再读取B文件,代码如下。
js
const fs = require('fs');
fs.readFile(fileA, function(err, data){
fs.readFile(fileB, function(err, data) {
//...
});
});
不难想象,如果依次读取多个文件,就会出现多重嵌套。代码不是纵向发展,而是横向发展,很快就会乱成一团,无法管理。这种情况就称为"回调函数噩梦"(callbackhell)。
Promise就是为了解决这个问题而提出的。它不是新的语法功能,而是一种新的写法,允许将回调函数的横向加载改成纵向加载。采用Promise,连续读取多个文件的写法如下。
js
const readFile = require('fs-readfile-promise');
readFile('app.js')
.then((data)=> {
console.log(data.toString());
})
.then(()=> {
return readFile('package.json');
})
.then((data)=> {
console.log(data.toString());
})
.catch((err)=> {
console.log(err);
})
上面的代码中使用了fs-readfile-promise模块,其作用是返回一个Promise版本的readFile函数。Promise提供then方法加载回调函数,catch方法捕捉执行过程中抛出的错误。
可以看到,Promise的写法只是回调函数的改进,使用then方法后,异步任务的两段执行看得更清楚了,除此以外并无新意。
Promise的最大问题是代码冗余,原来的任务被Promise包装了一下,不管什么操作,一眼看去都是一堆then,原来的语义变得很不清楚。
那么,有没有更好的写法呢?
2、Generator函数
2.1、协程
传统的编程语言早已有异步编程的解决方案(其实是多任务的解决方案)。其中有一种叫作"协程"(coroutine),意思是多个线程互相协作,完成异步任务。
协程有点像函数,又有点像线程。其运行流程大致如下。
- 第1步,协程A开始执行。
- 第2步,协程A执行到一半,暂停,执行权转移到协程B。
- 第3步,(一段时间后)协程B交还执行权。
- 第4步,协程A恢复执行。
上面的协程A就是异步任务,因为它分成两段(或多段)执行。
举例来说,读取文件的协程写法如下。
js
fucntion asyncJob() {
//...其他代码
let f = yield readFile(fileA);
//。。。其他代码
}
上面的函数asyncJob是一个协程,它的奥妙就在于其中的yield命令。它表示执行到此处执行权将交给其他协程。也就是说,yield命令是异步两个阶段的分界线。
协程遇到yield命令就暂停,等到执行权返回,再从暂停的地方继续往后执行。它的最大优点就是代码的写法非常像同步操作,如果去除yield命令,简直一模一样。
2.2、Generator函数的概念
Generator函数是协程在ES6中的实现,最大特点就是可以交出函数的执行权(即暂停执行)。整个Generator函数就是一个封装的异步任务,或者说是异步任务的容器。异步操作需要暂停的地方,都用yield语句注明。Generator函数的执行方法如下。
js
function* gen(x) {
let y = yield x + 2;
return y;
}
let g = gen(1);
console.log(g.next());//{ value: 3, done: false }
console.log(g.next());//{ value: undefined, done: true }
上面的代码中,调用Generator函数会返回一个内部指针(即遍历器)g。这是Generator函数不同于普通函数的另一个地方,即执行它不会返回结果,返回的是指针对象。调用指针g的next方法,会移动内部指针(即执行异步任务的第一段),指向第一个遇到的yield语句,上例中是执行到x+2为止。
换言之,next方法的作用是分阶段执行Generator函数。每次调用next方法,会返回一个对象,表示当前阶段的信息(value属性和done属性)。value属性是yield语句后表达式的值,表示当前阶段的值;done属性是一个布尔值,表示Generator函数是否执行完毕,即是否还有下一个阶段。
2.3、Generator函数的数据交换和错误处理
Generator函数可以暂停执行和恢复执行,这是它能封装异步任务的根本原因。除此之外,它还有两个特性使它可作为异步编程的完整解决方案:函数体内外的数据交换和错误处理机制。next方法返回值的value属性,是Generator函数向外输出数据;next方法还可以接受参数,这是向Generator函数体内输入数据。
js
function * gen(x) {
let y = yield x + 2;
return y;
}
let g = gen(1);
console.log(g.next());//{ value: 3, done: false }
console.log(g.next(2));//{ value: 2, done: true }
上面的代码中,第一个next方法的value属性,返回表达式x+2的值(3)。第二个next方法带有参数2,这个参数可以传入Generator函数,作为上个阶段异步任务的返回结果被函数体内的变量y接收。因此,这一步的value属性返回的就是2(变量y的值)。
Generator函数内部还可以部署错误处理代码,捕获函数体外抛出的错误。
js
function* gen(x) {
try {
let y = yield x + 2;
} catch (e) {
console.log(e);
}
return y;
}
let g = gen(1);
console.log(g.next());//{ value: 3, done: false }
g.throw('error');//error
上面的最后一行,Generator函数体外使用指针对象的throw方法抛出的错误,可以被函数体内的try...catch代码块捕获。这意味着,出错的代码与处理错误的代码实现了时间和空间上的分离,这对于异步编程无疑是很重要的。
2.4、异步任务的封装
下面看看如何使用Generator函数执行一个真实的异步任务。
js
let fetch = require('node-fetch');
function * gen() {
let url = 'https://api.github.com/users/github';
let result = yield fetch(url);
console.log(result.bio);
}
上面的代码中,Generator函数封装了一个异步操作,先读取一个远程接口,然后从JSON格式的数据解析信息。就像前面说的,这段代码非常像同步操作,只是加上了yield命令。
执行这段代码的方法如下。
js
const fetch = require('node-fetch');
function * gen() {
let url = 'https://api.github.com/users/github';
let result = yield fetch(url);
console.log(result.bio);
}
let g = gen();
let result = g.next();
//fetch返回Promise
result.value.then((data)=> {
//第一步:转为JSON
return data.json();
}).then((data)=> {
//第二阶段:打印
g.next(data);
});
//How people build software.
上面的代码中,首先执行Generator函数获取遍历器对象,然后使用next方法(第二行)执行异步任务的第一阶段。由于Fetch模块返回的是一个Promise对象,因此要用then方法调用下一个next方法。
可以看到,虽然Generator函数将异步操作表示得很简洁,但是流程管理(即何时执行第一阶段,何时执行第二阶段)却不方便。
3、Thunk函数
3.1、参数的求值策略
Thunk函数早在20世纪60年代就诞生了。
那时,编程语言刚刚起步,计算机学家还在研究编译器怎么写比较好。一个争论的焦点是"求值策略",即函数的参数到底应该何时求值。
js
let x = 1;
function f(m) {
return m * 2;
}
console.log(x + 5);//6
上面的代码先定义函数f,然后向它传入表达式x+5。请问,这个表达式应该何时求值?
一种意见是"传值调用"(call by value),即在进入函数体前就计算x+5的值(等于6),再将这个值传入函数f。C语言就采用了这种策略。
js
f(x + 5);
//传值调用时等同于
f(6)
另一种意见是"传名调用"(call by name),即直接将表达式x+5传入函数体,只在用到它时求值。Haskell语言采用了这种策略。
js
f(x + 5)
//传名调用时等同于
(x + 5) * 2
传值调用和传名调用,哪一种比较好?回答是各有利弊。传值调用比较简单,但是对参数求值时实际上尚未用到这个参数,有可能造成性能损失。
js
function f(a, b) {
return b;
}
let x = 10;
f(3 * x * x -2 * x - 1, x);
上面的代码中,函数f的第一个参数是一个复杂的表达式,但是函数体内根本没有用到。对这个参数求值,实际上是不必要的。因此,有一些计算机学家倾向于"传名调用",即只在执行时求值。
3.2、Thunk函数的含义
编译器的"传名调用"实现往往是先将参数放到一个临时函数中,再将这个临时函数传入函数体。这个临时函数就叫作Thunk函数。
js
function f(m) {
return m * 2;
}
f(x + 5);
//等同于
let thunk = function() {
return x + 5;
};
function f(thunk) {
return thunk() * 2;
}
上面的代码中,函数f的参数x+5被一个函数替换了。凡是用到原参数的地方,对Thunk函数求值即可。这就是Thunk函数的定义,它是"传名调用"的一种实现策略,用来替换某个表达式。
3.3、JavaScript语言的Thunk函数
JavaScript语言是传值调用,它的Thunk函数含义有所不同。在JavaScript语言中,Thunk函数替换的不是表达式,而是多参数函数,它将其替换成单参数的版本,且只接受回调函数作为参数。
js
const fs = require('fs');
//正常版本的readFile(多参数版本)
fs.readFile(filename, callback);
//Thunk版本的feadFile(单参数版本)
let readFileTHunk = Thunk(fileName);
readFileTHunk(callback);
let Thunk = function(fileName) {
return function(callback) {
return fs.readFile(fileName, callback);
};
};
上面的代码中,fs模块的readFile方法是一个多参数函数,两个参数分别为文件名和回调函数。经过转换器处理,它变成了一个单参数函数,只接受回调函数作为参数。这个单参数版本,就叫作Thunk函数。
任何函数,只要参数有回调函数,就能写成Thunk函数的形式。下面是一个简单的Thunk函数转换器。
js
let Thunk = function(fn) {
return function() {
let args = Array.prototype.slice.call(arguments);
return function(callback) {
args.push(callback);
return fn.apply(this, args);
}
};
};
使用上面的转换器生成fs.readFile的Thunk函数如下。
js
let readFileThunk = Thunk(fs.readFile);
readFileThunk(fileA)(callback);
3.4、Thunkify模块
用于生产环境的转换器,建议使用Thunkify模块。安装命令如下。
shell
npm install thunkify
使用方式如下。
js
const thunkify = require('thunkify');
const fs = require('fs');
let read = thunkify(fs.readFile);
read('package.json')(function(err, str){
console.log(str.toString());
});
Thunkify的源码与前面那个简单的转换器非常像。
js
function thunkify(fn){
assert('function' == typeof fn, 'function required');
return function(){
var args = new Array(arguments.length);
var ctx = this;
for(var i = 0; i < args.length; ++i) {
args[i] = arguments[i];
}
return function(done){
var called;
args.push(function(){
if (called) return;
called = true;
done.apply(null, arguments);
});
try {
fn.apply(ctx, args);
} catch (err) {
done(err);
}
}
}
};
它的源码主要多了一个检查机制,变量called确保回调函数只运行一次。这样的设计与下文的Generator函数相关。请看下面的例子。
js
const thunkify = require('thunkify');
function f(a, b, callback) {
let sum = a + b;
callback(sum);
callback(sum);
}
let ft = thunkify(f);
let print = console.log.bind(console);
ft(1, 2)(print);//3
上面的代码中,由于thunkify只允许回调函数执行一次,所以只输出一行结果。
3.5、Generator函数的流程管理
你可能会问,Thunk函数有什么用?回答是以前确实没什么用,但是ES6有了Generator函数,Thunk函数现在可以用于Generator函数的自动流程管理。
以读取文件为例,下面的Generator函数封装了两个异步操作:
js
const fs = require('fs');
const thunkify = require('thunkify');
let readFile = thunkify(fs.readFile);
let gen = function* () {
let r1 = yield readFile('app.js');
console.log(r1.toString());
let r2 = yield readFile('package.json');
console.log(r2.toString());
};
上面的代码中,yield命令用于将程序的执行权移出Generator函数。那么就需要一种方法,将执行权再交还给Generator函数。
这种方法就是Thunk函数,因为它可以在回调函数中将执行权交还给Generator函数。为了便于理解,我们先看如何手动执行上面这个Generator函数。
js
const fs = require('fs');
const thunkify = require('thunkify');
let readFile = thunkify(fs.readFile);
let gen = function* () {
let r1 = yield readFile('app.js');
console.log(r1.toString());
let r2 = yield readFile('package.json');
console.log(r2.toString());
};
let g = gen();
let r1 = g.next();
r1.value(function(err, data){
if(err)
throw err;
let r2 = g.next(data);
r2.value(function(err, data){
if(err)
throw err;
g.next(data);
});
});
上面的代码中,变量g是Generator函数的内部指针,表示目前执行到哪一步。next方法负责将指针移动到下一步,并返回该步的信息(value属性和done属性)。
仔细查看上面的代码,可以发现Generator函数的执行过程其实是将同一个回调函数反复传入next方法的value属性。于是我们可以用递归来自动完成这个过程。
3.6、Thunk函数的自动流程管理
Thunk函数真正的威力在于可以自动执行Generator函数。下面就是一个基于Thunk函数的Generator执行器。
js
function run(fn) {
let gen = fn();
function next(err, data) {
let result = gen.next(data);
if(result.done)
return;
result.value(next);
}
next();
}
run(gen);
上面的run函数就是一个Generator函数的自动执行器。内部的next函数就是Thunk的回调函数。next函数先将指针移到Generator函数的下一步(gen.next方法),然后判断Generator函数是否结束(result.done属性),如果没有结束,就将next函数再传入Thunk函数(result.value属性),否则就直接退出。
有了这个执行器,执行Generator函数就方便多了。不管有多少个异步操作,直接传入run函数即可。当然,前提是每一个异步操作都要是Thunk函数。也就是说,跟在yield命令后面的必须是Thunk函数。
js
let gen = function* () {
let f1 = yield readFile('fileA');
let f2 = yield readFile('fileB');
//...
let fn = yield readFile('fileN');
};
run(gen);
上面的代码中,函数gen封装了n个异步的读取文件操作,只要执行run函数,这些操作就会自动完成。这样一来,异步操作不仅可以写得像同步操作,而且一行代码就可以执行。
Thunk函数并不是Generator函数自动执行的唯一方案。因为自动执行的关键是,必须有一种机制自动控制Generator函数的流程,接收和交还程序的执行权。回调函数可以做到这一点,Promise对象也可以做到这一点。
4、co模块
4.1、基本用法
co模块(https://github.com/tj/co)是著名程序员TJHolowaychuk于2013年6月发布的一个小工具,用于Generator函数的自动执行。
比如有一个Generator函数,用于依次读取两个文件。
js
const fs = require('fs');
let gen = function* (){
let f1 = yield fs.readFile('app.js');
let f2 = yield fs.readFile('package.json');
console.log(f1.toString());
console.log(f2.toString());
};
co模块可以让你不用编写Generator函数的执行器。
js
const co = require('co');
co(gen);
上面的代码中,Generator函数只要传入co函数就会自动执行。
co函数返回一个Promise对象,因此可以用then方法添加回调函数。
js
const fs = require('fs');
const thunkify = require('thunkify');
const co = require('co');
let readFile = thunkify(fs.readFile);
let gen = function* (){
let f1 = yield readFile('app.js');
let f2 = yield readFile('package.json');
console.log(f1.toString());
console.log(f2.toString());
};
co(gen).then(()=> {
console.log('done');
})
上面的代码中,等到Generator函数执行结束,就会输出一行提示。
4.2、co模块的原理
为什么co模块可以自动执行Generator函数?
前面说过,Generator就是一个异步操作的容器。它的自动执行需要一种机制,当异步操作有了结果能够自动交回执行权。
有两种方法可以做到这一点。
- 回调函数。将异步操作包装成Thunk函数,在回调函数中交回执行权。
- Promise对象。将异步操作包装成Promise对象,用then方法交回执行权。
co模块其实就是将两种自动执行器(Thunk函数和Promise对象)包装成了一个模块。使用co的前提条件是,Generator函数的yield命令后面只能是Thunk函数或Promise对象。
上一节已经介绍了基于Thunk函数的自动执行器。下面来看基于Promise对象的自动执行器。这是理解co模块所必需的。
4.3、基于Promise对象的自动执行
还是沿用上面的例子。首先,把fs模块的readFile方法包装成一个Promise对象。
js
const fs = require('fs');
let readFile = function(fileName) {
return new Promise((resolve, reject)=> {
fs.readFile(fileName, (error, data)=> {
if(error)
reject(error);
resolve(data);
});
});
};
let gen = function* () {
let f1 = yield readFile('app.js');
let f2 = yield readFile('package.json');
console.log(f1.toString());
console.log(f2.toString());
};
然后,手动执行上面的Generator函数。
js
let g = gen();
g.next().value.then((data) => {
g.next(data).value.then((data) => {
g.next(data);
});
})
手动执行其实就是用then方法层层添加回调函数。理解这一点,就可以写出一个自动执行器。
js
function run(gen) {
let g = gen();
function next(data) {
let result = g.next(data);
if(result.done)
return result.value;
result.value.then((data)=> {
next(data);
});
}
next();
}
run(gen);
上面的代码中,只要Generator函数还没有执行到最后一步,next函数就调用自身以实现自动执行。
4.4、co模块的源码
co就是上面那个自动执行器的扩展,它的源码只有几十行,非常简单。
首先,co函数接受Generator函数作为参数,返回一个Promise对象。
js
function co(gen) {
let ctx = this;
return new Promise(function(resolve, reject) {});
}
在返回的Promise对象中,co先检查参数gen是否为Generator函数。如果是,就执行该函数,得到一个内部指针对象;如果不是就返回,并将Promise对象的状态改为Resolved。
js
function co(gen) {
let ctx = this;
return new Promise(function(resolve, reject) {
if(typeof gen === 'function') gen = gen.call(ctx);
if(!gen || typeof gen.next !== 'function') return resolve(gen);
});
}
接着,co将Generator函数的内部指针对象的next方法包装成onFulfilled函数。这主要是为了能够捕捉抛出的错误。
js
function co(gen) {
let ctx = this;
return new Promise(function(resolve, reject){
if(typeof gen === 'function')
gen = gen.call(ctx);
if(!gen || typeof gen.next !== 'function')
return resolve(gen);
onFulfilled();
function onFulfilled(res) {
let ret;
try {
ret = gen.next(res);
} catch (e) {
return reject(e);
}
next(ret);
}
});
}
最后,就是关键的next函数,它会反复调用自身。
js
function next(ret) {
if(ret.done)
return resolveInclude(ret.value);
let value = toPromise.call(createContext, ret.value);
if(value && isPromise(value))
return value.then(onFulfilled, onRejected);
return onRejected(new TypeError('You may only yield a function, promise, generator, arrray, or object, '
+ 'but the following object was passed:"' + String(ret.value) + '"'
))
}
上面的代码中,next函数的内部代码一共只有4行命令。
- 第1行,检查当前是否为Generator函数的最后一步,如果是就返回。
- 第2行,确保每一步的返回值是Promise对象。
- 第3行,使用then方法为返回值加上回调函数,然后通过onFulfilled函数再次调用next函数。
- 第4行,在参数不符合要求的情况下(参数非Thunk函数和Promise对象),将Promise对象的状态改为Rejected,从而终止执行。
4.5、处理并发的异步操作
co支持并发的异步操作,即允许某些操作同时进行,等到它们全部完成才进行下一步。
这时,要把并发的操作都放在数组或对象里面,跟在yield语句后面。
js
//数组的写法
co(function* () {
let res = yield [
Promise.resolve(1),
Promise.resolve(2)
];
console.log(res);
}).catch(onerror);
//对象的写法
co(function *() {
let res = yield {
1: Promise.resolve(1),
2: Promise.resolve(2),
};
console.log(res);
}).catch(onerror);
下面是另一个例子。
js
co(function *() {
let values = [n1, n2, n3];
yield values.map(somethingAsync);
});
function* somethingAsync(x) {
//do something async
return y;
}
上面的代码允许并发3个somethingAsync异步操作,等到它们全部完成才会进行下一步。
5、async函数
5.1、含义
ES7提供了async函数,使得异步操作变得更加方便。async函数是什么?一句话,async函数就是Generator函数的语法糖。
前文有一个Generator函数,依次读取两个文件。
js
const fs = require('fs');
let readFile = function(fileName) {
return new Promise(function(resolve, reject) {
fs.readFile(fileName, function(error, data) {
if(error)
reject(error);
resolve(data);
});
});
};
let gen = function* () {
let f1 = yield readFile('app.js');
let f2 = yield readFile('package.json');
console.log(f1.toString());
console.log(f2.toString());
};
写成async函数就是下面这样。
js
let asyncReadFile = async function () {
let f1 = await readFile('app.js');
let f2 = await readFile('package.json');
console.log(f1.toString());
console.log(f2.toString());
}
一比较就会发现,async函数就是将Generator函数的星号(*)替换成async,将yield替换成await,仅此而已。
async函数对Generator函数的改进体现在以下4点。
- 内置执行器。Generator函数的执行必须靠执行器,所以才有了co模块,而async函数自带执行器。也就是说,async函数的执行与普通函数一模一样,只要一行。
js
let result = asyncReadFile();
- 上面的代码调用了asyncReadFile函数,然后它就会自动执行,输出最后结果。完全不像Generator函数,需要调用next方法,或者用co模块,才能得到真正执行,从而得到最终结果。
- 更好的语义。async和await比起星号和yield,语义更清楚。async表示函数里有异步操作,await表示紧跟在后面的表达式需要等待结果。
- 更广的适用性。co模块约定,yield命令后面只能是Thunk函数或Promise对象,而async函数的await命令后面可以是Promise对象和原始类型的值(数值、字符串和布尔值,但这时等同于同步操作)。
- 返回值是Promise。async函数的返回值是Promise对象,这比Generator函数的返回值是Iterator对象方便多了。你可以用then方法指定下一步的操作。
进一步说,async函数完全可以看作由多个异步操作包装成的一个Promise对象,而await命令就是内部then命令的语法糖。
5.2、async函数的实现
async函数的实现就是将Generator函数和自动执行器包装在一个函数中。
js
async function fn(args) {
//...
}
//等同于
function fn(args) {
return spawn(function*() {
//...
});
}
所有的async函数都可以写成上面的第二种形式,其中的spawn函数就是自动执行器。
下面给出spawn函数的实现,基本就是前文自动执行器的翻版。
js
function spawn(genF) {
return new Promise(function(resolve, reject) {
let gen = genF();
function step(nextF) {
try {
let 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);
})
})
}
5.3、async函数的用法
同Generator函数一样,async函数返回一个Promise对象,可以使用then方法添加回调函数。当函数执行时,一旦遇到await就会先返回,等到触发的异步操作完成,再接着执行函数体内后面的语句。
下面是一个例子。
js
async function getStockPriceByName(name) {
let symbol = await getStockSymbol(name);
let stockPrice = await getStockPrice(symbol);
return stockPrice;
}
getStockPriceByName('goog')
.then((result)=> {
console.log(result);
});
上面的代码是一个获取股票报价的函数,函数前面的async关键字表明该函数内部有异步操作。
调用该函数时,会立即返回一个Promise对象。
下面的例子指定了多少毫秒后输出一个值。
js
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);
//hello world
5.4、注意点
await命令后面的Promise对象,运行结果可能是Rejected,所以最好把await命令放在try...catch代码块中。
js
async function myFunction() {
try {
await somethingThatReturnsAPromise();
} catch(err) {
console.log(err);
}
}
//另一种写法
async function myFunction() {
await somethingThatReturnsAPromise()
.catch((err) => {
console.log(err);
});
}
await命令只能用在async函数中,用在普通函数中会报错。
js
async function dbFuc(dbFuc) {
let docs = [{}, {}, {}];
//报错
docs.forEach((doc)=> {
await dbFuc.post(doc);
});
}
上面的代码会报错,因为await用在了普通函数中。但是,即便将forEach方法的参数改成async函数也有问题。
js
async function dbFuc(dbFuc) {
let docs = [{}, {}, {}];
//可能得到错误结构
docs.forEach(async function (docs) {
await dbFuc.post(doc);
});
}
上面的代码可能不会正常工作,原因是这时3个db.post操作将并发执行,也就是同时执行,而不是继发执行。正确的写法是采用for循环。
js
async function dbFuc(dbFuc) {
let docs = [{}, {}, {}];
for(let doc of docs) {
await dbFuc.post(doc);
};
}
如果确实希望多个请求并发执行,可以使用Promise.all方法。
js
async function dbFuc(dbFuc) {
let docs = [{}, {}, {}];
let promises = docs.map((doc)=> dbFuc.post(doc));
let results = await Promise.all(promises);
console.log(results);
}
//或者使用下面的写法
async function dbFuc(dbFuc) {
let docs = [{}, {}, {}];
let promises = docs.map((doc)=> dbFuc.post(doc));
let results = [];
for(let promise of promises) {
results.push(await promise);
}
console.log(results);
}
ES6将await增加为保留字。使用这个词作为标识符,在ES5中是合法的,在ES6中将抛出SyntaxError。
5.5、与Promise、Generator的比较
我们通过一个例子来看async函数与Promise、Generator函数的区别。
假定某个DOM元素上部署了一系列的动画,前一个动画结束才能开始后一个。如果当中有一个动画出错就不再往下执行,返回上一个成功执行的动画的返回值。
首先是Promise的写法。
js
function chainAnimationsPromise(elem, animations) {
//变量ret用来保存上一个动画的返回值
let ret = null;
//新建一个空的Promise
let p = Promise.resolve();
//使用then方法添加所有动画
for(let anim in animations) {
p = p.then((val)=> {
ret = val;
return anim(elem);
})
}
//返回一个部署了错误捕捉机制的Promise
return p.catch((e)=> {
//忽略错误,继续执行
}).then(()=> {
return ret;
});
}
虽然Promise的写法比起回调函数的写法有很大改进,但是一眼看上去,代码完全是Promise的API(then、catch等),操作本身的语义反而不容易看出来。
接着是Generator函数的写法。
js
function chainAnimationsPromise(elem, animations) {
return spawn(function*() {
let ret = null;
try {
for(let anim of animations) {
ret = yield anim(elem);
}
} catch(e) {
//忽略错误,继续执行
}
return ret;
});
}
上面的代码使用Generator函数遍历了每个动画,语义比Promise写法更清晰,用户定义的操作全部出现在spawn函数的内部。这个写法的问题在于,必须有一个任务运行器自动执行Generator函数,上面的spawn函数就是自动执行器,它返回一个Promise对象,而且保证yield语句后面的表达式必须返回一个Promise。
最后是async函数的写法。
js
async function chainAnimationsPromise(elem, animations) {
let ret = null;
try {
for(let anim of animations) {
ret = await anim(elem);
}
} catch(e) {
//忽略错误,继续执行
}
return ret;
}
可以看到,async函数的实现最简洁,最符合语义,几乎没有语义不相关的代码。它将Generator写法中的自动执行器改在语言层面提供,不暴露给用户,因此代码量最少。如果使用Generator写法,自动执行器需要用户自己提供。