Iterator 和 for…of 循环的用法
ES6 添加了Map
和Set
数据格式。需要一种统一的接口机制,来处理所有不同的数据结构。遍历器(Iterator)就是这样一种机制。任何数据结构只要部署 Iterator 接口,就可以完成遍历操作。
Iterator 的作用有三个:
- 为各种数据结构,提供一个统一的、简便的访问接口;
- 使得数据结构的成员能够按某种次序排列;
- ES6 创造了一种新的遍历命令for…of循环,Iterator 接口主要供for…of消费
Iterator 的遍历过程是这样的。
- 创建一个指针对象,指向当前数据结构的起始位置。遍历器对象本质上,是一个指针对象。
- 第一次调用指针对象的
next
方法,可以将指针指向数据结构的第一个成员 - 第二次调用指针对象的
next
方法,指针就指向数据结构的第二个成员 - 不断调用指针对象的
next
方法,直到它指向数据结构的结束位置
每一次调用next
方法,都会返回数据结构的当前成员的信息。具体来说,就是返回一个包含value
和done
两个属性的对象。其中,value
属性是当前成员的值,done
属性是一个布尔值,表示遍历是否结束。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 |
var it = makeIterator(['a', 'b']); it.next() // { value: "a", done: false } it.next() // { value: "b", done: false } it.next() // { value: undefined, done: true } function makeIterator(array) { var nextIndex = 0; return { next: function() { return nextIndex < array.length ? {value: array[nextIndex++], done: false} : // done:false可省略 {value: undefined, done: true}; // 此处value: undefined实际可省略 } }; } |
用TypeScript的写法,遍历器接口(Iterable)、指针对象(Iterator)和next方法返回值的规格可以描述如下
1 2 3 4 5 6 7 8 9 10 11 12 13 |
interface Iterable { [Symbol.iterator]() : Iterator, } interface Iterator { next(value?: any) : IterationResult, } interface IterationResult { value: any, done: boolean, } |
使用for...of
循环遍历某种数据结构时,该循环会自动去寻找 Iterator 接口。
ES6 规定,默认的 Iterator 接口部署在数据结构的Symbol.iterator
属性,或者说,一个数据结构只要具有Symbol.iterator
属性,就可以认为是“可遍历的”(iterable)。
Symbol.iterator
属性本身是一个函数,就是当前数据结构默认的遍历器生成函数。执行这个函数,就会返回一个遍历器。至于属性名Symbol.iterator,它是一个表达式,返回Symbol对象的iterator属性,这是一个预定义好的、类型为 Symbol 的特殊值,所以要放在方括号内。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 |
const obj = { [Symbol.iterator] : function () { return { next: function () { return { value: 1, done: true }; } }; } }; // 对象obj是可遍历的(iterable),因为具有Symbol.iterator属性 |
ES6 的有些数据结构原生具备 Iterator 接口(比如数组),即不用任何处理,就可以被for…of循环遍历。因为,这些数据结构原生部署了Symbol.iterator属性,另外一些数据结构没有(比如对象)。凡是部署了Symbol.iterator属性的数据结构,就称为部署了遍历器接口。调用这个接口,就会返回一个遍历器对象。
原生具备 Iterator 接口的数据结构如下。
- Array
- Map
- Set
- String
- TypedArray
- 函数的 arguments 对象
- NodeList 对象
1 2 3 4 5 6 7 8 |
let arr = ['a', 'b', 'c']; let iter = arr[Symbol.iterator](); iter.next() // { value: 'a', done: false } iter.next() // { value: 'b', done: false } iter.next() // { value: 'c', done: false } iter.next() // { value: undefined, done: true } |
对于原生部署 Iterator 接口的数据结构,不用自己写遍历器生成函数,for…of循环会自动遍历它们。除此之外,其他数据结构(主要是对象)的 Iterator 接口,都需要自己在Symbol.iterator属性上面部署,这样才会被for…of循环遍历。
对象(Object)之所以没有默认部署 Iterator 接口,是因为对象的哪个属性先遍历,哪个属性后遍历是不确定的,需要开发者手动指定。
本质上,遍历器是一种线性处理,对于任何非线性的数据结构,部署遍历器接口,就等于部署一种线性转换。不过,严格地说,对象部署遍历器接口并不是很必要,因为这时对象实际上被当作 Map 结构使用,ES5 没有 Map 结构,而 ES6 原生提供了。
一个对象如果要具备可被for…of循环调用的 Iterator 接口,就必须在Symbol.iterator
的属性上部署遍历器生成方法(原型链上的对象具有该方法也可)。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 |
class RangeIterator { constructor(start, stop) { this.value = start; this.stop = stop; } [Symbol.iterator]() { return this; } next() { var value = this.value; if (value < this.stop) { this.value++; return {done: false, value: value}; } return {done: true, value: undefined}; } } function range(start, stop) { return new RangeIterator(start, stop); } for (var value of range(0, 3)) { console.log(value); // 0, 1, 2 } |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 |
function Obj(value) { this.value = value; this.next = null; } Obj.prototype[Symbol.iterator] = function() { var iterator = { next: next }; var current = this; function next() { if (current) { var value = current.value; current = current.next; return { done: false, value: value }; } else { return { done: true }; } } return iterator; } var one = new Obj(1); var two = new Obj(2); var three = new Obj(3); one.next = two; two.next = three; for (var i of one){ console.log(i); // 1, 2, 3 } |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 |
let obj = { data: [ 'hello', 'world' ], [Symbol.iterator]() { const self = this; let index = 0; return { next() { if (index < self.data.length) { return { value: self.data[index++], done: false }; } else { return { value: undefined, done: true }; } } }; } }; |
对于类似数组的对象(存在数值键名和length属性),部署 Iterator 接口,有一个简便方法,就是Symbol.iterator
方法直接引用数组的 Iterator 接口。
1 2 3 |
NodeList.prototype[Symbol.iterator] = Array.prototype[Symbol.iterator]; // 或者 NodeList.prototype[Symbol.iterator] = [][Symbol.iterator]; [...document.querySelectorAll('div')] // 可以执行了 |
NodeList 对象是类似数组的对象,本来就具有遍历接口,可以直接遍历。上面代码中,我们将它的遍历接口改成数组的Symbol.iterator属性,可以看到没有任何影响。
1 2 3 4 5 6 7 8 9 10 11 |
let iterable = { 0: 'a', 1: 'b', 2: 'c', length: 3, [Symbol.iterator]: Array.prototype[Symbol.iterator] }; for (let item of iterable) { console.log(item); // 'a', 'b', 'c' } |
1 2 3 4 5 6 7 8 9 10 11 12 |
// 普通对象部署数组的Symbol.iterator方法,并无效果。 let iterable = { a: 'a', b: 'b', c: 'c', length: 3, [Symbol.iterator]: Array.prototype[Symbol.iterator] }; for (let item of iterable) { console.log(item); // undefined, undefined, undefined } |
1 2 3 4 5 6 |
// 如果Symbol.iterator方法对应的不是遍历器生成函数(即会返回一个遍历器对象),解释引擎将会报错。 var obj = {}; obj[Symbol.iterator] = () => 1; [...obj] // TypeError: [] is not a function |
有了遍历器接口,数据结构就可以用for...of
循环遍历,也可以使用while循环遍历。
1 2 3 4 5 6 7 8 |
var $iterator = ITERABLE[Symbol.iterator](); var $result = $iterator.next(); while (!$result.done) { var x = $result.value; // ... $result = $iterator.next(); } |
ITERABLE
代表某种可遍历的数据结构,$iterator是它的遍历器对象。遍历器对象每次移动指针(next方法),都检查一下返回值的done属性,如果遍历还没结束,就移动遍历器对象的指针到下一步(next方法),不断循环。
调用 Iterator 接口的场合
有一些场合会默认调用 Iterator 接口(即Symbol.iterator
方法),除了for...of
循环,还有几个别的场合。
解构赋值
1 2 3 4 5 6 7 8 9 |
// 对数组和 Set 结构进行解构赋值时,会默认调用Symbol.iterator方法。 let set = new Set().add('a').add('b').add('c'); let [x,y] = set; // x='a'; y='b' let [first, ...rest] = set; // first='a'; rest=['b','c']; |
扩展运算符
扩展运算符(…)也会调用默认的 Iterator 接口。
1 2 3 4 5 6 7 8 9 |
// 例一 var str = 'hello'; [...str] // ['h','e','l','l','o'] // 例二 let arr = ['b', 'c']; ['a', ...arr, 'd'] // ['a', 'b', 'c', 'd'] |
只要某个数据结构部署了 Iterator 接口,就可以对它使用扩展运算符,将其转为数组。
yield*
yield*
后面跟的是一个可遍历的结构,它会调用该结构的遍历器接口。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 |
let generator = function* () { yield 1; yield* [2,3,4]; yield 5; }; var iterator = generator(); iterator.next() // { value: 1, done: false } iterator.next() // { value: 2, done: false } iterator.next() // { value: 3, done: false } iterator.next() // { value: 4, done: false } iterator.next() // { value: 5, done: false } iterator.next() // { value: undefined, done: true } |
其他场合
由于数组的遍历会调用遍历器接口,所以任何接受数组作为参数的场合,其实都调用了遍历器接口。比如:
- for…of
- Array.from()
- Map(), Set(), WeakMap(), WeakSet()(比如new Map([[‘a’,1],[‘b’,2]]))
- Promise.all()
- Promise.race()
字符串的 Iterator 接口
字符串是一个类似数组的对象,也原生具有 Iterator 接口。
1 2 3 4 5 6 7 8 9 10 |
var someString = "hi"; typeof someString[Symbol.iterator] // "function" var iterator = someString[Symbol.iterator](); iterator.next() // { value: "h", done: false } iterator.next() // { value: "i", done: false } iterator.next() // { value: undefined, done: true } |
覆盖原生的Symbol.iterator方法,可以修改遍历器的行为。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 |
var str = new String("hi"); [...str] // ["h", "i"] str[Symbol.iterator] = function() { return { next: function() { if (this._first) { this._first = false; return { value: "bye", done: false }; } else { return { done: true }; } }, _first: true }; }; [...str] // ["bye"] str // "hi" |
Symbol.iterator方法的最简单实现,还是使用 Generator 函数。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 |
let myIterable = { [Symbol.iterator]: function* () { yield 1; yield 2; yield 3; } } [...myIterable] // [1, 2, 3] // 或者采用下面的简洁写法 let obj = { * [Symbol.iterator]() { yield 'hello'; yield 'world'; } }; for (let x of obj) { console.log(x); } // "hello" // "world" |
遍历器对象的 return(),throw()
自己写遍历器对象生成函数时,next方法是必须的,return方法和throw方法是可选的。
return方法的使用场合是,如果for...of
循环提前退出(通常是因为出错,或者有break语句),就会调用return方法。如果一个对象在完成遍历前,需要清理或释放资源,就可以部署return方法。
return方法必须返回一个对象,这是 Generator 规格决定的。
throw方法主要是配合 Generator 函数使用,一般的遍历器对象用不到这个方法。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 |
function readLinesSync(file) { return { [Symbol.iterator]() { return { next() { return { done: false }; }, return() { file.close(); return { done: true }; } }; }, }; } |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 |
// 情况一,触发遍历器的return方法。 // 输出文件的第一行以后,就会执行return方法,关闭这个文件 for (let line of readLinesSync(fileName)) { console.log(line); break; } // 情况二,触发遍历器的return方法 // 执行return方法关闭文件之后,再抛出错误。 for (let line of readLinesSync(fileName)) { console.log(line); throw new Error(); } |
for…of循环
for...of
循环可以使用的范围包括数组、Set 和 Map 结构、某些类似数组的对象(比如arguments
对象、DOM NodeList 对象)、Generator 对象,以及字符串。
数组原生具备iterator接口(即默认部署了Symbol.iterator属性),for…of循环本质上就是调用这个接口产生的遍历器,可以用下面的代码证明。
1 2 3 4 5 6 7 8 9 10 11 12 13 |
const arr = ['red', 'green', 'blue']; for(let v of arr) { console.log(v); // red green blue } const obj = {}; obj[Symbol.iterator] = arr[Symbol.iterator].bind(arr); for(let v of obj) { console.log(v); // red green blue } |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 |
var arr = ['a', 'b', 'c', 'd']; // forEach获取键名和键值 arr.forEach((ele, idx)=>{ console.log(`idx: ${idx}, element: ${ele}`) }) // for...in获取键名 for (let a in arr) { console.log(a); // 0 1 2 3 } // for...of获取键值 // 如果要通过for...of循环,获取数组的索引,可以借助数组实例的entries方法和keys方法 for (let a of arr) { console.log(a); // a b c d } |
for...of
循环调用遍历器接口,数组的遍历器接口只返回具有数字索引的属性。这一点跟for...in
循环也不一样。
1 2 3 4 5 6 7 8 9 10 11 |
let arr = [3, 5, 7]; arr.foo = 'hello'; for (let i in arr) { console.log(i); // "0", "1", "2", "foo" } for (let i of arr) { console.log(i); // "3", "5", "7" } |
Set 和 Map 结构也原生具有 Iterator 接口,可以直接使用for...of
循环。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 |
var engines = new Set(["Gecko", "Trident", "Webkit", "Webkit"]); for (var e of engines) { console.log(e); } // Gecko // Trident // Webkit // 遍历的顺序是按照各个成员被添加进数据结构的顺序。下面的例子也一样 var es6 = new Map(); es6.set("edition", 6); es6.set("committee", "TC39"); es6.set("standard", "ECMA-262"); for (var [name, value] of es6) { console.log(name + ": " + value); } // edition: 6 // committee: TC39 // standard: ECMA-262 for (let pair of es6) { console.log(pair); } // ['edition', 6] // ['committee', 'TC39'] // ['standard', 'ECMA-262'] |
计算生成的数据结构
有些数据结构是在现有数据结构的基础上,计算生成的。比如,ES6 的数组、Set、Map 都部署了以下三个方法,调用后都返回遍历器对象。
entries()
返回一个遍历器对象,用来遍历[键名, 键值]组成的数组。对于数组,键名就是索引值;对于 Set,键名与键值相同。Map 结构的 Iterator 接口,默认就是调用entries方法。keys()
返回一个遍历器对象,用来遍历所有的键名。values()
返回一个遍历器对象,用来遍历所有的键值。
以上三个方法调用后生成的遍历器对象,所遍历的都是计算生成的数据结构。
1 2 3 4 5 6 7 8 |
let arr = ['a', 'b', 'c']; for (let pair of arr.entries()) { console.log(pair); } // [0, 'a'] // [1, 'b'] // [2, 'c'] |
类似数组的对象
类似数组的对象包括好几类。下面是for…of循环用于字符串、DOM NodeList 对象、arguments对象的例子。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 |
// 字符串 let str = "hello"; for (let s of str) { console.log(s); // h e l l o } // DOM NodeList对象 let paras = document.querySelectorAll("p"); for (let p of paras) { p.classList.add("test"); } // arguments对象 function printArgs() { for (let x of arguments) { console.log(x); } } printArgs('a', 'b'); // 'a' // 'b' |
对于字符串来说,for…of循环还有一个特点,就是会正确识别 32 位 UTF-16 字符。
1 2 3 4 5 6 |
for (let x of 'a\uD83D\uDC0A') { console.log(x); } // 'a' // '\uD83D\uDC0A' |
并不是所有类似数组的对象都具有 Iterator 接口,一个简便的解决方法,就是使用Array.from
方法将其转为数组。
1 2 3 4 5 6 7 8 9 10 11 12 |
let arrayLike = { length: 2, 0: 'a', 1: 'b' }; // 报错 for (let x of arrayLike) { console.log(x); } // 正确 for (let x of Array.from(arrayLike)) { console.log(x); } |
遍历对象,可以使用for…in
,但不能直接使用for...of
。不过,可以配合使用Object.keys
来达到目的。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 |
for (var key of Object.keys(someObject)) { console.log(key + ': ' + someObject[key]); } // 或者,用Generator函数包装一下 function* entries(obj) { for (let key of Object.keys(obj)) { yield [key, obj[key]]; } } for (let [key, value] of entries(obj)) { console.log(key, '->', value); } // a -> 1 // b -> 2 // c -> 3 |
JavaScript中的其他遍历方法
- for循环。缺点: 写法麻烦
- 数组内置的
forEach
方法。缺点: 无法中途跳出循环,break
和return
不能让代码退出循环 for...in
循环,适合遍历对象,不适合遍历数组。缺点: 遍历数组的时候,键名是”0″,”1″,”2″等字符串,而数组的键名应该是数字。另外,这种方式不仅遍历数组的数字键名,还会遍历其他手动添加的键,甚至是原型链上的键。最后,某些情况下,for…in循环会以任意顺序遍历键名。for...of
循环。可以与break
、continue
、return
配合使用。
1 2 3 4 5 6 |
for (var n of fibonacci) { if (n > 1000) break; console.log(n); } |