ES6 入门教程

ECMAScript 6 入门

作者：阮一峰

本文仅用于学习记录，不存在任何商业用途，如侵删

文章目录

• • • ES6 入门教程
    • 28 异步遍历器
    • • 28.1 同步遍历器的问题
      • 28.2 异步遍历的接口
      • 28.3 for await...of

28 异步遍历器

28.1 同步遍历器的问题

Iterator 接口是一种数据遍历的协议，只要调用遍历器对象的next方法，就会得到一个对象，表示当前遍历指针所在的那个位置的信息。

next方法返回的对象的结构是{value, done}，其中value表示当前的数据的值，done是一个布尔值，表示遍历是否结束。

function idMaker() {let index = 0;return {next: function() {return { value: index++, done: false };}};
}const it = idMaker();it.next().value // 0
it.next().value // 1
it.next().value // 2
// ...

上面代码中，变量it是一个遍历器（iterator）。每次调用it.next()方法，就返回一个对象，表示当前遍历位置的信息。

这里隐含着一个规定，it.next()方法必须是同步的，只要调用就必须立刻返回值。也就是说，一旦执行it.next()方法，就必须同步地得到value和done这两个属性。

如果遍历指针正好指向同步操作，当然没有问题，但对于异步操作，就不太合适了。

function idMaker() {let index = 0;return {next: function() {return new Promise(function (resolve, reject) {setTimeout(() => {resolve({ value: index++, done: false });}, 1000);});}};
}

上面代码中，next()方法返回的是一个 Promise 对象，这样就不行，不符合 Iterator 协议，只要代码里面包含异步操作都不行。

也就是说，Iterator 协议里面next()方法只能包含同步操作。

目前的解决方法是，将异步操作包装成 Thunk 函数或者 Promise 对象，即next()方法返回值的value属性是一个 Thunk 函数或者 Promise 对象，等待以后返回真正的值，而done属性则还是同步产生的。

function idMaker() {let index = 0;return {next: function() {return {value: new Promise(resolve => setTimeout(() => resolve(index++), 1000)),done: false};}};
}const it = idMaker();it.next().value.then(o => console.log(o)) // 0
it.next().value.then(o => console.log(o)) // 1
it.next().value.then(o => console.log(o)) // 2
// ...

【隔1秒输出】

上面代码中，value属性的返回值是一个 Promise 对象，用来放置异步操作。但是这样写很麻烦，不太符合直觉，语义也比较绕。

ES2018 引入了“异步遍历器”（Async Iterator），为异步操作提供原生的遍历器接口，即value和done这两个属性都是异步产生。

28.2 异步遍历的接口

异步遍历器的最大的语法特点，就是调用遍历器的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 asyncIterable = createAsyncIterable(['a', 'b']);
const asyncIterator = asyncIterable[Symbol.asyncIterator]();
const [{value: v1}, {value: v2}] = await Promise.all([asyncIterator.next(), asyncIterator.next()
]);console.log(v1, v2); // a b

另一种用法是一次性调用所有的next方法，然后await最后一步操作。

async function runner() {const writer = openFile('someFile.txt');writer.next('hello');writer.next('world');await writer.return();
}runner();

28.3 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的循环体。

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

Node v10 支持异步遍历器，Stream 就部署了这个接口。下面是读取文件的传统写法与异步遍历器写法的差异。

// 传统写法
function main(inputFilePath) {const readStream = fs.createReadStream(inputFilePath,{ encoding: 'utf8', highWaterMark: 1024 });readStream.on('data', (chunk) => {console.log('>>> '+chunk);});readStream.on('end', () => {console.log('### DONE ###');});
}// 异步遍历器写法
async function main(inputFilePath) {const readStream = fs.createReadStream(inputFilePath,{ encoding: 'utf8', highWaterMark: 1024 });for await (const chunk of readStream) {console.log('>>> '+chunk);}console.log('### DONE ###');
}