异步遍历器

2024/1/31 JavaScript

# 同步遍历器的问题

​ 举个例子,变量it是一个遍历器,每次调用it.next()方法就返回一个对象,表示当前遍历位置的信息。这里隐含着一个规定,it.next()方法必须是同步的,只要调用就必须立刻返回值。也就是说,一旦执行it.next()方法,就必须同步地得到value和done这两个属性。如果遍历指针正好指向同步操作,当然没有问题。但如果next()方法返回的是一个Promise对象就不行,不符合Iterator协议,只要代码里面包含异步操作都不行。也就是说,Iterator协议里面next()方法只能包含同步操作。

​ 目前的解决方法是,将异步操作包装成Thunk函数或Promise对象,即next()方法返回值的value属性是一个Thunk函数或Promise对象,用来放置异步操作,等待以后返回真正的值,而done属性则还是同步产生的。但是这样写很麻烦,不太符合直觉,语义也比较绕。

​ ES2018引入了异步遍历器,为异步操作提供原生的遍历器接口,即value和done这两个属性都是异步产生。

# 异步遍历的接口

​ 异步遍历器的最大的语法特点就是调用遍历器的next方法,返回的是一个Promise对象。因此,可以使用then方法指定这个Promise对象的状态变为resolve以后的回调函数。回调函数的参数则是一个具有value和done两个属性的对象,这个跟同步遍历器是一样的。

​ 一个对象的同步遍历器的接口部署在Symbol.iterator属性上面。同样,对象的异步遍历器接口部署在Symbol.asyncIterator属性上面。不管是什么样的对象,只要它的Symbol.asyncIterator属性有值,就表示应该对它进行异步遍历。

​ 异步遍历器的next方法返回的是一个Promise对象,因此,可以把它放在await命令后面,next方法用await处理以后就不必使用then方法了。

​ 注意,异步遍历器的next方法是可以连续调用的,不必等到上一步产生的Promise对象resolve以后再调用。这种情况下,next方法会累积起来,自动按照每一步的顺序运行下去。①可以把所有的next方法放在Promise.all方法里面,②还可以一次性调用所有的next方法,然后await最后一步操作。

//把所有的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();
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

# for await...of

​ for...of循环用于遍历同步的Iterator接口。新引入的for await...of循环则是用于遍历异步的Iterator接口。注意,for await...of循环也可以用于同步遍历器。

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的循环体
1
2
3
4
5
6
7
8

​ for await...of循环的一个用途,是部署了asyncIterable操作的异步接口可以直接放入这个循环。

​ await用来处理next方法返回的Promise对象,一旦resolve,就把得到的值传入for...of的循环体;如果被reject,for await...of就会报错,要用try...catch捕捉。

# 异步 Generator 函数

​ 就像Generator函数返回一个同步遍历器对象一样,异步Generator函数的作用是返回一个异步遍历器对象。在语法上,异步Generator函数就是async函数与Generator函数的结合。

async function* gen() { //gen是一个异步Generator函数,执行后返回一个异步Iterator对象
  yield 'hello';
}
const genObj = gen();
genObj.next().then(x => console.log(x)); //对该对象调用next方法,返回一个Promise对象
// { value: 'hello', done: false }
1
2
3
4
5
6

​ 异步遍历器的设计目的之一就是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);
  }
}
//map是一个Generator函数,第一个参数是可遍历对象iterable,第二个参数是一个回调函数func。map的作用是将iterable每一步返回的值使用func进行处理
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

​ 异步操作前面使用await关键字标明,即await后面的操作应该返回Promise对象。凡是使用yield关键字的地方就是next方法停下来的地方,它后面的表达式的值(即await file.readLine()的值),会作为next()返回对象的value属性,这一点是与同步Generator函数一致的。

​ 异步Generator函数内部能够同时使用await和yield命令。await命令用于将外部操作产生的值输入函数内部,yield命令用于将函数内部的值输出。

​ 异步Generator函数可以与for await...of循环结合起来使用。

async function* prefixLines(asyncIterable) {
  for await (const line of asyncIterable) {
    yield '> ' + line;
  }
}//如果像这个例子那样,yield命令后面是一个字符串,会被自动包装成一个Promise对象。
1
2
3
4
5

​ 异步Generator函数的返回值是一个异步Iterator,即每次调用它的next方法,会返回一个Promise对象,也就是说,跟在yield命令后面的应该是一个Promise对象。

​ 如果异步Generator函数抛出错误,会导致Promise对象的状态变为reject,抛出的错误被catch方法捕获。

​ 注意,普通的 async 函数返回的是一个Promise对象,而异步Generator函数返回的是一个异步Iterator对象。async函数和异步Generator函数是封装异步操作的两种方法,都用来达到同一种目的。区别在于,前者自带执行器,后者通过for await...of执行,或者自己编写执行器。

​ 异步Generator函数也可以通过next方法的参数接收外部传入的数据。同步的数据结构也可以使用异步Generator函数。

​ JavaScript有四种函数形式:普通函数、async 函数、Generator 函数和异步Generator函数。

  • 当需要执行同步操作且不需要特殊的控制流或迭代机制时,应使用普通函数。它们适用于大多数基本的编程任务,如计算、数据处理和简单的逻辑操作。
  • 如果是一系列按照顺序执行的异步操作(比如读取文件,然后写入新内容,再存入硬盘),可以使用async函数。它们适用于网络请求、定时操作、文件读写等需要等待的异步任务。
  • 当需要创建一个可以逐步产生值的迭代器时,应使用Generator函数。它们适用于需要逐步处理数据或控制代码执行流程的场景,如分页加载数据、逐步计算等。
  • 如果是一系列产生相同数据结构的异步操作(比如一行一行读取文件),可以使用异步Generator函数。它们适用于处理流式数据、逐步处理大量异步数据或需要异步生成值的场景。

# yield* 语句

​ yield语句也可以跟一个异步遍历器。与同步Generator函数一样,for await...of循环会展开yield

async function* gen1() {
  yield 'a';
  yield 'b';
  return 2;
}
async function* gen2() {
  const result = yield* gen1(); // result最终会等于2
}
//与同步 Generator 函数一样,for await...of循环会展开yield*
(async function () {
  for await (const x of gen2()) {
    console.log(x);
  }
})();
// a
// b
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
上次更新: 2024/4/13 08:06:14