async函数的异步迭代器
《迭代器》一章说过,Iterator 接口是一种数据遍历的协议,只要调用迭代器对象的next方法,就会得到一个对象,表示当前遍历指针所在的那个位置的信息。next方法返回的对象的结构是{value, done},其中value表示当前的数据的值,done是一个布尔值,表示遍历是否结束。
这里隐含着一个规定,next方法必须是同步的,只要调用就必须立刻返回值。也就是说,一旦执行next方法,就必须同步地得到value和done这两个属性。如果遍历指针正好指向同步操作,当然没有问题,但对于异步操作,就不太合适了。目前的解决方法是,Generator函数里面的异步操作,返回一个
Thunk 函数或者 Promise 对象,即value属性是一个 Thunk 函数或者 Promise
对象,等待以后返回真正的值,而done属性则还是同步产生的。
目前,有一个提案,为异步操作提供原生的迭代器接口,即value和done这两个属性都是异步产生,这称为”异步迭代器“(Async
Iterator)。
异步遍历的接口
异步迭代器的最大的语法特点,就是调用迭代器的next方法,返回的是一个 Promise 对象。
asyncIterator
.next()
.then(
({ value, done }) => /* ... */
);
上面代码中,asyncIterator是一个异步迭代器,调用next方法以后,返回一个
Promise 对象。因此,可以使用then方法指定,这个 Promise 对象的状态变为resolve以后的回调函数。回调函数的参数,则是一个具有value和done两个属性的对象,这个跟同步迭代器是一样的。
我们知道,一个对象的同步迭代器的接口,部署在Symbol.iterator属性上面。同样地,对象的异步迭代器接口,部署在Symbol.asyncIterator属性上面。不管是什么样的对象,只要它的Symbol.asyncIterator属性有值,就表示应该对它进行异步遍历。
下面是一个异步迭代器的例子。
const asyncIterable = createAsyncIterable(['a', 'b']);
const asyncIterator = asyncIterable[Symbol.asyncIterator]();
asyncIterator
.next()
.then(iterResult1 => {
console.log(iterResult1); // { value: 'a', done: false }
return asyncIterator.next();
})
.then(iterResult2 => {
console.log(iterResult2); // { value: 'b', done: false }
return asyncIterator.next();
})
.then(iterResult3 => {
console.log(iterResult3); // { value: undefined, done: true }
});
上面代码中,异步迭代器其实返回了两次值。第一次调用的时候,返回一个 Promise 对象;等到 Promise 对象resolve了,再返回一个表示当前数据成员信息的对象。这就是说,异步迭代器与同步迭代器最终行为是一致的,只是会先返回
Promise 对象,作为中介。
由于异步迭代器的next方法,返回的是一个 Promise 对象。因此,可以把它放在await命令后面。
async function f() {
const asyncIterable = createAsyncIterable(['a', 'b']);
const asyncIterator = asyncIterable[Symbol.asyncIterator]();
console.log(await asyncIterator.next());
// { value: 'a', done: false }
console.log(await asyncIterator.next());
// { value: 'b', done: false }
console.log(await asyncIterator.next());
// { value: undefined, done: true }
}
上面代码中,next方法用await处理以后,就不必使用then方法了。整个流程已经很接近同步处理了。
注意,异步迭代器的next方法是可以连续调用的,不必等到上一步产生的 Promise 对象resolve以后再调用。这种情况下,next方法会累积起来,自动按照每一步的顺序运行下去。下面是一个例子,把所有的next方法放在Promise.all方法里面。
const asyncGenObj = createAsyncIterable(['a', 'b']);
const [{value: v1}, {value: v2}] = await Promise.all([
asyncGenObj.next(), asyncGenObj.next()
]);
console.log(v1, v2); // a b
另一种用法是一次性调用所有的next方法,然后await最后一步操作。
const writer = openFile('someFile.txt');
writer.next('hello');
writer.next('world');
await writer.return();
for await...of
前面介绍过,for...of循环用于遍历同步的 Iterator 接口。新引入的for await...of循环,则是用于遍历异步的 Iterator 接口。
async function f() {
for await (const x of createAsyncIterable(['a', 'b'])) {
console.log(x);
}
}
// a
// b
上面代码中,createAsyncIterable()返回一个异步迭代器,for...of循环自动调用这个迭代器的next方法,会得到一个
Promise 对象。await用来处理这个 Promise 对象,一旦resolve,就把得到的值(x)传入for...of的循环体。
ES6 for await...of循环的一个用途,是部署了 asyncIterable 操作的异步接口,可以直接放入这个循环。
let body = '';
async function f() {
for await(const data of req) body += data;
const parsed = JSON.parse(body);
console.log('got', parsed);
}
上面代码中,req是一个 asyncIterable 对象,用来异步读取数据。可以看到,使用for await...of循环以后,代码会非常简洁。
如果next方法返回的 Promise 对象被reject,for await...of就会报错,要用try...catch捕捉。
async function () {
try {
for await (const x of createRejectingIterable()) {
console.log(x);
}
} catch (e) {
console.error(e);
}
}
注意,for await...of循环也可以用于同步迭代器。
(async function () {
for await (const x of ['a', 'b']) {
console.log(x);
}
})();
// a
// b
异步 Generator函数
就像 Generator函数返回一个同步迭代器对象一样,异步 Generator函数的作用,是返回一个异步迭代器对象。
在语法上,异步 Generator函数就是async函数与 Generator函数的结合。
async function* gen() {
yield 'hello';
}
const genObj = gen();
genObj.next().then(x => console.log(x));
// { value: 'hello', done: false }
上面代码中,gen是一个异步 Generator函数,执行后返回一个异步 Iterator 对象。对该对象调用next方法,返回一个
Promise 对象。
异步迭代器的设计目的之一,就是 Generator函数处理同步操作和异步操作时,能够使用同一套接口。
// 同步 Generator函数
function* map(iterable, func) {
const iter = iterable[Symbol.iterator]();
while (true) {
const {value, done} = iter.next();
if (done) break;
yield func(value);
}
}
// 异步 Generator函数
async function* map(iterable, func) {
const iter = iterable[Symbol.asyncIterator]();
while (true) {
const {value, done} = await iter.next();
if (done) break;
yield func(value);
}
}
上面代码中,可以看到有了异步迭代器以后,同步 Generator函数和异步 Generator函数的写法基本上是一致的。
下面是另一个异步 Generator函数的例子。
async function* readLines(path) {
let file = await fileOpen(path);
try {
while (!file.EOF) {
yield await file.readLine();
}
} finally {
await file.close();
}
}
上面代码中,异步操作前面使用await关键字标明,即await后面的操作,应该返回
Promise 对象。凡是使用yield关键字的地方,就是next方法的停下来的地方,它后面的表达式的值(即await file.readLine()的值),会作为next()返回对象的value属性,这一点是与同步
Generator函数一致的。
异步 Generator函数内部,能够同时使用await和yield命令。可以这样理解,await命令用于将外部操作产生的值输入函数内部,yield命令用于将函数内部的值输出。
上面代码定义的异步 Generator函数的用法如下。
(async function () {
for await (const line of readLines(filePath)) {
console.log(line);
}
})()
异步 Generator函数可以与for await...of循环结合起来使用。
async function* prefixLines(asyncIterable) {
for await (const line of asyncIterable) {
yield '> ' + line;
}
}
异步 Generator函数的返回值是一个异步 Iterator,即每次调用它的next方法,会返回一个
Promise 对象,也就是说,跟在yield命令后面的,应该是一个 Promise 对象。
async function* asyncGenerator() {
console.log('Start');
const result = await doSomethingAsync(); // (A)
yield 'Result: '+ result; // (B)
console.log('Done');
}
const ag = asyncGenerator();
ag.next().then({value, done} => {
// ...
})
上面代码中,ag是asyncGenerator函数返回的异步
Iterator 对象。调用ag.next()以后,asyncGenerator函数内部的执行顺序如下。
打印出Start。
await命令返回一个 Promise 对象,但是程序不会停在这里,继续往下执行。
程序在B处暂停执行,yield命令立刻返回一个
Promise 对象,该对象就是ag.next()的返回值。
A处await命令后面的那个
Promise 对象 resolved,产生的值放入result变量。
B处的 Promise 对象 resolved,then方法指定的回调函数开始执行,该函数的参数是一个对象,value的值是表达式'Result: ' + result的值,done属性的值是false。
A 和 B 两行的作用类似于下面的代码。
return new Promise((resolve, reject) => {
doSomethingAsync()
.then(result => {
resolve({
value: 'Result: '+result,
done: false,
});
});
});
如果异步 Generator函数抛出错误,会被 Promise 对象reject,然后抛出的错误被catch方法捕获。
async function* asyncGenerator() {
throw new Error('Problem!');
}
asyncGenerator()
.next()
.catch(err => console.log(err)); // Error: Problem!
注意,普通的 async函数返回的是一个 Promise 对象,而异步 Generator函数返回的是一个异步 Iterator 对象。可以这样理解,async函数和异步 Generator函数,是封装异步操作的两种方法,都用来达到同一种目的。区别在于,前者自带执行器,后者通过for await...of执行,或者自己编写执行器。下面就是一个异步 Generator函数的执行器。
async function takeAsync(asyncIterable, count = Infinity) {
const result = [];
const iterator = asyncIterable[Symbol.asyncIterator]();
while (result.length < count) {
const {value, done} = await iterator.next();
if (done) break;
result.push(value);
}
return result;
}
上面代码中,异步 Generator函数产生的异步迭代器,会通过while循环自动执行,每当await iterator.next()完成,就会进入下一轮循环。一旦done属性变为true,就会跳出循环,异步迭代器执行结束。
下面是这个自动执行器的一个使用实例。
async function f() {
async function* gen() {
yield 'a';
yield 'b';
yield 'c';
}
return await takeAsync(gen());
}
f().then(function (result) {
console.log(result); // ['a', 'b', 'c']
})
异步 Generator函数出现以后,JavaScript 就有了四种函数形式:普通函数、async函数、Generator函数和异步 Generator函数。请注意区分每种函数的不同之处。基本上,如果是一系列按照顺序执行的异步操作(比如读取文件,然后写入新内容,再存入硬盘),可以使用 async函数;如果是一系列产生相同数据结构的异步操作(比如一行一行读取文件),可以使用异步 Generator函数。
异步 Generator函数也可以通过next方法的参数,接收外部传入的数据。
const writer = openFile('someFile.txt');
writer.next('hello'); // 立即执行
writer.next('world'); // 立即执行
await writer.return(); // 等待写入结束
上面代码中,openFile是一个异步 Generator函数。next方法的参数,向该函数内部的操作传入数据。每次next方法都是同步执行的,最后的await命令用于等待整个写入操作结束。
最后,同步的数据结构,也可以使用异步 Generator函数。
async function* createAsyncIterable(syncIterable) {
for (const elem of syncIterable) {
yield elem;
}
}
上面代码中,由于没有异步操作,所以也就没有使用await关键字。
yield* 语句
yield*语句也可以跟一个异步迭代器。
async function* gen1() {
yield 'a';
yield 'b';
return 2;
}
async function* gen2() {
// result 最终会等于 2
const result = yield* gen1();
}
上面代码中,gen2函数里面的result变量,最后的值是2。
与同步 Generator函数一样,for await...of循环会展开yield*。
(async function () {
for await (const x of gen2()) {
console.log(x);
}
})();
// a
// b