C#一步一步实现插件框架的示例(二)

时间:2022-03-23 20:49:45

前一篇链接:C#一步一步实现插件框架的示例(一)

今天我们再接着前一篇来完善插件功能。在前一篇中我们将生成插件按钮的代码直接写在了WorkBench中,无法体现插件式开发的优越性,现在我们来对其进行分离。

首先对WorkBench类中的构造函数进行修改,删除原来的生成按钮功能的函数,改变后如下:

 public WorkBench()
        {
            InitializeComponent();
            this.Controls.Add(ToolBar);
            Application.Idle += new EventHandler(Application_Idle);
            LoadDlls();
        }

前一篇中对插件所标识的功能直接在构造函数中写死了。现在我们使用反射的方式来将其进行分离,我们将插件单独编译成一个DLL,当然一个DLL中可以包含多个插件,也可以一个DLL一个插件。由于在应用程序目录中可能会有很多其他的DLL,所以我们在这里约定包含有插件的DLL命名规则为:*.addin.dll,这样我们就只载入符合这种命名规则的DLL。

  void LoadDlls()
        {
            //获取所有符合命名规则的DLL
            var files = Directory.GetFiles(Application.StartupPath, "*.addin.dll");
            for (int i = 0; i < files.Length; i++)
            {
                LoadAddin(files[i]);
            }            
        }

        private void LoadAddin(string path)
        {
            //通过反射,获取DLL中的类型,并遍历所有为AbstractCommand子类的类,因为我们的插件都继承于AbstractCommand
            Assembly assembly = Assembly.LoadFrom(path);
            Type[] types = assembly.GetTypes();
            foreach (var t in types)
            {
                var obj = assembly.CreateInstance(t.ToString());
                if (obj is AbstractCommand)
                {
                    AddButton((AbstractCommand)obj);
                }
            }
        }

 

由于DLL中可能包含有不是插件的类,所以我们通过: if (obj is AbstractCommand)来判断,因为我们的插件都是继承于AbstractCommand类,然后就调用AddButton函数根据传入的AbstractCommand的子类来生成工具栏的按钮:

   void AddButton(AbstractCommand info)
        {
            ToolBarButton t = new ToolBarButton(info);
            this.ToolBar.Items.Add(t);
            list.Add(t);
        }

关于ToolBarButton类请查看上一篇介绍或者源码。

然后我们将上一篇中的test类移出,新建一个DLL,参考到本项目,编译输出名称为:*.addin.dll,将其输出目录设置到相同的目录。运行即可自动生成对应的按钮。

如中我们将所生成的*.addin.dll拷贝多个到当前目录,如:td1.addin.dll    td2.addin.dll,再运行程序,程序会发现有三个插件,生成三个对应的按钮,只是他们的功能都是相同的。

C#一步一步实现插件框架的示例(二)

最后附上源代码:http://files.cnblogs.com/city-hunter/ExampleAddin1.rar

下一篇介绍如何生成MDI窗口