C++ 的协程

现代C++中的协程（coroutines）是C++20引入的一项重大语言特性，它们允许函数在执行过程中可以暂停并稍后从暂停点恢复执行。协程提供了一种控制流机制，使得函数可以包含多个入口点和出口点，这与传统的单入口、单出口的函数模型形成了鲜明对比。

协程的核心思想是“可恢复的函数”，即在执行过程中，函数可以“挂起”其执行状态，并在将来的某个时间点“恢复”执行。这种机制使得编写异步代码变得更加直观和易于管理，因为你可以使用类似于同步代码的结构来表达异步操作。

在C++中，协程通过特定的语法和一组标准库组件来实现。以下是一些关键点：

1. 协程句柄（coroutine handle）：
   协程句柄是一个轻量级的对象，它封装了与协程执行相关的状态和控制信息。你可以使用协程句柄来暂停、恢复或销毁协程。

2. 协程承诺类型（promise type）：
   每个协程都有一个与之关联的承诺类型（通常是一个模板类），它定义了协程的返回类型和状态。承诺类型负责在协程挂起和恢复时管理其状态，并处理与协程相关的异常和返回值。

3. co_await、co_yield 和 co_return：
   这三个关键字是C++协程语法的核心。co_await用于挂起协程并等待一个awaitable对象的完成；co_yield用于在生成器中逐个产生值；co_return用于从协程返回结果。

4. 标准库支持：
   C++20标准库提供了一些与协程相关的组件，如std::suspend_always、std::suspend_never和std::coroutine_handle等，以及用于定义协程行为的模板类（如std::generator和std::async_generator，尽管这些可能在未来的标准中有所变化或扩展）。

5. 异步编程：
   协程最显著的应用之一是异步编程。通过协程，你可以编写看起来像是同步调用的异步代码，从而简化异步操作的复杂性。

6. 生成器：
   协程还可以用于实现生成器，即按需产生一系列值的函数。这与迭代器类似，但生成器允许更复杂的逻辑和状态管理。

7. 实现细节：
   协程的实现涉及编译器对特定语法结构的支持，以及标准库提供的底层机制。编译器需要识别协程函数，并在编译时生成适当的代码来处理协程的挂起和恢复。

使用协程涉及几个关键步骤，包括定义协程函数、使用特定的协程语法（如co_await、co_yield和co_return），以及可能定义自定义的promise类型来管理协程的状态和返回值。以下是一个基本的指南，帮助你开始在现代C++中使用协程。

1. 编译器支持

首先，确保你的编译器支持C++20协程。GCC 10及以上版本、Clang 11及以上版本以及MSVC（Visual Studio 2019版本16.6及以上）都提供了对C++20协程的支持。

2. 包含必要的头文件

在你的C++源文件中包含必要的头文件。对于基本的协程功能，你可能需要包含<coroutine>头文件。

#include <coroutine>

3. 定义协程函数

协程函数使用co_await、co_yield（对于生成器）或co_return来控制其执行流程。下面是一个简单的例子，展示了如何使用co_await来挂起和恢复协程的执行。

#include <coroutine>
#include <iostream>
#include <thread>
#include <chrono>// 一个简单的awaitable对象，它会在一段时间后“完成”
struct simple_awaitable {bool await_ready() const noexcept { return false; } // 协程需要挂起void await_suspend(std::coroutine_handle<>) const noexcept {} // 挂起时的操作（这里为空）void await_resume() const noexcept {} // 恢复时的操作（这里为空）// 模拟异步等待（例如，I/O操作）static simple_awaitable await_now() { return {}; }
};// 协程函数示例
struct MyCoroutine {struct promise_type {MyCoroutine get_return_object() { return MyCoroutine{std::coroutine_handle<promise_type>::from_promise(*this)}; }std::suspend_always initial_suspend() { return {}; }std::suspend_always final_suspend() noexcept { return {}; }void return_void() {}void unhandled_exception() { std::exit(1); } // 处理异常（这里简单退出程序）};std::coroutine_handle<promise_type> handle;MyCoroutine(std::coroutine_handle<promise_type> h) : handle(h) {}~MyCoroutine() { if (handle) handle.destroy(); }void resume() { handle.resume(); }
};MyCoroutine example_coroutine() {std::cout << "Before await\n";co_await simple_awaitable::await_now(); // 挂起协程std::cout << "After await\n";
}int main() {auto coro = example_coroutine();std::cout << "Main thread continues\n";std::this_thread::sleep_for(std::chrono::seconds(1)); // 模拟主线程做一些其他工作coro.resume(); // 恢复协程的执行return 0;
}

4. 使用协程

在上面的例子中，example_coroutine是一个协程函数，它使用co_await来挂起其执行。在main函数中，我们创建了协程对象coro，并在稍后通过调用coro.resume()来恢复其执行。

5. 自定义promise类型（可选）

在上面的例子中，我们定义了MyCoroutine结构和一个简单的promise_type来管理协程的状态。对于更复杂的协程，你可能需要定义自己的promise类型来处理返回值、异常和协程的生命周期。

6. 注意事项

• 协程是编译器和语言特性的结合，因此确保你的编译器和标准库支持C++20协程。
• 协程的状态管理是通过promise类型来实现的，因此理解promise类型的工作原理对于编写有效的协程至关重要。
• 协程的异步性质意味着它们可以与其他线程交互，因此需要注意线程安全和同步问题。
• 尽管C++20引入了协程的基本框架和语法，但协程的完整功能和最佳实践仍在不断发展和完善中。因此，在使用协程时，建议查阅最新的C++标准文档和编译器文档，以获取最新的信息和最佳实践。