async/await 语法降级

November 3, 2024

ES2015/ES2016 已支持 Generator，但不支持 async/await。
Typescript 编译器使用如下辅助函数降级 async/await 操作符。

var __awaiter =
    (this && this.__awaiter) || // 检查 this.__awaiter 是否已存在，若存在则直接使用，避免重复定义
    function (thisArg, _arguments, P, generator) {
        // thisArg:  绑定 Generator 函数的 this 上下文
        // _arguments:  Generator 函数的参数 (通常不使用)
        // P:  Promise 构造函数 (默认为全局 Promise)
        // generator:  Generator 函数

        function adopt(value) {
            // 此函数完全等价于 Promise.resolve 静态方法
            return value instanceof P
                ? value
                : new P(function (resolve) {
                      resolve(value);
                  });
        }

        // 返回一个新的 Promise，用于包装 Generator 函数的执行
        return new (P || (P = Promise))(function (resolve, reject) {
            // resolve:  用于解决外部 Promise
            // reject:  用于拒绝外部 Promise

            function fulfilled(value) {
                // 处理 Promise 的 resolve 结果
                try {
                    step(generator.next(value)); // 将 Promise 的 resolve 值传递给 Generator 的 next 方法
                } catch (e) {
                    reject(e); // 如果 Generator 执行过程中出现错误，则拒绝外部 Promise
                }
            }

            function rejected(value) {
                // 处理 Promise 的 reject 结果
                try {
                    step(generator["throw"](value)); // 将 Promise 的 reject 值传递给 Generator 的 throw 方法
                } catch (e) {
                    reject(e); // 如果 Generator 执行过程中出现错误，则拒绝外部 Promise
                }
            }

            function step(result) {
                // 驱动 Generator 函数的执行
                result.done // 检查 Generator 是否执行完毕
                    ? resolve(result.value) // 如果执行完毕，则用 Generator 的返回值解决外部 Promise
                    : adopt(result.value).then(fulfilled, rejected); // 如果未执行完毕，则等待 yield 后面的 Promise 完成，然后继续执行 Generator
            }

            // 开始执行 Generator 函数
            step((generator = generator.apply(thisArg, _arguments || [])).next());
        });
    };

降级过程如下：

async function foo() {
    const p1 = new Promise((resolve) => setTimeout(() => resolve("1"), 1000));
    const p2 = new Promise((_, reject) => setTimeout(() => reject("2"), 500));
    const results = [await p1, await p2]; // 不要这么写！请使用 Promise.all 或 Promise.allSettled
}

async function foo() {/*BODY*/} 会被转换为 function foo() { return __awaiter(this, void 0, void 0, function* () {/*BODY*/}) }

可以发现，await 都转为了 yield

function foo() {
    return __awaiter(this, void 0, void 0, function* () {
        const p1 = new Promise((resolve) => setTimeout(() => resolve("1"), 1000));
        const p2 = new Promise((_, reject) => setTimeout(() => reject("2"), 500));
        const results = [yield p1, yield p2]; // 不要这么写！请使用 Promise.all 或 Promise.allSettled
    });
}

对于 ES5，由于不支持 Generator，编译器还将使用 __generator 辅助函数转换 Generator

Generator 的本质是一个状态机，其 Polyfill 就比较复杂了

由于它不属于本文的核心部分，说明略

// prettier-ignore
var __generator = (this && this.__generator) || function (thisArg, body) {
    // thisArg: Generator 函数的 this 上下文
    // body: Generator 函数的主体逻辑

    var _ = { 
        label: 0, // 当前 label，用于跳转
        sent: function() { 
            // 用于 yield* 表达式，获取 yield* 后 Generator 的返回值
            if (t[0] & 1) throw t[1]; // 如果 Generator 抛出异常，则重新抛出
            return t[1]; // 返回 Generator 的返回值
        },
        trys: [], // try 块的栈
        ops: []  // 操作的栈，用于循环、switch 和 finally 等
    },
    f, // 标记 Generator 是否正在执行
    y, // yield 后表达式的结果，或者 yield* 的 Generator 对象
    t, // 临时变量
    g = Object.create((typeof Iterator === "function" ? Iterator : Object).prototype); // 创建一个迭代器对象


    // 定义 next、throw 和 return 方法
    return g.next = verb(0), 
           g["throw"] = verb(1), 
           g["return"] = verb(2), 
           typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), // 实现 Symbol.iterator 接口
           g; // 返回生成的迭代器对象


    function verb(n) { return function (v) { return step([n, v]); }; }
    // verb 函数用于创建 next、throw 和 return 方法。
    // n 表示操作类型：0 为 next，1 为 throw，2 为 return。
    // v 表示传入的值。

    function step(op) {
        // 驱动 Generator 执行的核心函数
        if (f) throw new TypeError("Generator is already executing."); // 如果 Generator 正在执行，则抛出错误
        while (g && (g = 0, op[0] && (_ = 0)), _) try { // g 为迭代器对象，_ 为状态对象
            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
            // 处理 yield* 表达式，如果 yield* 后面的 Generator 还没有执行完毕，则返回 yield* 后 Generator 的返回值

            if (y = 0, t) op = [op[0] & 2, t.value]; // 将 yield 后表达式的结果赋值给 op[1]
            switch (op[0]) {
                case 0: case 1: t = op; break; // next 和 throw 操作
                case 4: _.label++; return { value: op[1], done: false }; // yield 表达式
                case 5: _.label++; y = op[1]; op = [0]; continue; // yield* 表达式
                case 7: op = _.ops.pop(); _.trys.pop(); continue; // try 块结束
                default:
                    // 处理 try...catch...finally 块
                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
                    // 如果不是 try 块，并且是 catch 或 finally 块，则跳出循环
                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
                    // try 块中的跳转
                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
                    // catch 块中的跳转
                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
                    // finally 块中的跳转
                    if (t[2]) _.ops.pop();
                    _.trys.pop(); continue; // 恢复 try 块之前的状态
            }
            op = body.call(thisArg, _); // 执行 Generator 函数的主体逻辑
        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; } // 处理异常和 finally 块
        if (op[0] & 5) throw op[1]; // 重新抛出异常
        return { value: op[0] ? op[1] : void 0, done: true }; // 返回 Generator 的最终结果
    }
};

←Back to home

This work is licensed under CC BY-NC-SA 4.0