JavaScript迭代器和可迭代协议是语言级遍历契约:对象实现[Symbol.iterator]方法并返回符合next()协议的迭代器,即可被for...of等语法无缝使用。

JavaScript 的迭代器和可迭代协议不是语法糖,而是语言级的遍历契约:只要对象实现了 [Symbol.iterator] 方法并返回符合 next() 协议的对象,它就能被 for...of、[...iterable]、Array.from()、解构赋值等所有消费可迭代对象的语法无缝使用。
为什么对象加了 [Symbol.iterator] 就能用 for...of?
因为 for...of 会自动调用该方法获取迭代器,再反复调用其 next(),直到 done: true。这个过程不依赖数组索引、也不关心内部结构——只认协议。
-
[Symbol.iterator]必须是无参函数,每次调用都应返回**全新迭代器对象**(否则多次遍历会互相干扰) -
next()返回的对象必须有value和done两个属性;done: true后,value可省略或为undefined(但不能缺失done) - 原生类型如
Array、String、Map、Set都已内置实现,所以天然支持
手动实现迭代器:状态管理容易出错,但适合学习原理
手写 next() 要自己维护当前状态(比如计数器、游标),稍不注意就会漏掉边界判断或重复返回。
class Range {
constructor(from, to) {
this.from = from;
this.to = to;
}
[Symbol.iterator]() {
let current = this.from;
return {
next() {
if (current <= this.to) {
return { value: current++, done: false };
} else {
return { done: true }; // ⚠️ 不要漏掉 done: true!
}
}
};
}
}- 错误常见于:忘记在循环末尾返回
{ done: true },导致for...of死循环 - 不要在
[Symbol.iterator]外部闭包中复用同一个current变量,否则多个for...of同时遍历会冲突 - 如果需要支持异步迭代(如读取文件流),手写更复杂,此时应优先考虑
AsyncIterator
用生成器函数 function* 实现:简洁、安全、推荐日常使用
生成器函数天然返回符合迭代器协议的对象,yield 自动暂停/恢复执行,状态由引擎托管,几乎不会出错。
立即学习“Java免费学习笔记(深入)”;
class Countdown {
constructor(from) {
this.from = from;
}
*[Symbol.iterator]() {
for (let i = this.from; i > 0; i--) {
yield i; // 每次 yield 对应一次 next() 调用
}
}
}
console.log([...new Countdown(3)]); // [3, 2, 1]
-
yield后面的值就是next().value;函数结束自动返回{ done: true } - 生成器函数内部可自由使用
if、while、甚至await(配合async function*) - 注意:生成器函数不能用箭头函数替代(
()* => {}语法非法)
自定义迭代器最容易被忽略的坑
不是“怎么写”,而是“怎么用对”:很多问题其实出在协议理解偏差上。
-
done: true后继续调用next(),仍应返回{ done: true }(不能抛错,也不能重置) - 对象本身不可迭代 ≠ 没有
[Symbol.iterator],可能是你查错了原型链(比如直接在实例上定义,但忘了绑定this) - 解构赋值和扩展运算符(
[...obj])同样依赖该协议,但它们会**立即消耗整个迭代器**,不适合无限序列(如function* infinite() { while(true) yield Date.now(); }) - 若需支持多次遍历(如一个
Range被展开两次),[Symbol.iterator]必须每次都返回新迭代器,不能缓存或复用
真正难的不是写出一个能跑的迭代器,而是写出一个**健壮、可重入、语义清晰**的迭代器——尤其当它要暴露给他人使用,或嵌入到数据处理管道中时,协议细节决定它能不能被放心地交给 Array.from 或第三方库处理。










