如果使用DI + MEF,在容器中的类之间传递事件的好方法是什么?

本文关键字:之间 是什么 方法 事件 DI MEF 如果 | 更新日期: 2023-09-27 18:11:15

我有一个包含数百个类的MEF容器。在不同的类之间传递消息的好方法是什么?

我更喜欢一个可以与任何依赖注入(DI)容器一起工作的解决方案,包括Unity, Castle Windsor等

如果使用DI + MEF,在容器中的类之间传递事件的好方法是什么?

注意:这是一个"分享你的知识,问答式"条目

介绍事件发布者

此事件发布者允许MEF容器中的任何类向MEF容器中的任何其他类发送消息。

这段代码已经经过多年的验证,并且在使用WPF/MVVM时特别有用。

它是一对多订阅,因此一旦消息发出,它将被任何正在观察该自定义类型消息的侦听器接收。

这个例子是为MEF,但它也适用于任何其他依赖注入(DI)容器,如Unity, Castle Windsor等。如果您将EventPublisher转换为单例,则可以将其与普通c#一起使用(即不使用DI容器)。如果你想让我发布代码,请告诉我。

这段代码并不新鲜:在开源社区中有数百种其他事件发布者的实现,例如在MVVM Light中。然而,这个例子使用了如此少量的代码,通过在调试器中单步执行,就可以看到它是如何在底层工作的。

c#使用

将锅炉板代码添加到您的项目中(见下文)。

创建自定义事件类型。它可以是一个类、一个结构体,甚至是一个enum,例如:

public enum NavigationType
{
    Unknown = 0,
    MyOption1,
    MyOption2
}

…然后,我可以将eventPublisher导入任何类,如下所示:

[ImportingConstructor]
public BrokerOrderSearchResultViewModel(
    IEventPublisher<NavigationType> eventPublisher,
    )
{
    _eventPublisher = eventPublisher;
    ...

…在构造函数中,我可以订阅类型为NavigationType的事件:

_eventPublisher.GetEvent<NavigationType>().Subscribe(o => 
{
    Console.Write(o);
});

…在其他任何地方,我都可以推出事件,这些事件将在订阅中接收:

_eventPublisher.Publish(NavigationType.MyOption1);

c#锅炉板代码

添加响应式扩展(RX) NuGet包到你的项目。

创建接口:

public interface IEventPublisher
{
    IObservable<TEvent> GetEvent<TEvent>();
    void Publish<TEvent>(TEvent sampleEvent);
}
public interface IEventPublisher<in T>
{
    IObservable<TEvent> GetEvent<TEvent>() where TEvent : T;
    void Publish<TEvent>(TEvent sampleEvent) where TEvent : T;
}

…使用这个实现:

// NOTE: This class must be a singleton (there should only ever
// be one copy; this happens automatically in any dependency injection
// container). This class is the central dictionary that routes events
// of any incoming type, to all listeners for that same type.
[Export(typeof (IEventPublisher))]
public class EventPublisher : IEventPublisher
{
    private readonly ConcurrentDictionary<Type, object> _subjects;

    public EventPublisher()
    {
        _subjects = new ConcurrentDictionary<Type, object>();
    }
    public IObservable<TEvent> GetEvent<TEvent>()
    {
        return (ISubject<TEvent>)_subjects.GetOrAdd(typeof(TEvent), t => new Subject<TEvent>());
    }
    public void Publish<TEvent>(TEvent sampleEvent)
    {
        object subject;
        if (_subjects.TryGetValue(typeof (TEvent), out subject))
        {
            ((ISubject<TEvent>)subject).OnNext(sampleEvent);
        }
        // Could add a lock here to make it thread safe, but in practice,
        // the Dependency Injection container sets everything up once on
        // startup and it doesn't change from that point on, so it just
        // works.
    }
}
// NOTE: There can be many copies of this class, one for
// each type of message. This happens automatically in any
// dependency injection container because its a <T> class. 
[Export(typeof (IEventPublisher<>))]
public class EventPublisher<T> : IEventPublisher<T>
{
    private readonly IEventPublisher _eventPublisher;
    [ImportingConstructor]
    public EventPublisher(IEventPublisher eventPublisher)
    {
        _eventPublisher = eventPublisher;
    }
    public IObservable<TEvent> GetEvent<TEvent>() where TEvent : T
    {
        return _eventPublisher.GetEvent<TEvent>();
    }
    public void Publish<TEvent>(TEvent sampleEvent) where TEvent : T
    {
        _eventPublisher.Publish(sampleEvent);
    }
}

讨论

这段代码展示了将事件从一个类发送到另一个类是多么简单。

如所示,您需要创建一个新的自定义类型来发送消息。类型可以是枚举、结构体或类。如果类型是类或结构,则它可以包含任意数量的属性。如果使用特定自定义类型发送消息,则侦听该类型消息的所有订阅者都将收到该消息。您可以创建许多自定义类型,每个类型对应您需要与之通信的事件。

在幕后,所有代码所做的就是保存一个自定义类型的字典。在发送时,它在字典中查找适当的订阅者,然后使用响应式扩展(Reactive Extensions, RX)发送消息。然后,所有侦听该类型的订阅者都将收到该消息。

有时候,如果到处都有太多的事件,很难看到哪些类在与哪些类通信。在这种情况下,这很简单:您可以使用"在文件中查找"来查找包含字符串IEventPublisher<NavigationType>的所有类,最终列出发送或侦听我们自定义类型NavigationType的事件的所有类。

注意:这段代码不是灵丹妙药。过于依赖事件是一种糟糕的代码气味,因为类层次结构应该以这样一种方式组成,即类不应该依赖于它们的父类。要了解更多信息,请研究SOLID的原理,特别是LSP。然而,有时使用事件是不可避免的,因为我们别无选择,只能跨类层次结构。

未来的增强

当前,此事件发布器未实现IDisposable。它应该。

如果你不想做一些过于复杂的事情,可以使用EventAggregator

http://blogs.msdn.com/b/gblock/archive/2009/02/23/event-aggregation-with-mef-with-and-without-eventaggregator.aspx

还有一种将其引入项目的方法MEFfy方法:

https://msdn.microsoft.com/en-us/library/microsoft.practices.prism.mefextensions.events.mefeventaggregator (v = pandp.50) . aspx

你也可以编写你自己的EventAggregator模式(根据M. Fowler),但是你必须考虑干净地删除订阅的处理程序,这很可能会导致你进入弱引用的领域,并且(或者不是)存在于那里。