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

本文关键字:应用程序 文件 插件 何通过 添加 删除 | 更新日期: 2023-09-27 18:01:39

假设我有一个这样的插件接口:

// 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#项目然后编译时,一个'LovelyPlugin'实例被自动添加到PluginList.list,如果我删除这个文件然后编译,在应用程序中根本没有LovelyPlugin的痕迹。

我有一个c#解决方案,有一些类似的项目(轻型,标准,额外,…)。它们之间的所有区别是一个有或没有一些插件文件。所有的.cs文件是添加链接到所有这些项目,我想同时建立所有这些项目。

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

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

您可以使用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;
        }
    }
}

添加到您的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. 将所有这些构建的插件添加到您的列表。