如何使用Prism框架的EventAggregator在模块间进行通信

目的

本文主要介绍如何使用Prism类库提供的事件机制在松耦合组件之间相互通信，Prism类库的事件机制建立在事件聚合服务之上，允许发布者和订阅者通过事件进行通信，不需要彼此之间引用。

事件聚合

EventAggregator提供了多点传送发布/订阅功能。这意味着可能有可以触发同一事件多个发布者和可以监听同一事件的订阅者。

使用方法

事件参数类

using Microsoft.Practices.Prism.Events;

/// <summary>
/// 定义事件，切换主题
/// </summary>
public class ChangeSystemThemeEvent : CompositePresentationEvent<string> { }

注意：

事件参数类是各模块间共享的，需要将其定义在一个公共的位置。

事件参数类需要继承CompositePresentationEvent<TPayload> ，其中TPayLoad为参数类型，注意类的实现是空的。

发布事件

using Microsoft.Practices.ServiceLocation;
using Microsoft.Practices.Prism.Events;

// 发布 改变系统主题事件
ServiceLocator.Current.GetInstance<IEventAggregator>().GetEvent<ChangeSystemThemeEvent>().Publish("主题名称");

订阅事件

CompositePresentationEvent类提供了多个重载的Subscribe方法来订阅事件，例子中使用了最基本的订阅事件的版本。

using Microsoft.Practices.Prism.Events;

//订阅 改变系统主题事件
SubscriptionToken eventToken= ServiceLocator.Current.GetInstance<IEventAggregator>().GetEvent<ChangeSystemThemeEvent>().Subscribe(ChangeThemeEvent);

/// <summary>
/// 切换主题
/// </summary>
void ChangeThemeEvent(string theme)
{
// TODO:切换系统主题处理逻辑
// Step 1.
// Step 2.
// Step 3.
}

注意：

1. 在使用Subscribe方法订阅事件时，可以使用ThreadOption 参数指定接受事件的线程。

ThreadOption可以使用：

PublisherThread.使用这个设置，在发布者进程中接收事件，这是默认设置。

BackgroundThread. 使用这个设置在.NET Framework线程池中异步接收事件。

UIThread. 使用这个设置在UI线程接收事件。

2. Subscibe方法返回一个SubscriptionToken类型的订阅标识，它可以在后面用于移除订阅事件。

3. 默认情况下，事件订阅为弱引用订阅，如果在短时间内引发多个事件并且关心其性能时，可以订阅强引用事件。在Subscribe方法中将keepSubscriberReferenceAlive参数设置为True即可实现强引用事件。如果使用了强引用，订阅者需要能够在当订阅对象不在使用时去掉订阅并正确的回收它。

4. 订阅事件时也可以通过使用filter参数来筛选是否处理发布者的事件，filter参数是System.Predicate<TPayLoad>类型。

取消订阅事件

如果订阅者不在想要接收事件，可以通过订阅者的处理逻辑来取消订阅也可以通过使用一个订阅标识来取消订阅。

using Microsoft.Practices.ServiceLocation;
using Microsoft.Practices.Prism.Events;

// 取消订阅事件
ServiceLocator.Current.GetInstance<IEventAggregator>().GetEvent<ChangeSystemThemeEvent>().Unsubscribe(eventToken);