快捷導(dǎo)航

C++20中的協(xié)程(Coroutine)的實現(xiàn)

更新時間：2021年03月09日 09:46:08 作者：Ninsun Closear

這篇文章主要介紹了C++20中的協(xié)程(Coroutine)的實現(xiàn)，文中通過示例代碼介紹的非常詳細，對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值，需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧

C++20中的協(xié)程(Coroutine)

從2017年開始, 協(xié)程(Coroutine)的概念就開始被建議加入C++20的標準中了，并已經(jīng)開始有人對C++20協(xié)程的提案進行了介紹。1事實上，協(xié)程的概念在很早就出現(xiàn)了，甚至其他語言（JS，Python，C#等）早就已經(jīng)支持了協(xié)程。
可見，協(xié)程并不是C++所特有的概念。

那么，什么是協(xié)程？

簡單來說，協(xié)程就是一種特殊的函數(shù)，它可以在函數(shù)執(zhí)行到某個地方的時候暫停執(zhí)行，返回給調(diào)用者或恢復(fù)者（可以有一個返回值），并允許隨后從暫停的地方恢復(fù)繼續(xù)執(zhí)行。注意，這個暫停執(zhí)行不是指將函數(shù)所在的線程暫停執(zhí)行，而是單純的暫停執(zhí)行函數(shù)本身。

那么，這種特殊函數(shù)有什么用呢？最常見的用途，就是將“異步”風格的編程“同步”化。

比如，我們有一個請求webapi的庫，然后在某個應(yīng)用中我們需要發(fā)送一個http請求，然后等待web服務(wù)器反饋消息。恰巧的是，我們需要按順序請求多次，比如，只有請求A返回了，我們才能發(fā)送請求B，因為請求B中包含請求A返回的結(jié)果。然后等請求B返回了，我們才能發(fā)送請求C等等。
我們不能阻塞主線程，那么此時我們應(yīng)該怎么辦？
最常見的思路就是開一個新線程，然后使用“回調(diào)函數(shù)”，例如：

// 示意代碼
void requestA(int req, std::function<void(int)> cb)
{
 // 我們的webapi是異步調(diào)用, 我們開啟一個線程請求并等待調(diào)用完畢
 std::thread t([req, cb]() {
    auto response = webapi.request(req);
    // 假定response有個等待返回值的接口waitForFinish，他會阻塞當前線程，直到拿到返回值
    int rt = response.waitForFinish();
    // 返回了, 那么我們調(diào)用回調(diào)函數(shù)
    cb(rt); 
  });
  t.detach();
}

假定我們還有相同結(jié)構(gòu)的requestB,requestC以及其它, 那么我們會怎么用呢? 有了lamda表達式，通過回調(diào)函數(shù)進行鏈式調(diào)用可以很簡單的寫成如下形式：

int main()
{
 requestA(1, [](int rt){
 requestB(rt, [](int rt2){
  requestC(rt2, [](int rt3){
  // 根據(jù)需要可能會繼續(xù)嵌套下去
  });
 });
 });
 // 甚至可能需要再來一遍, 因為我們還需要使用另一個參數(shù)請求
 requestA(2, [](int rt){
 requestB(rt, [](int rt2){
  requestC(rt2, [](int rt3){
  // 根據(jù)需要可能會繼續(xù)嵌套下去
  });
 });
 });
}

這還是好的，如果你使用Qt的信號槽來實現(xiàn)，并同時可能有多個請求，你可能還會遇到另一個問題：“我怎么知道這個返回值是我發(fā)送的哪個請求產(chǎn)生的？”如果webapi庫沒有提供請求與反饋之間互相對應(yīng)的相關(guān)支持，你可能會更加的郁悶。

那么, 使用協(xié)程又會有哪些不一樣呢?

想象一下, 同樣的requestA,requestB,requestC,（當然已經(jīng)修改為了協(xié)程的寫法）你可以這么用

task<void> request()
{
 int rt = co_await requestA(1);
 // 處理一些中間結(jié)果
 rt = co_await requestB(rt);
 // 處理一些中間結(jié)果
 rt = co_await requestC(rt);
 // 對最終結(jié)果做一些事情
}

這三個異步函數(shù)會在同一個線程中按照調(diào)用順序依次完成調(diào)用。

沒錯, 不再需要回調(diào)函數(shù), 你可以完全順序的, 仿佛異步調(diào)用不存在的使用同步調(diào)用的寫法。正是因為協(xié)程，我們就可以使用一個更加“同步”化的方式，實現(xiàn)異步調(diào)用了。

只要一個關(guān)鍵字co_await就能享用。隔壁的JavaScript早就用上了（ES6版本），現(xiàn)在，終于，C++也可以使用了！

那么這么好用的協(xié)程，是不是只要C++20一推出，我們加上一個關(guān)鍵字就能直接把異步調(diào)用轉(zhuǎn)化為同步調(diào)用呢？
很遺憾，并不能。

C++20的協(xié)程只是給了我們一個“使用同步風格進行異步調(diào)用”的框架，具體的實現(xiàn)還是需要我們自己去做。

如果你對JavaScript中的協(xié)程有所了解的話，就會明白，在ES6中，一個函數(shù)可以通過await等待返回的前提，是這個函數(shù)被聲明為async，而這是ES6提供的一個“語法糖”，也就是說，這個關(guān)鍵字只起到“提示”的作用，真正的實現(xiàn)是需要Promise的。
C++20中也是這樣，協(xié)程是特殊函數(shù)，但是在C++20中，這個特殊函數(shù)不是由普通函數(shù)添加一個關(guān)鍵字組成的，我們需要為實現(xiàn)這個特殊函數(shù)做一些額外的工作。

目前，C++20應(yīng)該不會提供自動化的包裝功能，或者簡化包裝的庫，也就是說，想要讓某個函數(shù)成為協(xié)程函數(shù)，我們需要人工的做一些額外的工作，一些輔助的自動化的工具應(yīng)該會在C++23標準中提供，讓協(xié)程真正的可以被廣大開發(fā)人員使用。
雖然輔助工具再C++23才會提供，但是最基礎(chǔ)的已經(jīng)在C++20中存在了。

在我們繼續(xù)講解之前，先明確一些概念。

co_return，co_yield，co_await是為了使用協(xié)程而新增加的三個關(guān)鍵字，這些關(guān)鍵字在非協(xié)程函數(shù)中是無法使用的。這也就意味著，在main函數(shù)中直接調(diào)用co_await xxxx(); 是不行的。

這似乎有點違反我們的常識。協(xié)程的關(guān)鍵字只能在協(xié)程函數(shù)中使用有點遞歸的意思，這難道意味著普通的函數(shù)中沒法使用協(xié)程函數(shù)了？這其實是我們一開始聽說協(xié)程的描述時會產(chǎn)生的一種誤解。
為了消除這種誤解，我們先了解一下到底什么是協(xié)程函數(shù)，以及它到底特殊在哪里。

協(xié)程函數(shù)和Awaitable類

接下來我們先從如何定義協(xié)程函數(shù)開始：

簡單來說，就是如果一個函數(shù)的返回值是一個符合Promise規(guī)范的類，并且在這個函數(shù)中使用了co_return，co_yield，co_await中的一個或多個，那么這個函數(shù)就是一個協(xié)程函數(shù)。

那么Promise規(guī)范又是啥？Promise在英文中是許諾的意思。簡單來說，Promise規(guī)范就是：如果在類A中定義一個叫做promise_type的結(jié)構(gòu)體，并且其中包含特定名字的函數(shù)，那么這個類A就符合Promise規(guī)范，它就是一個符合Promise規(guī)范的類，它也就是一個Promise。

比如以下例子：

struct task{
 struct promise_type {
  auto get_return_object() { return task{}; }
  std::suspend_never initial_suspend() { return {}; }
  std::suspend_never final_suspend() { return {}; }
  void return_void() {}
  void unhandled_exception() {}
 };
}

由于類task中定義了promise_type，同時其中包含了符合規(guī)范的5個函數(shù)，它就是一個Promise。
然后根據(jù)協(xié)程規(guī)范，返回這個類的函數(shù)就是協(xié)程函數(shù)，于是如果我們有以下定義：

task getTask() {
 // 實現(xiàn)中不需要返回task，也不能寫return
 co_return;
}

getTask()就是一個協(xié)程函數(shù)了。當然，如果協(xié)程函數(shù)中不使用co_wait或者co_yield其實就沒有什么意義。

然而，我們雖然有了協(xié)程函數(shù)，但是我們依舊無法使用co_await，為什么呢？因為co_await關(guān)鍵字實際上是一個運算符，其后面只能跟隨一個“實現(xiàn)了三個特定函數(shù)的類”。這三個特定函數(shù)如下所述：2

struct suspend_always {
 constexpr bool await_ready() const noexcept { return false; }
 constexpr void await_suspend(std::coroutine_handle<> h) const noexcept {}
 constexpr void await_resume() const noexcept {}
};

注意，我們實現(xiàn)的時候只需要有包含這三個名字的函數(shù)就行了，并不需要繼承。

如果我們使用co_await suspend_always(); 會發(fā)生什么呢？

suspend_always會被構(gòu)造，調(diào)用其構(gòu)造函數(shù)（一般情況下我們就可以通過構(gòu)造函數(shù)模仿一個普通的函數(shù)調(diào)用了）。
通過await_ready()判斷是否需要等待，如果返回true，就表示不需要等待，如果返回false，就表示需要等待。
如果不需要等待，則立刻執(zhí)行await_resume，否則先執(zhí)行await_suspend，然后進入等待，調(diào)用co_await awaitable(); 的函數(shù)會在這里暫停運行，但是不會影響所在線程的執(zhí)行。
我們可以在await_suspend函數(shù)中通過傳統(tǒng)的回調(diào)函數(shù)法執(zhí)行一些異步操作，然后在回調(diào)函數(shù)中調(diào)用std::coroutine_handle<>的resume函數(shù)主動恢復(fù)。
await_resume會在恢復(fù)執(zhí)行后立刻執(zhí)行，注意：co_wait的返回值就是該函數(shù)的返回值，而await_resume函數(shù)允許擁有任意的返回值類型，模板類型也是允許的。

也就是說可以使用以下的模板類讓co_wait的返回值更加的自由：3

template <class T>
struct someAsyncOpt {
 bool await_ready()
 void await_suspend(std::coroutine_handle<>);
 T await_resume();
};

最后，我們也應(yīng)該了解，同一個線程在一個時間點最多只能跑一個協(xié)程；在同一個線程中，協(xié)程的運行是穿行的，沒有數(shù)據(jù)爭用(data race)，也不需要鎖。

至此，我們完成了協(xié)程的基本介紹。

那么，到底要如何使用協(xié)程呢？

了解了協(xié)程后我們就可以發(fā)現(xiàn)了以下事實：

一個線程只能有一個協(xié)程

協(xié)程函數(shù)需要返回值是Promise
協(xié)程的所有關(guān)鍵字必須在協(xié)程函數(shù)中使用
在協(xié)程函數(shù)中可以按照同步的方式去調(diào)用異步函數(shù)，只需要將異步函數(shù)包裝在Awaitable類中，使用co_wait關(guān)鍵字調(diào)用即可。

知道了以上事實，我們就可以按照以下方式使用協(xié)程了：

在一個線程中同一個時間只調(diào)用一個協(xié)程函數(shù)，即只有一個協(xié)程函數(shù)執(zhí)行完畢了，再去調(diào)用另一個協(xié)程函數(shù)。
使用Awatiable類包裝所有的異步函數(shù)，一個異步函數(shù)處理一請求中的一部分工作（比如執(zhí)行一次SQL查詢，或者執(zhí)行一次http請求等）。
在對應(yīng)的協(xié)程函數(shù)中按照需要，通過增加co_wait關(guān)鍵字同步的調(diào)用這些異步函數(shù)。注意一個異步函數(shù)（包裝好的Awaiable類）可以在多個協(xié)程函數(shù)中調(diào)用，協(xié)程函數(shù)可能在多個線程中被調(diào)用（雖然一個線程同一時間只調(diào)用一個協(xié)程函數(shù)），所以最好保證Awaiable類是線程安全的，避免出現(xiàn)需要加鎖的情況。
在線程中通過調(diào)用不同的協(xié)程函數(shù)響應(yīng)不同的請求。