TypeScript 迭代器(iterator)和生成器(generator)
⒈迭代器(iterator)
1.可迭代性
当一个对象实现了Symbol.iterator
属性时,我们认为它是可迭代的。 一些内置的类型如 Array
,Map
,Set
,String
,Int32Array
,Uint32Array
等都已经实现了各自的Symbol.iterator
。 对象上的 Symbol.iterator
函数负责返回供迭代的值。
2.for..of语句
for..of
会遍历可迭代的对象,调用对象上的Symbol.iterator
方法。 下面是在数组上使用 for..of
的简单例子:
let array = [7, "fanqi", true]; for (let item of array) { console.log(item); // 7, "fanqi", true }
3.for..of
vs. for..in
语句
for..of
和for..in
均可迭代一个列表,但它们之间的区别很大,最明显的区别莫过于它们用于迭代的值不同,for..in
迭代的是对象键的列表,而for..of
迭代的是对象值的列表。
下面的例子展示了两者之间的区别:
let list = [4, 5, 6]; for (let i in list) { console.log(i); // "0", "1", "2", } for (let i of list) { console.log(i); // "4", "5", "6" }
另一个区别是for..in
可以操作任何对象;它提供了查看对象属性的一种方法。 但是 for..of
关注于迭代对象的值。内置对象Map
和Set
已经实现了Symbol.iterator
方法,让我们可以访问它们保存的值。
let pets = new Set(["Cat", "Dog", "Hamster"]); pets["species"] = "mammals"; for (let pet in pets) { console.log(pet); // "species" } for (let pet of pets) { console.log(pet); // "Cat", "Dog", "Hamster" }
但这样的特性仅仅在ES6及以上才生效。
当我们将TypeScript的代码生成目标设定为ES5或ES3,迭代器就只允许在Array
类型上使用。 在非数组值上使用 for..of
语句会得到一个错误,即使这些非数组值已经实现了Symbol.iterator
属性也是不可以的。
编译器会生成一个简单的for
循环做为for..of
循环,比如:
let numbers = [1, 2, 3]; for (let num of numbers) { console.log(num); }
生成的代码为:
var numbers = [1, 2, 3]; for (var _i = 0; _i < numbers.length; _i++) { var num = numbers[_i]; console.log(num); }
当目标设定为兼容ECMAScipt 2015或更高的引擎时,编译器会生成相应引擎的for..of
内置迭代器实现方式。
⒉生成器(generator)
function* 是用来创建generator函数的语法(在MDN的文档中generator称为生成器)
调用generator函数时会返回一个generator对象。generator对象遵循迭代器接口,即通常所见到的next、return和throw函数。
generator函数用于创建懒迭代器,例如下面的这个函数可以返回一个无限整数的列表:
function* infiniteList(){ let i = 0; while(true){ yield i++; } } const iterator = infiniteList(); while(true){ console.log(iterator.next()); //{ value: xxxx, done: false } }
当然,也可以设定某个条件终止它,而不只是永远循环下去。如下所示:
function* infiniteList(){ let i = 0; while(i < 3){ yield i++; } } const iterator = infiniteList(); while(true){ console.log(iterator.next()); //{ value: xxxx, done: false } }
可以说这个设定是generator中最令人兴奋的部分。它在实质上允许一个函数可以暂停执行,比如当我们执行了第一次的iterator.next()后,可以先去做别的事,再回来继续执行iterator.next(),这样剩余函数的控制权就交给了调用者。
当你直接调用generator函数时,它并不会执行,它只会创建一个generator对象。
在下面的例子中,我们可以看到一个更灵活的使用方式:
function* generator(){ console.log('开始执行'); yield 0; console.log('执行暂停'); yield 1; console.log('执行结束'); } const iterator = generator(); console.log(iterator.next()); console.log('a'); console.log(iterator.next()); console.log('b'); console.log(iterator.next()); console.log('c');
执行它则会看到如下输出结果:
开始执行 { value: 0, done: false } a 执行暂停 { value: 1, done: false } b 执行结束 { value: undefined, done: true } c
从上面代码可以得知:
-
- generator对象只会在调用next()时开始执行。
- 函数在执行到yield语句时会暂停并返回yield的值。
- 函数在next被调用时继续恢复执行。
所以实质上generator函数的执行与否是由外部的generator对象控制的。
不过除了yield传值到外部,我们也可以通过next传值到内部进行调用。下面的例子展示了iterator.next传值的方式:
function* generator(){ let y = yield; console.log(`'Hello ${y}'`); } const iterator = generator(); console.log(iterator.next()); console.log('a'); console.log(iterator.next('fanqi'));
执行它则会看到如下输出结果:
{ value: undefined, done: false } a 'Hello fanqi' { value: undefined, done: true }
以上便是next和return函数的内容,接下来我们来看一下throw函数如何处理迭代器内部报错。
下面是一个iterator.throw的例子:
function* generator(){ try{ yield 1; } catch(error){ console.log(error.message); } } const iterator = generator(); console.log(iterator.next()); console.log('a'); console.log(iterator.throw(new Error('未知的错误发生!')));
执行它则会看到如下输出结果:
{ value: 1, done: false } a 未知的错误发生! { value: undefined, done: true }
通过以上的案例我们可以得知,外部是可以对generator内部进行干涉的:
-
- 外部系统可以传递一个值到generator函数体中。
- 外部系统可以抛入一个异常到generator函数体中。