使用 C++/WinRT 的并发和异步操作

Important

本主题介绍协同例程和 co_await 的概念，我们建议你在 UI 应用程序和非 UI 应用程序中使用它们。为简单起见，本介绍性主题中的大多数代码示例都显示了Windows控制台应用程序（C++/WinRT）项目。本主题中后面的代码示例使用协同例程，但为方便起见，控制台应用程序示例还会在退出前继续使用阻止性的 get 函数调用，这样应用程序就不会在显示其输出之前退出。你不会从 UI 线程执行该操作（调用阻止 get 函数）。相反，你将使用 co_await 语句。在 UI 应用程序中使用的技术在主题 “高级并发”和“异步”主题中介绍。

本介绍性主题介绍了一些方法，你可以使用 C++/WinRT 创建和使用Windows 运行时异步对象。阅读本主题后，另请参阅高级并发和异步，尤其是有关将用于 UI 应用程序的技术。

异步操作和 Windows 运行时“Async”函数

任何具有完成时间可能超过 50 毫秒的Windows 运行时 API 都作为异步函数实现（名称以“Async”结尾）。异步函数的实现在另一个线程上启动工作，并使用表示异步操作的对象立即返回。异步操作完成后，返回的对象包含工作产生的任何值。 Windows：：Foundation Windows 运行时命名空间包含四种类型的异步操作对象。

其中每个异步操作类型都投影到 winrt：：Windows：：Foundation C++/WinRT 命名空间中的相应类型。 C++/WinRT 还包含一个内部的 await 适配器结构体。你不会直接使用它，但是，由于该结构，你可以编写一个 co_await 语句，以协作等待返回这些异步操作类型之一的任何函数的结果。然后，可以自行创作返回这些类型的协同例程。

异步Windows函数的示例是 SyndicationClient：：RetrieveFeedAsync，该函数返回 IAsyncOperationWithProgress TResult、 TProgress<> 类型的异步操作对象。

让我们来看一些阻止和不阻止使用 C++/WinRT 来调用类似 API 的方法。为了说明基本思路，我们将在接下来的几个代码示例中使用Windows控制台应用程序（C++/WinRT）项目。高级并发和异步中讨论了更适合 UI 应用程序的技术。

阻止调用线程

下面的代码示例从 RetrieveFeedAsync 接收一个异步操作对象，并对该对象调用 get，以阻塞调用线程，直到异步操作的结果可用。

如果要将此示例直接复制粘贴到Windows控制台应用程序（C++/WinRT）项目的主源代码文件中，请先在项目属性中设置“不使用预编译标头”。

// main.cpp
#include <winrt/Windows.Foundation.h>
#include <winrt/Windows.Web.Syndication.h>

using namespace winrt;
using namespace Windows::Foundation;
using namespace Windows::Web::Syndication;

void ProcessFeed()
{
    Uri rssFeedUri{ L"https://blogs.windows.com/feed" };
    SyndicationClient syndicationClient;
    SyndicationFeed syndicationFeed{ syndicationClient.RetrieveFeedAsync(rssFeedUri).get() };
    // use syndicationFeed.
}

int main()
{
    winrt::init_apartment();
    ProcessFeed();
}

调用 get 可以方便编写代码，对于出于任何原因不想使用协同例程的控制台应用或后台线程来说，这是一种理想选择。但这既不是并发也不是异步操作，因此不适合 UI 线程（如果试图在 UI 线程上使用它，会在未优化的版本中触发断言）。为了避免阻塞 OS 线程，使其无法执行其他有用的工作，我们需要采用另一种方法。

编写协同例程

C++/WinRT 将 C++ 协同例程集成到编程模型中，以提供一种自然的方式来协作等待结果。可以通过编写协同例程来生成自己的 Windows 运行时异步操作。在下面的代码示例中，ProcessFeedAsync 是协程。

注释

get 函数存在于 C++/WinRT 投影类型 winrt：：Windows：：Foundation：：IAsyncAction 上，因此可以从任何 C++/WinRT 项目中调用函数。找不到作为 IAsyncAction 接口的成员列出的函数，因为 get 不是实际Windows 运行时类型 IAsyncAction 的应用程序二进制接口（ABI）图面的一部分。

// main.cpp
#include <iostream>
#include <winrt/Windows.Foundation.Collections.h>
#include <winrt/Windows.Web.Syndication.h>

using namespace winrt;
using namespace Windows::Foundation;
using namespace Windows::Web::Syndication;

void PrintFeed(SyndicationFeed const& syndicationFeed)
{
    for (SyndicationItem const& syndicationItem : syndicationFeed.Items())
    {
        std::wcout << syndicationItem.Title().Text().c_str() << std::endl;
    }
}

IAsyncAction ProcessFeedAsync()
{
    Uri rssFeedUri{ L"https://blogs.windows.com/feed" };
    SyndicationClient syndicationClient;
    SyndicationFeed syndicationFeed{ co_await syndicationClient.RetrieveFeedAsync(rssFeedUri) };
    PrintFeed(syndicationFeed);
}

int main()
{
    winrt::init_apartment();

    auto processOp{ ProcessFeedAsync() };
    // do other work while the feed is being printed.
    processOp.get(); // no more work to do; call get() so that we see the printout before the application exits.
}

协同例程是可以暂停和恢复的函数。在上面的 ProcessFeedAsync 协程中，当执行到 co_await 语句时，该协程会异步发起对 RetrieveFeedAsync 的调用，然后立即挂起自身，并将控制权返回给调用方（在上面的示例中，即 main）。然后，main 可以继续执行工作，同时将检索并打印提要。完成该操作（RetrieveFeedAsync 调用完成）后，ProcessFeedAsync 协同例程将在下一个语句中恢复。

可以将一个协同例程聚合到其他协同例程中。或者，也可以调用 get 以阻塞和等待其完成（以及获得结果，如果有）。也可以将其传递给支持Windows 运行时的另一种编程语言。

也可以通过使用委托来处理异步操作的已完成和/或正在进行中的事件。有关详细信息和代码示例，请参阅异步操作和操作的委托类型。

如上所示，在上面的代码示例中，我们在退出 main 之前继续使用阻止 get 函数调用。但这只是使应用程序在完成打印输出之前不会退出。

异步返回 Windows 运行时类型

在下一个示例中，我们封装了针对特定 URI 对 RetrieveFeedAsync 的调用，从而得到一个异步返回 SyndicationFeed 的 RetrieveBlogFeedAsync 函数。

// main.cpp
#include <iostream>
#include <winrt/Windows.Foundation.Collections.h>
#include <winrt/Windows.Web.Syndication.h>

using namespace winrt;
using namespace Windows::Foundation;
using namespace Windows::Web::Syndication;

void PrintFeed(SyndicationFeed const& syndicationFeed)
{
    for (SyndicationItem const& syndicationItem : syndicationFeed.Items())
    {
        std::wcout << syndicationItem.Title().Text().c_str() << std::endl;
    }
}

IAsyncOperationWithProgress<SyndicationFeed, RetrievalProgress> RetrieveBlogFeedAsync()
{
    Uri rssFeedUri{ L"https://blogs.windows.com/feed" };
    SyndicationClient syndicationClient;
    return syndicationClient.RetrieveFeedAsync(rssFeedUri);
}

int main()
{
    winrt::init_apartment();

    auto feedOp{ RetrieveBlogFeedAsync() };
    // do other work.
    PrintFeed(feedOp.get());
}

在上面的示例中，RetrieveBlogFeedAsync 返回一个 IAsyncOperationWithProgress，它同时具有进度和返回值。在 RetrieveBlogFeedAsync 运行并检索源的同时，我们还可以执行其他工作。然后，我们对该异步操作对象调用 get 以阻塞并等待其完成，然后获取该操作的结果。

如果要异步返回 Windows 运行时类型，那么应返回一个 IAsyncOperation<TResult> 或一个 IAsyncOperationWithProgress<TResult, TProgress>。任何第一方或第三方运行时类都符合条件，或者任何可传入 Windows 运行时函数或可从 Windows 运行时函数传出的类型也都符合条件（例如 int 或 winrt::hstring）。如果尝试将其中一种异步操作类型与非Windows 运行时类型一起使用，编译器将帮助你解决“T 必须为 WinRT 类型”错误。

如果协程没有至少一个 co_await 语句，那么要被视为协程，它必须至少有一个 co_return 或 co_yield 语句。在某些情况下，协同例程可以返回值而不引入任何异步，因此不阻塞也不切换上下文。下面是一个通过缓存某个值来实现这一点的示例（在第二次及之后的调用时）。

winrt::hstring m_cache;

IAsyncOperation<winrt::hstring> ReadAsync()
{
    if (m_cache.empty())
    {
        // Asynchronously download and cache the string.
    }
    co_return m_cache;
}

异步返回非 Windows Runtime 类型

如果要异步返回非 Windows 运行时类型的类型，则应返回并行模式库 (PPL) concurrency::task。建议使用 并发：：task ，因为它可提供比 std：：future 更好的性能（以及更好的兼容性）。

小窍门

如果包含 <pplawait.h>，则可以将 concurrency::task 用作协程类型。

// main.cpp
#include <iostream>
#include <ppltasks.h>
#include <winrt/Windows.Foundation.Collections.h>
#include <winrt/Windows.Web.Syndication.h>

using namespace winrt;
using namespace Windows::Foundation;
using namespace Windows::Web::Syndication;

concurrency::task<std::wstring> RetrieveFirstTitleAsync()
{
    return concurrency::create_task([]
        {
            Uri rssFeedUri{ L"https://blogs.windows.com/feed" };
            SyndicationClient syndicationClient;
            SyndicationFeed syndicationFeed{ syndicationClient.RetrieveFeedAsync(rssFeedUri).get() };
            return std::wstring{ syndicationFeed.Items().GetAt(0).Title().Text() };
        });
}

int main()
{
    winrt::init_apartment();

    auto firstTitleOp{ RetrieveFirstTitleAsync() };
    // Do other work here.
    std::wcout << firstTitleOp.get() << std::endl;
}

参数传递

对于同步函数，默认情况下应使用 const& 参数。这将避免复制开销（涉及引用计数，意味着互锁的增加和减少）。

// Synchronous function.
void DoWork(Param const& value);

但如果向协同例程传递引用参数，可能会遇到问题。

// NOT the recommended way to pass a value to a coroutine!
IASyncAction DoWorkAsync(Param const& value)
{
    // While it's ok to access value here...

    co_await DoOtherWorkAsync(); // (this is the first suspension point)...

    // ...accessing value here carries no guarantees of safety.
}

在协同程序中，在第一个暂停点之前，执行是同步的；到达第一个暂停点时，控制返回到调用方，调用帧超出范围。在协同例程恢复时，引用参数引用的源值可能已发生更改。从协同例程的角度来看，引用参数具有不受控制的生命周期。因此，在上面的示例中，我们可以一直安全地访问 value，直到 co_await；但在这之后就不能再访问它了。如果调用方销毁了 value，则尝试在协同例程中访问它会导致内存损坏。如果 DoOtherWorkAsync 函数有可能暂停并在恢复后尝试使用 value，我们也无法安全地将 value 传递给 DoOtherWorkAsync。

为了能够在暂停和恢复后安全地使用参数，默认情况下，协同例程应使用按值传递，以确保按值进行捕获并避免生命周期问题。如果你确信这样做是安全的，那么可以偏离该指导意见的情况将极为罕见。

// Coroutine
IASyncAction DoWorkAsync(Param value); // not const&

按值传递要求参数的移动或复制开销不高，智能指针通常就是这样的。

也可以认为（除非你想要移动值）通过常量值传递是很好的做法。它不会对你要复制的源值产生任何影响，但这样能让意图更明确，而且如果你不小心修改了副本，也会有所帮助。

// coroutine with strictly unnecessary const (but arguably good practice).
IASyncAction DoWorkAsync(Param const value);

另请参阅标准数组和向量，其中说明了如何将标准向量传递给异步被调用方。

如果不能更改协同例程的签名，但是能够更改实现，则可在首次执行 co_await 之前进行本地复制。

IASyncAction DoWorkAsync(Param const& value)
{
    auto safe_value = value;
    // It's ok to access both safe_value and value here.

    co_await DoOtherWorkAsync();

    // It's ok to access only safe_value here (not value).
}

如果 Param 复制代价很高，那么就在第一个 co_await 之前只提取你需要的部分。

IASyncAction DoWorkAsync(Param const& value)
{
    auto safe_data = value.data;
    // It's ok to access safe_data, value.data, and value here.

    co_await DoOtherWorkAsync();

    // It's ok to access only safe_data here (not value.data, nor value).
}

在类成员协同例程中安全访问 this 指针

请参阅 C++/WinRT 中的强引用和弱引用。

重要 API

反馈

此页面是否有帮助？

Last updated on 2026-07-06