如何通过 add/remove 插件文件使应用程序可插入？

Question

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

// 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# 解决方案，它有一些类似的项目（Light、Standard、Extra 等）。它们之间的所有区别是一个有或没有一些插件文件。所有 .cs 个文件 添加为 link 所有这些项目，我想同时构建所有这些项目。

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

Answer 1

将此添加到您的 PluginList class:

// 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;
            }
        })());
}

基本上在运行时这将：

获取当前项目中的所有类型（from 行）。
过滤这些类型以仅包括实现您的 Plugin 接口（where 行）的 classes。
它尝试在 select 行中使用默认构造函数（零参数）构建这些插件中的每一个 classes。如果你想要失败构造函数的异常，你可以简单地更改 return null;.
将所有此类构建的插件添加到您的列表中。

Answer 2

您可以使用 MEF...

从引用开始 System.ComponentModel.Composition

阅读有关进出口的 MEF 文档。在您的例子中，插件是 "Exports"。我们可以使用 [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 class 以简化示例。您可以在下面看到主窗体是如何 "Importing" 在程序集中找到的 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;
        }
    }
}

如何通过 add/remove 插件文件使应用程序可插入？

How to make app pluggable by add/remove a plugin file?

c#

plugins