十八、【开源】EnterpriseFrameWork框架核心类库之Winform控制器

回《【开源】EnterpriseFrameWork框架系列文章索引》

EFW框架源代码下载：http://pan.baidu.com/s/1qWJjo3U

EFW框架中的WinController控制器可以说是整个Winform版中最具有价值的地方，能够熟练使用它的话，可以让你写得代码结构清晰不知多少倍，真正的做到了CS开发的界面层与逻辑层的完全隔离；更重要的是改变了你写界面代码的思维，让你一次性写出功能完善的代码，真的，传统的那种事件驱动的方式编码会让你的代码变得越来越臃肿，就算你懂得不断重构你的代码，也完全避免不了出现臃肿的情况；所以必须使用WinController控制器模式从源头彻底解决这种问题；

WinController控制器与界面不一定是一一对应的，一个控制器可以对应多个界面，当几个界面的操作十分密切时就可以用一个控制器来控制它们的行为；一个界面对应多个控制器这种方式最好不要这么做，这样会让你的程序变得复杂，也破坏了业务架构与框架之间的关系，参考第十一章《EnterpriseFrameWork框架的分层与系统业务的结合》。

本章主要内容通过解读框架源代码来学习WinController是怎么实现的，以及学习控制器这种设计模式；

本文要点：

1.如何使用Winform控制器

2.Winform控制器的设计思路

3.Winform控制器BaseController基类的实现代码

4.Winform控制器的自定义标签MenuAttribute和ViewAttribute

5.通过Winform控制器打开界面

Winform控制器源代码目录结构

EFW框架控制器设计图

1.如何使用Winform控制器

如上图，Books.Winform项目里的是界面文件，Books项目的是界面接口文件和控制器文件，frmBookManager对象继承IfrmBook接口，bookwinController对象依IfrmBook接口；

见上图，Books实例中保存数据功能代码调用流程，界面代码frmBookManager继承了IfrmBook接口的两个方法并实现，点击保存按钮，btnsave_Click事件内并不实现保存数据的代码而只是向控制器发送一个消息，指定需要调用的方法名称bookSave，程序开始执行控制器中的bookSave方法，利用接口属性frmBook.currBook从界面获取数据，并利用框架中的ORM保存到数据库；接着调用GetBooks方法将数据显示在界面上；GetBooks方法调用后台的IBookDao对象获取Book数据，再通过frmBook.loadbooks(dt)接口方法将数据绑定到界面控件gridBook上；

2.Winform控制器的设计思路

Winform控制器的设计思路有点类似Web系统中的MVC模式，控制器处理这后台数据对象与前台界面直接的交互，利用接口从界面获取数据，再传递给后台对象处理，处理完后再利用接口将数据传递给界面控件显示；整个交互的逻辑代码是在控制器中实现的，数据怎么从界面获取与数据怎么绑定到界面控件都是在前端界面接口中实现的，而数据怎么存储到数据库与怎么从数据库获取数据都是在后端Dao或ObjectModel中实现的，当然也可以在控制器中利用oleDb直接操作数据库，但好的程序结构还是放在Dao和ObjectModel中合适些；

Winform控制器必须继承框架中的BaseController对象，还有控制器类名上要指定菜单标签MenuAttribute和界面标签ViewAttribute，BaseController对象封装了控制器的一些处理功能，MenuAttribute和ViewAttribute一个对应系统的菜单名，一个决定控制器能操作的界面对象；

3.Winform控制器BaseController基类的实现代码

因为所有Winform控制器都必须继承BaseController基类，所以我们有必要先看一下BaseController基类的代码是怎么样的；

BaseController文件

 /// <summary>
     /// Winform控制器基类
     /// </summary>
     public abstract class BaseController : AbstractBusines
     {
         public AbstractDatabase oleDb
         {
             get
             {
                 return _oleDb;
             }
         }

         public SysLoginRight GetSysLoginRight
         {
             get
             {
                 if (EFWCoreLib.CoreFrame.Init.AppGlobal.cache.GetData("RoleUser") != null)
                 {
                     return (SysLoginRight)EFWCoreLib.CoreFrame.Init.AppGlobal.cache.GetData("RoleUser");
                 }
                 else
                 {
                     return new SysLoginRight();
                 }
             }
         }

         internal IBaseView _defaultView;

         public IBaseView DefaultView
         {
             get { return _defaultView; }
         }

         private Dictionary<string, IBaseView> _iBaseView;
         public Dictionary<string, IBaseView> iBaseView
         {
             get { return _iBaseView; }
             set
             {
                 _iBaseView = value;
                 foreach (KeyValuePair<string, IBaseView> val in _iBaseView)
                 {
                     //val.Value.ControllerEvent += new ControllerEventHandler(UI_ControllerEvent);
                     val.Value.InvokeController = new ControllerEventHandler(UI_ControllerEvent);
                 }
             }
         }

         public CloseTab closeTab;

         /// <summary>
         /// 创建BaseController的实例
         /// </summary>
         public BaseController()
         {

         }
         /// <summary>
         /// 界面控制事件
         /// </summary>
         /// <param name="eventname">事件名称</param>
         /// <param name="objs">参数数组</param>
         /// <returns></returns>
         public virtual object UI_ControllerEvent(string eventname, params object[] objs)
         {
             switch (eventname)
             {
                 case "Close":
                     if (closeTab != null)
                         closeTab();
                     break;
                 case "this":
                     return this;
             }

             MethodInfo meth = this.GetType().GetMethod(eventname);
             if (meth != null)
             {
                 MethodAttribute[] WinM = (MethodAttribute[])meth.GetCustomAttributes(typeof(MethodAttribute), true);
                 if (WinM.Length > )
                 {
                     if (WinM[].OpenDBKeys != null && WinM[].OpenDBKeys.ToString().Trim() != "")
                     {
                         List<string> dbkeys = WinM[].OpenDBKeys.Split(new char[] { ',' }).ToList();
                         this.BindMoreDb(oleDb, "default");
                         foreach (string dbkey in dbkeys)
                         {
                             EFWCoreLib.CoreFrame.DbProvider.AbstractDatabase _Rdb = EFWCoreLib.CoreFrame.DbProvider.FactoryDatabase.GetDatabase(dbkey);
                             _Rdb.WorkId = GetSysLoginRight.WorkId;
                             //创建数据库连接
                             this.BindMoreDb(_Rdb, dbkey);
                         }
                     }
                 }
                 return meth.Invoke(this, objs);
             }
             return null;
         }

         /// <summary>
         /// 初始化全局web服务参数对象
         /// </summary>
         public virtual void Init() { }

         public virtual IBaseView GetView(string frmName)
         {
             return iBaseView[frmName];
         }
     }

BaseController基类封装了控制器的四方面的功能：

1）数据库操作对象oleDb，这样我们可以直接在控制器方法内使用它执行SQL语句操作数据库

2）系统登录后的用户信息GetSysLoginRight，这样我们可以再控制器中很方便的使用当前登录的用户信息；

3）界面对象字典iBaseView，这属性与控制器上ViewAttribute标签配置相对应，可以从中取出配置的界面接口对象来操作界面；

4）处理界面请求控制器方法的功能UI_ControllerEvent，界面使用InvokeController向控制器发送消息，而怎么效应界面的消息在此方法中实现的，利用反射机制执行对应的控制器方法；

4.Winform控制器的自定义标签MenuAttribute和ViewAttribute

这里的设计是这样的，一个控制器可以配置多个MenuAttribute，那么系统可以挂多个菜单，而这几个菜单都是公用这一个控制器，同样一个控制器可以配置多个ViewAttribute，控制器就可以同时操作这些配置的界面；

MenuAttribute文件

   [AttributeUsageAttribute(AttributeTargets.Class, Inherited = true, AllowMultiple = false)]
     public class MenuAttribute:Attribute
     {

         string _defaultName;

         /// <summary>
         /// 菜单名称
         /// </summary>
         public string DefaultName
         {
             get { return _defaultName; }
             set { _defaultName = value; }
         }

         private string _defaultViewName;
         /// <summary>
         /// 菜单对应打开界面
         /// </summary>
         public string DefaultViewName
         {
             get { return _defaultViewName; }
             set { _defaultViewName = value; }
         }

         string _memo;
         public string Memo
         {
             get { return _memo; }
             set { _memo = value; }
         }

         public MenuAttribute()
         {
         }

         public MenuAttribute(string defaultName,string memo)
         {
             this._defaultName = defaultName;
             this._memo = memo;
         }
     }

ViewAttribute文件

 [AttributeUsageAttribute(AttributeTargets.Class, Inherited = true, AllowMultiple = true)]
     public class ViewAttribute:Attribute
     {
         private string _name;
         /// <summary>
         /// 界面名称
         /// </summary>
         public string Name
         {
             get { return _name; }
             set { _name = value; }
         }

         private bool _defaultShow;
         public bool DefaultView
         {
             get { return _defaultShow; }
             set { _defaultShow = value; }
         }

         private Type _viewType;
         /// <summary>
         /// 界面对象类型
         /// </summary>
         public Type ViewType
         {
             get { return _viewType; }
             set { _viewType = value; }
         }

         private string _dllName;
         /// <summary>
         /// 界面存放的DLL
         /// </summary>
         public string DllName
         {
             get { return _dllName; }
             set { _dllName = value; }
         }

         private string _viewTypeName;
         /// <summary>
         /// 界面类型名称
         /// </summary>
         public string ViewTypeName
         {
             get { return _viewTypeName; }
             set { _viewTypeName = value; }
         }

         string _memo;
         public string Memo
         {
             get { return _memo; }
             set { _memo = value; }
         }
     }

5.通过Winform控制器打开界面

Winform系统打开一个界面是这样操作的，用户点击系统主界面上的菜单，框架就会调用WinformViewCreator对象来实例化控制器对象和实例化控制器配置的所有界面窗体对象，所以我们有必要看一下WinformViewCreator对象是怎么实现的；

WinformViewCreator文件

  public override Object InstanceController(CloseTab close)
         {
             try
             {

                 //加载类库
                 Assembly assembly = null;
                 assembly = Assembly.LoadFrom(AppGlobal.AppRootPath + "\\" + dllfile);

                 //获得控制器类（型）
                 Type type = assembly.GetType(controllername, false, true);

                 MenuAttribute[] menuAttribute = (MenuAttribute[])type.GetCustomAttributes(typeof(MenuAttribute), true);
                 ViewAttribute[] viewAttribute = (ViewAttribute[])type.GetCustomAttributes(typeof(ViewAttribute), true);
                 //ServiceAttribute[] serviceAttribute = (ServiceAttribute[])type.GetCustomAttributes(typeof(ServiceAttribute), true);

                 if (menuAttribute.Length > )
                 {
                     Dictionary<string, IBaseView> viewDic = new Dictionary<string, IBaseView>();
                     //Dictionary<string, SoapHttpClientProtocol> serviceDic = new Dictionary<string, SoapHttpClientProtocol>();
                     BaseController controller = (BaseController)System.Activator.CreateInstance(type);

                     EFWCoreLib.CoreFrame.DbProvider.AbstractDatabase Rdb = EFWCoreLib.CoreFrame.DbProvider.FactoryDatabase.GetDatabase();
                     Rdb.WorkId = controller.GetSysLoginRight.WorkId;
                     controller.BindDb(Rdb, AppGlobal.container);

                     controller.closeTab = close;//关闭窗口

                     for (int index = ; index < viewAttribute.Length; index++)
                     {
                         if (viewAttribute[index].ViewType == null)
                         {
                             if (string.IsNullOrEmpty(viewAttribute[index].DllName))
                             {
                                 continue;
                             }
                             Assembly _assembly = Assembly.LoadFrom(AppGlobal.AppRootPath + "\\" + viewAttribute[index].DllName);
                             viewAttribute[index].ViewType = _assembly.GetType(viewAttribute[index].ViewTypeName, false, true);
                         }
                         IBaseView view = (IBaseView)System.Activator.CreateInstance(viewAttribute[index].ViewType);
                         if (viewAttribute[index].DefaultView) controller._defaultView = view;
                         if (index ==  && viewAttribute.ToList().FindIndex(x => x.DefaultView == true) == -) controller._defaultView = view;
                         viewDic.Add(viewAttribute[index].ViewType.Name, view);
                     }
                     //for (int index = 0; index < serviceAttribute.Length; index++)
                     //{
                     //    SoapHttpClientProtocol service = (SoapHttpClientProtocol)System.Activator.CreateInstance(serviceAttribute[index].ServiceType);
                     //    serviceDic.Add(serviceAttribute[index].ServiceType.Name, service);
                     //}

                     controller.iBaseView = viewDic;
                     //controller.service = serviceDic;

                     controller.Init();//初始化
                     return controller;
                 }

                 return null;
             }
             catch (Exception err)
             {
                 throw err;
             }
         }

上面代码中有两点需要说明一下，首先根据菜单配置的控制器名称通过反射实例化控制器对象；

接着根据控制器的配置的ViewAttribute标签，实例化界面对接并添加到iBaseView属性中；