Prism库中的事件聚合器(EventAggregator)详解

什么是事件聚合器

Prism库提供了一种基于事件聚合器(EventAggregator)的事件机制，允许应用程序中松耦合的组件之间进行通信。这种机制使得发布者和订阅者能够通过事件进行交互，而无需直接引用对方。

事件聚合器实现了多播发布/订阅功能，这意味着可以有多个发布者引发相同的事件，也可以有多个订阅者监听同一事件。在跨模块发布事件或在业务逻辑代码(如控制器和展示器)之间发送消息时，可以考虑使用事件聚合器。

核心组件

IEventAggregator接口

IEventAggregator是事件聚合器的主要接口，容器中提供的EventAggregator类实现了这个接口。它负责定位或构建事件，并维护系统中的事件集合。

public interface IEventAggregator
{
    TEventType GetEvent<TEventType>() where TEventType : EventBase;
}

PubSubEvent类

PubSubEvent是Prism库中EventBase类的唯一实现，它负责连接发布者和订阅者，维护订阅者列表并将事件分派给订阅者。

PubSubEvent是一个泛型类，需要定义有效负载类型作为泛型类型参数。这有助于在编译时强制发布者和订阅者提供正确的方法以实现成功的事件连接。

事件生命周期

创建事件

要创建一个事件，需要从PubSubEvent<TPayload>派生一个特定的事件类。TPayload是事件有效负载的类型，当事件发布时，这个有效负载将作为参数传递给订阅者。

public class TickerSymbolSelectedEvent : PubSubEvent<string>{}

在复合应用程序中，事件通常会在多个模块之间共享，因此它们通常定义在共享程序集(如"Core"或"Infrastructure"项目)中。

发布事件

发布者通过从EventAggregator获取事件并调用Publish方法来引发事件。要访问EventAggregator，可以通过依赖注入在类构造函数中添加IEventAggregator类型的参数。

public class MainPageViewModel
{
    IEventAggregator _eventAggregator;
    
    public MainPageViewModel(IEventAggregator ea)
    {
        _eventAggregator = ea;
    }
    
    void PublishEvent()
    {
        _eventAggregator.GetEvent<TickerSymbolSelectedEvent>().Publish("STOCK0");
    }
}

订阅事件

订阅者可以使用PubSubEvent类上的Subscribe方法重载之一来订阅事件。

public class MainPageViewModel
{
    public MainPageViewModel(IEventAggregator ea)
    {
        ea.GetEvent<TickerSymbolSelectedEvent>().Subscribe(ShowNews);
    }

    void ShowNews(string companySymbol)
    {
        // 实现逻辑
    }
}

高级订阅选项

在UI线程上订阅

当订阅者需要在接收到事件后更新UI元素时，可以指定在UI线程上接收事件：

ea.GetEvent<TickerSymbolSelectedEvent>().Subscribe(ShowNews, ThreadOption.UIThread);

可用的ThreadOption选项包括：

• PublisherThread：在发布者的线程上接收事件(默认设置)
• BackgroundThread：在.NET线程池线程上异步接收事件
• UIThread：在UI线程上接收事件

订阅过滤

订阅者可以使用过滤参数来只处理符合特定条件的事件：

tickerEvent.Subscribe(ShowNews, ThreadOption.UIThread, false, 
                     companySymbol => companySymbol == "STOCK0");

使用强引用订阅

默认情况下，PubSubEvent使用弱委托引用来订阅，这允许订阅者在不再使用时被垃圾回收。但在性能关键场景下，可以使用强引用：

bool keepSubscriberReferenceAlive = true;
tickerEvent.Subscribe(ShowNews, ThreadOption.UIThread, keepSubscriberReferenceAlive, 
                     companySymbol => companySymbol == "STOCK0");

取消订阅

当订阅者不再需要接收事件时，可以通过以下方式取消订阅：

1. 直接使用处理程序取消订阅：

_event.Unsubscribe(ShowNews);

2. 使用订阅令牌取消订阅：

SubscriptionToken _token = _event.Subscribe(ShowNews);
// ...
_event.Unsubscribe(_token);

最佳实践

1. 对于跨模块通信，优先使用事件聚合器而不是直接引用
2. 在UI更新场景中，确保在正确的线程上处理事件
3. 谨慎使用强引用订阅，记得在不再需要时手动取消订阅
4. 考虑将共享事件定义在公共程序集中
5. 避免在回调委托中修改有效负载对象，以防止并发问题

事件聚合器是Prism库中实现松耦合通信的强大工具，合理使用可以大大提高应用程序的模块化和可维护性。