构建插件式的应用程序框架

/article/4789532.html

构建插件式的应用程序框架(一)－－－－开篇

说起插件（plug－in）式的应用程序大家应该不陌生吧,记得很早以前有一款很流行的MP3播放软件winmap,它是我记忆里最早认识的一款使用插件模式的应用程序,你可以使用他的插件管理器插入很多的音乐效果器,皮肤,甚至是歌词显示的面板。接下来看到了Photoshop使用插件模式管理虑镜。最后发现只要是大一点的应用程序基本都使用了插件式的程序框架，就拿我们最常用的工具来说吧，Visual
Studio，Office，Delphi，Eclipse等等。Eclipse将插件模式发挥到了及至，因为他是开源的的，所以众多的爱好者，开发出了让人应接不暇的插件。

为什么使用插件式的应用程序框架呢？我的答案就是他为应用程序的功能扩展提供的无限的想象空间。一个应用程序，无论你前期做了多少的市场调查，需求分析做的多么完美，你也只是迎合一部分人的期望，更甚，你只迎合了一部分人的一部分期望，或者一部分人在某一时间的一部分期望。所以当程序发布以后，你依然有机会提供新的功能而不必重新发布程序，人们也可以根据自己的需要来开发新的功能来满足自己的需求，据我所知有很多的软件公司就是专门开发插件来赚钱，真是一举多得，何乐而不为呢？

我们来看一些常见的提供插件模式的应用程序是如何实现插件功能的。据我的使用经验来看，Visual Studio和Office其实都是自动化程序，通过COM的方式提供了一组接口。开发人员可以利用这些接口来开发基于COM的插件，当插件开发完成后，注册COM组件。在Visual
Studio中你可以使用Add－in管理器来选择是否启用插件，而Office似乎省去了这一步，一旦你注册了Office插件，Office应用程序在启动的时候会自动加载插件。COM方式似乎最受微软的宠爱，因为COM是一种二进制重用标准，用户可以使用大部分流行的语言来开发插件。当然你也可以使用别的方式，比如普通DLL，只是这样对于开发人员来说适用面就窄了，因为各个厂商DLL的内部结构是不尽相同的，比VC开发出的DLL和Borland
C＋＋builder开发出的DLL结构就不同，需要专门的工具进行转换。现在，还有另外一种方式，使用dotNet的Assembly，使用dotNet的好处是开发简单，使用也同样简单（不需要注册），而且你也可用通过COM互操作让开发人员可以使用各种语言进行插件开发，当然用dotNet开发还是最简单的，省去不少中间过程。

其实上面介绍的三种方式开发的插件最终还是寄宿在DLL中，从中我们就可以看出一些端倪。为什么使用DLL呢？DLL虽然也是PE格式，但是他是不能独立运行的，一般情况下，都是在运行时加载到应用程序的内存空间。插件模式正好是利用了这一点，插件不是应用程序的一部分，他以二进制的方式独立存在，由用户决定是否使用他。

那么插件是如何与应用程序进行交互的呢？首先必须有一个契约，应用程序要声明我有哪些功能是可以被插件使用的，并且具备什么条件才能成为我的插件。其次，应用程序不依赖于插件，也就是说，没有你插件，我也可以很好的运行。再次，应用程序必须有一种策略来获取插件存在的位置，比如Visual studio是通过注册表的方式。最后，应用程序可以通过某种方式动态的加载插件。

构建插件式的应用程序框架(二)－－－－订立契约

无论是用COM的方式，还是普通DLL，抑或.NET方式来实现插件框架，首先要面临的问题就是如何订立契约。如同我上一篇文章讲到的一样，契约是应用程序和插件之间进行交互的依据和凭证。应用程序必须声明我有什么样的功能可被插件使用，并且插件必须符合什么条件才能被我使用。反之，插件必须要知道应用程序提供什么样的功能，我才能将自己的功能融入到应用程序的体系中。本系列文章主要讲如何使用.NET实现插件式的应用程序框架，所以其它的方式我就不再提了。

如何使用.NET订立契约呢？首先想到的Interface，其次是抽象类，但是在插件模式中我使用接口，因为我们是在满足应用程序的主要目的的基础上来提供附加的插件功能，就这一点来说，接口更灵活，更容易扩展。接下来，如何订立契约的内容呢？这就要根据你的业务需求了，为了讲解的方便，我们定义一个最最基本的插件式应用程序的插件契约。我们做一个假定，我们的应用程序是一个多文档的应用程序，包含一个主菜单栏，一个工具栏，菜单栏可以在程序的上下左右四个方向停靠，另外还有一个状态栏。到后边，如果有必要，我会扩展这个应用程序，让他本身提供更多的可供插件使用的功能。所以就目前而言，我想实现的功能就是让插件为主程序添加工具条，菜单项并实现一些简单的功能。

应用程序向插件提供服务有两种方式，一种是直接再应用程序接口中声明属性或者方法，一种是将应用程序接口声明成一个服务容器。我打算两种方式都用，明确的功能就在接口中直接声明成属性或者方法，另外将应用程序声明成一个服务容器，以方便插入更多的服务功能，提高应用程序的可扩展性。

下边是一个非常简单的应用程序接口定义，对于我们的假定已经足够了。


using System;


using System.Collections.Generic;


using System.Text;


using System.ComponentModel.Design;


using System.Windows.Forms;




namespace PluginFramework






{


public interface IApplication:IServiceContainer






{




ToolStripPanel LeftToolPanel

{ get;}




ToolStripPanel RightToolPanel

{ get;}




ToolStripPanel TopToolPanel

{ get;}




ToolStripPanel BottomToolPanel

{ get;}






MenuStrip MainMenuStrip

{ get;}




StatusStrip StatusBar

{ get;}


}


}



插件的接口定义：


using System;


using System.Collections.Generic;


using System.Text;




namespace PluginFramework






{


public interface IPlugin






{




IApplication Application

{ get;set;}




String Name

{ get;set;}




String Description

{ get;set;}


void Load();


void UnLoad();




event EventHandler<EventArgs> Loading;


}

}

构建插件式的应用程序框架(三)－－－－动态加载

不管你采用什么方式实现插件式的应用程序框架，核心还是动态加载，换句话说，没有动态加载技术也就无所谓插件式的应用程序框架了。使用Com实现的话，你可以利用Com的API通过ProgID来动态创建COM对象，如果使用普通DLL，你需要使用Windows的API函数LoadLibrary来动态加载DLL，并用GetProcAddress函数来获取函数的地址。而使用.NET技术的话，你需要使用Assembly类的几个静态的Load（Load，LoadFile，LoadFrom）方法来动态加载汇集。

一个Assembly里可以包含多个类型，由此可知，一个Assembly里也可以包含多个插件，就像前一篇文章所讲，只要它从IPlugin接口派生出来的类型，我们就承认它是一个插件类型。那么Assembly被动态加载了以后，我们如何获取Assembly里包含的插件实例呢？这就要用到反射（Reflection）机制了。我们需要使用Assembly的GetTypes静态方法来得到Assembly里所包含的所有的类型，然后遍历所有的类型并判断每一个类型是不是从IPlugin接口派生出来的，如果是，我们就使用Activator的静态方法CreateInstance方法来获得这个插件的实例。.NET的动态加载就是这几个步骤。下来，我做一个简单的例子来演练一下动态加载。首先声明一点，这个例子非常简单，纯粹是为了演练动态加载，我们的真正的插件式的应用程序框架里会有专门的PluginService来负责插件的加载，卸载。

我们的插件位于一个DLL里，所以我们首先创建一个Class library工程。创建一个FirstPlugin类让它派生于IPlugin接口，并实现接口的方法和属性，由于本文的目的是演示动态加载，所以IPlugin接口的Loading事件我们就不提供默认的实现了，虽然编译的时候会给出一个警告，我们不必理会它。这个插件的功能就是在应用程序里创建一个停靠在主窗体底部的ToolStrip，这个ToolStrip上有一个按钮，点击这个按钮，会弹出一个MessageBox显示“The
first plugin”。下面是代码：


using System;


using System.Collections.Generic;


using System.Text;


using PluginFramework;


using System.Windows.Forms;




namespace FirstPlugin






{


public class FirstPlugin:IPlugin






{


private IApplication application = null;


private String name="";


private String description = "";






IPlugin Members#region IPlugin Members




public IApplication Application






{


get






{


return application;


}


set






{


application = value;


}


}




public string Name






{


get






{


return name;


}


set






{


name = value;


}


}




public string Description






{


get






{


return description;


}


set






{


description = value;


}


}




public void Load()






{


if (application != null && application.BottomToolPanel != null)






{


//创建一个向主程序添加的ToolStrip


ToolStrip sampleToolStrip = new ToolStrip();


ToolStripButton button = new ToolStripButton("Click Me");


button.Click += new EventHandler(button_Click);


sampleToolStrip.Items.Add(button);




//在主程序的底端添加ToolStrip


application.BottomToolPanel.Controls.Add(sampleToolStrip);


}


}




void button_Click(object sender, EventArgs e)






{


MessageBox.Show("The first plugin");


}




//相关的文章主要讲动态加载，所以卸载就不实现了


public void UnLoad()






{


throw new Exception("The method or operation is not implemented.");


}




public event EventHandler<EventArgs> Loading;




#endregion


}


}



接下来我们创建一个Windows Application工程让主窗体派生于IApplication接口并实现IApplication接口的方法和属性，下来我们声明1个MenuStrip和1个StatusStrip，让他们分别停靠在窗口的顶部和底端，接下来我们声明4个ToolStripPanel，分别人他们停靠在上下左右四个边，最后我们创建一个ToolStrip,在上边添加一个按钮，当点击这个按钮的时候，我们动态的加载插件。

为了方便演示，我们把生成的Assembly放置到固定的位置，以方便主程序加载，在本例里，我们在应用程序所在的文件夹里创建一个子文件夹Plugins（E:\Practise\PluginSample\PluginSample\bin\Debug\Plugins），将插件工程产生的Assembly（FirstPlugin.dll）放置在这个子文件夹。下面是动态加载的代码：


private void toolStripButton1_Click(object sender, EventArgs e)






{


//动态加载插件，为了方便起见，我直接给出插件所在的位置


String pluginFilePath = Path.GetDirectoryName(Application.ExecutablePath) + "\\plugins\\FirstPlugin.dll";


Assembly assembly = Assembly.LoadFile(pluginFilePath);




//得到Assembly中的所有类型


Type[] types = assembly.GetTypes();




//遍历所有的类型，找到插件类型，并创建插件实例并加载


foreach (Type type in types)






{


if (type.GetInterface("IPlugin") != null)//判断类型是否派生自IPlugin接口






{


IPlugin plugin = (IPlugin)Activator.CreateInstance(type);//创建插件实例


plugin.Application = this;


plugin.Load();


}


}

}

构建插件式的应用程序框架(四)－－－－服务容器

在构建插件式的应用程序框架(二)－－－－订立契约一文中，可以看到我们的IApplication接口是派生于IServiceContainer接口的。为什么要派生于IServiceContainer呢？我们来看看IServiceContainer的定义，它有几个AddService方法和RemoveService方法以及从IserviceProvider继承过来的GetService方法。Service本身是.NET设计时架构的基础，Service提供设计时对象访问某项功能的方法实现，说起来还真拗口。就我看来，ServiceContainer机制的本质就是解耦合，就是将类型的设计时功能从类型本身剥离出来。如果你把类型的设计时功能也封装到类型里，这样的类型包含了很多只有开发人员才会用到而最终用户根本不需要的功能，使得类型既臃肿有不便于扩展。而将设计时功能剥离出来，这样类型就可以不依赖于特定的设计环境，之所以现在有这么多非官方的.NET设计环境可能就是这个原因吧。

我们的插件式的应用程序框架正好也需要这样一个松散的架构，我就移花接木把它应用到我们的框架中。

ServiceContainer是.NET提供的IserviceContainer的实现，如果没有特殊的需要我们不必扩展它，而是直接的利用它。在上一篇文章中我们在实现IApplication接口的时候就直接使用的ServiceContainer。我们在使用Service架构的时候，总是倾向于有一个根容器，各个Service容器构成了一个Service容器树，每一个节点的服务都可以一直向上传递，直到根部，而每一个节点请求Service的时候，我们总是可以从根节点获得。我把这个根节点比喻成一个服务中心，它汇总了所有可提供的服务，当某个对象要请求服务（GetService）只需要向根结点发送要获得的服务，根结点就可以把服务的对象传递给它。

从另外一个角度看，ServiceContainer为我们的插件是应用程序提供了有力的支持，利用ServiceContainer，你不但可以获得应用程序所提供的所有的功能，而且你还可以通过插件向应用程序添加Service，而你添加的Service又可以服务另外的Service，这样我们的应用程序框架就更加的灵活了。但是任何东西都是有两面性的，带来灵活的同时也为开发人员的工作增加了复杂度，所以使用ServcieContianer开发的应用程序必须提供足够详细的文档，否则开发人员可能根本不知道你到底有多少Service可以用，因为很多的Service是通过插件提供的，可能应用程序的作者都不会知道程序发布以后会出现多少Service。

写了这么多，可能接触过ServiceContainer的朋友已经觉得罗唆了，没接触过的还是觉得说得莫明其妙。有空接着写，我会创建几个简单的服务演练演练，增强一下感性认识，呵呵。

构建插件式的应用程序框架(五)－－－－管理插件

我们现在已经搭建了插件式的应用程序框架，接下来的工作就是要充实框架的内容，提供基本的服务，也就是Service。我想首要的任务就是提供插件的管理服务，我在前面的文章也提到了，要实现动态加载必须要知道插件寄宿在哪里，哪些要加载，哪些不加载，这些就是这篇文章要讨论的问题。

首先解决的就是插件放在什么地方，我采取的传统的方法，将插件放到应用程序所在目录下的制定目录，我会在应用程序所在的目录下创建一个文件夹，命名为Plugins。接下来的工作就是要通知哪些插件是要加载的，哪些是不需要加载的，我会将这些信息放到应用程序的配置文件中的制定配置块中，当应用程序运行的时候，就会读取配置文件，并根据获得的信息加载插件。另外我们的应用程序框架是建立在Service基础之上，所以我需要创建一个管理插件的service。

我们现在定义一个插件管理的Service接口。


using System;


using System.Collections.Generic;


using System.Text;




namespace PluginFramework






{


public interface IPluginService






{




IApplication Application

{ get;set;}


void AddPlugin(String pluginName, String pluginType, String Assembly, String pluginDescription);


void RemovePlugin(String pluginName);


String[] GetAllPluginNames();


Boolean Contains(String pluginName);


Boolean LoadPlugin(String pluginName);


Boolean UnLoadPlugin(String pluginName);


IPlugin GetPluginInstance(String pluginName);


void LoadAllPlugin();


}


}



PluginService要实现的目标首先是在配置文件中添加/删除要加载的插件以及相关的信息，接下来就是动态的加载插件。我们要定义几个类型：Plugin配置区块类型，Plugin元素类型，plugin元素集合类型，以便我们能够读取插件的信息。

最后我们实现PluginService：


using System;


using System.Collections.Generic;


using System.Text;


using System.Xml;


using System.Configuration;


using System.Reflection;


using System.Windows.Forms;


using System.IO;


using System.Collections;




namespace PluginFramework






{


public class PluginService : IPluginService






{


private IApplication application = null;


private PluginConfigurationSection config = null;


private Dictionary<String, IPlugin> plugins = new Dictionary<string, IPlugin>();


private XmlDocument doc = new XmlDocument();




public PluginService()






{




}




public PluginService(IApplication application)






{


this.application = application;




}






IPluginService Members#region IPluginService Members




public void AddPlugin(string pluginName, string pluginType, string assembly, string pluginDescription)






{


doc.Load(AppDomain.CurrentDomain.SetupInformation.ConfigurationFile);


XmlNode pluginNode = doc.SelectSingleNode("/configuration/PluginSection");


XmlElement ele = doc.CreateElement("add");


XmlAttribute attr = doc.CreateAttribute("Name");


attr.Value = pluginName;


ele.SetAttributeNode(attr);


XmlAttribute attrType = doc.CreateAttribute("Type");


attrType.Value = pluginType;


ele.SetAttributeNode(attrType);




XmlAttribute attrAss = doc.CreateAttribute("Assembly");


attrAss.Value = assembly;


ele.SetAttributeNode(attrAss);




XmlAttribute attrDes = doc.CreateAttribute("Description");


attrDes.Value = pluginDescription;


ele.SetAttributeNode(attrDes);


pluginNode.AppendChild(ele);


doc.Save(AppDomain.CurrentDomain.SetupInformation.ConfigurationFile);


ConfigurationManager.RefreshSection("PluginSection");


}




public void RemovePlugin(string pluginName)






{


doc.Load(AppDomain.CurrentDomain.SetupInformation.ConfigurationFile);


XmlNode node = doc.SelectSingleNode("/configuration/PluginSection");


foreach (XmlNode n in node.ChildNodes)






{


if (n.Attributes != null)






{


if (n.Attributes[0].Value == pluginName)






{


node.RemoveChild(n);


}


}


}


doc.Save(AppDomain.CurrentDomain.SetupInformation.ConfigurationFile);


ConfigurationManager.RefreshSection("PluginSection");


}




public string[] GetAllPluginNames()






{


config = (PluginConfigurationSection)ConfigurationManager.GetSection("PluginSection");


PluginConfigurationElement pe = new PluginConfigurationElement();


ArrayList ps = new ArrayList();


for (Int32 i = 0; i < config.PluginCollection.Count; i++)






{


pe = config.PluginCollection[i];


ps.Add(pe.Name);


}


return (String[])ps.ToArray(typeof(String));


}




public bool Contains(string pluginName)






{


config = (PluginConfigurationSection)ConfigurationManager.GetSection("PluginSection");


PluginConfigurationElement pe = new PluginConfigurationElement();


List<String> ps = new List<string>();


for (Int32 i = 0; i < config.PluginCollection.Count; i++)






{


pe = config.PluginCollection[i];


ps.Add(pe.Name);


}


return ps.Contains(pluginName);


}




public bool LoadPlugin(string pluginName)






{


Boolean result = false;


config = (PluginConfigurationSection)ConfigurationManager.GetSection("PluginSection");


PluginConfigurationElement pe = new PluginConfigurationElement();




String path = Path.GetDirectoryName(System.Windows.Forms.Application.ExecutablePath) + "\\Plugin";


try






{


for (Int32 i = 0; i < config.PluginCollection.Count; i++)






{


pe = config.PluginCollection[i];


if (pe.Name == pluginName)






{


Assembly assembly = Assembly.LoadFile(path + "\\" + pe.Assembly);


Type type = assembly.GetType(pe.Type);


IPlugin instance = (IPlugin)Activator.CreateInstance(type);


instance.Application = application;


instance.Load();


plugins[pluginName] = instance;


result = true;


break;


}


}


if (!result)






{


MessageBox.Show("Not Found the Plugin");


}


}


catch (Exception e)






{


MessageBox.Show(e.Message);


result = false;


}


return result;


}




public bool UnLoadPlugin(string pluginName)






{


Boolean result = false;


try






{


IPlugin plugin = GetPluginInstance(pluginName);


plugin.UnLoad();


result = true;


}


catch (Exception e)






{


MessageBox.Show(e.Message);


}


return result;


}




public void LoadAllPlugin()






{


PluginConfigurationElement pe = new PluginConfigurationElement();


config = (PluginConfigurationSection)ConfigurationManager.GetSection("PluginSection");


String path = Path.GetDirectoryName(System.Windows.Forms.Application.ExecutablePath) + "\\Plugin";


try






{


for (Int32 i = 0; i < config.PluginCollection.Count; i++)






{


pe = config.PluginCollection[i];


Assembly assembly = Assembly.LoadFile(path + "\\" + pe.Assembly);


Type type = assembly.GetType(pe.Type);


IPlugin instance = (IPlugin)Activator.CreateInstance(type);


instance.Application = application;


instance.Load();


plugins[pe.Name] = instance;


}


}


catch (Exception e)






{


MessageBox.Show(e.Message);


}


}




public IApplication Application






{


get






{


return application;


}


set






{


application = value;


}


}




public IPlugin GetPluginInstance(string pluginName)






{


IPlugin plugin = null;


if (plugins.ContainsKey(pluginName))






{


plugin = plugins[pluginName];


}


return plugin;


}




#endregion


}


}



由于代码比较多，我也就不一一列举了，只把比较重要的代码列出来，其余的我会提供源代码的下载。在实现了PluginService以后，我们需要有一个地方能够使用这个Service来管理插件，我的做法是在一个菜单里添加一个项目，当用户点击这个项目的时候弹出插件管理的对话框，用户在这个对话框中选择使用那些插件，当插件被选中的时候，插件会被立即加载进来，并且记录到配置文件里，当用户下次运行应用程序的时候，插件默认会被自动的加载。

另外从现在开始我们就需要使用配置文件了，所以，我们需要给应用程序添加一个app.config文件，文件内容如下：


<?xml version="1.0" encoding="utf-8" ?>


<configuration>


<configSections>


<section


name="PluginSection"


type="PluginFramework.PluginConfigurationSection, PluginFramework"


/>


</configSections>


<PluginSection>




</PluginSection>


</configuration>
样子，总体来说我们就为Plugin的管理提供了一个基本的实现，如果大家还有什么不明白的地方，可以参考我提供的源代码或者通过e-mail和我联系。