明辉站/网站教程/内容

用 .NET 完成插件机制

网站教程2024-02-09 阅读
[摘要]在.NET中,一个完整的类型名称的格式如 "类型名, 程序集名"。例如:"System.Configuration.NameValueSectionHandler, System, Version=1.0.3300.0, Culture=neutral, Public...
 

在.NET中,一个完整的类型名称的格式如 "类型名, 程序集名"。

例如:"System.Configuration.NameValueSectionHandler, System, Version=1.0.3300.0, Culture=neutral, PublicKeyToken=b77a5c561934e089"。

  • 类型名为:System.Configuration.NameValueSectionHandler,这是带名字空间的完整类型名。
    你也可以使用该类型的FullName得到。
    如:string typeName = typeof(NameValueSectionHandler).FullName;
  • 程序集名为:"System, Version=1.0.3300.0, Culture=neutral, PublicKeyToken=b77a5c561934e089",
    程序集名为System,系统为自动为其适配扩展名(如System.dll或System.exe);
    Version、Culture、PublicKeyToken为程序集的具体版本、文化背景、签名,没有特定要求,这些都可以省略。

我们可以根据类型的名称,来动态载入一个所需要的类型。如:

string typeName = "System.Configuration.NameValueSectionHandler, System";
Type t = Type.GetType(typeName);
Object obj = Activator.CreateInstance(t);

System.Configuration.NameValueSectionHandler obj = (System.Configuration.NameValueSectionHandler)Activator.CreateInstance(t);

此时,obj 就是所需要的类型实例。

通常的插件,是需要实现一定的接口的类。因此,在载入插件之前,需要确定该插件类型是否是合适的。
比如,一个插件的接口为 IPlugin,那么我们可以用如下方式来识别:

string interfaceName = typeof(IPlugin).FullName;
string typeName = "Muf.MyPlugin, MyPlugin";
Type t = Type.GetType(typeName);
             
if (  t == null
  !t.IsClass
  !t.IsPublic
    t.GetInterface(interfaceName) == null)
{
 return null; // 不是所需要的插件
}

总结上述代码,我们可以做出通用的加载插件的代码:

/// <summary>
/// 动态装载并创建类型,该类型拥有指定接口
/// </summary>
/// <param name="className">类型名称</param>
/// <param name="interfaceName">指定的接口名称</param>
/// <param name="param">指定构造函数的参数(null或空的数组表示调用默认构造函数)</param>
/// <returns>返回所创建的类型(null表示该类型无法创建或找不到)</returns>
public static object LoadObject(string className, string interfaceName, object[] param)
{
 try
 {
  Type t = Type.GetType(className);
             
  if ( t == null
     !t.IsClass
      !t.IsPublic
      t.IsAbstract
      t.GetInterface(interfaceName) == null)
  {
   return null;
  }

  object o = Activator.CreateInstance(t, param);
  if( o == null )
  {
   return null;
  }
    
  return o;
 }
 catch( Exception ex )
 {
  return null;
 }
}

以后,我们就可以使用LoadObject载入任何所需的插件。

插件配置,一般有两种方法:
1. 将插件类型名称写在配置文件中,如app.config。配置文件的使用可以参考沐枫专栏的其它文章。
2. 指定一个目录为插件目录,然后在该目录中所有的程序集(如*.dll)全部加载,并用反射机制,获取所有的公共类型,并全部尝试用LoadObject加载,加载成功的就是合适的插件。


……

相关阅读