在C#中建立模块化程序的最佳方法是什么？

Question

在C#中建立模块化程序的最佳方法是什么？

22

我和我的朋友正在编写一款 IRC C# 机器人，我们希望能够包含一个模块系统，以便用户可以编写自定义模块来扩展功能。

该机器人使用正则表达式将服务器的所有原始数据分解，并触发相应的事件来处理数据。例如，典型的事件处理程序可能如下所示：

OnChannelMessage(object sender, ChannelMessageEventArgs e)
{
}

在ChannelMessageEventArgs中会包含频道名称、发送者的昵称、消息等信息。我希望有一个插件系统，让人们可以构建模块并在机器人加载时或运行期间随意加载/卸载它们。理想情况下，我希望能够即时编译.cs文件，并在plugin.cs文件中包含以下几个内容：

要捕获的事件，例如OnChannelMessage以及在OnChannelEventArgs中的Channeldata
当给出这些信息时要做什么
帮助文本（我可以从主机器人内部调用，比如一个字符串help =“ 这是此插件的帮助”，可以在任何时候返回而不实际调用插件）
插件名称等

感谢任何关于新手如何开始编程的想法。

- caesay

5个回答

18

Managed Extensibility Framework (MEF)提供了您所需的插件架构。您可以提供一个公共接口，供用户进行扩展。然后，MEF可以扫描目录中的DLL并动态加载任何可导出项。

例如，您的插件作者可以创建类似于：

[Export(typeof(IModule))]
public class MyModule : IModule
{
   void HandleMessage(ChannelEventArgs e) {}
}

那么你的代码可能会像这样：

void OnChannelMessage(ChannelEventArgs e)
{
  foreach(IModule module in Modules)
  {
     module.HandleMessage(e);
  }
}

[Import]
public IEnumerable<IModule> Modules { get; set; }

- bendewey

有没有一种方法可以在不使用任何外部框架的情况下完成这样的事情？ - caesay

1

这是开源的，所以你可以查看，但是使用 FileSystemWatcher、Assembly.Load 和一些反射技术，你应该能够相对容易地建模出类似的东西。 - bendewey

5

你可以自己编写框架代码...不过为什么要重复造轮子呢？ - Paolo

导入方面比导出方面要困难得多。您可能希望避免使用setter注入部分，而只是使用一个辅助函数来获取导入内容。 - bendewey

1

@Paolo同意，特别是因为这将与.NET4一起发布。 - bendewey

4

请看微软的托管可扩展性框架（MEF）- 它提出了一些您想要的功能，并提供了许多其他功能：

谷歌搜索“托管可扩展性框架”的结果

- Aviad P.

1

另外值得注意的是，它将成为.NET 4.0的一部分。 - Wim Coenen

3

在.NET 3.5的核心中有另一个选项，称为托管AddIn框架（MAF）。请查看以下链接。

示例和工具：http://clraddins.codeplex.com/

MAF博客：http://blogs.msdn.com/clraddins/

一篇好文章：http://blogs.microsoft.co.il/blogs/bursteg/archive/2007/08/13/Build-AddIns-with-System-AddIn.aspx

- m3kh

2

MEF - 托管可扩展性框架是当前的热门话题，我认为这将是最合适的选择。

如果这行不通，你还可以查找Prism，他们有另一种实现模块的方法。

- Mark Pearl

网页内容由stack overflow 提供, 点击上面的

可以查看英文原文，
原文链接

- dan · Accepted Answer

我以前在项目中使用过这样的东西，但已经有一段时间了。可能有一些框架可以为您执行这种类型的操作。

要编写自己的插件架构，基本上要定义一个接口，让所有模块都实现它，并将其放在程序和模块都共享的程序集中：

public interface IModule
{
     //functions/properties/events of a module
}

然后您的实现人员将根据此程序集编写他们的模块，最好使用默认构造函数。

public class SomeModule : IModule {} ///stuff

在您的程序中（假设您的模块将编译为自己的程序集），您需要加载包含模块的程序集引用，找到实现模块接口的类型，并对它们进行实例化。

var moduleAssembly = System.Reflection.Assembly.LoadFrom("assembly file");
var moduleTypes = moduleAssembly.GetTypes().Where(t => 
   t.GetInterfaces().Contains(typeof(IModule)));

var modules = moduleTypes.Select( type =>
            {   
               return  (IModule) Activator.CreateInstance(type);
            });

如果你想即时编译代码：你需要创建一个编译器对象，告诉它需要引用哪些程序集（包括System和包含IModule的那个程序集，以及任何其他必要的引用），然后告诉它将源文件编译成一个程序集。从中获取导出类型，过滤并保留实现IModule接口的类型，并对它们进行实例化。

//I made up an IModule in namespace IMod, with string property S
string dynamicCS = @"using System; namespace DYN 
             { public class Mod : IMod.IModule { public string S 
                 { get { return \"Im a module\"; } } } }";

var compiler = new Microsoft.CSharp.CSharpCodeProvider().CreateCompiler();
var options = new System.CodeDom.Compiler.CompilerParameters(
       new string[]{"System.dll", "IMod.dll"});

var dynamicAssembly= compiler.CompileAssemblyFromSource(options, dynamicCS);
//you need to check it for errors here

var dynamicModuleTypes = dynamicAssembly.CompiledAssembly.GetExportedTypes()
    .Where(t => t.GetInterfaces().Contains(typeof(IMod.IModule)));
var dynamicModules = dynModType.Select(t => (IMod.IModule)Activator.CreateInstance(t));

查找有关插件架构和加载动态程序集的教程，以更好地了解如何进行此类操作。这只是一个开始。一旦掌握了基础知识，您就可以开始做一些非常酷的事情。

至于处理元数据（模块X命名为YYY，应处理事件A、B和C）：尝试将其纳入您的类型系统中。您可以为不同的功能/事件制作不同的接口，或者将所有功能放在一个接口上，并在模块类上使用属性（您将在共享程序集中声明这些属性），使用属性来声明模块应订阅哪些事件。基本上，您希望使人们为您的系统编写模块尽可能简单。

 enum ModuleTypes { ChannelMessage, AnotherEvent, .... }

 [Shared.Handles(ModuleTypes.ChannelMessage)]
 [Shared.Handles(ModuleTypes.AnotherEvent)]
 class SomeModule : IModule { ... }

或者

 //this is a finer-grained way of doing it
 class ChannelMessageLogger : IChannelMessage {}
 class PrivateMessageAutoReply : IPrivateMessage {}

玩得开心！