Regenerator

定义

Regenerator 是一个源码转换（source transformation）工具，作用是把生成器函数、yield 表达式、以及异步迭代（Asynchronous Iteration）相关语法，转换成等价的 ES5 代码^[1]。转换后的代码在行为上与原生生成器一致，因此可以在尚未实现生成器的旧版 JavaScript 引擎里运行^[1]。它并不处理 ES6 的全部新特性，只专注于生成函数这一件事，因此使用者不必为了获得生成器支持而引入整套运行时。

原理

转换的核心思路是把生成函数改写成一个状态机^[3]。转换器先分析函数体的控制流，找出所有 yield 暂停点，再按这些暂停点把函数体切分为若干状态，每个状态对应生成代码里 switch 语句的一个 case 分支^[4]。生成代码通过读取上下文对象（context）上的 next 属性来决定跳转到哪个分支，从而模拟出函数的暂停与恢复^[4]。

最外层由 regeneratorRuntime.wrap 包裹这个状态机，wrap 负责实现生成器协议中的 next、return、throw 等方法，并保存两次恢复之间的内部状态^[2]。承担状态机生成工作的核心类是 Emitter，它维护可跳转位置表、try/catch/finally 条目列表以及 break、continue、return 等控制流的处理逻辑^[4]。对于异步函数，转换分两步进行：先把 async 函数改写为生成函数，再对生成函数施加同一套状态机转换，以便复用已有的基础设施^[2]。

整个流水线由解析、转换、代码生成和运行时注入 4 个阶段组成：源码先解析为抽象语法树，由 regenerator-transform 完成状态机改写，再重新生成代码字符串，并按需附带运行时辅助函数^[2]。在 Babel 集成形态下，解析与代码生成分别由 @babel/parser 和 @babel/generator 承担^[4]。项目早期依赖 Esprima 解析器，以及自行维护的 ast-types 和 recast 两个抽象语法树操作库。

发展历程

Regenerator 由 Facebook JavaScript 基础设施团队开发，代码仓库创建于 2013 年 10 月 5 日^[5]。主要作者 Ben Newman 在 2013 年 11 月的 ECMAScript 讨论邮件列表中说明，该工具大约在两周前于 Hacker News 上公布，当时已获得 328 个 GitHub 星标、21 次 fork 和 9 位贡献者^[6]。同期出现的配套项目包括浏览器化转换器 regeneratorify 与命令行包装 gnode^[6]。

该项目随后被拆分为多个包：负责转换的 regenerator-transform、提供运行时支持的 regenerator-runtime，以及把转换配置整合起来的 regenerator-preset^[2]。早期版本说明中把目标语法描述为实验性实现于 Node.js v0.11 的 ES6 生成器，后来的说明改为对应 ECMAScript 2015 标准与异步迭代提案^[1]。

授权方面，仓库内的 regenerator-runtime 文件标注的版权年份为 2014 年，最初采用 BSD 风格许可^[7]。相关议题记录显示，在与 Babel 7 发布配套的协调过程中，代码以 MIT 许可重新发布到 npm^[7]。代码托管页面显示该仓库已被所有者归档^[5]。

应用

命令行是直接使用方式之一，可对单个文件或整个目录执行转换，并通过选项决定是否把运行时一并写入输出。它还提供编程接口，支持直接输出转换后的代码字符串，或对已有的抽象语法树执行转换。

更常见的用法是作为 Babel 插件接入构建流程，即 regenerator-transform，可写入配置文件的插件列表，也可通过命令行或 Node API 调用^[8]。该插件提供 3 个开关项：generators、async 和 asyncGenerators，默认值均为启用^[9]。在 Babel 生态中它还以 @babel/plugin-transform-regenerator 的名称分发^[10]。

运行时依赖的引入方式与构建目标有关。使用 @babel/plugin-transform-runtime 时，可把代码中的 regeneratorRuntime 引用替换为从 @babel/runtime 包导入的实现，从而避免在每个文件内重复内联运行时^[11]。作为运行时包的 regenerator-runtime 在 npm 上被大量项目间接依赖，其周下载量以千万计^[12]。该运行时也常用于让 async/await 语法在只支持旧版 ES 的浏览器上运行，例如早期版本的 IE^[13]。

局限

该工具的设计目标单一，只转换生成函数，不覆盖 ES6 的其他语言特性。转换产物的运行依赖运行时库，如果遗漏引入 regenerator-runtime，会出现运行时找不到 regeneratorRuntime 的错误^[14]。在处理导出、函数提升等场景时，若代码中声明的先后顺序有意义，还需要显式调整写法^[14]。

转换本身带有额外开销：它把原函数拆解为状态机并引入上下文对象与辅助函数，生成的代码体积和结构复杂度都高于原生写法^[4]。try/catch/finally 等结构的处理尤其复杂，因为异常需要跨越 yield 边界被正确捕获^[3]。项目作者也指出，随着越来越多的引擎原生实现生成器，这类工具的长期必要性会下降，其价值主要体现在原生支持普及之前的过渡时期^[6]。

参见

• Babel —— 集成 regenerator 转换能力的主流 JavaScript 编译器，regenerator-transform 以插件形式在其中分发。

• 生成器 —— Regenerator 所转换的目标语言特性，提供 yield 暂停与恢复语义。

• ECMAScript 2015 —— 生成器函数与 yield 语法的标准化来源。

• 转译器 —— Regenerator 所属的工具类别，把新语法改写成等价的旧语法代码。

• 抽象语法树 —— 转换流水线中用于分析控制流与重写代码的中间表示。

• 异步编程 —— async/await 等语法所服务的编程范式，也是 regenerator-runtime 的主要应用场景。