.Net开发笔记(十七) 应用程序扩展
在很多场合,我们需要在已有软件程序上增加一些新的功能,几乎所有原因是因为原有软件功能不能满足我们的需要,我们平时做的插件就属于这种情况,最常见的是VS IDE的插件开发,网上老外写的一篇关于插件开发的文章,很详细(网址)。如果我们要给一个已有软件扩展新的功能,一般我们必须知道原有软件提供给二次开发人员的接口,也就是说,如果原有软件在设计的时候,压根儿就没有考虑到后续可能存在的二次开发,也不提供任何接口,那么通常情况下,是很难在它的基础上扩展出新功能的(除非是原有软件开发者)。
还有一种可以扩展已有程序功能的方式,网址,利用windows消息、windows hook技术,理论上可以给任何一个桌面应用程序扩展出新功能,而不需要任何接口,但是,这种方式很有局限性,扩展出来的功能几乎停留在操作系统级别上,比如UI外观样式等,并不能真正的去与已有软件程序进行交互。老外这篇文章其实重点是在讲Windows hooks和Windows Message。
这篇文章不是讲怎么去开发VS插件,更不是谈哪个具体软件比如CAD、PROE的二次开发,我只是想将看似复杂的东西简单化地解释一下,看看“给已有软件扩展新功能”到底是怎么回事。以插件为例:
首先,宿主程序和插件之间一定要有交互的,不然的话,插件是不会知道什么时候该干什么事情;其次,宿主程序一定会传递某些数据信息给插件,否则你叫插件拿什么原材料干活?最后,宿主程序一定是要有所准备的,什么叫有所准备?也就是说,在开发宿主程序的时候,一定要为以后的功能扩展留有接口,所有插件必须遵守这个接口给出的规范,知道应该在什么时候跟插件通讯,了解插件的任何一个行为将会导致什么样的结果,并且作出相应的反应。综上所述,给已有程序扩展新功能,关键还是在这个“已有程序”身上,如果一个程序出生的时候就没想着将来别人要给自己增加功能,那你不用再想着去给它扩展功能了。也就是我文章刚开始说到的,并不是你可以在任何一个程序基础上扩展新功能。
图1
如上图所示,宿主程序与插件之间通过某一协议进行通信,这个跟上一篇最后讲到的“框架和客户端代码之间的关系”很相似,你可以把宿主程序看做是框架,而插件则是客户端代码(参见上一篇文章图6)。
图2
如上图,在宿主程序中应该提前设计好该在什么时候与插件通信,以及给它传递对应数据信息,接着返回交互结果。宿主程序应该考虑所有与插件交互的地方和时间,然而插件不一定处处都会有所反应,也就是说,一个宿主程序设计好100个与插件交互的地方(插件最多可以在这100个地方大做文章),但是你开发一个插件时,根据具体需要,完全可以只响应其中的某几个。
图3
文章后面我附上一个简单的画图Demo,实现简单的画板、保存(默认可以保存JPG图片格式和PIC可编辑格式)等功能,然后自己又做了一个插件,插件主要新增了以下功能:
- 增加一个“关于”菜单,点击弹出关于对话框;
- 已有画板程序只能绘制圆形和正方形,增加了一个三角形图形;
- 将画图保存成JPG格式时,在图片上添加水印;
- 增加一种全新的文件格式(newpic格式),可以将画图保存为newpic格式的文件,这个有点类似photoshop的ico插件,安装后,PS可以将图片保存为ico格式。
整个项目源码分为以下三个部分:
- PluginDemo:宿主程序,在它的基础上扩展新的功能;
- PluginHelper:扩展功能时必须遵守的规范(接口),随宿主程序一起开发,通常就是我们常说的“二次开发包”,理论上应该还有二次开发说明文档之类的东西;
- Plugin:我自己开发的一个插件。
正常情况下,1和2由已有软件开发商提供,3由二次开发人员开发。
下面主要说明一下PluginHelper中的两个接口,其余的源码诸位可以自己下下来看看。
IPlugin接口:
1 /// <summary> 2 /// 插件接口 所有插件必须实现该接口 3 /// </summary> 4 public interface IPlugin 5 { 6 void ApplicationLoaded(PluginApplication pluginApplication); //应用加载后 7 void FileSavingAsJPG(Bitmap bitmap,string filepath); //文件保存为JPG 8 void FileSavingAsPIC(PluginApplication pluginApplication); //文件保存为PIC 9 void BeforeSave(Dictionary<string,SaveFileHandler> extensions); //保存文件之前 10 void BeforeOpen(Dictionary<string,OpenFileHandler> extensions); //打开文件之前 11 void ApplicationExiting(); //应用退出时 12 }
如接口代码所示,在固定时候固定地方,宿主程序都会调用对应方法与插件通信。
IObject接口:
1 /// <summary> 2 /// 图形接口 所有的图形都必须实现该接口 3 /// </summary> 4 public interface IObject 5 { 6 int X 7 { 8 get; 9 set; 10 } 11 int Y 12 { 13 get; 14 set; 15 } 16 void Draw(Graphics g); 17 }
所有新扩展图形都必须实现该接口。
如果想要开发自己的插件,只需要知道二次开发包(PluginHelper.dll),定义一个类实现IPlugin接口就行。
图4
最后上几张效果图,没插件之前的宿主程序:
图5
安装插件后的宿主程序:
图6
如上图所示,安装插件后,菜单多了“关于”菜单项,工具栏多了“三角形”按钮,可以保存另外一种“newpic”格式的文件,另外,在保存为JPG格式图片时,已有软件保存图片为:
图7
安装插件后,保存为JPG格式文件如下:
图8
如上图,安装插件后,保存的JPG图有水印。
下载源码:https://files.cnblogs.com/xiaozhi_5638/PluginDemo.rar
将开发的插件放在宿主程序的plugins目录下,重启宿主程序就可以。希望对各位有帮助!