0

0

JavaScript迭代器协议如何自定义遍历【教程】

夢幻星辰

夢幻星辰

发布时间:2026-01-21 17:11:02

|

186人浏览过

|

来源于php中文网

原创

要让对象支持 for...of,需在对象上定义[Symbol.iterator]方法,该方法每次调用须返回新迭代器实例,其next()方法返回{value, done}格式对象。

javascript迭代器协议如何自定义遍历【教程】

JavaScript 迭代器协议本身不提供“自定义遍历逻辑”的 API,而是要求你实现 Symbol.iterator 方法并返回一个符合迭代器协议的对象——也就是说,不是“配置”遍历,而是“构造”一个能被 for...ofArray.from、展开运算符等消费的对象。

如何让一个对象支持 for...of

关键不是重写语言机制,而是让对象返回一个有 next() 方法的对象。这个 next() 必须返回形如 { value: any, done: boolean } 的对象。

  • 必须在对象上定义 [Symbol.iterator] 属性(注意方括号和 Symbol 字面量)
  • [Symbol.iterator] 必须是函数,且每次调用都应返回**新的迭代器实例**(否则多次 for...of 会互相干扰)
  • 返回的迭代器对象不必是类实例,普通对象 + next() 方法也合法

例如,让一个范围对象可遍历:

const range = {
  from: 1,
  to: 3,
  [Symbol.iterator]() {
    let current = this.from;
    return {
      next: () => {
        if (current <= this.to) {
          return { value: current++, done: false };
        } else {
          return { value: undefined, done: true };
        }
      }
    };
  }
};

for (const n of range) console.log(n); // 1, 2, 3

next() 中的 donevalue 怎么配合

done: true 表示迭代结束,此时 value 仍会被读取(比如 for...of 不再使用它,但 iterator.next().value 仍可访问),但规范不要求它有意义;常见做法是设为 undefined

立即学习Java免费学习笔记(深入)”;

燕雀Logo
燕雀Logo

为用户提供LOGO免费设计在线生成服务

下载
  • 如果 done: false 但没传 value,实际值为 undefined(不是报错)
  • 如果 done: truevalue 有值,该值会在最后一次 next() 调用中返回(例如 Array.from(range) 会收集它之前的全部 value,不包含这次)
  • 迭代器可以是无限的(永远返回 { done: false }),但消费方(如 for...of)无法中断,需靠逻辑控制(如 break

为什么不能直接在原型上挂 [Symbol.iterator]

可以挂,但多数情况不推荐——因为 Symbol.iterator 是非枚举属性,for...in 看不到,不影响遍历行为;真正的问题在于:如果你在 Object.prototype 或某个基类原型上添加它,会影响所有继承者,可能破坏预期行为(比如让普通 plain object 变成可遍历,而它本不该有业务语义上的“遍历顺序”)。

  • 更安全的做法是只在明确需要遍历的类或对象字面量上显式定义
  • 若用 class,建议把迭代逻辑封装在独立方法里,再由 [Symbol.iterator] 调用,便于复用和测试
  • 注意:箭头函数不能用作 [Symbol.iterator],因为它没有 this 绑定,无法访问实例属性

与生成器函数 function* 的关系

生成器函数是创建迭代器最简洁的方式:它自动返回符合协议的迭代器对象,且天然支持暂停/恢复、状态保持。

  • 不用手动管理 currentdone 状态,yield 隐式处理
  • 生成器函数体内的 this 指向调用时的上下文,适合类中使用
  • 性能上,简单场景下手写迭代器略快;复杂逻辑(异步、递归、多状态)用生成器更清晰、不易出错

等价写法:

class Range {
  constructor(from, to) {
    this.from = from;
    this.to = to;
  }
  *[Symbol.iterator]() {
    for (let i = this.from; i <= this.to; i++) {
      yield i;
    }
  }
}

自定义迭代器的核心约束很轻,但容易忽略两点:一是每次 [Symbol.iterator] 调用必须返回新迭代器(避免共享状态),二是 next() 返回值结构不能错——哪怕只是漏写 donefor...of 就会无限循环。

相关专题

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

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

557

2023.06.20

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

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

374

2023.07.04

js四舍五入
js四舍五入

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

754

2023.07.04

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

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

478

2023.09.01

JavaScript转义字符
JavaScript转义字符

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

454

2023.09.04

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

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

1031

2023.09.04

如何启用JavaScript
如何启用JavaScript

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

658

2023.09.12

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

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

553

2023.09.20

Java编译相关教程合集
Java编译相关教程合集

本专题整合了Java编译相关教程,阅读专题下面的文章了解更多详细内容。

7

2026.01.21

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
React 教程
React 教程

共58课时 | 3.9万人学习

TypeScript 教程
TypeScript 教程

共19课时 | 2.3万人学习

Bootstrap 5教程
Bootstrap 5教程

共46课时 | 2.9万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号