如何通过 Symbol.iterator 让普通的业务实体对象支持 for...of 遍历

风婷姑娘_1262

风婷姑娘_1262

2026-05-14

270人浏览

原创

要让普通业务实体对象支持for...of遍历,核心是为其实现[symbol.iterator]方法,返回符合迭代器协议的对象(含next()方法,返回{value, done});需明确遍历目标(如属性值、键名、键值对或业务字段),推荐在类中用生成器函数定义,确保每次调用返回全新迭代器且不破坏封装性。

如何通过 symbol.iterator 让普通的业务实体对象支持 for...of 遍历

要让普通业务实体对象支持 for...of 遍历,核心是为该对象实现 [Symbol.iterator] 方法,返回一个符合迭代器协议的对象(即有 next() 方法,返回 { value, done } 形式的对象)。

明确迭代目标:决定遍历什么

业务对象通常不是天然可迭代的集合,需先明确“遍历时想拿到什么”。常见选择包括:

  • 对象自身的可枚举属性值(类似 Object.values())
  • 属性键名(类似 Object.keys())
  • 键值对数组(类似 Object.entries())
  • 业务语义上的特定字段(如订单对象只遍历商品项、用户对象只遍历角色列表)

在类中定义 Symbol.iterator 方法

推荐在类定义中直接部署该方法。它必须是生成器函数(function*)或返回迭代器对象的普通函数。使用生成器更简洁直观:

class User {
  constructor(name, roles, email) {
    this.name = name;
    this.roles = Array.isArray(roles) ? roles : [];
    this.email = email;
  }
<p>*[Symbol.iterator]() {
// 示例:只遍历业务上关心的字段值
yield this.name;
yield this.email;
yield this.roles;
}
}</p>

这样就能直接用 for...of:

const user = new User('张三', ['admin', 'editor'], 'zhang@example.com');
for (const item of user) {
  console.log(item); // '张三' → 'zhang@example.com' → ['admin','editor']
}

支持多种遍历策略(可选进阶)

若需按不同方式遍历(如有时要键、有时要值),可不直接在实例上定义 [Symbol.iterator],而是提供显式方法,并让默认迭代器保持语义清晰。例如:

class Order {
  constructor(id, items, total) {
    this.id = id;
    this.items = items || [];
    this.total = total;
  }
<p>// 默认遍历:只暴露业务核心数据(如商品项)
<em>[Symbol.iterator]() {
yield</em> this.items; // 委托遍历 items 数组
}</p><p>// 显式方法供其他需求
keys() {
return Object.keys(this)[Symbol.iterator]();
}</p><p>entries() {
return Object.entries(this)[Symbol.iterator]();
}
}</p>

调用时:

const order = new Order('ORD-001', [{ name: '笔记本', qty: 2 }], 99.9);
for (const item of order) {
  console.log(item); // { name: '笔记本', qty: 2 }
}
<p>// 如需遍历属性名,显式调用
for (const key of order.keys()) {
console.log(key); // 'id', 'items', 'total'
}</p>

注意兼容性与边界情况

实际使用中需留意几点:

  • [Symbol.iterator] 是 ES6+ 特性,确保运行环境支持(现代浏览器和 Node.js ≥ 4 均支持)
  • 方法必须返回迭代器对象,不能直接返回数组或原始值;否则 for...of 会报错 is not iterable
  • 若对象含异步数据(如待加载的关联列表),[Symbol.iterator] 本身不能是 async function*(那是 AsyncIterator),此时应改用 for await...of 并实现 [Symbol.asyncIterator]
  • 避免在迭代器中修改原对象状态,保证遍历过程纯净、可预测
PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

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

下载

相关标签:

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

相关专题

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

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

2023.06.20

5006

5

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

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

2023.07.04

1229

3

js四舍五入
js四舍五入

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

2023.07.04

4944

6

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

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

2023.09.01

960

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

3525

4

如何启用JavaScript
如何启用JavaScript

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

2023.09.12

4593

6

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

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

2023.09.20

3020

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.8万人学习