我们现在从插件式框架的启动开始讲起,在插件式框架启动的时候,即一个exe窗体进入Load事件的时候,它需要执行的第一个动作是遍历插件plugin所在的文件夹中的每一个DLL文件,寻找出这些DLL中包含的对象,并识别这些对象的身份。
这个过程就是大名鼎鼎的“反射”机制,在.NET中,Framework提供了必要的机制,让用户能够在运行时刻识别一个类的身份。如下面这段代码:
try
{
PluginCollection m_cmds=new PluginCollection();'新建一个容器
string[] files=Directory.GetFiles(System.Windows.Forms.Application.StartupPath+"遍历插件文件夹
foreach(string file in files)
{
Assembly assembly =Assembly.LoadFrom (file);'载入一个文件
if(assembly !=null)
{
try
{
Type[] types=assembly.GetTypes();'获得这个文件的所有类型
for(int i=0;i<types.Length ;i=(i+1))
{
Type[] interfaces=types[i].GetInterfaces ();'遍历这个类的所有接口
foreach(Type theInterface in interfaces)
{
if (theInterface.Name =="ICommand")'如果有一个接口为ICommand,则被承认是一个插件
{
try
{
ICommand cmd=(ICommand)Activator.CreateInstance(types[i]);;'动态生成一个ICommand对象
m_cmds.Add(cmd);'将该对象装入容器
break;
}
catch(ConfigurationException ex)
{
MessageBox.Show(ex.Message );
}
}
}
}
}
catch(ReflectionTypeLoadException ex)
{
MessageBox.Show(ex.Message );
}
}
}
return m_cmds;
}
catch(Exception ex)
{
return null;
}
在上面的代码中,PluginCollection 是一个实现了BaseCollection接口的普遍性容器,它可以装载任何形式的插件对象,如ICommand、ITool等,都可以放在这个容器中,供将来使用。
插件式框架的一个问题是插件对象如何与框架平台进行交互,即契约约定。一个对象凭借什么身份被认为是框架的插件呢,一般而言,我们使用Interface来实现。我的框架实现了ICommand、ITool、IToolBarDef和IMenuDef四个接口,与ArcMap的四个接口基本一致。如ICommand接口是如下定义的:
public interface ICommand:IPlugin
{
Bitmap Bitmap{get;}
string Caption{get;}
string Category{get;}
bool Checked{get;}
bool Enabled{get;}
int HelpContextID {get;}
string HelpFile {get;}
string Message {get;}
string Name {get;}
void OnClick();
void OnCreate (INBApplication hook);
string Tooltip {get;}
}
在上面的接口定义中,ArcMap的ICommand接口的Bitmap属性传递的是一个资源号,我则直接传递了一个Bitmap对象,方便使用。这些接口定义以后,框架就认为,凡是实现了ICommand或其它三个接口的对象,都可以被认为是一个插件对象。
既然这样,我们就实现了插件式框架的第一步,寻找出所有的插件对象,并分别将它们放入一个集合对象中。在本插件框架中,我使用了四个容器,来分别装四种插件。但在这之前还有两个小问题,属于编程技巧,一是如何设置一种配置,让一个插件的寻找过程自动化;另外一个则是如何实现这种容器。对于这两个问题,需要讲解.NET中的配置节configuration和容器的一些知识。这些将在第三个blog中讲述。
下面是我开发的这个插件式框架,所有的功能都是插件,没有一个是写死在框架中的: