编写C#插件系统

Zac*_*ack 33 c# plugins extensibility

我正在尝试编写一个插件系统来为我的应用程序提供一些可扩展性,这样有人可以为应用程序编写一个插件,而无需触及主应用程序的代码(并冒险破坏某些内容).

我已经写了基础"IPlugin"接口(atm,还没有实现)

这是我加载的方式:

public static void Load()
{
    // rawr: http://www.codeproject.com/KB/cs/c__plugin_architecture.aspx
    String[] pluginFiles = Directory.GetFiles(Plugins.PluginsDirectory, "*.dll");
    foreach (var plugin in pluginFiles)
    {
        Type objType = null;
        try
        {
            //Assembly.GetExecutingAssembly().GetName().Name
            MessageBox.Show(Directory.GetCurrentDirectory());
            Assembly asm = Assembly.Load(plugin);
            if (asm != null)
            {
                objType = asm.GetType(asm.FullName);
                if (objType != null)
                {
                    if (typeof(IPlugin).IsAssignableFrom(objType))
                    {
                        MessageBox.Show(Directory.GetCurrentDirectory());
                        IPlugin ipi = (IPlugin)Activator.CreateInstance(objType);
                        ipi.Host = Plugins.m_PluginsHost;
                        ipi.Assembly = asm;
                    }
                }
            }
        }
        catch (Exception e)
        {
            MessageBox.Show(e.ToString(), "Unhandled Exception! (Please Report!)", System.Windows.Forms.MessageBoxButtons.OK, System.Windows.Forms.MessageBoxIcon.Information);
        }
    }
}
Run Code Online (Sandbox Code Playgroud)

一位朋友试图提供帮助,但我真的不明白出了什么问题.

插件的文件夹结构如下:

\
\插件\

所有插件都引用[root]目录中名为"Lab.Core.dll"的.dll,并且由于加载了重复引用,因此它不存在于Plugins目录中.

插件系统是从Lab.Core.dll加载的,也是我的可执行文件引用的.类型"IPlugin"也在Lab.Core.dll中.Lab.Core.dll与我的应用程序的核心完全一样.

编辑:

问题:为什么/我得到的例外情况是什么?如何修复它?

最终编辑:

好的,所以我决定在看一下朋友为TF2监管机构写的一些源代码后重新编写它.

这是我得到的,它的工作原理:

    public class TestPlugin : IPlugin {
    #region Constructor

    public TestPlugin() {
        //
    }

    #endregion

    #region IPlugin Members

    public String Name {
        get {
            return "Test Plugin";
        }
    }

    public String Version {
        get {
            return "1.0.0";
        }
    }

    public String Author {
        get {
            return "Zack";
        }
    }

    public Boolean OnLoad() {
        MessageBox.Show("Loaded!");
        return true;
    }

    public Boolean OnAllLoaded() {
        MessageBox.Show("All loaded!");
        return true;
    }

    #endregion
}

        public static void Load(String file) {
        if (!File.Exists(file) || !file.EndsWith(".dll", true, null))
            return;

        Assembly asm = null;

        try {
            asm = Assembly.LoadFile(file);
        } catch (Exception) {
            // unable to load
            return;
        }

        Type pluginInfo = null;
        try {
            Type[] types = asm.GetTypes();
            Assembly core = AppDomain.CurrentDomain.GetAssemblies().Single(x => x.GetName().Name.Equals("Lab.Core"));
            Type type = core.GetType("Lab.Core.IPlugin");
            foreach (var t in types)
                if (type.IsAssignableFrom((Type)t)) {
                    pluginInfo = t;
                    break;
                }

            if (pluginInfo != null) {
                Object o = Activator.CreateInstance(pluginInfo);
                IPlugin plugin = (IPlugin)o;
                Plugins.Register(plugin);
            }
        } catch (Exception) {
        }
    }

    public static void LoadAll() {
        String[] files = Directory.GetFiles("./Plugins/", "*.dll");
        foreach (var s in files)
            Load(Path.Combine(Environment.CurrentDirectory, s));

        for (Int32 i = 0; i < Plugins.List.Count; ++i) {
            IPlugin p = Plugins.List.ElementAt(i);
            try {
                if (!p.OnAllLoaded()) {
                    Plugins.List.RemoveAt(i);
                    --i;
                }
            } catch (Exception) {
                Plugins.List.RemoveAt(i);
                --i;
            }
        }
    }
Run Code Online (Sandbox Code Playgroud)

Eri*_*ert 28

托管可扩展性框架(MEF)是.NET中的一个新库,可以更好地重用应用程序和组件.使用MEF,.NET应用程序可以从静态编译转变为动态编写.如果您正在构建可扩展的应用程序,可扩展的框架和应用程序扩展,那么MEF就适合您.

http://www.codeplex.com/MEF

编辑:CodePlex即将消失 - 代码已移至Github仅用于存档目的:https://github.com/MicrosoftArchive/mef

  • 当然,不使用MEF就可以.MEF没有什么神奇之处.但MEF是由插件架构专家多年设计和实现的.(我在2004年IIRC上对MEF的初步设计进行了一些工作.)你真的想尝试复制专业建筑师在这个领域五年工作的努力吗? (10认同)

Bra*_*ker 8

听起来你有一个循环引用.你说你的插件引用了Lab.Core.DLL,但你也说插件是从Lab.Core.DLL加载的.

我误解了这里发生的事情吗?

编辑:好了,现在您已将问题添加到问题中......

你需要让Lab.Core.DLL可以被加载的插件访问,因为它是一个依赖项.通常这意味着将它放在同一目录或GAC中.

我怀疑这里有更深层次的设计问题,但这是你的直接问题.


Jho*_*re- 6

作为旁边的答案,我使用这两个接口来实现它

///<summary>
///</summary>
public interface IPlugin {
    ///<summary>
    ///</summary>
    string Name { get; }
    ///<summary>
    ///</summary>
    string Description { get; }
    ///<summary>
    ///</summary>
    string Author { get; }
    ///<summary>
    ///</summary>
    string Version { get; }

    ///<summary>
    ///</summary>
    IPluginHost Host { get; set; }

    ///<summary>
    ///</summary>
    void Init();
    ///<summary>
    ///</summary>
    void Unload();

    ///<summary>
    ///</summary>
    ///<returns></returns>
    IDictionary<int, string> GetOptions();
    ///<summary>
    ///</summary>
    ///<param name="opcion"></param>
    void ExecuteOption(int option);

}



///<summary>
///</summary>
public interface IPluginHost {
    ///<summary>
    ///</summary>
    IDictionary<string, object> Variables { get; }
    ///<summary>
    ///</summary>
    ///<param name="plugin"></param>
    void Register(IPlugin plugin);
}
Run Code Online (Sandbox Code Playgroud)