JavaScript自定义迭代器和提前终止迭代器

简介: 与 Iterable 接口类似,任何实现 Iterator 接口的对象都可以作为迭代器使用。下面这个例子中的 Counter 类只能被迭代一定的次数

👦个人简介:张清悠,字澄澈,号寻梦客,爱好旅行、运动,主攻前端方向技术研发,副攻Unity 3D、C++、Python人工智能等
📝个人寄语:学会不为过程的缓慢而焦虑,即使暂时未能如你所愿,但只要你在努力,你就在不断成长!
🙏个人公众号:清悠小猿(海量源码尽在其中,欢迎关注)

一、自定义迭代器

与 Iterable 接口类似,任何实现 Iterator 接口的对象都可以作为迭代器使用。下面这个例子中
的 Counter 类只能被迭代一定的次数:

class Counter {
    
 // Counter 的实例应该迭代 limit 次
 constructor(limit) {
    
 this.count = 1; 
 this.limit = limit; 
 } 
 next() {
    
 if (this.count <= this.limit) {
    
 return {
    done: false, value: this.count++ }; 
 } else {
    
 return {
    done: true, value: undefined }; 
 } 
 } 
 [Symbol.iterator]() {
    
 return this; 
 } 
} 
let counter = new Counter(3); 
for (let i of counter) {
    
 console.log(i); 
} 
// 1 
// 2 
// 3

这个类实现了 Iterator 接口,但不理想。这是因为它的每个实例只能被迭代一次:

for (let i of counter) {
    console.log(i); 
//1
//2
//3
for (let i of counter) {
    console.log(i); } 
// (nothing logged)

为了让一个可迭代对象能够创建多个迭代器,必须每创建一个迭代器就对应一个新计数器。为此,
可以把计数器变量放到闭包里,然后通过闭包返回迭代器:

class Counter {
    
 constructor(limit) {
    
 this.limit = limit; 
 } 
 [Symbol.iterator]() {
    
 let count = 1, 
 limit = this.limit; 
 return {
    
 next() {
    
 if (count <= limit) {
    
 return {
    done: false, value: count++ }; 
 } else {
    
 return {
    done: true, value: undefined }; 
 } 
 } 
 }; 
 } 
} 
let counter = new Counter(3); 
for (let i of counter) {
    console.log(i); } 
// 1 
// 2 
// 3 
for (let i of counter) {
    console.log(i); } 
// 1 
// 2 
// 3

每个以这种方式创建的迭代器也实现了 Iterable 接口。Symbol.iterator 属性引用的工厂函数
会返回相同的迭代器:

let arr = ['foo', 'bar', 'baz']; 
let iter1 = arr[Symbol.iterator](); 
console.log(iter1[Symbol.iterator]); // f values() { [native code] } 
let iter2 = iter1[Symbol.iterator](); 
console.log(iter1 === iter2); // true

因为每个迭代器也实现了 Iterable 接口,所以它们可以用在任何期待可迭代对象的地方,比如

for-of 循环:
let arr = [3, 1, 4]; 
let iter = arr[Symbol.iterator]();
for (let item of arr ) {
    console.log(item); } 
// 3 
// 1 
// 4 
for (let item of iter ) {
    console.log(item); } 
// 3 
// 1 
// 4

二、 提前终止迭代器

可选的 return()方法用于指定在迭代器提前关闭时执行的逻辑。执行迭代的结构在想让迭代器知
道它不想遍历到可迭代对象耗尽时,就可以“关闭”迭代器。可能的情况包括:
 for-of 循环通过 break、continue、return 或 throw 提前退出;
 解构操作并未消费所有值。
return()方法必须返回一个有效的 IteratorResult 对象。简单情况下,可以只返回{ done: true }。
因为这个返回值只会用在生成器的上下文中,所以本章后面再讨论这种情况。
如下面的代码所示,内置语言结构在发现还有更多值可以迭代,但不会消费这些值时,会自动调用

return()方法。
class Counter {
    
 constructor(limit) {
    
 this.limit = limit; 
 } 
 [Symbol.iterator]() {
    
 let count = 1, 
 limit = this.limit; 
 return {
    
 next() {
    
 if (count <= limit) {
    
 return {
    done: false, value: count++ }; 
 } else {
    
 return {
    done: true }; 
 } 
 }, 
 return() {
    
 console.log('Exiting early'); 
 return {
    done: true }; 
 } 
 }; 
 } 
} 
let counter1 = new Counter(5); 
for (let i of counter1) {
    
 if (i > 2) {
    
 break;
  } 
 console.log(i); 
}
// 1 
// 2 
// Exiting early 
let counter2 = new Counter(5); 
try {
    
 for (let i of counter2) {
    
 if (i > 2) {
    
 throw 'err'; 
 } 
 console.log(i); 
 } 
} catch(e) {
   } 
// 1 
// 2 
// Exiting early 
let counter3 = new Counter(5); 
let [a, b] = counter3; 
// Exiting early

如果迭代器没有关闭,则还可以继续从上次离开的地方继续迭代。比如,数组的迭代器就是不能关
闭的:

let a = [1, 2, 3, 4, 5]; 
let iter = a[Symbol.iterator](); 
for (let i of iter) {
    
 console.log(i); 
 if (i > 2) {
    
 break 
 } 
} 
// 1 
// 2 
// 3 
for (let i of iter) {
    
 console.log(i); 
} 
// 4 
// 5

因为 return()方法是可选的,所以并非所有迭代器都是可关闭的。要知道某个迭代器是否可关闭,
可以测试这个迭代器实例的 return 属性是不是函数对象。不过,仅仅给一个不可关闭的迭代器增加这
个方法并不能让它变成可关闭的。这是因为调用 return()不会强制迭代器进入关闭状态。即便如此,
return()方法还是会被调用。

let a = [1, 2, 3, 4, 5]; 
let iter = a[Symbol.iterator](); 
iter.return = function() {
    
 console.log('Exiting early'); 
 return {
    done: true };
 }; 
for (let i of iter) {
    
 console.log(i); 
 if (i > 2) {
    
 break 
 } 
} 
// 1 
// 2 
// 3 
// 提前退出
for (let i of iter) {
    
 console.log(i); 
} 
// 4 
// 5

总结:

```
本期我们分享的是JavaScript(十)的自定义迭代器和提前终止迭代器
我们下期:JavaScript的生成器详解
原创不易,期待您的点赞关注与转发评论😜😜

目录
相关文章
|
16天前
|
前端开发 JavaScript
使用JavaScript实现复杂功能:构建一个自定义的拖拽功能
使用JavaScript实现复杂功能:构建一个自定义的拖拽功能
|
3月前
|
前端开发 JavaScript 中间件
掌握JavaScript中的迭代器和生成器(下)
掌握JavaScript中的迭代器和生成器(下)
|
3月前
|
存储 JavaScript 前端开发
掌握JavaScript中的迭代器和生成器(上)
掌握JavaScript中的迭代器和生成器
|
6月前
uniapp自定义过滤器filter.js
uniapp自定义过滤器filter.js
65 0
|
7月前
|
JSON JavaScript 前端开发
JavaScript的自定义对象
JavaScript的自定义对象
|
4月前
|
存储 设计模式 监控
如何构建自定义 Node.js 事件发射器
如何构建自定义 Node.js 事件发射器
503 2
|
4月前
|
JavaScript 测试技术
【sgGoogleTranslate】自定义组件:基于Vue.js用谷歌Google Translate翻译插件实现网站多国语言开发
【sgGoogleTranslate】自定义组件:基于Vue.js用谷歌Google Translate翻译插件实现网站多国语言开发
|
3月前
|
存储 JavaScript 前端开发
JavaScript 自定义对象 及 new()原理与实现 如何完整地手写实现new
JavaScript 自定义对象 及 new()原理与实现 如何完整地手写实现new
61 0
|
4月前
|
JavaScript 前端开发 C++
如何构建自定义 Node.js 事件发射器
如何构建自定义 Node.js 事件发射器
37 2
|
4月前
|
前端开发 JavaScript
前端用原生js编辑文件内容→创建生成文件(格式可以自定义)→下载文件
前端用原生js编辑文件内容→创建生成文件(格式可以自定义)→下载文件