如何利用 Symbol.iterator 为自定义业务对象挂载标准迭代契约以支持 for...of

秋磊君_9776

秋磊君_9776

2026-05-12

945人浏览

原创

要让自定义对象支持for...of,需在原型上定义[symbol.iterator]方法,返回符合迭代器协议的对象:含next()方法,每次返回{value, done}。生成器函数是最简洁实现方式;手动实现则适用于分页、懒加载等精细控制场景。

如何利用 symbol.iterator 为自定义业务对象挂载标准迭代契约以支持 for...of

要让自定义对象支持 for...of,关键是在其原型(或实例)上定义 [Symbol.iterator] 方法,返回一个符合迭代器协议的对象:即具有 next() 方法,每次调用返回 { value, done } 形式的对象。

理解迭代器协议的核心要求

标准迭代契约不关心数据怎么存、怎么取,只约定接口行为:

  • [Symbol.iterator] 必须是无参函数,返回一个对象
  • 该返回对象必须有 next() 方法
  • next() 每次调用返回 { value: any, done: boolean }
  • 当 done 为 true 时,value 可选(常用于终止信号)

为类添加 Symbol.iterator 的典型写法

推荐在类的原型上定义,复用性高。例如实现一个管理用户列表的业务类:

class UserCollection {
  constructor(users = []) {
    this.users = users;
  }

  *[Symbol.iterator]() {
    for (const user of this.users) {
      yield user;
    }
  }
}

// 使用
const coll = new UserCollection([
  { id: 1, name: '张三' },
  { id: 2, name: '李四' }
]);

for (const user of coll) {
  console.log(user.name); // 张三、李四
}

这里用了生成器函数(function*),它天然满足迭代器协议——生成器函数执行后返回一个迭代器对象,自带合规的 next()。这是最简洁可靠的实现方式。

手动实现 next 而不依赖生成器

若需精细控制状态(如分页拉取、懒加载、带副作用的遍历),可手动构造迭代器对象:

class LazyOrderIterator {
  constructor(orderIds) {
    this.orderIds = orderIds;
    this.index = 0;
  }

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

  next() {
    if (this.index 
<p>要点:<code>[Symbol.iterator]()</code> 返回 <code>this</code> 是常见模式,但仅当该实例本身已具备 <code>next()</code> 且可被多次遍历(或设计为单次使用)时才适用;否则应返回新创建的独立迭代器实例,避免状态污染。</p>

<h3>注意边界与兼容性细节</h3>
<p>几个容易出错的地方:</p>
  • 不要在实例上直接赋值 this[Symbol.iterator] = ...,否则每个实例都重复创建函数,浪费内存;优先挂载到 prototype
  • 若对象是普通字面量(非类实例),可用 Object.defineProperty 或计算属性语法添加:{ [Symbol.iterator]() { return {...} } }
  • 确保 next() 总是返回对象,不能返回 undefined 或原始值,否则 for...of 会报错
  • TypeScript 中需声明 [Symbol.iterator]: Iterator<t></t> 类型,否则类型检查可能失败
PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

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

下载

相关标签:

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

相关专题

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

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

2023.06.20

4706

5

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

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

2023.07.04

1169

3

js四舍五入
js四舍五入

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

2023.07.04

4644

6

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

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

2023.09.01

920

4

JavaScript转义字符
JavaScript转义字符

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

2023.09.04

1836

5

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

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

2023.09.04

3365

4

如何启用JavaScript
如何启用JavaScript

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

2023.09.12

4353

6

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

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

2023.09.20

2860

5

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

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

2023.09.20

908

7

热门下载

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

精品课程

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

共6课时 | 54.6万人学习

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

共89课时 | 133.4万人学习