windows C++-在 C++/WinRT 中使用委托处理事件(下)

撤销已注册的委托

当你注册委托时，通常会向你返回一个令牌。 随后，可以使用该令牌撤销委托；这意味着将从事件取消注册委托，再次引发该事件时不会调用该委托。

为简单起见，上面的代码示例都没有介绍如何执行该操作。 但下面这个代码示例将令牌存储在结构的专用数据成员中，并在析构函数中撤销令牌的处理程序。

struct Example : ExampleT<Example>
{Example(winrt::Windows::UI::Xaml::Controls::Button const& button) : m_button(button){m_token = m_button.Click([this](IInspectable const&, RoutedEventArgs const&){// ...});}~Example(){m_button.Click(m_token);}private:winrt::Windows::UI::Xaml::Controls::Button m_button;winrt::event_token m_token;
};

可以不进行上面示例中的强引用，而存储对按钮的弱引用。

当事件源以同步方式引发其事件时，你就可以放心地撤销处理程序：不会收到更多事件了。 但对于异步事件，即使在撤销（尤其是在析构函数中撤销）后，你的对象在开始析构后仍可能收到正在进行的事件。 在析构之前找到取消订阅的地方也许可以缓解此问题。

或者，当你注册代理时，也可以指定 winrt::auto_revoke（即 winrt::auto_revoke_t 类型的值）以请求一个事件撤销程序（winrt::event_revoker 类型） 。 事件撤销程序为你保留对事件源（引发事件的对象）的弱引用。 可以通过调用 event_revoker::revoke 成员函数手动撤销；但事件撤销程序会在该函数超出范围时自动调用函数本身 。 撤销函数检查事件源是否仍然存在，如果存在，将撤销你的代理 。 在本示例中，无需存储事件源，并且不需要析构函数。

struct Example : ExampleT<Example>
{Example(winrt::Windows::UI::Xaml::Controls::Button button){m_event_revoker = button.Click(winrt::auto_revoke,[this](IInspectable const& /* sender */,RoutedEventArgs const& /* args */){// ...});}private:winrt::Windows::UI::Xaml::Controls::Button::Click_revoker m_event_revoker;
};

 下面是摘自 ButtonBase::Click 事件的文档主题的语法块 。 它显示了三个不同的注册和撤销函数。 可以清楚地看到从第三个重载进行声明时需要哪种类型的事件撤销程序。 你可以将相同类型的委托传递给“注册”和“使用 event_revoker 撤销”重载 。

// Register
winrt::event_token Click(winrt::Windows::UI::Xaml::RoutedEventHandler const& handler) const;// Revoke with event_token
void Click(winrt::event_token const& token) const;// Revoke with event_revoker
Button::Click_revoker Click(winrt::auto_revoke_t,winrt::Windows::UI::Xaml::RoutedEventHandler const& handler) const;

 在上述代码示例中，Button::Click_revoker 是 winrt::event_revoker<winrt::Windows::UI::Xaml::Controls::Primitives::IButtonBase> 的类型别名。 类似的模式适用于所有 C++/WinRT 事件。 每个 Windows 运行时事件都具有返回事件撤销程序的撤销函数重载，且该撤销程序的类型是事件源的成员。

另一个示例是，CoreWindow::SizeChanged 事件具有注册函数重载，它返回类型 CoreWindow::SizeChanged_revoker 的值 。

在页面-导航方案中，可以考虑撤销处理程序。 如果反复进入某个页面然后退出，则可以在离开该页面时撤销任何处理程序。 或者，如果你重复使用同一页面实例，请检查令牌的值，仅在该值未设置时注册 (if (!m_token){ ... })。 第三个选项是将事件撤销程序作为数据成员存储在页面中。 第四个选项（将在本主题后面描述）是捕获对 lambda 函数中的 this 对象的强引用或弱引用 。 

 如果“自动撤销”委托无法注册

如果在注册委托时尝试指定 winrt::auto_revoke，并且结果是 winrt::hresult_no_interface 异常，那么这通常意味着，事件源不支持弱引用。 例如，这是 Windows.UI.Composition 命名空间中的常见情况。 在此情况下，不能使用自动撤销功能。 必须故障回复到手动撤销事件处理程序。

异步操作和运算的委托类型

前面的示例使用的是 RoutedEventHandler 委托类型，但当然还有很多其他委托类型 。 例如，异步操作和运算（带进度和不带进度）具有期望相应类型的委托的已完成和/或进度事件。 例如，带进度的异步运算进度事件（可以是实现 IAsyncOperationWithProgress 的任何内容）需要 AsyncOperationProgressHandler 类型的委托 。 下面是使用 lambda 函数创作该类型的委托的代码示例。 该示例还演示了如何创作 AsyncOperationWithProgressCompletedHandler 代理 。

#include <winrt/Windows.Foundation.h>
#include <winrt/Windows.Web.Syndication.h>using namespace winrt;
using namespace Windows::Foundation;
using namespace Windows::Web::Syndication;void ProcessFeedAsync()
{Uri rssFeedUri{ L"https://blogs.windows.com/feed" };SyndicationClient syndicationClient;auto async_op_with_progress = syndicationClient.RetrieveFeedAsync(rssFeedUri);async_op_with_progress.Progress([](IAsyncOperationWithProgress<SyndicationFeed,RetrievalProgress> const& /* sender */,RetrievalProgress const& args){uint32_t bytes_retrieved = args.BytesRetrieved;// use bytes_retrieved;});async_op_with_progress.Completed([](IAsyncOperationWithProgress<SyndicationFeed,RetrievalProgress> const& sender,AsyncStatus const /* asyncStatus */){SyndicationFeed syndicationFeed = sender.GetResults();// use syndicationFeed;});// or (but this function must then be a coroutine, and return IAsyncAction)// SyndicationFeed syndicationFeed{ co_await async_op_with_progress };
}

如上面的“协同程序”注释所示，与将代理与异步操作和运算的已完成事件结合使用相比，你可能会发现使用协同程序更自然。 

对一个异步操作或运算实现多个完成处理程序是错误的做法 。 可对其已完成的事件使用单个委托，或者可对其运行 co_await。 如果同时采用这两种方法，则第二种方法会失败。

如果坚持使用委托而不是协同程序，则可以选择更简单的语法。

async_op_with_progress.Completed([](auto&& /*sender*/, AsyncStatus const /* args */)
{// ...
});

 返回一个值的代理类型

某些委托类型本身必须返回一个值。 示例：ListViewItemToKeyHandler，它将返回一个字符串 。 下面是创作该类型的委托的示例（请注意，lambda 函数将返回一个值）。

using namespace winrt::Windows::UI::Xaml::Controls;winrt::hstring f(ListView listview)
{return ListViewPersistenceHelper::GetRelativeScrollPosition(listview, [](IInspectable const& item){return L"key for item goes here";});
}

使用事件处理委托安全访问 this 指针

如果你使用对象的成员函数处理事件，或者从对象成员函数中的某个 lambda 函数内部处理事件，则需要考虑事件接收方（处理事件的对象）和事件源（引发事件的对象）的相对生存期。