如何通过 自定义迭代器 ([Symbol.iterator]) 实现可遍历的类实例

雨雪酱_2709

雨雪酱_2709

2026-05-10

1019人浏览

原创

要让类实例支持for...of等遍历,需定义[Symbol.iterator]方法返回符合迭代器协议的对象;若需异步遍历,则实现[Symbol.asyncIterator]方法。

要让一个类实例能被 for...of、扩展运算符([...obj])、解构等语法遍历,关键是在该实例上定义 [symbol.iterator] 方法,返回一个符合迭代器协议的对象(即有 next() 方法,返回 { value, done } 形式的对象)。

1. 基础实现:返回简单值序列

最常见场景是让实例按某种顺序“产出”内部数据(如数组、Map 的键/值等)。只需在类的原型或实例上定义 [Symbol.iterator],返回一个闭包内的迭代器函数即可:

示例:遍历类内部维护的 items 数组

[Symbol.iterator]
  • 不直接在 [Symbol.iterator] 中硬编码逻辑,而是委托给一个私有方法(如 _getIterator(mode))
  • 让 [Symbol.iterator] 默认返回一种模式(如 values),其他模式通过显式方法调用(.keys()、.entries())获取
  • 确保所有返回的迭代器都满足协议:每次调用 next() 返回 { value, done }

示例:模拟 Map 的遍历接口

class MyMap {
  constructor(entries = []) {
    this._data = new Map(entries);
  }

  [Symbol.iterator]() {
    return this.values(); // 默认遍历值
  }

  *keys() {
    for (const key of this._data.keys()) {
      yield key;
    }
  }

  *values() {
    for (const value of this._data.values()) {
      yield value;
    }
  }

  *entries() {
    for (const entry of this._data.entries()) {
      yield entry;
    }
  }
}

注意:这里用了生成器函数(function* 或 *method()),它天然返回迭代器,写法更简洁、状态自动管理,推荐优先使用。

3. 注意事项与常见陷阱

  • 必须返回迭代器对象:不是直接返回值,也不是返回普通对象;必须有 next() 方法,且每次调用返回 { value, done }
  • done 为 true 后仍可调用 next():规范要求后续调用应始终返回 { value: undefined, done: true },需在逻辑中处理越界情况
  • 避免闭包引用外部可变状态出错:若迭代器依赖实例属性(如 this.items),而该属性在遍历中途被修改,行为可能不符合预期;必要时可提前快照(如 const items = [...this.items])
  • 生成器函数是首选:比手写 next() 更安全、易读、支持 yield*、异步迭代(async function*)等高级特性

4. 进阶:支持异步迭代(AsyncIterator)

若数据源是异步的(如从 API 分页加载),可实现 [Symbol.asyncIterator],返回一个异步迭代器(next() 返回 Promise):

class AsyncCollection {
  constructor(fetcher) {
    this.fetcher = fetcher; // (page) => Promise<items>
  }

  async *[Symbol.asyncIterator]() {
    let page = 1;
    while (true) {
      const items = await this.fetcher(page);
      if (items.length === 0) break;
      for (const item of items) {
        yield item;
      }
      page++;
    }
  }
}

// 使用:
// for await (const item of asyncColl) { ... }
</items>
PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

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

下载

相关标签:

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

相关专题

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

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

2023.06.20

5526

5

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

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

2023.07.04

1349

3

js四舍五入
js四舍五入

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

2023.07.04

5464

6

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

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

2023.09.01

1020

4

JavaScript转义字符
JavaScript转义字符

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

2023.09.04

1976

5

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

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

2023.09.04

3825

4

如何启用JavaScript
如何启用JavaScript

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

2023.09.12

5013

6

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

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

2023.09.20

3280

5

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

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

2023.09.20

1048

7

热门下载

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

精品课程

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

共6课时 | 54.7万人学习

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

共89课时 | 134.1万人学习