插件系统:如何处理主机应用程序和插件之间的事件

本文关键字:插件 应用程序 主机 之间 事件 处理 系统 何处理 | 更新日期: 2023-09-27 17:50:52

注意:我需要使用.NET 3.5

我的测试应用程序分为三个部分(不同的项目和不同的dll(;主机应用程序、插件sdk和测试插件。

主机应用程序是一个WPF应用程序,有一个区域可以从插件加载到视图中。插件是通过反射加载的。这部分工作正常。

SDK包含插件可以实现的通用接口。我的一个接口有一个插件必须实现的事件,当它被触发时,主应用程序需要监听它,以执行基于自定义EventArgs的操作。SDK是从主机应用程序和插件中引用的。

我的第一个通用插件加载程序:

public static class GenericPluginLoader<T>
{
    public static ICollection<T> LoadPlugins(string path)
    {
        string[] dllFileNames = null;
        if (Directory.Exists(path))
        {
            dllFileNames = Directory.GetFiles(path, "*.dll");
            var assemblies = new List<Assembly>(dllFileNames.Length);
            foreach (var dllFile in dllFileNames)
            {
                var an = AssemblyName.GetAssemblyName(dllFile);
                var assembly = Assembly.Load(an);
                assemblies.Add(assembly);
            }
            var pluginType = typeof(T);
            var pluginTypes = new List<Type>();
            foreach (var assembly in assemblies)
            {
                if (assembly != null)
                {
                    Type[] types = assembly.GetTypes();
                    foreach (var type in types)
                    {
                        if (type.IsInterface || type.IsAbstract)
                        {
                            continue;
                        }
                        else
                        {
                            if (type.GetInterface(pluginType.FullName) != null)
                            {
                                pluginTypes.Add(type);
                            }
                        }
                    }
                }
            }
            var plugins = new List<T>(pluginTypes.Count);
            foreach (var type in pluginTypes)
            {
                var plugin = (T)Activator.CreateInstance(type);
                plugins.Add(plugin);
            }
            return plugins;
        }
        return null;
    }
}

我想要插件til实现的带有事件的接口以及自定义事件参数

public class JournalLineEventArgs : EventArgs
{
    public string LineNumber { get; set; }
}
public interface IJournalPlugin
{
    event EventHandler<JournalLineEventArgs> LineAdding;
}

我的插件中的事件处理程序

public event EventHandler<JournalLineEventArgs> LineAdding;

在我的主机应用程序中,我将插件加载到列表中,然后添加事件处理程序

private void InitializeIJournalPlugins()
{
    foreach (var plugin in journalPlugins) 
        plugin.LineAdding += OnJournalAdd;
}

这里的主要问题是,当我从插件中引发事件时,它会给我一个null引用异常。我认为这可能是因为主机应用程序知道插件事件,但插件不知道有任何东西在监听它——我是对的吗?(但是我该怎么做呢?

----更新2015-05-26 15:08-----

我现在通过绑定到WPF按钮的命令调用它:

public ICommand JournalLineCommand
{
    get
    {
        var eventArgs = new JournalLineEventArgs()
        {
            LineNumber = TextField
        };             
        return new RelayCommand(() => LineAdding(this, eventArgs));
    }
}

当我尝试引发它时,该事件为null。

插件系统:如何处理主机应用程序和插件之间的事件

我建议您重新思考应用程序的体系结构,以便使用标准解决方案来解决您的问题。

正如Aron所指出的,您可以使用EventAggregator在整个应用程序中发布和订阅事件。您可以使用现有的许多实现中的任何一个,这里有一个使用轻量级Caliburn.Micro.EventAggregator:的简单示例

示例事件:

public class SampleEvent
{
    public SampleEvent(int lineNumber)
    {
        LineNumber = lineNumber;
    }
    public int LineNumber { get; private set; }
}

样本发布商:

public class Publisher
{
    public Publisher(IEventAggregator eventAggregator)
    {
        EventAggregator = eventAggregator;            
    }
    public void PublishLineNumber(int lineNumber)
    {
        EventAggregator.Publish(new SampleEvent(lineNumber));
    }
    public IEventAggregator EventAggregator { get; private set; }
}

示例用户:

public class Subscriber : IHandle<SampleEvent>
{
    public Subscriber(IEventAggregator eventAggregator)
    {
        EventAggregator = eventAggregator;
        EventAggregator.Subscribe(this);
    }
    public IEventAggregator EventAggregator { get; private set; }
    public void Handle(SampleEvent message)
    {
        Console.WriteLine(message.LineNumber);
    }
}

主要方法:

static void Main(string[] args)
    {
        EventAggregator eventAggregator = new EventAggregator();
        Publisher publisher = new Publisher(eventAggregator);
        Subscriber subscriber = new Subscriber(eventAggregator);
        publisher.PublishLineNumber(5);
        Console.ReadLine();
    }

至于加载插件,我建议您使用MEF出口/进口。

您可以将它们与.NET 3.5 一起使用

您不应该重新发明轮子。微软模式团队已经有了一个用插件体系结构编写WPF应用程序的库。

Install-Package Prism.PubSubEvents

https://msdn.microsoft.com/en-us/library/ff921122.aspx

编辑:对于那些仍在使用.net 2.0的用户,当然有Prism 2.x

https://msdn.microsoft.com/en-us/library/ff648611.aspx