.Net 提供的反射(Reflection)機制可以很方便的加載插件。本文提供一種方法,可以靈活的正確的載入所需的插件。
在.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載入任何所需的插件。
插件一般放在配置文件中,並由程序讀入:
配置文件舉例(配置文件的使用參見我的相關隨筆):
<?XML version="1.0" encoding="utf-8" ?>
<configuration>
<configSections>
<section name="Channels" type="Vmp.Configuratio
n.ChannelsSectionHandler, Communication" />
</configSections>
<Channels>
<channel
ChannelType="Vmp.Communication.TcpChannel, Communication"
TraceFile="d:\log\channel1.log"
Port="2020" MaxConnections="300" BufferSize="2048"
/>
</Channels>
</configuration>
代碼范例:
private ArrayList channelsList = new ArrayList();
private LoadChannels()
{
ArrayList channelsConfig = (ArrayList)ConfigurationSettings.GetConfig( "Channels" );
foreach(Hashtable config in channelsConfig)
{
string channelType = (string) config["ChannelType"];
IChannel channel = (IChannel) CommonUtils.LoadObject(channelType, typeof(IChannel).FullName, new object[]{config});
if(channel == null)
continue;
channelsList.Add(channel);
}
也可以遍歷指定的插件目錄,並載入所有符合要求的插件,例如:
public IPlugin[] LoadAllPlugIn(string pluginDir)
{
// 設置默認的插件目錄
if(pluginDir == null || pluginDir == "")
pluginDir = "./PlugIns";
// 獲取插件接口名稱
string interfaceName = typeof(IPlugin).FullName;
// 用於存放插件的數組
ArrayList arr = new ArrayList();
// 遍歷插件目錄(假設插件為dll文件)
foreach(string file in Directory.GetFiles(pluginDir, "*.dll"))
{
// 載入插件文件
Assembly asm = Assembly.LoadFile(file);
// 遍歷導出的插件類
foreach(Type t in asm.GetExportedTypes())
{
// 載入插件,如果插件不符合指定的接口,則返回null
IPlugin plugin = LoadObject(t.FullName, interfaceName, null) as IPlugin;
if(plugin != null)
arr.Add(plugin);
}
}
; // 返回插件
return (IPlugin[])arr.ToArray(typeof(IPlugin));
}