编写C#插件系统

时间:2009-07-01 19:05:08

标签: 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);
        }
    }
}

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

插件的文件夹结构如下:

\\ \ Plugins \

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

插件系统是从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;
            }
        }
    }

3 个答案:

答案 0 :(得分:28)

  

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

http://www.codeplex.com/MEF

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

答案 1 :(得分:7)

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

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

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

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

我怀疑这里有更深层次的设计问题,但这是你当前的问题。

答案 2 :(得分: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);
}