它是一种接口,为各种
不同的数据
结构提供统一的访问机制
。任何数据结构只要部署Iterator
接口,就可以完成遍历操作(即依次处理该数据结构的所有成员)。
Iterator 的作用
- 1、为各种数据结构,提供一个统一的、简便的访问接口
- 2、使得数据结构的成员能够按某种次序排列
- 3、ES6 创造了一种新的遍历命令for…of循环,Iterator 接口主要供for…of消费
Iterator 的遍历过程
- (1)创建一个指针对象,指向当前数据结构的
起始位置
,也就是说,遍历器对象本质上,就是一个指针对象
- (2)第一次调用指针对象的
next
方法,可以将指针指向数据结构的第一个成员 - (3)第二次调用指针对象的
next
方法,指针就指向数据结构的第二个成员 - (4)不断调用指针对象的
next
方法,直到它指向数据结构的结束位置
每一次调用next方法,都会返回数据结构的当前成员的信息,包含
value
和done
两个属性的对象
value
属性是当前成员的值
done
属性是一个布尔值,表示遍历是否结束
只要done
返回true
,value
就是undefined
模拟next,写法特别经典
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} :
{value: undefined, done: true};
}
};
}
复制代码
从上面代码可以看出,遍历器与它所遍历的那个数据结构,实际上是分开的(不是同一个对象)
,完全可以用遍历器对象模拟出数据结构。
无限运行的遍历器对象的例子
var it = idMaker();
it.next().value // 0
it.next().value // 1
it.next().value // 2
// ...
function idMaker() {
var index = 0;
return {
next: function() {
return {value: index++, done: false};
}
};
}
复制代码
默认 Iterator 接口
Iterator
接口的目的,就是为所有数据结构,提供了一种统一的访问机制,即for...of
循环
当使用for...of
循环遍历某种数据结构时,该循环会自动去寻找 Iterator
接口。
一种数据结构只要部署了 Iterator
接口,我们就称这种数据结构是“可遍历的”(iterable)
。
ES6
规定,Iterator
接口默认部署在数据结构的Symbol.iterator
属性
一个数据结构只要具有
Symbol.iterator
属性,就可以认为是“可遍历的”
(iterable)
- 1、
Symbol.iterator
属性本身是一个函数,就是当前数据结构默认的遍历器生成函数。执行这个函数,就会返回一个遍历器 - 2、属性名
Symbol.iterator
,必须要放在方括号内
属性名Symbol.iterator
它是一个表达式
,返回Symbol对象的iterator属性
,这是一个预定义好的
、类型为Symbol
的特殊值,所以必须
要放在方括号内
const obj = {
[Symbol.iterator] : function () {
return {
next: function () {
return {
value: 1,
done: true
};
}
};
}
};
复制代码
上面代码中,对象
obj
因为具有Symbol.iterator
属性所以是可遍历的(iterable)。执行这个属性,会返回一个遍历器对象。
Symbol.iterator对象的根本特征
就是具有next方法
每次调用
next
方法,都会返回一个代表当前成员的信息对象,具有value
和done
两个属性。
原生具备 Iterator 接口
以下数据结构原生部署了Symbol.iterator属性,不用任何处理,就可以被for...of
循环遍历
- Array : let iter = arr
[Symbol.iterator]
() - Map : let iter = m
[Symbol.iterator]
() - Set
- String
- TypedArray
- 函数的 arguments 对象
- NodeList 对象
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
的属性上部署遍历器生成方法(原型链上的对象具有该方法也可)。
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 };
}
}
};
}
};
复制代码
对于”类数组”的对象(类数组转化为数组遍历)
简便方法是类数组Symbol.iterator方法直接引用数组的 Iterator 接口,NodeList.prototype[Symbol.iterator] = Array.prototype[Symbol.iterator];
对于类数组
(存在数值键名
和length
属性),部署 Iterator
接口,有一个简便方法,就是Symbol.iterator
方法直接引用数组的 Iterator
接口。
NodeList.prototype[Symbol.iterator] = Array.prototype[Symbol.iterator];
// 或者
NodeList.prototype[Symbol.iterator] = [][Symbol.iterator];
[...document.querySelectorAll('div')] // 可以执行了
复制代码
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'
}
复制代码
注意
,普通对象部署数组的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
}
复制代码
有了遍历器接口也可以使用while循环遍历
let iterable = {
a: 'a',
b: 'b',
c: 'c',
length: 3
};
var $iterator = iterable[Symbol.iterator]();
var $result = $iterator.next();
while (!$result.done) {
var x = $result.value;
// ...
$result = $iterator.next();
}
复制代码
上面代码中,ITERABLE
代表某种可遍历的数据结构,$iterator
是它的遍历器对象。
会默认调用 Iterator 接口的场合
(1)解构赋值(对数组和Set
结构进行解构赋值)
对数组和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'];
复制代码
(2)扩展运算符(…)
扩展运算符(...
)也会调用默认的 Iterator
接口。
// 例一
var str = 'hello';
[...str] // ['h','e','l','l','o']
// 例二
let arr = ['b', 'c'];
['a', ...arr, 'd']
// ['a', 'b', 'c', 'd']
复制代码
扩展运算符(...
)可以将任何部署了 Iterator 接口的数据结构,转为数组。
let arr = [...iterable];
复制代码
(3)yield*
yield*
后面跟的是一个可遍历的结构,它会调用该结构的遍历器接口。
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 }
复制代码
(4)其他场合(任何接受数组作为参数的场合)
由于数组的遍历会调用遍历器接口,所以任何接受数组作为参数的场合
,其实都调用了遍历器接口
。下面是一些例子。
- for…of
- Array.from()
- Map(), Set(), WeakMap(), WeakSet()(比如new Map([[‘a’,1],[‘b’,2]]))
- Promise.all()
- Promise.race()
字符串的 Iterator 接口
字符串是一个类似数组的对象,也原生具有 Iterator 接口
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方法,达到修改遍历器行为的目的
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"
复制代码
Iterator 接口与 Generator 函数
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"
复制代码
上面代码中,Symbol.iterator
方法几乎不用部署任何代码,只要用 yield 命令给出每一步的返回值即可。
遍历器对象的 return(),throw()
return方法的使用场合:
如果for...of
循环提前退出(通常是因为出错,或者有break
语句),就会调用return
方法
throw
方法主要是配合 Generator
函数使用,一般的遍历器对象用不到这个方法
function readLinesSync(file) {
return {
[Symbol.iterator]() {
return {
next() {
return { done: false };
},
return() {
file.close();
return { done: true };
}
};
},
};
}
复制代码
下面的两种情况,都会触发执行return方法。
// 情况一
for (let line of readLinesSync(fileName)) {
console.log(line);
break;
}
// 情况二
for (let line of readLinesSync(fileName)) {
console.log(line);
throw new Error();
}
复制代码
情况一输出文件的第一行以后,就会执行return方法,关闭这个文件;情况二会在执行return方法关闭文件之后,再抛出错误。
for…of 循环,遍历所有数据结构的统一的方法
作为遍历所有数据结构的统一的方法。
一个数据结构只要部署了Symbol.iterator
属性,就被视为具有 iterator
接口,就可以用for...of
循环遍历它的成员。
也就是说,for...of
循环内部调用的是数据结构的Symbol.iterator
方法。
for...of
循环可以使用的范围,只要部署了Symbol.iterator属性
- 数组
Set
Map
结构- 某些类似数组的对象(比如
arguments
对象、DOM NodeList
对象)、后文的Generator
对象,以及字符串
对于普通的对象
,for...of
结构不能直接使用,会报错
必须部署了 Iterator 接口后才能使用。但是,这样情况下,
for...in
循环依然可以用来遍历键名
let es6 = {
edition: 6,
committee: "TC39",
standard: "ECMA-262"
};
for (let e in es6) {
console.log(e);
}
// edition
// committee
// standard
for (let e of es6) {
console.log(e);
}
// TypeError: es6[Symbol.iterator] is not a function
复制代码
与其他遍历语法的比较
for循环
这种写法比较麻烦
for (var index = 0; index < myArray.length; index++) {
console.log(myArray[index]);
}
复制代码
forEach方法,无法中途跳出forEach循环,break命令或return命令都不能奏效
myArray.forEach(function (value) {
console.log(value);
});
复制代码
for…in循环可以遍历数组的键名,主要是为遍历对象
而设计的,不适用于遍历数组
for...in
循环有几个缺点。
- 数组的键名是数字,但是
for...in
循环是以字符串作为键名
“0”、“1”、“2”等等。 for...in
循环不仅遍历数字键名,还会遍历手动添加的其他键,甚至包括原型链上的键。- 某些情况下,
for...in
循环会以任意顺序遍历键名。
总之,for...in
循环主要是为遍历对象
而设计的,不适用于遍历数组
。
for…of循环相比上面几种做法,有一些显著的优点
for (let value of myArray) {
console.log(value);
}
复制代码
- 1、有着同
for...in
一样的简洁语法,但是没有for...in
那些缺点 - 2、不同于
forEach
方法,它可以与break、continue和return
配合使用 - 3、提供了遍历所有数据结构的统一操作接口
- 4、可以使用return、 break 语句,跳出for…of循环