插件式设计开发心得（一）

本人对插件式应用框架的开发是相当喜欢的，记得曾经写过一篇文章，《将工厂模式升华为插件式框架》，这篇文章中写的是在控制台下实现的一种将工厂模式进一步加工后的结果。这两天又重新理了一下思路，于是决定动手写一个winform环境下的插件式框架开发。当然，现在插件式开发的软件也是相当多的，这个可以网上搜一下，或者看我的《将工厂模式升华为插件式框架》，最后有提到。

插件式开发的核心思想我想应该是针对接口编程，那么好吧，我们现在开始插件式框架开发之旅吧。我以尝试开发一个小型系统工具为例子，以此为基础进行介绍我的插件式开发的思想，希望大家多多交流。

插件式应用框架一般都有以下几部分组成：

1、宿主程序：主界面程序（包含各种工具、菜单等），插件引擎（解析插件程序集），通信契约。

2、插件

3、另外的程序集、组件库（起框架辅助作用）

好吧，现在我们开始设计我们自己的插件引擎吧。

首先，我们要新建一个IApplication接口，此接口包含了主界面程序中所包含的所有内容，比如菜单，工具栏，tabcontrol，tabpage等。IApplication接口是所有插件与主主界面程序通信的公共契约，所以非常重要。代码如下：

Code:

1. namespace WingOfDream.SystemTool.CoreFramework
   {
       using System.Windows.Forms;
       /// <summary>
       /// 宿主程序的所有属性
       /// </summary>
       public interface IApplication
       {
           /// <summary>
           /// 主程序标题
           /// </summary>
           string Caption { get; set; }
           /// <summary>
           /// 主程序当前使用的工具Tool名称
           /// </summary>
           string CurrentTool { get; set; }
           /// <summary>
           /// 主程序当前的ToolStrip容器
           /// </summary>
           ToolStripContainer CurrentToolStripContainer { get; set; }
           /// <summary>
           /// 当前的ToolStrip
           /// </summary>
           ToolStrip CurrentToolStrip { get; set; }
           /// <summary>
           /// 当前的菜单
           /// </summary>
           MenuStrip CurrentMenuStrip { get; set; }
           /// <summary>
           /// 主程序当前显示的TabControl
           /// </summary>
           TabControl CurrentTabControl { get; set; }
           /// <summary>
           /// 主程序当前显示的TabPage
           /// </summary>
           TabPage CurrentTabPage { get; set; }
           /// <summary>
           /// 主程序名称
           /// </summary>
           string Name { get; }
           /// <summary>
           /// 主程序窗体对象
           /// </summary>
           Form MainPlatform { get; set; }
           /// <summary>
           /// 主程序UI界面的Visible属性
           /// </summary>
           bool Visible { get; set; }
       }
   }

读者可以看到，IApplication接口中包含的仅仅是一些属性，而插件就是通过这些属性，与主界面进行交互的。

下面来实现这个接口：

Code:

1. namespace WingOfDream.SystemTool.CoreFramework
   {
       using System.Windows.Forms;
       /// <summary>
       /// 实现IApplication
       /// </summary>
       public class Application : IApplication
       {
2.         #region IApplication 成员
3.         public string Caption
           {
               get
               {
                   return this.Caption;
               }
               set
               {
                   this.Caption = value;
               }
           }
4.         public string CurrentTool
           {
               get
               {
                   return this.CurrentTool;
               }
               set
               {
                   this.CurrentTool = value;
               }
           }
5.         public ToolStripContainer CurrentToolStripContainer
           {
               get
               {
                   return this.CurrentToolStripContainer; ;
               }
               set
               {
                   this.CurrentToolStripContainer = value;
               }
           }
6.         public MenuStrip CurrentMenuStrip
           {
               get
               {
                   return this.CurrentMenuStrip;
               }
               set
               {
                   this.CurrentMenuStrip = value;
               }
           }
7.         public ToolStrip CurrentToolStrip
           {
               get
               {
                   return this.CurrentToolStrip; ;
               }
               set
               {
                   this.CurrentToolStrip = value;
               }
           }
8.         public TabControl CurrentTabControl
           {
               get
               {
                   return this.CurrentTabControl;
               }
               set
               {
                   this.CurrentTabControl = value;
               }
           }
9.         public TabPage CurrentTabPage
           {
               get
               {
                   return this.CurrentTabPage;
               }
               set
               {
                   this.CurrentTabPage = value;
               }
           }
10.         public string Name
            {
                get { return this.Name; }
            }
11.         public Form MainPlatform
            {
                get
                {
                    return this.MainPlatform;
                }
                set
                {
                    this.MainPlatform = value;
                }
            }
12.         public bool Visible
            {
                get
                {
                    return this.Visible;
                }
                set
                {
                    this.Visible = value;
                }
            }
13.         #endregion
        }
    }

要知道，接口一旦继承就必须实现。具体可以参看MSDN中关于接口跟抽象类的设计原则，或者《.NET设计规范》。

有了主的通信契约，我们就可以定义插件类型的接口了。

我们首先得定义一个IPlugin接口，该接口为所有插件的基接口，所有插件接口必须继承与该接口。代码如下：

Code:

1. namespace WingOfDream.SystemTool.CoreFramework   
2. {   
3.     /// <summary>   
4.     /// 所有框架插件接口的基接口   
5.     /// </summary>   
6.     public interface IPlugin   
7.     {   
8.         /// <summary>   
9.         /// 按钮显示的文字   
10.         /// </summary>   
11.         string Caption { get; }   
12.         /// <summary>   
13.         /// 按钮所属类别   
14.         /// </summary>   
15.         string Category { get; }   
16.     }   
17. }  

下面我们来设计插件接口，首先请看IApplication接口中声明的插件对象的UI对象。我们要开发的插件UI对象有命令（ICommand）按钮、菜单栏（IMenuDef）、工具（ITool），工具条（IToolBarDef）、还有tabpage（ITabPage）。