C++/WinRT 中的敏捷对象

  • 项目

在大多数情况下，Windows 运行时类的实例可以从任何线程访问（如同大多数标准的 C++ 对象一样）。 此类 Windows 运行时类是敏捷的。 Windows 附带的 Windows 运行时类中只有一小部分是非敏捷的，但当你使用它们时，你需要考虑它们的线程模型和封送行为（封送是指跨单元边界传送数据）。 好消息是，每个 Windows 运行时对象默认情况下都是敏捷的，因此你自己的 C++/WinRT 类型默认情况下也是敏捷的。

但你可以选择退出。例如，你可能会有令人信服的理由来要求类型的对象驻留在某个给定的单线程单元中。 对于重入要求，通常需要这样做。 不过，敏捷对象越来越多，甚至用户界面 (UI) API 也提供敏捷对象。 总之，敏捷性是最简单、最有效率的选项。 此外，当实现一个激活工厂时，即使对应的运行时类不是敏捷的，激活工厂也必须是敏捷的。

注意

Windows 运行时基于 COM。 在 COM 环境中，注册的敏捷类使用 ThreadingModel = Both。 有关 COM 线程模型和单元的详细信息，请参阅了解和使用 COM 线程模型。

代码示例

让我们使用运行时类的示例实现来说明 C++/WinRT 是如何支持敏捷性的。

#include <winrt/Windows.Foundation.h>

using namespace winrt;
using namespace Windows::Foundation;

struct MyType : winrt::implements<MyType, IStringable>
{
    winrt::hstring ToString(){ ... }
};

由于我们没有选择退出，因此此实现是敏捷的。 winrt::implements 基结构实现 IAgileObject 和 IMarshal。 IMarshal 实现使用 CoCreateFreeThreadedMarshaler 来为不了解 IAgileObject 的旧代码执行正确的操作。

此代码检查对象的敏捷性。 如果 myimpl 不是敏捷的，则对 IUnknown::as 的调用将引发异常。

winrt::com_ptr<MyType> myimpl{ winrt::make_self<MyType>() };
winrt::com_ptr<IAgileObject> iagileobject{ myimpl.as<IAgileObject>() };

你可以调用 IUnknown::try_as，而不必处理异常。

winrt::com_ptr<IAgileObject> iagileobject{ myimpl.try_as<IAgileObject>() };
if (iagileobject) { /* myimpl is agile. */ }

IAgileObject 没有自己的方法，因此你无法使用它执行很多操作。 接下来的变体将更典型一些。

if (myimpl.try_as<IAgileObject>()) { /* myimpl is agile. */ }

IAgileObject 是一个标记接口。 IAgileObject 查询的成功或失败只不过是你从中获取的信息和实用工具的多少而已。

选择退出敏捷对象支持

你可通过以下方法选择明确退出敏捷对象支持：将 winrt::non_agile 标记结构作为模板参数传递给基类。

如果直接从 winrt::implements 派生。

struct MyImplementation: implements<MyImplementation, IStringable, winrt::non_agile>
{
    ...
}

如果正在创作运行时类。

struct MyRuntimeClass: MyRuntimeClassT<MyRuntimeClass, winrt::non_agile>
{
    ...
}

标记结构在 variadic 参数包中的位置无关紧要。

无论是否选择退出敏捷性，均可自行实现 IMarshal。 例如，可使用 winrt::non_agile 标记来避免默认的敏捷性实现，并自行实现 IMarshal（可能是为了支持按值封送语义）。

敏捷引用 (winrt::agile_ref)

如果你正在使用一个非敏捷对象，但你需要在某些潜在的敏捷上下文中传递该对象，那么一个选项是使用 winrt::agile_ref 结构模板来获取对非敏捷类型的实例或非敏捷对象的接口的敏捷引用。

NonAgileType nonagile_obj;
winrt::agile_ref<NonAgileType> agile{ nonagile_obj };

或者，你可以使用 winrt::make_agile 帮助程序函数。

NonAgileType nonagile_obj;
auto agile{ winrt::make_agile(nonagile_obj) };

在上述任一种情况中，agile 现在可以自由地传递到不同的单元中的线程并在其中使用。

co_await resume_background();
NonAgileType nonagile_obj_again{ agile.get() };
winrt::hstring message{ nonagile_obj_again.Message() };

Agile_ref::get 调用将返回一个可在调用 get 的线程上下文中安全使用的代理。

重要的 API