使用C++20 的协程创建通用的生成器

在上一篇中，我们通过拆解一个简单的例子描述了C++20 处理协程的过程。在此先简单的回顾一下各个部分的作用

回顾

1. promise_type
   主要提供一些与协程相关的接口：

• initial_suspend： 协程实例创建时执行，通过返回值来决定协程创建的同时执行还是等待
• final_suspend: 协程实例执行完之后是暂停还是继续，继续意味着会销毁这个实例
• yield_value/await_transform: 协程函数中执行 co_yield/co_await 时负责将后面的操作数转化为等待体awaiter 对象
• get_return_object: 返回协程对象
• return_void / return_value: 真正获取协程函数 co_return 的返回值
• unhandled_exception 协程函数发生异常时调用

2. 等待体是协程函数中调用 co_await/co_yield 时创建, 主要用来告诉编译器遇到这两个操作符时应该继续执行还是等待, 关于等待体 awaiter 它有如下几个接口:

• bool await_ready(): 根据返回值决定是继续还是等待
• await_suspend(coroutine_handle<>): 协程被挂起时调用
• await_resume(): 协程被恢复时调用

关于等待体，标准库有两个简单的实现:suspend_always和suspend_never

改进生成器

c++ 23 中存在一个标准的生成器std::generator，我们利用这个生成器可以将整个程序修改为:

#include<coroutine>#include<iostream>#include<generator>#include<ranges>std::generator<int>fibonacci(){inta=0;intb=1;for(;;){co_yielda;intnext=a+b;a=b;b=next;}}intmain(){for(autox:fibonacci()|std::views::take(10)){std::cout<<x<<std::endl;}return0;}

本文的目标是最终完成一个简单的、可用的、贴近标准库的 std::generator，进一步理解协程的原理

我们还是按照上一篇的组织方式，先放出完整的源代码，然后依次说明重要的点:

#include<coroutine>#include<iostream>#include<generator>#include<ranges>template<typenameT>structGenerator{structpromise_type{std::suspend_alwaysinitial_suspend(){returnstd::suspend_always{};}std::suspend_alwaysfinal_suspend()noexcept{returnstd::suspend_always{};}voidunhandled_exception()noexcept{_exp=std::current_exception();}Generatorget_return_object(){returnGenerator(std::coroutine_handle<promise_type>::from_promise(*this));}voidreturn_void(){}std::suspend_alwaysyield_value(T value){_value=std::move(value);returnstd::suspend_always{};}voidrethrow_if_exception(){if(_exp)throw_exp;}T _value={};std::exception_ptr _exp=nullptr;};Generator(std::coroutine_handle<promise_type>h):_handle(h){}~Generator(){if(_handle)_handle.destroy();}Generator(constGenerator&)=delete;Generator&operator=(constGenerator&)=delete;Generator(Generator&&other)noexcept:_handle(std::exchange(other._handle,nullptr)){}Generator&operator=(Generator&&other){if(this!=&other){if(_handle)_handle.destroy();//删除当前的协程，管理新协程_handle=std::exchange(other._handle,nullptr);}return*this;}boolis_done()noexcept{return!_handle||_handle.done();}Tnext(){if(is_done())throwstd::runtime_error("Generator exhausted");_handle.resume();_handle.promise().rethrow_if_exception();return_handle.promise()._value;}std::coroutine_handle<promise_type>_handle;// 迭代器structIterator{Generator&_gen;bool_is_end;Iterator(Generator&gen,boolis_end=false):_gen(gen),_is_end(is_end){}voidmove_next(){if(!_gen.is_done()){_gen._handle.resume();_gen._handle.promise().rethrow_if_exception();}else{_is_end=true;}}Toperator*()const{return_gen._handle.promise()._value;}Iterator&operator++(){move_next();return*this;}booloperator!=(constIterator&other)const{returnother._is_end!=_is_end;}};Iteratorbegin(){Iterator it{*this};it.move_next();returnit;}Iteratorend(){returnIterator{*this,true};}};Generator<int>fibonacci(){inta=0;intb=1;for(;;){co_yielda;intnext=a+b;a=b;b=next;}}intmain(){Generator<int>generator=fibonacci();for(autox:fibonacci()){std::cout<<x<<std::endl;}// std::generator 示例//for (auto x : fibonacci() | std::views::take(10))//{// std::cout << x << std::endl;//}return0;}

泛型与移动语义的优化

之前我们在yield_value函数中传入的参数是int类型，所以在函数中直接采用赋值运算符没有任何问题，但是考虑到泛化之后它可以生成任意类型的数据，在处理大结构的数据时，采用赋值运算将会产生多余的拷贝。因为函数参数中已经进行了拷贝，同时值传递不影响外部真实的数据，我们直接对参数执行移动操作可以节省一次拷贝。

异常处理的支持

上一篇，我们简单的将将unhandled_exception设置为空函数，这次我们在promise_type中保存了一个std::exception_ptr异常类型的指针用来捕获协程函数中的异常。

这个函数的实现也比较简单，我们说在协程函数发生异常时会调用promise_type结构中的unhandled_exception接口函数。这个函数中通过_exp = std::current_exception();获取最新的异常信息并保存。

在获取下一次的数据的时候，我们直接判断当前是否保存了异常信息，如果有则直接抛出。外界在调用next等函数获取值的时候可以直接捕获

Generator 禁止拷贝、仅支持移动操作

协程句柄coroutine_handle独占一段堆上分配的协程栈与promise对象，资源唯一不可共享。所以理论上只能有一个对象管理整个协程。

如果允许拷贝，则会出现多个结构同时指向一个协程对象。这些结构在析构时多次调用destroy 造成重复销毁的问题。或者某个对象没有及时更新造成访问无效内存。

而移动语义是所有权的转移，在同一时间有且只有一个对象真正的控制协程、拥有coroutine_handle句柄。配合最后的析构释放操作，能防止内存泄漏

move_next 实现

这里我们在迭代器中单独又写了一些与Generator::next相同的代码。这里主要出于两点考虑：

1. Generator 支持通过next来获取下一个数据，但是该函数返回T类型的下一个数据。外界实际上没有途经判断生成器是否已经无法生成多余的数据。所以我通过抛出异常，外界可以通过异常来判断是否还能生成数据，当然这里也可以使用std::optional来判断数据是否合理。既然会抛出异常，那么迭代器中的move_next就无法直接调用，谁也不希望范围for最后是靠异常退出的。

2. 迭代器需要一个end函数，end一般是返回一个越界的迭代器，在协程中我们实际上不需要构建一个额外的Generator 来判断是否越界。所以我在里面额外维护了一个_is_end。利用该变量来判断迭代器是否越界了。

基于以上理由，我没有复用Generator::next的代码

另外在Generator::begin函数中，我们首先调用了一次move_next，然后才返回迭代器。这是因为我们的initial_suspend函数返回suspend_always，在生成器对象被创建的时候协程还没有开始运行，此时生成器中的值是无效值。begin函数是用来获取它的起始值，此时值应该是有效的，所以提前调用一次move_next让它获取第一个值。

小结

当然标准库的std::generator实现比上述代码要复杂的多，特别是它支持ranges组件来设置范围，而我们的简单的生成器的退出完全依赖协程函数自身的退出条件，无法做到自主退出。

希望通过本节各位读者能对协程的原理有一个更深入的理解。也希望这个简陋的实现可以做到抛砖引玉的作用。