C++如何定义一个支持协程的Awaitable对象-C++-PHP中文网

awaitable对象的最小契约是必须提供await_ready()、await_suspend()、await_resume()三个成员函数。编译器仅依据函数名识别，不依赖继承或类名；await_ready()返回bool，await_suspend()可返回bool、coroutine_handle或void，await_resume()无参数并返回协程最终结果。

c++如何定义一个支持协程的awaitable对象

什么是Awaitable对象的最小契约

一个C++协程的Awaitable对象，核心就三件事：能调用await_ready()、能返回await_suspend()、能提供await_resume()。编译器只认这三个函数名，不关心类名或继承关系——哪怕是个空struct，只要这仨函数存在且可调用，它就是Awaitable。

常见错误是以为必须继承某个基类，或者漏掉await_suspend()的返回类型判断（它得返回bool、std::coroutine_handle，或另一个Awaitable）。

await_ready() 返回bool：告诉编译器“是否立刻继续执行”，比如I/O已就绪就返回true
await_suspend(std::coroutine_handle h)：挂起时被调用，返回true表示手动恢复（需后续调用resume()），返回false表示立即恢复，返回std::coroutine_handle则交由该handle调度
await_resume()：协程恢复后执行，返回值成为co_await expr的求值结果

如何让Awaitable支持任意协程帧（避免handle类型硬编码）

直接写await_suspend(std::coroutine_handle)看似简单，但会强制绑定到默认promise类型。实际项目中，不同协程可能用不同Promisetype（比如带线程池上下文的task或带取消语义的async_operation），这时应使用模板参数推导：

template<typename promise>
std::coroutine_handle<promise> await_suspend(std::coroutine_handle<promise> h) {
    // 保存h供后续恢复，或转发给线程池
    return some_other_handle; // 或 return {};
}</promise></promise></typename>

更稳妥的做法是声明为await_suspend(std::coroutine_handle h)（泛型handle），再在内部用h.promise()访问具体promise——这样既兼容所有协程类型，又避免模板爆炸。

别写await_suspend(std::coroutine_handle<my_promise>)</my_promise>：限制死类型，跨协程库就失效
如果await_suspend返回void，必须确保挂起逻辑绝对可靠（比如已注册回调），否则协程永远卡住
返回std::coroutine_handle时，该handle必须有效（不能是临时构造或已销毁）

为什么operator co_await不是必需的

很多教程一上来就重载operator co_await，但这其实是“可选优化”。只要类型本身有那三个await_*成员函数，编译器就直接用；只有当类型没有这些函数，但提供了operator co_await()返回另一个含await_*的对象时，才触发该操作符。

C++ Code Review Master

组合式C++代码评审方案，融合静态分析、AI推理、多轮迭代评审和C++专项检查，适用于PR审查、增量代码审查、全项目评审和代码质量评分，触发词包括review cpp、cpp代码评审、C++review、代码审查。

下载

典型误用：给一个纯数据结构（如http_response）强行加operator co_await，结果发现它没挂起能力，只是包装了个假Awaitable，最终阻塞主线程。

优先实现await_ready/await_suspend/await_resume三件套，清晰直接
operator co_await适合做适配层：比如把std::future<t></t>转成真正可挂起的Awaitable，而不是让std::future自己实现三件套
若同时提供operator co_await和成员await_*，成员函数优先级更高