Написание системы плагинов на C#
Я пытаюсь написать систему плагинов для обеспечения некоторой расширяемости моего приложения, чтобы кто-то мог написать плагин(ы) для приложения, не трогая код основного приложения (и рискуя сломать что-то).
У меня есть базовый интерфейс "IPlugin" (на данный момент ничего не реализовано).
Вот как я загружаю:
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\
Все плагины ссылаются на .dll под названием "Lab.Core.dll" в директории [root], но она не присутствует в директории Plugins из-за дублирования загружаемых ссылок.
Система плагинов загружается из Lab.Core.dll, на которую также ссылается мой исполняемый файл. Тип "IPlugin" также находится в Lab.Core.dll. Lab.Core.dll, как и было названо, является ядром моего приложения.
EDIT:
Вопрос: Почему/что это за исключение, которое я получаю, и как я могу его исправить?
ОКОНЧАТЕЛЬНАЯ ПРАВКА:
Итак, я решил переписать его, посмотрев на исходный код, который написал друг для регулятора 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;
}
}
}
Managed Extensibility Framework (MEF) - это новая библиотека в .NET, которая обеспечивает более широкое повторное использование приложений и компонентов. Используя MEF, приложения .NET могут перейти от статической компиляции к динамической. Если вы создаете расширяемые приложения, расширяемые фреймворки и расширения приложений, то MEF - это то, что вам нужно.
Edit: CodePlex уходит - код был перенесен на Github только в архивных целях: https://github.com/MicrosoftArchive/mef.
Похоже, что у вас есть круговая ссылка. Вы сказали, что ваши плагины ссылаются на Lab.Core.DLL, но вы также говорите, что плагины загружаются из Lab.Core.DLL.
Я неправильно понимаю, что здесь происходит?
EDIT: Хорошо, теперь, когда вы добавили свой вопрос к вопросу...
Вам нужно, чтобы Lab.Core.DLL был доступен для загружаемого плагина, поскольку он является зависимостью. Обычно это означает, что он должен находиться в той же директории или в GAC.
Я подозреваю, что здесь есть более глубокие вопросы проектирования, но это ваша непосредственная проблема.
В качестве дополнительного ответа, я использую эти 2 интерфейса для реализации этой задачи
///<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);
}
