第7 章 迭代器与生成器

本章内容
 理解迭代
 迭代器模式
 生成器
迭代的英文“iteration”源自拉丁文itero，意思是“重复”或“再来”。在软件开发领域，“迭代”
的意思是按照顺序反复多次执行一段程序，通常会有明确的终止条件。ECMAScript 6 规范新增了两个高
级特性：迭代器和生成器。使用这两个特性，能够更清晰、高效、方便地实现迭代。

7.1 理解迭代

在JavaScript 中，计数循环就是一种最简单的迭代：
循环是迭代机制的基础，这是因为它可以指定迭代的次数，以及每次迭代要执行什么操作。每次循
环都会在下一次迭代开始之前完成，而每次迭代的顺序都是事先定义好的。
迭代会在一个有序集合上进行。（“有序”可以理解为集合中所有项都可以按照既定的顺序被遍历
到，特别是开始和结束项有明确的定义。）数组是JavaScript 中有序集合的最典型例子。
因为数组有已知的长度，且数组每一项都可以通过索引获取，所以整个数组可以通过递增索引来遍历。
由于如下原因，通过这种循环来执行例程并不理想。
 迭代之前需要事先知道如何使用数据结构。数组中的每一项都只能先通过引用取得数组对象，
然后再通过[]操作符取得特定索引位置上的项。这种情况并不适用于所有数据结构。
 遍历顺序并不是数据结构固有的。通过递增索引来访问数据是特定于数组类型的方式，并不适
用于其他具有隐式顺序的数据结构。
ES5 新增了Array.prototype.forEach()方法，向通用迭代需求迈进了一步（但仍然不够理想）：
这个方法解决了单独记录索引和通过数组对象取得值的问题。不过，没有办法标识迭代何时终止。
因此这个方法只适用于数组，而且回调结构也比较笨拙。
在ECMAScript 较早的版本中，执行迭代必须使用循环或其他辅助结构。随着代码量增加，代码会
变得越发混乱。很多语言都通过原生语言结构解决了这个问题，开发者无须事先知道如何迭代就能实现
迭代操作。这个解决方案就是迭代器模式。Python、Java、C++，还有其他很多语言都对这个模式提供
了完备的支持。JavaScript 在ECMAScript 6 以后也支持了迭代器模式。

7.2 迭代器模式

迭代器模式（特别是在ECMAScript 这个语境下）描述了一个方案，即可以把有些结构称为“可迭
代对象”（iterable），因为它们实现了正式的Iterable 接口，而且可以通过迭代器Iterator 消费。
可迭代对象是一种抽象的说法。基本上，可以把可迭代对象理解成数组或集合这样的集合类型的对
象。它们包含的元素都是有限的，而且都具有无歧义的遍历顺序：
不过，可迭代对象不一定是集合对象，也可以是仅仅具有类似数组行为的其他数据结构，比如本章
开头提到的计数循环。该循环中生成的值是暂时性的，但循环本身是在执行迭代。计数循环和数组都具
有可迭代对象的行为。
注意 临时性可迭代对象可以实现为生成器，本章后面会讨论。
任何实现Iterable 接口的数据结构都可以被实现Iterator 接口的结构“消费”（consume）。迭
代器（iterator）是按需创建的一次性对象。每个迭代器都会关联一个可迭代对象，而迭代器会暴露迭代
其关联可迭代对象的API。迭代器无须了解与其关联的可迭代对象的结构，只需要知道如何取得连续的
值。这种概念上的分离正是Iterable 和Iterator 的强大之处。

7.2.1 可迭代协议

实现Iterable 接口（可迭代协议）要求同时具备两种能力：支持迭代的自我识别能力和创建实现
Iterator 接口的对象的能力。在ECMAScript 中，这意味着必须暴露一个属性作为“默认迭代器”，而
且这个属性必须使用特殊的Symbol.iterator 作为键。这个默认迭代器属性必须引用一个迭代器工厂
函数，调用这个工厂函数必须返回一个新迭代器。
很多内置类型都实现了Iterable 接口：
 字符串
 数组
映射
 集合
 arguments 对象
 NodeList 等DOM 集合类型
检查是否存在默认迭代器属性可以暴露这个工厂函数：
实际写代码过程中，不需要显式调用这个工厂函数来生成迭代器。实现可迭代协议的所有类型都会
自动兼容接收可迭代对象的任何语言特性。接收可迭代对象的原生语言特性包括：
 for-of 循环
 数组解构
 扩展操作符
 Array.from()
 创建集合
 创建映射
 Promise.all()接收由期约组成的可迭代对象
 Promise.race()接收由期约组成的可迭代对象
 yield*操作符，在生成器中使用
这些原生语言结构会在后台调用提供的可迭代对象的这个工厂函数，从而创建一个迭代器：
如果对象原型链上的父类实现了Iterable 接口，那这个对象也就实现了这个接口：

7.2.2 迭代器协议

迭代器是一种一次性使用的对象，用于迭代与其关联的可迭代对象。迭代器API 使用next()方法
在可迭代对象中遍历数据。每次成功调用next()，都会返回一个IteratorResult 对象，其中包含迭
代器返回的下一个值。若不调用next()，则无法知道迭代器的当前位置。
next()方法返回的迭代器对象IteratorResult 包含两个属性：done 和value。done 是一个布
尔值，表示是否还可以再次调用next()取得下一个值；value 包含可迭代对象的下一个值（done 为
false），或者undefined（done 为true）。done: true 状态称为“耗尽”。可以通过以下简单的数
组来演示：
这里通过创建迭代器并调用next()方法按顺序迭代了数组，直至不再产生新值。迭代器并不知道
怎么从可迭代对象中取得下一个值，也不知道可迭代对象有多大。只要迭代器到达done: true 状态，
后续调用next()就一直返回同样的值了：
每个迭代器都表示对可迭代对象的一次性有序遍历。不同迭代器的实例相互之间没有联系，只会独
立地遍历可迭代对象：
迭代器并不与可迭代对象某个时刻的快照绑定，而仅仅是使用游标来记录遍历可迭代对象的历程。
如果可迭代对象在迭代期间被修改了，那么迭代器也会反映相应的变化：
注意 迭代器维护着一个指向可迭代对象的引用，因此迭代器会阻止垃圾回收程序回收可
迭代对象。
“迭代器”的概念有时候容易模糊，因为它可以指通用的迭代，也可以指接口，还可以指正式的迭
代器类型。下面的例子比较了一个显式的迭代器实现和一个原生的迭代器实现。

7.2.3 自定义迭代器

与Iterable 接口类似，任何实现Iterator 接口的对象都可以作为迭代器使用。下面这个例子中
的Counter 类只能被迭代一定的次数：
这个类实现了Iterator 接口，但不理想。这是因为它的每个实例只能被迭代一次：
为了让一个可迭代对象能够创建多个迭代器，必须每创建一个迭代器就对应一个新计数器。为此，
可以把计数器变量放到闭包里，然后通过闭包返回迭代器：
每个以这种方式创建的迭代器也实现了Iterable 接口。Symbol.iterator 属性引用的工厂函数
会返回相同的迭代器：
因为每个迭代器也实现了Iterable 接口，所以它们可以用在任何期待可迭代对象的地方，比如
for-of 循环：

7.2.4 提前终止迭代器

可选的return()方法用于指定在迭代器提前关闭时执行的逻辑。执行迭代的结构在想让迭代器知
道它不想遍历到可迭代对象耗尽时，就可以“关闭”迭代器。可能的情况包括：
 for-of 循环通过break、continue、return 或throw 提前退出；
 解构操作并未消费所有值。
return()方法必须返回一个有效的IteratorResult 对象。简单情况下，可以只返回{ done: true }。
因为这个返回值只会用在生成器的上下文中，所以本章后面再讨论这种情况。
如下面的代码所示，内置语言结构在发现还有更多值可以迭代，但不会消费这些值时，会自动调用
return()方法。
如果迭代器没有关闭，则还可以继续从上次离开的地方继续迭代。比如，数组的迭代器就是不能关
闭的：
因为return()方法是可选的，所以并非所有迭代器都是可关闭的。要知道某个迭代器是否可关闭，
可以测试这个迭代器实例的return 属性是不是函数对象。不过，仅仅给一个不可关闭的迭代器增加这
个方法并不能让它变成可关闭的。这是因为调用return()不会强制迭代器进入关闭状态。即便如此，
return()方法还是会被调用。

7.3 生成器

生成器是ECMAScript 6 新增的一个极为灵活的结构，拥有在一个函数块内暂停和恢复代码执行的
能力。这种新能力具有深远的影响，比如，使用生成器可以自定义迭代器和实现协程。

7.3.1 生成器基础

生成器的形式是一个函数，函数名称前面加一个星号（*）表示它是一个生成器。只要是可以定义
函数的地方，就可以定义生成器。
注意 箭头函数不能用来定义生成器函数。
标识生成器函数的星号不受两侧空格的影响：
调用生成器函数会产生一个生成器对象。生成器对象一开始处于暂停执行（suspended）的状态。与
迭代器相似，生成器对象也实现了Iterator 接口，因此具有next()方法。调用这个方法会让生成器
开始或恢复执行。
next()方法的返回值类似于迭代器，有一个done 属性和一个value 属性。函数体为空的生成器
函数中间不会停留，调用一次next()就会让生成器到达done: true 状态。
value 属性是生成器函数的返回值，默认值为undefined，可以通过生成器函数的返回值指定：
生成器函数只会在初次调用next()方法后开始执行，如下所示：
生成器对象实现了Iterable 接口，它们默认的迭代器是自引用的：

7.3.2 通过yield 中断执行

yield 关键字可以让生成器停止和开始执行，也是生成器最有用的地方。生成器函数在遇到yield
关键字之前会正常执行。遇到这个关键字后，执行会停止，函数作用域的状态会被保留。停止执行的生
成器函数只能通过在生成器对象上调用next()方法来恢复执行：
此时的yield 关键字有点像函数的中间返回语句，它生成的值会出现在next()方法返回的对象里。
通过yield 关键字退出的生成器函数会处在done: false 状态；通过return 关键字退出的生成器函
数会处于done: true 状态。
生成器函数内部的执行流程会针对每个生成器对象区分作用域。在一个生成器对象上调用next()
不会影响其他生成器：

yield 关键字只能在生成器函数内部使用，用在其他地方会抛出错误。类似函数的return 关键字，
yield 关键字必须直接位于生成器函数定义中，出现在嵌套的非生成器函数中会抛出语法错误：
1. 生成器对象作为可迭代对象
在生成器对象上显式调用next()方法的用处并不大。其实，如果把生成器对象当成可迭代对象，
那么使用起来会更方便：
在需要自定义迭代对象时，这样使用生成器对象会特别有用。比如，我们需要定义一个可迭代对象，
而它会产生一个迭代器，这个迭代器会执行指定的次数。使用生成器，可以通过一个简单的循环来实现：
传给生成器的函数可以控制迭代循环的次数。在n 为0 时，while 条件为假，循环退出，生成器函
数返回。
2. 使用yield 实现输入和输出
除了可以作为函数的中间返回语句使用，yield 关键字还可以作为函数的中间参数使用。上一次让
生成器函数暂停的yield 关键字会接收到传给next()方法的第一个值。这里有个地方不太好理解——
第一次调用next()传入的值不会被使用，因为这一次调用是为了开始执行生成器函数：
yield 关键字可以同时用于输入和输出，如下例所示：
因为函数必须对整个表达式求值才能确定要返回的值，所以它在遇到yield 关键字时暂停执行并
计算出要产生的值："foo"。下一次调用next()传入了"bar"，作为交给同一个yield 的值。然后这
个值被确定为本次生成器函数要返回的值。
yield 关键字并非只能使用一次。比如，以下代码就定义了一个无穷计数生成器函数：
假设我们想定义一个生成器函数，它会根据配置的值迭代相应次数并产生迭代的索引。初始化一个
新数组可以实现这个需求，但不用数组也可以实现同样的行为：
另外，使用while 循环也可以，而且代码稍微简洁一点：
这样使用生成器也可以实现范围和填充数组：
3. 产生可迭代对象
可以使用星号增强yield 的行为，让它能够迭代一个可迭代对象，从而一次产出一个值：
与生成器函数的星号类似，yield 星号两侧的空格不影响其行为：
因为yield*实际上只是将一个可迭代对象序列化为一连串可以单独产出的值，所以这跟把yield
放到一个循环里没什么不同。下面两个生成器函数的行为是等价的：
yield*的值是关联迭代器返回done: true 时的value 属性。对于普通迭代器来说，这个值是
undefined：
对于生成器函数产生的迭代器来说，这个值就是生成器函数返回的值：
4. 使用yield*实现递归算法
yield*最有用的地方是实现递归操作，此时生成器可以产生自身。看下面的例子：
在这个例子中，每个生成器首先都会从新创建的生成器对象产出每个值，然后再产出一个整数。结
果就是生成器函数会递归地减少计数器值，并实例化另一个生成器对象。从最顶层来看，这就相当于创
建一个可迭代对象并返回递增的整数。
使用递归生成器结构和yield*可以优雅地表达递归算法。下面是一个图的实现，用于生成一个随
机的双向图：
图数据结构非常适合递归遍历，而递归生成器恰好非常合用。为此，生成器函数必须接收一个可迭
代对象，产出该对象中的每一个值，并且对每个值进行递归。这个实现可以用来测试某个图是否连通，
即是否没有不可到达的节点。只要从一个节点开始，然后尽力访问每个节点就可以了。结果就得到了一
个非常简洁的深度优先遍历：
7.3.3 生成器作为默认迭代器
因为生成器对象实现了Iterable 接口，而且生成器函数和默认迭代器被调用之后都产生迭代器，
所以生成器格外适合作为默认迭代器。下面是一个简单的例子，这个类的默认迭代器可以用一行代码产
出类的内容：
这里，for-of 循环调用了默认迭代器（它恰好又是一个生成器函数）并产生了一个生成器对象。
这个生成器对象是可迭代的，所以完全可以在迭代中使用。

7.3.4 提前终止生成器

与迭代器类似，生成器也支持“可关闭”的概念。一个实现Iterator 接口的对象一定有next()
方法，还有一个可选的return()方法用于提前终止迭代器。生成器对象除了有这两个方法，还有第三
个方法：throw()。
return()和throw()方法都可以用于强制生成器进入关闭状态。
1. return()
return()方法会强制生成器进入关闭状态。提供给return()方法的值，就是终止迭代器对象的值：
与迭代器不同，所有生成器对象都有return()方法，只要通过它进入关闭状态，就无法恢复了。
后续调用next()会显示done: true 状态，而提供的任何返回值都不会被存储或传播：

这里，for-of 循环调用了默认迭代器（它恰好又是一个生成器函数）并产生了一个生成器对象。
这个生成器对象是可迭代的，所以完全可以在迭代中使用。

7.3.4 提前终止生成器

与迭代器类似，生成器也支持“可关闭”的概念。一个实现Iterator 接口的对象一定有next()
方法，还有一个可选的return()方法用于提前终止迭代器。生成器对象除了有这两个方法，还有第三
个方法：throw()。
return()和throw()方法都可以用于强制生成器进入关闭状态。
1. return()
return()方法会强制生成器进入关闭状态。提供给return()方法的值，就是终止迭代器对象的值：
与迭代器不同，所有生成器对象都有return()方法，只要通过它进入关闭状态，就无法恢复了。
后续调用next()会显示done: true 状态，而提供的任何返回值都不会被存储或传播：
for-of 循环等内置语言结构会忽略状态为done: true 的IteratorObject 内部返回的值。
2. throw()
throw()方法会在暂停的时候将一个提供的错误注入到生成器对象中。如果错误未被处理，生成器
就会关闭：

JavaScript

function* generatorFn() {

for (const x of [1, 2, 3]) {

yield x;

}

}

const g = generatorFn();

console.log(g); // generatorFn {<suspended>}

try {

g.throw('foo');

} catch (e) {

console.log(e); // foo

}

console.log(g); // generatorFn {<closed>}

不过，假如生成器函数内部处理了这个错误，那么生成器就不会关闭，而且还可以恢复执行。错误
处理会跳过对应的yield，因此在这个例子中会跳过一个值。比如：

JavaScript

function* generatorFn() {

for (const x of [1, 2, 3]) {

try {

yield x;

} catch(e) {}

}

}

const g = generatorFn();

console.log(g.next()); // { done: false, value: 1}

g.throw('foo');

console.log(g.next()); // { done: false, value: 3}

在这个例子中，生成器在try/catch 块中的yield 关键字处暂停执行。在暂停期间，throw()方
法向生成器对象内部注入了一个错误：字符串"foo"。这个错误会被yield 关键字抛出。因为错误是在
生成器的try/catch 块中抛出的，所以仍然在生成器内部被捕获。可是，由于yield 抛出了那个错误，
生成器就不会再产出值2。此时，生成器函数继续执行，在下一次迭代再次遇到yield 关键字时产出了
值3。
注意 如果生成器对象还没有开始执行，那么调用throw()抛出的错误不会在函数内部被
捕获，因为这相当于在函数块外部抛出了错误。

7.4 小结

迭代是一种所有编程语言中都可以看到的模式。ECMAScript 6 正式支持迭代模式并引入了两个新的
语言特性：迭代器和生成器。
迭代器是一个可以由任意对象实现的接口，支持连续获取对象产出的每一个值。任何实现Iterable
接口的对象都有一个Symbol.iterator 属性，这个属性引用默认迭代器。默认迭代器就像一个迭代器
工厂，也就是一个函数，调用之后会产生一个实现Iterator 接口的对象。
迭代器必须通过连续调用next()方法才能连续取得值，这个方法返回一个IteratorObject。这
个对象包含一个done 属性和一个value 属性。前者是一个布尔值，表示是否还有更多值可以访问；后
者包含迭代器返回的当前值。这个接口可以通过手动反复调用next()方法来消费，也可以通过原生消
费者，比如for-of 循环来自动消费。
生成器是一种特殊的函数，调用之后会返回一个生成器对象。生成器对象实现了Iterable 接口，
因此可用在任何消费可迭代对象的地方。生成器的独特之处在于支持yield 关键字，这个关键字能够
暂停执行生成器函数。使用yield 关键字还可以通过next()方法接收输入和产生输出。在加上星号之
后，yield 关键字可以将跟在它后面的可迭代对象序列化为一连串值。