如何通过添加/删除插件文件使应用程序可插入?

时间:2015-07-07 17:31:29

标签: c# plugins

假设我有一个这样的插件界面:

// PluginInterface.cs
interface Plugin
{
    bool Check_When_Loaded(string q);
}

static class PluginList
{
    public static List<Plugin> list = new List<Plugin>();
}

我在MainWindow.cs中使用它:

// MainWindow.cs
private void Window_Loaded(object sender, RoutedEventArgs e)
{
    foreach (var p in PluginList.list)
    {
        if (p.Check_When_Loaded(q.Text)) break;
    }
}

假设我写了一个插件LovelyPlugin.cs

// LovelyPlugin.cs
class LovelyPlugin : Plugin
{
    public bool Check_When_Loaded(string q)
    {
        return true;
    }
}

我需要的是当我将LovelyPlugin.cs添加到C#项目然后编译,一个&#39; LovelyPlugin&#39;实例自动添加到PluginList.list,如果我删除此文件然后编译,则应用程序中根本没有LovelyPlugin的痕迹。

我有一个C#解决方案,有一些simliar项目(Light,Standard,Extra,...)。他们之间的所有区别是有或没有一些插件文件。所有.cs个文件都是添加为链接到所有这些项目中,我想要将所有这些项目完整地构建。

我可以使用#define#if条件,然后单独构建每个项目。但我想知道是否有任何方法可以满足我的需要通过添加/删除插件文件而不对每个项目的其他源代码文件进行任何更改。任何帮助将不胜感激!

2 个答案:

答案 0 :(得分:2)

您可以使用MEF ...

首先引用System.ComponentModel.Composition

阅读有关进口和出口的MEF文件。在您的情况下,插件是“导出”。我们可以使用[InheritedExport]属性来允许实现IPlugin的每个具体对象都可以导出。

// IPlugin.cs

using System.ComponentModel.Composition;

[InheritedExport]
public interface IPlugin
{
    bool Check_When_Loaded(string q);
}

您对IPlugin的具体实现不会改变。

// LovelyPlugin.cs

class LovelyPlugin : IPlugin
{
    public bool Check_When_Loaded(string q)
    {
        return true;
    }
}

我删除了你的静态PluginList类来简化示例。您可以在下面看到主表单是如何“导入”在程序集中找到的任何IPlugin的实现。如果您添加(或删除)IPlugin的其他具体实现并重新编译,则列表将相应地反映。

// MainWindow.cs

using System.ComponentModel.Composition;
using System.ComponentModel.Composition.Hosting;
using System.Reflection;

public partial class Form1 : Form
{
    [ImportMany]
    public List<IPlugin> list = new List<IPlugin>();

    public Form1()
    {
        InitializeComponent();
    }

    private void WindowLoaded(object sender, EventArgs e)
    {
        var catalog = new AssemblyCatalog(Assembly.GetExecutingAssembly());

        var container = new CompositionContainer(catalog);

        container.ComposeParts(this);

        foreach (var p in list)
        {
            if (p.Check_When_Loaded(this.Name)) break;
        }
    }
}

答案 1 :(得分:1)

将此添加到您的PluginList课程:

// using System.Reflection;
static PluginList()
{
    list.AddRange(
        from t in Assembly.GetAssembly(typeof(PluginList)).GetTypes()
        where t.IsClass && t.GetInterfaces().Contains(typeof(Plugin))
        select new Func<Plugin>(() => {
            try
            {
                return (Plugin)t.GetConstructor(new Type[] { }).Invoke(new object[] { });
            }
            catch
            {
                return null;
            }
        })());
}

基本上在运行时,这将:

  1. 获取当前项目中的所有类型(from行)。
  2. 过滤这些类型,只包含实现Plugin界面的类(where行)。
  3. 它尝试使用select行中的默认构造函数(零参数)构造每个插件类中的一个。如果您想要失败的构造函数的例外,您只需更改return null;
  4. 将所有此类构建的插件添加到列表中。