get_return_object 必须返回协程函数声明的完全匹配类型(如 task),构造时通过 std::coroutine_handle::from_promise(*this) 转移 promise 所有权,不可抛异常、不可调用 resume、不可返回引用或指针。

get_return_object 必须返回协程的最终对象,不能只返回 promise 实例
很多人误以为 get_return_object 只是“把 promise 包一层”,结果协程挂起后直接崩溃或行为未定义。它真正的职责是:构造并返回用户最终拿到的那个协程句柄(比如 Task、Generator<int></int>),而这个句柄内部必须持有对 promise_type 的所有权(通常通过 std::coroutine_handle<promise_type>::from_promise</promise_type> 获取)。
常见错误现象:Segmentation fault 或 undefined behavior,尤其在协程首次挂起前就访问了已销毁的 promise;或者编译失败,报错类似 no matching function for call to 'get_return_object' —— 往往是因为返回类型没和协程函数声明匹配。
- 返回类型必须与协程函数的声明类型完全一致(例如函数声明为
Task<int> foo();</int>,则get_return_object必须返回Task<int></int>) - 不要在
get_return_object里调用std::coroutine_handle::resume()或做任何调度逻辑——那是协程启动器(如co_await启动点)的事 - 典型实现是:在
Task构造函数中用std::coroutine_handle<promise_type>::from_promise(*this)</promise_type>拿到 handle,并保存为成员
promise_type 里必须定义 get_return_object,且不能是 const 成员函数
get_return_object 是 promise_type 的非静态成员函数,由编译器在协程帧分配后、首次挂起点之前自动调用。它不能是 const,因为此时 promise 对象刚被默认构造,可能需要修改其状态(比如设置初始状态字段、记录协程 ID 等)。
使用场景:你正在实现一个自定义协程类型(比如 Lazy<t></t>),需要让协程体一创建就进入“待调度”状态,而不是立即执行。
组合式C++代码评审方案,融合静态分析、AI推理、多轮迭代评审和C++专项检查,适用于PR审查、增量代码审查、全项目评审和代码质量评分,触发词包括review cpp、cpp代码评审、C++review、代码审查。
- 签名固定为:
T get_return_object(),其中T是协程函数的返回类型 - 不能重载为
get_return_object(int)或带参数的版本——编译器不会传参 - 如果忘记定义,MSVC 报
C7548,Clang 报error: no member named 'get_return_object' in 'MyPromise'
别在 get_return_object 里抛异常,否则协程无法安全析构
一旦 get_return_object 抛异常,协程帧(包括 promise 和栈空间)可能已部分构造,但编译器不会自动调用 promise.destroy(),导致资源泄漏甚至 double-free。C++20 标准明确要求:若该函数抛异常,协程对象的析构行为是未定义的。
性能影响:加 try/catch 不仅增加代码体积,还会干扰编译器对协程帧布局的优化(尤其是 stackless 协程)。
- 替代方案:用返回值标记失败(比如返回
std::optional<task>></task>),但注意这违背了协程函数签名约定,不推荐 - 更合理做法:把可能失败的初始化逻辑移到
initial_suspend()的awaitable中,那里可安全捕获异常并控制是否挂起 - 如果真要检查(如验证线程亲和性),用
assert或日志警告,而非抛异常
返回对象的构造必须转移 promise 所有权,不能拷贝
协程帧中的 promise_type 实例生命周期由协程帧管理,一旦协程结束,帧释放,promise 自动析构。如果 get_return_object 返回的对象只是引用或指针持有 promise,后续访问就是悬垂指针。
容易踩的坑:写成 return Task{&*this}; 或 return Task{this}; —— 这类代码在协程刚创建时看似能跑,但只要协程挂起再恢复,this 指向的内存可能已被回收或复用。
- 正确方式:在返回类型(如
Task)内部存储std::coroutine_handle<promise_type></promise_type>,它通过from_promise(*this)获得,能安全跨挂起生命周期 -
std::coroutine_handle是轻量值类型(通常就是一个指针大小),可放心移动、存储、传递 - 切勿在
get_return_object中调用handle.done()或handle.resume()—— 此时 handle 尚未被外部持有,没人负责后续管理
std::coroutine_handle 维系,而它的有效性完全取决于你有没有在 get_return_object 里正确建立那一层“从 promise 到 handle”的映射——漏掉或写错,后面所有 await、resume、destroy 都会出问题。C++免费学习笔记(深入):立即使用
在学习笔记中,你将探索 C++ 的入门与实战技巧!










