事件 (C++/CX)
Windows 运行时类型可声明（即发布）事件，同一组件或其他组件中的客户端代码可通过将名为 event handlers 的方法与事件相关联来订阅这些事件。 一个事件可以有多个事件处理程序与之关联。 当发布对象引发事件时，将调用所有事件处理程序。 这样，订阅类可在发布者引发事件时执行任何适当的自定义操作。 属于委托类型的事件可指定在所有事件处理程序订阅事件时所需的签名。
使用 Windows 组件中的事件
Windows 运行时中的许多组件都公开事件。 例如，当传感器报告新的发光值时，LightSensor 对象触发 ReadingChanged 事件。 在程序中使用 LightSensor 对象时，可定义一个在激发 ReadingChanged 事件时调用的方法。 该方法可以执行任何所需操作；唯一的要求是它的签名必须与调用的委托的签名匹配。 有关如何创建委托事件处理程序和订阅事件的详细信息，请参阅委托。
创建自定义事件
声明
你可以在 ref 类或接口中声明事件，它可具有公共、内部（公共/私有）、公共受保护、受保护、私有受保护或私有可访问性。 在声明事件时，编译器会在内部创建一个对象，该对象将公开两个方法：add 和 remove。 在订阅对象寄存器事件处理程序时，事件对象会将其存储在集合中。 激发事件时，事件对象将依次调用其列表中的所有处理程序。 普通事件（如以下示例中的事件）具有隐式后备存储，以及隐式的 add 和 remove 访问器方法。 你可以按照对属性指定自定义 get 和 set 访问器的方式指定自己的访问器。 实现类不能手动遍历常用事件中的事件订阅服务器列表。
下面的示例演示如何声明和触发事件。 请注意，该事件有一个委托类型并用“^”符号声明。
namespace EventTest
{
ref class Class1;
public delegate void SomethingHappenedEventHandler(Class1^ sender, Platform::String^ s);
public ref class Class1 sealed
{
public:
Class1(){}
event SomethingHappenedEventHandler^ SomethingHappened;
void DoSomething()
{
//Do something....
// ...then fire the event:
SomethingHappened(this, L"Something happened.");
}
};
}
使用情况
下面的示例演示订阅类如何使用 += 运算符订阅事件并在激发事件时调用事件处理程序。 请注意，提供的函数与 EventTest 命名空间中的发布程序端上定义的委托的签名匹配。
namespace EventClient
{
using namespace EventTest;
namespace PC = Platform::Collections; //#include <collection.h>
public ref class Subscriber sealed
{
public:
Subscriber() : eventCount(0)
{
// Instantiate the class that publishes the event.
publisher= ref new EventTest::Class1();
// Subscribe to the event and provide a handler function.
publisher->SomethingHappened +=
ref new EventTest::SomethingHappenedEventHandler(
this,
&Subscriber::MyEventHandler);
eventLog = ref new PC::Map<int, Platform::String^>();
}
void SomeMethod()
{
publisher->DoSomething();
}
void MyEventHandler(EventTest::Class1^ mc, Platform::String^ msg)
{
// Our custom action: log the event.
eventLog->Insert(eventCount, msg);
eventCount++;
}
private:
PC::Map<int, Platform::String^>^ eventLog;
int eventCount;
EventTest::Class1^ publisher;
};
}
警告
通常，除非要格外注意以避免循环引用，否则更好的做法是对事件处理程序使用命名函数而不是 lambda。 命名函数会通过弱引用捕获“this”指针，而 lambda 通过强引用捕获该指针并创建一个循环引用。 有关更多信息，请参见 弱引用和中断循环 (C++/CX)。
自定义添加和移除方法
在内部，事件具有添加方法、移除方法和引发方法。 在客户端代码订阅事件时，将调用添加方法，并且传入的委托将添加到事件的调用列表中。 发布类调用事件，这将导致调用 raise() 方法，并依次调用列表中的每个委托。 订阅方可将其自身从委托列表中移除，这将导致调用事件的移除方法。 如果你未在代码中定义这些方法，则编译器将提供这些方法的默认版本；它们称为常用事件。 在许多情况下，只需一个常用事件。
如果你必须执行自定义逻辑以响应添加或移除订户的操作，则可以为事件指定自定义添加、移除和引发方法。 例如，如果你具有只在报告事件时才需要的高开销对象，那么你可以延迟创建该对象，直到客户端实际订阅事件时为止。
下一个示例演示如何在事件中添加自定义添加、移除和引发方法：
namespace EventTest2
{
ref class Class1;
public delegate void SomethingHappenedEventHandler(Class1^ sender, Platform::String^ msg);
public ref class Class1 sealed
{
public:
Class1(){}
event SomethingHappenedEventHandler^ SomethingHappened;
void DoSomething(){/*...*/}
void MethodThatFires()
{
// Fire before doing something...
BeforeSomethingHappens(this, "Something's going to happen.");
DoSomething();
// ...then fire after doing something...
SomethingHappened(this, L"Something happened.");
}
event SomethingHappenedEventHandler^ _InternalHandler;
event SomethingHappenedEventHandler^ BeforeSomethingHappens
{
Windows::Foundation::EventRegistrationToken add(SomethingHappenedEventHandler^ handler)
{
// Add custom logic here:
//....
return _InternalHandler += handler;
}
void remove(Windows::Foundation::EventRegistrationToken token)
{
// Add custom logic here:
//....
_InternalHandler -= token;
}
void raise(Class1^ sender, Platform::String^ str)
{
// Add custom logic here:
//....
return _InternalHandler(sender, str);
}
}
};
}
从订户端移除事件处理程序
在某些少见的情况下，你可能希望移除先前订阅的事件的事件处理程序。 例如，你可能要用另一个事件处理程序替换它，或者删除它占有的一些资源。 若要移除处理程序，必须存储自 += 操作返回的 EventRegistrationToken。 然后，可以对标记使用 -= 运算符以移除事件处理程序。 但是，即使在移除原始处理程序后，也仍可以调用它。 例如，事件源获取处理程序列表并开始调用它们时，可能会出现争用条件。 如果在发生此情况时删除事件处理程序，则列表将过期。 因此，如果要删除事件处理程序，请创建成员标志。 如果事件被删除，则设置它，然后在事件处理程序中，检查标志，如果已设置，则立即返回。 下一个示例演示基本模式。
namespace EventClient2
{
using namespace EventTest2;
ref class Subscriber2 sealed
{
private:
bool handlerIsActive;
Platform::String^ lastMessage;
void TestMethod()
{
Class1^ c1 = ref new Class1();
handlerIsActive = true;
Windows::Foundation::EventRegistrationToken cookie =
c1->SomethingHappened +=
ref new EventTest2::SomethingHappenedEventHandler(this, &Subscriber2::MyEventHandler);
c1->DoSomething();
// Do some other work�..then remove the event handler and set the flag.
handlerIsActive = false;
c1->SomethingHappened -= cookie;
}
void MyEventHandler(Class1^ mc, Platform::String^ msg)
{
if (!handlerIsActive)
return;
lastMessage = msg;
}
};
}
备注
多个处理程序可以与同一事件关联。 事件源按顺序从同一线程调用到所有事件处理程序。 如果一个事件接收器在事件处理程序方法内受阻，则它将阻止事件源为该事件调用其他事件处理程序。
事件源对事件接收器调用事件处理程序的顺序不能保证，可能因调用而异。
另请参阅
反馈
即将发布：在整个 2024 年，我们将逐步淘汰作为内容反馈机制的“GitHub 问题”，并将其取代为新的反馈系统。 有关详细信息，请参阅：https://aka.ms/ContentUserFeedback。
提交和查看相关反馈