ES6迭代器简介

简单介绍下 ES6 规范里面迭代器(Iterator)相关的概念。最近为啥会看到迭代器,是因为看了 fetch 相关的 Headers 接口,为了实现下 Headers 接口就涉及到了迭代器。

迭代器(Iterator)

为什么要有迭代器,是为了给不同的数据结构一个统一的迭代方法,不管你是一个 Array 还是一个 Queue 还是一个 Dictionary,反正只要你提供了符合规范的迭代器,程序员就能通过统一的方法来迭代你这个数据结构。迭代器是一个实现了 Iterator 接口的对象。接口指定迭代器对象必须实现一个 next 方法,如下示例伪代码。

var iterator = {
  next: function() {
    // impl
  }
}

next 方法是否接受参数,在规范中并不严格限定,取决于实现当前这个迭代器的对象。但是必须能接受无参数的情况,因为 ES6 语法使用迭代器的时候是不会传参数的,譬如 for-of。next 方法返回的数据结构是 {done:boolean, value:ES6value}。每次调用 next,如果与之关联的数据结构里面有数据,那么按照当前数据结构自己的规则把当前被迭代到的元素放到返回的数据结构的 value 值中,done 填写 false。done 标识是否迭代到了最后。当迭代到最后一个元素后,再调用一次 next 后,返回的 done 就应该是 true。用代码示例下:

function getArrayIterator( array ) {
  // 等下再说
}

var iterator = getArrayIterator( [1, 2, 3, 4] );
iterator.next(); // { done: false, value: 1 }
iterator.next(); // { done: false, value: 2 }
iterator.next(); // { done: false, value: 3 }
iterator.next(); // { done: false, value: 4 }
iterator.next(); // { done: true, value: undefined }
iterator.next(); // { done: true, value: undefined }

当迭代器已经迭代完最后一个元素,那么无论调用几次 next 返回的 done 都是 true。不过规范里面说,如果在迭代的过程中,next 返回的数据结构中没有 done 这个属性的话,我们应该视作其值是 false。再来看看 value,其取值可以是规范中的任意类型。当迭代到最后一个元素后,即 done:true 的时候,value 可以是 undefined,也可以被填入一个返回值。MDN 中加了一篇文章的链接来说明当 done:true 时候,value 如果被设成有一个 returnValue 的意义,不过我英语比较挫真心没有看懂,只能列下原文引用:

Why can iterators (optionally) return a value after the last element? That capability is the reason for elements being wrapped. Otherwise, iterators could simply return a publicly defined sentinel (stop value) after the last element.

可迭代对象(Iterable)

迭代器是通过可迭代对象获得的,譬如数组就是一个可迭代对象。那么如何通过可迭代对象获得迭代器呢?规范中规定可迭代对象必须实现一个名为 @@iterator 的方法,调用这个方法返回和当前对象挂钩的迭代器,譬如:

function getArrayIterator( array ) {
  return array[ '@@iterator' ]();
}

var iterator = getArrayIterator( [1, 2, 3, 4] );

但是 @@iterator 方法的名字并不是一个 string,而是 Symbol.iterator。Symbol 是ES6 引入的一个新的类型,表示一个独一无二的值(这里就不展开了)。所以上例获取迭代器不是正确的写法,正确的应该是:

function getArrayIterator( array ) {
  return array[ Symbol.iterator ]();
}

var iterator = getArrayIterator( [1, 2, 3, 4] );

ES6 中新加了一些针对可迭代对象的语法,譬如 for-of:

var array = [ 1, 2, 3 ];
for ( let i of array ) {
  console.log( i );
}
// 输出
// 1
// 2
// 3

/* 上面的 for-of 和下面的代码等价 */
var iterator = array[ Symbol.iterator ]();
var iteratorResult = iterator.next();
while( !iteratorResult.done ) {
  console.log( iteratorResult.value );
  iteratorResult = iterator.next();
}

迭代器(Iterator)可选属性

其实迭代器除了规定一定要实现的 next 方法,还有两个是可选实现的方法 return 和 throw。

return

return 方法如果被调用,意味着调用者要终结此次迭代。return 返回一个 {done:true, value:arg} 对象,value 是调用 return 方法时传入的参数,即:

var iterator = {
  next: function() {
    // impl
  },
  return: function( arg ) {
    return {
      done: true,
      value: arg
    }
  }
}

return 方法被调用后,后续再调用当前迭代器的 next 方法,返回的对象 done 一律为 true。

throw

throw 方法如果被调用,表示迭代的过程中检测到了异常。一般来说 throw 方法传入的参数就是错误对象(但是这个不是强制规定的)。throw 方法的通常行为应该是以抛出异常的方式抛出传入的对象,但是这个行为也是建议不强制。如果 throw 方法不抛出异常,那么返回值为 {done:true}。表示迭代终结,后续再调用当前迭代器的 next 方法,返回的对象 done 一律为 true。

因为 return 和 throw 两个方法是可选实现的,所以在调用迭代器这个两个方法前,都要检测这两个方法是否存在。


2017.4.6 补充:
规范里面指出,迭代器也必须是一个可迭代的对象,即:

iterator = {
  next: function() {

  },
  [Symbol.iterator]: function() {
    return this;
  }
}
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 206,723评论 6 481
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 88,485评论 2 382
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 152,998评论 0 344
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 55,323评论 1 279
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 64,355评论 5 374
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,079评论 1 285
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,389评论 3 400
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,019评论 0 259
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,519评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,971评论 2 325
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,100评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,738评论 4 324
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,293评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,289评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,517评论 1 262
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,547评论 2 354
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,834评论 2 345

推荐阅读更多精彩内容