如何实现自定义的异步迭代器 (Async Iterator)?

风磊小哥_5846

风磊小哥_5846

2026-07-16

174人浏览

原创

实现自定义异步迭代器需定义symbol.asynciterator方法并返回含next()的对象,next()返回promise,推荐用class管理状态,可选return()支持清理。

如何实现自定义的异步迭代器 (async iterator)?

要实现自定义的异步迭代器,核心是让对象满足 Symbol.asyncIterator 方法,并返回一个符合异步迭代器协议的对象(即具有 next() 方法、返回 Promise 并最终 resolve { value, done } 的对象)。

定义符合协议的 asyncIterator 方法

JavaScript 中的异步迭代器必须在对象上部署 [Symbol.asyncIterator]() 方法。这个方法需返回一个对象,该对象的 next() 方法返回 Promise。

  • 确保返回的是一个对象,不是 Promise;next() 才返回 Promise
  • done: true 表示迭代结束,之后的 next() 调用也应返回 { value: undefined, done: true }
  • 可配合闭包或类状态保存当前迭代位置(如索引、队列、流缓冲等)

用类封装并维护内部状态

推荐使用 class 实现,便于管理异步状态(例如读取文件块、轮询 API、消费消息队列)。构造时接收数据源或配置,内部保存游标、缓存、锁等。

Aoyo.ai
Aoyo.ai

一款AI工具,主要用于一款基于RAG技术的AI搜索引擎,适合需要提升相关任务效率的用户。

下载
  • 在 [Symbol.asyncIterator]() 中返回 this 或新实例(避免多次调用复用同一状态)
  • next() 方法中可 await 异步操作(如 fetch、read()、setTimeout)
  • 注意错误处理:若异步操作失败,next() 返回的 Promise 应 reject,以便 for await...of 捕获

支持取消与清理(可选但推荐)

标准协议未强制要求取消机制,但在实际场景(如网络请求、定时任务)中,主动终止迭代能避免资源泄漏。

  • 可添加 return() 方法(非必需,但被 for await...of 在 break/return 时调用)
  • return() 应清理资源(如 abort AbortController、关闭 stream、清除 timer)并返回 Promise.resolve({ value: undefined, done: true })
  • 也可暴露 cancel() 方法供手动调用

简单示例:延迟逐个返回数组项

以下是一个最小可行实现,模拟每 100ms 返回一个值:

class DelayedAsyncIterator {
  constructor(items) {
    this.items = items;
    this.index = 0;
  }

  [Symbol.asyncIterator]() {
    return this;
  }

  async next() {
    if (this.index >= this.items.length) {
      return { value: undefined, done: true };
    }
    await new Promise(r => setTimeout(r, 100));
    return { value: this.items[this.index++], done: false };
  }

  // 可选:支持提前退出
  async return() {
    this.index = this.items.length;
    return { value: undefined, done: true };
  }
}

// 使用:
for await (const item of new DelayedAsyncIterator([1, 2, 3])) {
  console.log(item); // 每 100ms 输出一个
}

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
js获取数组长度的方法
js获取数组长度的方法

在js中,可以利用array对象的length属性来获取数组长度,该属性可设置或返回数组中元素的数目,只需要使用“array.length”语句即可返回表示数组对象的元素个数的数值,也就是长度值。php中文网还提供JavaScript数组的相关下载、相关课程等内容,供大家免费下载使用。

2023.06.20

5106

5

js刷新当前页面
js刷新当前页面

js刷新当前页面的方法:1、reload方法,该方法强迫浏览器刷新当前页面,语法为“location.reload([bForceGet]) ”;2、replace方法,该方法通过指定URL替换当前缓存在历史里(客户端)的项目,因此当使用replace方法之后,不能通过“前进”和“后退”来访问已经被替换的URL,语法为“location.replace(URL) ”。php中文网为大家带来了js刷新当前页面的相关知识、以及相关文章等内容

2023.07.04

1249

3

js四舍五入
js四舍五入

js四舍五入的方法:1、tofixed方法,可把 Number 四舍五入为指定小数位数的数字;2、round() 方法,可把一个数字舍入为最接近的整数。php中文网为大家带来了js四舍五入的相关知识、以及相关文章等内容

2023.07.04

5024

6

js删除节点的方法
js删除节点的方法

js删除节点的方法有:1、removeChild()方法,用于从父节点中移除指定的子节点,它需要两个参数,第一个参数是要删除的子节点,第二个参数是父节点;2、parentNode.removeChild()方法,可以直接通过父节点调用来删除子节点;3、remove()方法,可以直接删除节点,而无需指定父节点;4、innerHTML属性,用于删除节点的内容。

2023.09.01

980

4

JavaScript转义字符
JavaScript转义字符

JavaScript中的转义字符是反斜杠和引号,可以在字符串中表示特殊字符或改变字符的含义。本专题为大家提供转义字符相关的文章、下载、课程内容,供大家免费下载体验。

2023.09.04

1896

5

js生成随机数的方法
js生成随机数的方法

js生成随机数的方法有:1、使用random函数生成0-1之间的随机数;2、使用random函数和特定范围来生成随机整数;3、使用random函数和round函数生成0-99之间的随机整数;4、使用random函数和其他函数生成更复杂的随机数;5、使用random函数和其他函数生成范围内的随机小数;6、使用random函数和其他函数生成范围内的随机整数或小数。

2023.09.04

3585

4

如何启用JavaScript
如何启用JavaScript

JavaScript启用方法有内联脚本、内部脚本、外部脚本和异步加载。详细介绍:1、内联脚本是将JavaScript代码直接嵌入到HTML标签中;2、内部脚本是将JavaScript代码放置在HTML文件的`<script>`标签中;3、外部脚本是将JavaScript代码放置在一个独立的文件;4、外部脚本是将JavaScript代码放置在一个独立的文件。

2023.09.12

4653

6

Js中Symbol类详解
Js中Symbol类详解

javascript中的Symbol数据类型是一种基本数据类型,用于表示独一无二的值。Symbol的特点:1、独一无二,每个Symbol值都是唯一的,不会与其他任何值相等;2、不可变性,Symbol值一旦创建,就不能修改或者重新赋值;3、隐藏性,Symbol值不会被隐式转换为其他类型;4、无法枚举,Symbol值作为对象的属性名时,默认是不可枚举的。

2023.09.20

3060

5

java访问控制修饰符介绍
java访问控制修饰符介绍

java访问控制修饰符有四种,分别是public、protected、private、默认访问修饰符。详细介绍:1、public,public是最宽松的访问控制修饰符,被修饰的类、方法和变量可以被任何其他类访问,当一个类、方法或变量被声明为public时,它们可以在任何地方被访问,无论是同一个包中的类还是不同包中的类;2、protected修饰符等等。

2023.09.20

968

7

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
热门推荐
/
最新课程
phpStudy极速入门视频教程
phpStudy极速入门视频教程

共6课时 | 54.7万人学习

独孤九贱(4)_PHP视频教程
独孤九贱(4)_PHP视频教程

共89课时 | 133.9万人学习