.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.Configuration.ChannelsSectionHandler, Communication" />
</configSections>
<Channels>
<channel
ChannelType="Vmp.Communication.TcpChannel, Communication"
TraceFile="d:logchannel1.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));
}