symbol.iterator用于同步遍历,需返回具有next方法的迭代器对象,支持for...of循环;Symbol.asyncIterator用于异步遍历,返回promise形式的{value, done}结果,支持for await...of循环。
Symbol.iterator 和 Symbol.asyncIterator 是 javaScript 中用于定义对象遍历行为的特殊符号,它们决定了对象如何被 for...of 循环或异步循环处理。
Symbol.iterator:控制同步遍历
Symbol.iterator 定义一个对象的同步迭代器。只要一个对象实现了这个方法,就可以在 for...of 中使用。
该方法必须返回一个迭代器对象,这个对象有 next() 方法,每次调用返回 { value, done } 格式的结果。
常见例子:
例如:
立即学习“Java免费学习笔记(深入)”;
const myIterable = { data: [1, 2, 3], [Symbol.iterator]() { let index = 0; return { next: () => { if (index < this.data.length) { return { value: this.data[index++], done: false }; } else { return { done: true }; } } }; } }; for (const item of myIterable) { console.log(item); // 输出 1, 2, 3 }
Symbol.asyncIterator:支持异步遍历
Symbol.asyncIterator 用于定义异步迭代器,适用于数据是逐步异步获取的场景,比如读取流、分页数据等。
它返回一个对象,其 next() 方法返回 Promise,resolve 结果为 { value, done }。
需要用 for await...of 来遍历。
典型应用:
示例:
const myAsyncIterable = { async *[Symbol.asyncIterator]() { for (let i = 1; i <= 3; i++) { await new Promise(resolve => setTimeout(resolve, 1000)); yield i; } } }; for await (const item of myAsyncIterable) { console.log(item); // 每秒输出 1, 2, 3 }
基本上就这些。Symbol.iterator 处理“我能怎么被一步步取值”,而 Symbol.asyncIterator 解决“我怎么被一步步异步取值”。两者让自定义对象也能自然融入 for...of 或 for await...of 的语法中。区别在于是否涉及等待。