一种简捷的支持插件的应用程序结构

一种最基本的插件模式

既为插件,一般均以动态库方式提供,以使主程序可以在运行中加载或卸载,从而使主程序在不需要增加代码,重新编译的情况下增加一些功能,同样,当你的软件到用户手中之后,用户仍然可以通过安装插件使用这些附加功能,从而使使软件更新,升级变得更为便利;所以,现在支持插件的程序已经变得非常普遍,并且一般插件也都以动态库的形式出现(Windows的dll和Linux的so),新手看看,高手飘过.
其实,要让咱们的软件具有这种能力也不是一件很奢侈的事情,本文将介绍一种很基本但很好用的插件模式,它应用在wxWidgets工程中也是相当便利的,应该说是wxWidgets使得我们使用这种插件机制更为便利:

1.主程序定义插件接口,也就是说,它定义了如何访问插件,样例如下:
//插件接口定义,则主程序给出自己的规则
//Plugin.h
class Plugin : public wxEvtHandler
{
  public:
   virtual bool PerformTask() = 0;
   virtual wxWindow* GetGUI() = 0;
};
这里,Plugin从wxEvtHandler继承,使得它具有WX样式处理事件能力;至于接口提供的方法则依具体需求而定了.事实上,可里还可以定义更多的接口方法,比如GetName,GetHelpString,GetCategory等,让主程序知道此插件的一些信息,甚至是使用规则(当然都是主程序的规范了)

2.插件实现:插件实现独立于主程序,只需要插件实现Plugin接口即可:
//如果我们需要插件处理某些消息,则需要添加相应的消息处理,当然,WX风格的
class MyPlugin : public Plugin
{
public:
  virtual bool PerformTask(){
                wxMessageBox(wxT("PerformTask from MyPlugin"));
        }
  virtual wxWindow* GetGUI(){
          //在此创建插件的界面的顶级窗口即可,一般的,可以使用wxPanel的一个实例做为顶级窗口返回
        }
};

3.让插件能够被主程序使用:
在这里,就具有一些不同的做法了,比如让插件实现的插件类暴露出来,比如MS下的__declspec(dllexport);在我们的这个例子里,让所有的东西变得那么简捷和自然:我们只提供一个外部可见的全局方法,而非导出整个类;同时,我们也可以通过检查一个动态库是否提供了此导出方法来确定是否是合乎要求的插件(当然,实际应用中还不太够):
#ifdef __WIN32__
#define IMPLEMENT_PLUGIN(name) __declspec(dllexport) CreatePlugin(){ return new name();}
#else
#define IMPLEMENT_PLUGIN(name) CreatePlugin(){ return new name();}
#endif

==============================
至此,按照这个办法我们已经可以编译出一个dll或so待用了;另一方面,在主程序(插件的使用端)方面,我们需要在一个我们希望的目录里面检测插件:

typedef Plugin* (*CreatePluginFunction)();
//在插件目录中扫描插件
bool ScanPlugins(const wxString& pluginsDir)
{
wxDir dir(pluginsDir);//插件目录
if(dir.IsOpen()){
        #ifdef __WIN32__
        wxString nameFormat = wxT("*.dll");
        #else
        wxString nameFormat = wxT("*.so");
        #endif
        wxString fileName;
        bool cont = dir.GetFirst(&fileName,nameFormat,wxDIR_FILES);
        while(cont){
                LoadUsablePlugin(fileName);//如果它是合法插件,则加载之
                cont = dir.GetNext(&fileName);
        }//end while
        return true;
    }//end if
return false;
}
//检查一个动态库是否为合法插件,如果是,则加载之
bool LoadUsablePlugin(const wxString& fileName)
{
        wxDynamicLibrary dll;
        if(dll.Load(fileName)){
                wxDYNLIB_FUNCTION(CreatePluginFunction,CreatePlugin,dll);
                //它相当在于调用 CreatePluginFunction* pfnCreatePlugin = (CreatePluginFunction)dll.GetSymbol(wxT("CreatePlugin"));
                if(pfnCreatePlugin){
                        Plugin* plugin = pfnCreatePlugin();
                        if(plugin){
                                //插件实例已经创建,我们可以将其保存了,比如在菜单上显示,这样,在适当的地方就可以使用这个插件了
                                AddPluginInstance(plugin,fileName);//我只是举了这么个例子
                                //插件已经创建并做好相关动作,我们不应该让函数退出的时候使这个插件动态库被从内存中卸载吧
                                dll.Detach();
                                return true;
                        }//end if plugin
                }//end if pfnCreatePlugin
        }
        return false;
}
在我们的界面构造的地方,就可以适当地调用插件实例的GetGUI方法让插件创建其定义的界面了

到现在为止,我们已要可以使用这个简单的方案来构建一个支持插件的应用程序了.我的上一个单位是做连锁销售的,业务有些复杂,但是软件自动化还是不够完善,比如,我经常需完成配货,退货,结算等相关的一系列业务,和一些业务查询;我就是按照这种方案构建了一个支持插件的框架程序应付日常应用,并且把它也共享给其他同事使用,按照权限给他们不同的插件使用权.我还没有来得及查看CodeBlocks和CodeLite它们使用的插件机制,但一定比这个复杂是不用置疑的,今天发此一贴是让和我一样的初学者学习了了解.感兴趣的同学可以查看原贴,并下载相关源码试验,也可以按照我这上面提到的一些代码细节来写一个样例,算是课后习题吧.
原贴在: http://wiki.wxwidgets.org/Programs_That_Support_Plugins