C#的插件编程: 唐伯虎与他八个老婆之间不得不说的故事

一边在网上找C#插件编程的资料，一边在电脑里放着经典的周星驰电影《唐伯虎点秋香》，也算是次愉快学习。看到其中几个外景很眼熟，一打听，果然是在嘉定汇龙潭拍摄的 - 我的大学就在那里附近，天天晨跑要经过的。 

片中一个经典情节就是唐伯虎的老妈给他物色了8个老婆，个个貌如天仙，不过就喜欢喝酒打牌。突然觉得正好可以用来做插件编程的例子啊！唐伯虎是主程序，每个老婆都可以做成一个插件DLL程序，唐妈正好充当伯虎与众媳妇间的接口定义。

 先看唐妈接口，她负责定义要连接的两方，也就是伯虎和媳妇各自的属性和方法：

using System;
using System.Collections.Generic;
using System.Text;

namespace 老娘
...{
    public interface 媳妇
    ...{
        // 插件应用程序名属性
        string 媳妇名   // 媳妇的姓名
        ...{
            get;
            set;
        }

        // 主程序属性
        伯虎 Host       // 媳妇总得有个老公吧
        ...{
            get;
            set;
        }

        // 其它属性
        object OtherInfo    // 别的属性
        ...{
            get;
            set;
        }

        // 调用插件窗口
        void 我来啦(string arg);    // 叫媳妇总得答个话吧
    }

    public interface 伯虎
    ...{
        // 识别并注册插件（比如动态加载入菜单）
        bool Register(媳妇 girl);
    }
}

 

OK，编译成DLL。

现在编写一个媳妇，当然为了当上媳妇，先得引用老娘.dll，并且using 老娘。项目类型应该是Windows类库，也可以先生成WindowsApp，然后删掉program.cs，并把项目的输出类型改为类库。但是最重要的是要添加一个类，用来定义接口的具体实现。类名一定要是刚才定义接口时的NameSpace:接口名，这里也就是 老娘: 媳妇。

using System;
using System.Collections.Generic;
using System.Text;
using System.Windows.Forms;
using System.Windows;
using 老娘;

namespace 老婆乙
...{
    class 老娘 : 媳妇 //类名一定要这么写
    ...{
        private string m_媳妇名 = "老婆２号";
        public string 媳妇名
        ...{
            get
            ...{
                return m_媳妇名;
            }
            set
            ...{
                m_媳妇名 = value;
            }
        }

        private 伯虎 m_host = null;
        public 伯虎 Host
        ...{
            get
            ...{
                return m_host;
            }
            set
            ...{
                m_host = value;
                m_host.Register(this);
            }
        }

        private object m_OtherInfo = null;
        public object OtherInfo
        ...{
            get
            ...{
                return m_OtherInfo;
            }
            set
            ...{
                m_OtherInfo = value;
            }
        }

        public void 我来啦(string arg)
        ...{
            Form1 frm = new Form1("人家的幺鸡不见了嘛～　有空再画一张不就得了．．．");
            if (frm.ShowDialog() == DialogResult.Yes)
            ...{
                m_OtherInfo = "哼，小气！";
            }
            else
            ...{
                m_OtherInfo = "这才乖～～";
            }
        }

    }
}

 接口里提到的东东都实现了。这个老婆乙的窗体类就没啥特殊的了，扔一个Label两个Button完事：

using System;
using System.Collections.Generic;
using System.ComponentModel;
using System.Data;
using System.Drawing;
using System.Text;
using System.Windows.Forms;

namespace 老婆乙
...{
    public partial class Form1 : Form
    ...{
        public Form1(string arg)
        ...{
            InitializeComponent();
            label1.Text = arg;
        }

        private void button1_Click(object sender, EventArgs e)
        ...{
            this.DialogResult = DialogResult.Yes;
        }

        private void button2_Click(object sender, EventArgs e)
        ...{
            this.DialogResult = DialogResult.No;
        }

    }
}

别的媳妇也可以照此办理，保证这些接口都实现就可以了，怎么实现就看具体需求了！不高兴一个一个写过去真写八个老婆了。

下面看看伯虎兄是怎么在他娘的安排下接受他的娇妻们的：

当然首先还是要using 老娘;并且定义窗体内有效的变量private 老娘.媳妇[] 众媳妇;
因为用到反射，所以还要using System.Reflection; 

窗体类的定义也要注意加上老娘接口的伯虎部分: public partial class frmMain : Form,伯虎

        // 载入插件
        private void LoadPlugIn()
        ...{
            //　搜索目录下的所有DLL
            string path = Application.StartupPath;
            string[] pluginFiles = Directory.GetFiles(path, "*.dll");

            // 产生媳妇数组
            众媳妇 = new 媳妇[pluginFiles.Length];

            // 检索所有DLL
            for (int i = 0; i < pluginFiles.Length; i++)
            ...{
                // 不要后缀
                string args = pluginFiles[i].Substring(pluginFiles[i].LastIndexOf("/") + 1, pluginFiles[i].IndexOf(".dll") - pluginFiles[i].LastIndexOf("/") - 1);

                Type ObjType = null;

                try
                ...{
                    //载入插件
                    Assembly ass = null;
                    ass = Assembly.Load(args);
                    if (ass != null)
                    ...{
                        // 检索插件的指定类
                        ObjType = ass.GetType(args + ".老娘");

                        //Type[] t = ass.GetTypes();
                        //for (int k = 0; k < t.Length; k++)
                        //{
                        //    MessageBox.Show(t.GetValue(k).ToString());
                        //}

                    }
                }
                catch (Exception ex)
                ...{
                    //MessageBox.Show(ex.Message);
                }

                try
                ...{
                    // OK Lets create the object as we have the Report Type
                    if (ObjType != null)
                    ...{

                        众媳妇[i] = (媳妇)Activator.CreateInstance(ObjType);
                        众媳妇[i].Host = this;

                    }
                }
                catch (Exception ex)
                ...{
                    //MessageBox.Show(ex.Message);
                }

            }

        }


        //注册插件，动态载入菜单
        public bool Register(媳妇 girl)
        ...{
            //MenuItem mn = new MenuItem(ipi.PlugInAppName, new EventHandler(NewLoad));
            //menuItem2.MenuItems.Add(mn);

            ToolStripMenuItem mn = new ToolStripMenuItem();
            mn.Text = girl.媳妇名;
            mn.Click += new EventHandler(NewLoad);
            menuWife.DropDownItems.Add(mn);

            return true;
        }

        // 载入菜单的Click事件
        private void NewLoad(object sender, System.EventArgs e)
        ...{
            ToolStripMenuItem mn = (ToolStripMenuItem)sender;
            label1.Text = "";

            // 检索所有老婆
            for (int i = 0; i < 众媳妇.Length; i++)
            ...{
                string strType = mn.Text;　//　记下老婆的名字

                if (众媳妇[i] != null)　// 老婆存在！
                ...{
                    if (众媳妇[i].媳妇名 == strType)　// 当前老婆就是要找的那个
                    ...{
                        // 选中的老婆来报到
                        众媳妇[i].我来啦("");
                        label1.Text = 众媳妇[i].媳妇名 + ": " + 众媳妇[i].OtherInfo.ToString();
                        break;
                    }
                }
            }
        }

具体运行时，把老婆DLL们复制到唐伯虎主程序下就可以了。当然你也可以像PhotoShop那样专门开一个插件目录，只要需要稍微修改一下搜索DLL路径代码就可以了！