详解C++20协程如何使用

简介

C++20协程是C++20新特性之一，它提供了更加高效的异步编程模型。在C++20中，协程这个概念被引入了语言标准，对于需要高效异步编程的任务，使用协程可以更加便捷地完成。

本文主要介绍C++20协程的基本概念、使用方法以及示例代码。

协程概念

协程（Coroutine），也称为替代栈（Stackless）协程，是一种比线程更加轻量级的异步编程模型。协程基于生成器（Generator）模式，通过控制流的暂停和恢复来达到异步编程的目的。

在C++20中，协程范式由以下两种构建方式组成：

• Coroutine generator：生成器，用于产生一系列值，并且控制流程暂停和恢复。
• Coroutine async：异步协程，用于并发执行任务，异步等待子任务完成，并且控制流程暂停和恢复。

协程使用方法

协程定义

协程通过co_await和co_yield两个关键字来控制流程的暂停和恢复。协程函数以co_await为结构点暂停执行，并且可以恢复执行。使用协程函数需要满足以下两个条件：

1. 返回类型为一个awaiter对象。
2. 实现了await_suspend、await_resume和await_ready等三个成员函数。

创建一个简单的协程示例代码如下：

#include <coroutine>
#include <iostream>

using namespace std;

struct square_awaitable {
    int input;
    bool await_ready() {
        return true;
    }
    int await_resume() {
        return input * input;
    }
    void await_suspend(std::coroutine_handle<> coro) {
    }
};

struct square_generator {
    square_generator(int value): input(value) {}
    square_awaitable operator co_await() { return { input }; }
    bool operator() () {
        if (input > 0) {
            cout << input << " -> " << (input * input) << endl;
            input--;
            co_yield *this;
        }
        return false;
    }
private:
    int input;
};

int main() {
    square_generator g(3);
    while (g()) {}
    return 0;
}

上述示例代码中，square_generator为一个可重复执行的生成器。在while循环中，每次调用co_yield将会产生一个暂停点，控制流会暂时离开当前函数，等待下次调用时继续执行。

在实现中，square_awaitable是一个调用co_await的对象，await_ready和await_resume在这里并没有使用，await_suspend也没有做任何事情。在函数调用结束后，将会返回一个awaiter对象，该对象包含了co_await的参数input。

协程使用

使用协程的流程为：在协程中调用异步代码，将控制流交回给事件循环，等待异步回调结果，并在回调结果就绪后恢复协程执行。

以网络IO为例，以下是一个简单协程使用示例：

#include <coroutine>
#include <iostream>
#include <asio.hpp>

using namespace std;

asio::io_context io;

struct read_awaitable {
    asio::ip::tcp::socket* sock;
    size_t len;
    size_t _read_len = 0;
    bool await_ready() { 
        return false;
    }
    bool await_suspend(std::coroutine_handle<> coro) {
        sock->async_read_some(asio::buffer(read_buf, len), [this,coro](auto ec, auto len){
            _read_len = len;
            *coro.resume();
        });
        return true;
    }
    char read_buf[10240];
    size_t await_resume() {
        return _read_len;
    }
};

struct async_reader {
    asio::ip::tcp::socket* sock;
    async_reader(asio::ip::tcp::socket& socket): sock(&socket) {}
    read_awaitable operator co_await(size_t len) { return {sock, len}; }
};

asio::awaitable<void> async_http_get(asio::ip::tcp::socket& socket, asio::ip::tcp::endpoint ep) {
    co_await socket.async_connect(ep, asio::use_awaitable);
    co_await async_reader{socket}("GET / HTTP/1.0\r\n\r\n", 1024);
    char data[10240];
    co_await socket.async_read_some(asio::buffer(data, 10240), asio::use_awaitable);
    cout << data << endl;
}

int main() {
    asio::ip::tcp::socket socket(io);
    asio::co_spawn(io, async_http_get(socket, {asio::ip::address::from_string("172.217.28.163"), 80}), [](auto ec){});
    io.run();
    return 0;
}

在上述示例中，我们创建了一个协程async_http_get，在其中调用异步函数读取网络数据。在read_awaitable中，我们使用了C++20的asio库来完成异步IO操作，await_suspend中将控制流暂停，等待异步读取完成，再使用resume函数恢复协程执行。使用协程，需要通过co_spawn函数来启动异步执行，并使用io.run()进入事件循环。

示例代码

更多协程示例代码请参考examples/coroutine文件夹下的示例代码，示例包含了异步http、异步文件读取、异步定时器、异步无锁队列等。