在现代 JavaScript 中,生成器函数 (Generator Functions) 是 ES6 (ECMAScript 2015) 引入的一项强大特性,它允许你定义一种可以暂停 (pause) 执行并在之后恢复 (resume) 执行的函数。与传统函数一次性执行完毕不同,生成器函数通过使用特殊的 function* 语法和 yield 关键字,能够按需生成一系列值,从而实现惰性求值 (Lazy Evaluation)协程 (Coroutine) 的行为。

生成器函数是理解和使用 JavaScript 异步编程模式(如 async/await 的底层原理)以及处理无限数据流、自定义迭代逻辑的关键。它们极大地提升了代码的表达力、控制流的灵活性和资源管理的效率。

本教程将全面深入地探讨 JavaScript 中生成器函数的方方面面。我们将从解释生成器函数的核心概念和它与普通函数的根本区别开始。随后,我们将详细剖析 function* 语法、yield 关键字 (yield 表达式) 以及 next() 方法的工作原理,理解它们如何共同构建出可暂停和可恢复的执行流程。我们将深入探讨生成器对象提供的额外方法,如 return()throw(),以及强大的 yield* 表达式,它允许我们委托给其他生成器或可迭代对象。最后,我们将通过丰富的实际应用场景(包括异步编程、无限序列、自定义迭代)和最佳实践,帮助您彻底掌握生成器函数的强大功能,编写出更灵活、更高效、更具表现力的 JavaScript 代码。


1. 什么是生成器函数 (Generator Functions)?核心概念

生成器函数是一种特殊类型的函数,它能够在执行过程中暂停,并在之后从暂停的地方恢复执行。每次暂停时,它都会通过 yield 关键字返回一个值。

主要特点:

  1. 定义方式: 使用 function* 语法定义(注意函数名前的星号 *)。
  2. yield 关键字: 用于暂停生成器函数的执行,并返回一个值给调用者。当生成器恢复执行时,它会从 yield 语句的下一个点继续。
  3. 返回生成器对象 (Generator Object): 调用生成器函数并不会直接执行函数体,而是返回一个生成器对象。这个生成器对象符合迭代器协议,拥有 next(), return(), throw() 方法。

示例:一个简单的生成器函数

function* simpleGenerator() {
    console.log("Start");
    yield 1; // 第一次暂停,返回 1
    console.log("Middle");
    yield 2; // 第二次暂停,返回 2
    console.log("End");
    // 函数自然结束,隐式返回 undefined
}

const gen = simpleGenerator(); // 调用生成器函数,返回生成器对象

console.log(gen.next()); // 执行到第一个 yield,输出 "Start",返回 { value: 1, done: false }
console.log(gen.next()); // 从上一个 yield 后继续执行,输出 "Middle",返回 { value: 2, done: false }
console.log(gen.next()); // 从上一个 yield 后继续执行,输出 "End",返回 { value: undefined, done: true }
console.log(gen.next()); // 再次调用,函数已执行完毕,始终返回 { value: undefined, done: true }

动手实践: 在您的浏览器开发者工具控制台中运行上述代码。仔细观察 console.log 的输出顺序和 gen.next() 的返回值,以直观感受生成器函数的暂停和恢复机制。

2. 生成器对象 (Generator Object)

当调用一个生成器函数时,它会返回一个生成器对象。这个对象是特殊的迭代器 (Iterator)。这意味着它实现了迭代器协议,拥有 next() 方法,并且可以被 for...of 循环遍历。

除了 next() 方法,生成器对象还提供了一些额外的方法来与生成器函数进行交互:

  • next(value): 恢复生成器执行,并可以向暂停的 yield 表达式“发送”一个值。
  • return(value): 提前终止生成器,使其完成。
  • throw(exception): 在生成器内部抛出一个异常,可以被生成器内部的 try...catch 捕获。

3. yield 关键字的深入理解

yield 关键字是生成器函数的核心。它扮演着双重角色:

  1. 暂停点: yield 暂停了生成器函数的执行,并将其后面的表达式的值作为 next() 方法调用的结果返回给调用者。
  2. 恢复点: 当生成器通过 next() 方法恢复执行时,它会从 yield 语句的右侧继续执行。
3.1 yield 表达式的返回值

yield 表达式本身也有一个返回值,这个返回值是下一次调用 next() 方法时传入的参数

function* sendValueGenerator() {
    const received1 = yield "Hello"; // 第一次暂停,返回 "Hello"
    console.log("Received 1:", received1); // 接收到 next() 传入的值
    const received2 = yield "World"; // 第二次暂停,返回 "World"
    console.log("Received 2:", received2);
    return "Done"; // 最终返回值
}

const gen = sendValueGenerator();

console.log(gen.next());        // 执行到第一个 yield,输出 "Hello",received1 此时还没赋值
                                // { value: 'Hello', done: false }

console.log(gen.next("First value from outside")); // 恢复执行,"First value from outside" 赋值给 received1
                                                    // 执行到第二个 yield,输出 "Received 1: First value from outside"
                                                    // 返回 { value: 'World', done: false }

console.log(gen.next("Second value from outside"));// 恢复执行,"Second value from outside" 赋值给 received2
                                                    // 执行到函数结束,输出 "Received 2: Second value from outside"
                                                    // 返回 { value: 'Done', done: true }

console.log(gen.next());        // 再次调用,函数已结束
                                // { value: undefined, done: true }

动手实践: 运行此示例,观察 received1received2 是如何获得外部通过 next() 方法传入的值的。这是生成器实现双向通信的关键。

4. return() 方法:提前终止生成器

生成器对象的 return() 方法可以提前终止生成器函数的执行。它会使生成器进入 done: true 状态,并且可以将一个可选的值作为其 value 属性返回。

function* earlyExitGenerator() {
    yield 1;
    yield 2;
    yield 3;
}

const gen = earlyExitGenerator();

console.log(gen.next());       // { value: 1, done: false }
console.log(gen.return("Early termination!")); // { value: 'Early termination!', done: true }
console.log(gen.next());       // { value: undefined, done: true } (已经终止)

注意: 如果生成器函数内部有 try...finally 块,return() 方法会先执行 finally 块中的代码。

5. throw() 方法:向生成器内部注入错误

生成器对象的 throw() 方法可以在生成器函数暂停的位置注入一个错误。这个错误可以在生成器内部通过 try...catch 块捕获。

function* errorHandlingGenerator() {
    try {
        yield 1;
    } catch (e) {
        console.log("Caught inside generator:", e.message);
    }
    yield 2;
}

const gen = errorHandlingGenerator();

console.log(gen.next());        // { value: 1, done: false }
console.log(gen.throw(new Error("Something went wrong!"))); // 注入错误,被 catch 捕获
                                                            // 输出: Caught inside generator: Something went wrong!
                                                            // 返回 { value: 2, done: false }

console.log(gen.next());        // { value: undefined, done: true }

如果生成器内部没有捕获这个错误,那么错误会像普通函数一样向上传播,最终在调用 throw() 方法的地方抛出。

6. yield* 委托 (Yield Delegation)

yield* 表达式用于将生成器的执行委托给另一个可迭代对象(通常是另一个生成器)。它会遍历被委托的可迭代对象,并 yield 出其所有值,直到被委托对象完成。

function* generatorA() {
    yield 'A1';
    yield 'A2';
    return 'Return A'; // generatorA 的最终返回值
}

function* generatorB() {
    yield 'B1';
    const resultFromA = yield* generatorA(); // 委托给 generatorA
    console.log("Result from generatorA:", resultFromA); // 接收 generatorA 的返回值
    yield 'B2';
}

const genB = generatorB();

console.log(genB.next()); // { value: 'B1', done: false }
console.log(genB.next()); // { value: 'A1', done: false } (来自 generatorA)
console.log(genB.next()); // { value: 'A2', done: false } (来自 generatorA)
// generatorA 执行完毕,其 return 值 'Return A' 被赋给 resultFromA
// console.log("Result from generatorA:", 'Return A') 被打印
console.log(genB.next()); // { value: 'B2', done: false }
console.log(genB.next()); // { value: undefined, done: true }

yield* 的作用:

  1. 遍历: 自动遍历被委托的迭代器,并 yield 出每个值。
  2. 返回值传递: 被委托迭代器(或生成器)的最终返回值(通过 return 语句或自然结束)会被赋值给 yield* 表达式的左侧变量。

7. 生成器函数的实际应用场景

7.1 实现自定义迭代器

生成器函数是创建自定义可迭代对象的最简洁方式。任何需要按需生成序列的场景都非常适合。

class MyCustomIterable {
    constructor(start, end) {
        this.start = start;
        this.end = end;
    }

    // 使用生成器函数实现 Symbol.iterator
    *[Symbol.iterator]() {
        for (let i = this.start; i <= this.end; i++) {
            yield i;
        }
    }
}

const iterable = new MyCustomIterable(10, 15);
for (const num of iterable) {
    console.log(num); // 10, 11, 12, 13, 14, 15
}

console.log([...iterable]); // [10, 11, 12, 13, 14, 15]
7.2 处理无限序列 (Lazy Evaluation)

生成器可以创建无限序列,因为它们只在被请求时才生成下一个值。

function* naturalNumbers() {
    let n = 0;
    while (true) {
        yield n++;
    }
}

const numbers = naturalNumbers();
console.log(numbers.next().value); // 0
console.log(numbers.next().value); // 1
console.log(numbers.next().value); // 2
// 永远不会耗尽内存,因为值是惰性生成的
7.3 异步编程 (Co-routines / async/await 的底层实现)

生成器可以用来编写看起来像同步代码的异步操作。async/await 实际上就是基于生成器和 Promise 的语法糖。

示例:使用生成器模拟 async/await

function fakeAjax(url, delay) {
    return new Promise(resolve => {
        setTimeout(() => {
            resolve(`Data from ${url} (delayed by ${delay}ms)`);
        }, delay);
    });
}

function* getData() {
    console.log("Fetching data 1...");
    const data1 = yield fakeAjax("api/data1", 1000); // 暂停,等待 Promise 完成
    console.log("Received data 1:", data1);

    console.log("Fetching data 2...");
    const data2 = yield fakeAjax("api/data2", 500);
    console.log("Received data 2:", data2);

    return "All data fetched!";
}

// 运行器函数 (类似于 async/await 机制)
function run(generatorFunction) {
    const generator = generatorFunction(); // 获取生成器对象

    function handle(iteratorResult) {
        if (iteratorResult.done) {
            return Promise.resolve(iteratorResult.value);
        }

        return Promise.resolve(iteratorResult.value).then(
            res => handle(generator.next(res)), // Promise 成功,将结果传入生成器
            err => handle(generator.throw(err)) // Promise 失败,向生成器抛出错误
        );
    }

    try {
        return handle(generator.next()); // 启动生成器
    } catch (e) {
        return Promise.reject(e);
    }
}

run(getData)
    .then(finalResult => console.log("Final result:", finalResult))
    .catch(error => console.error("Error in run:", error));

// 运行结果(延迟后):
// Fetching data 1...
// Received data 1: Data from api/data1 (delayed by 1000ms)
// Fetching data 2...
// Received data 2: Data from api/data2 (delayed by 500ms)
// Final result: All data fetched!

这个例子展示了生成器如何通过 yield 一个 Promise 来暂停执行,并在 Promise 解决后通过 next() 将结果“发送”回生成器,从而实现类似 async/await 的同步式异步编程体验。

7.4 实现状态机 (State Machine)

生成器可以很自然地表示一系列状态和它们之间的转换。

function* trafficLight() {
    while (true) {
        yield 'red';
        yield 'yellow';
        yield 'green';
    }
}

const light = trafficLight();
console.log(light.next().value); // red
console.log(light.next().value); // yellow
console.log(light.next().value); // green
console.log(light.next().value); // red

8. 生成器函数的优点

  • 惰性求值/按需生成: 仅在需要时才生成值,节省内存和计算资源,尤其适用于处理大型或无限数据集。
  • 简化异步代码: 允许编写看起来是同步的异步代码,是 async/await 的基础。
  • 可暂停/可恢复: 提供了对函数执行流的细粒度控制。
  • 统一迭代接口: 与迭代器协议无缝集成,便于自定义数据结构的遍历。
  • 双向通信: yieldnext(value) 允许生成器函数与外部环境进行双向通信。
  • 易于实现状态机: 自然地表达一系列状态和转换。

9. 生成器函数的注意事项与局限性

  • 一次性生成器对象: 大多数生成器对象都是一次性消费的。一旦迭代完成(done: true),它们就不能再用于生成更多值。你需要再次调用生成器函数来获取一个新的生成器对象。
  • 性能开销: 相对于简单的 for 循环,生成器存在一定的性能开销。在对性能极致敏感的场景下(例如,对数组进行简单的元素访问),可能需要权衡。但在大多数抽象和控制流场景中,其带来的代码收益远大于性能损失。
  • 调试难度: 调试暂停和恢复的执行流程可能会比调试传统函数稍微复杂一些。
  • 不是纯函数: 生成器是有状态的,每次调用 next() 都会改变其内部状态,因此它们通常不是纯函数。

10. 最佳实践

  1. 使用 for...of 遍历生成器: 如果你只是想消费生成器生成的所有值,for...of 是最简洁、最推荐的方式。
  2. 明确 yield 的返回值: 理解 yield 表达式的返回值是下一次 next() 传入的参数,这对于实现双向通信至关重要。
  3. 合理使用 try...catchfinally 在生成器内部处理错误,并通过 finally 块进行资源清理。
  4. 理解 yield* 的委托机制: 当需要组合多个生成器或遍历其他可迭代对象时,yield* 能够简化代码。
  5. 用于需要按需生成值的场景: 避免在简单的循环或不需要暂停/恢复的场景过度使用生成器。
  6. 在异步编程中,优先考虑 async/await 尽管生成器可以实现类似的异步流控制,但 async/await 是更现代、更易读的语法糖。但理解生成器有助于理解 async/await 的底层机制。

11. 总结与展望

生成器函数是 JavaScript 中一项革命性的特性,它改变了我们思考函数执行和数据流的方式。

  • 核心: function* 语法,yield 暂停,next() 恢复。
  • 机制: 返回生成器对象(一个迭代器),支持 next(), return(), throw()
  • 关键特性: 双向通信 (yieldnext(value)), yield* 委托。
  • 应用: 自定义迭代、无限序列(惰性求值)、异步流控制(async/await 基础)、状态机。

掌握生成器函数意味着你对 JavaScript 的控制流有了更深层次的理解,能够编写出更高效、更具表现力、更适应现代复杂应用需求的 JavaScript 代码。它是通往更高级异步编程和函数式编程模式的重要桥梁。

Logo

Agent 垂直技术社区,欢迎活跃、内容共建。

更多推荐