“老坛泡新菜”:SOD MVVM框架，让WinForms焕发新春

相关文章推荐
文质彬彬的大象 · Spring Boot ...· 6 月前 ·
冷静的围巾 · 再谈RDD、DataFrame、DataSe ...· 1 年前 ·
爱运动的投影仪 · Getting error ...· 1 年前 ·
淡定的跑步机 · Python Django后端，到前端js ...· 1 年前 ·
活泼的大葱 · python ...· 1 年前 ·
腾讯云
备案控制台
开发者社区
TVP
文章/答案/技术大牛
写文章
专栏首页程序员的SOD蜜 “老坛泡新菜”:SOD MVVM框架，让WinForms焕发新春
6 0

分享
namespace System.ComponentModel
    // 摘要: 
    //     向客户端发出某一属性值已更改的通知。
    public interface INotifyPropertyChanged
        // 摘要: 
        //     在更改属性值时发生。
        event PropertyChangedEventHandler PropertyChanged;
SOD框架的实体类基类 EntityBase 实现了此接口：
public abstract class EntityBase : INotifyPropertyChanged, ICloneable, PWMIS.Common.IEntity
/// <summary>
        /// 属性改变事件
        /// </summary>
        public event PropertyChangedEventHandler PropertyChanged;
        /// <summary>
        /// 触发属性改变事件
        /// </summary>
        /// <param name="propertyFieldName">属性改变事件对象</param>
        protected virtual void OnPropertyChanged(string propertyFieldName)
            if (this.PropertyChanged != null)
                string currPropName = EntityFieldsCache.Item(this.GetType()).GetPropertyName(propertyFieldName);
                this.PropertyChanged(this, new PropertyChangedEventArgs(currPropName));
// 其它代码略… … 
  }





    
所以SOD框架的实体类可以直接用来作为MVVM上的Model提供给View 做为被绑定对象，因此要我们只需要解决WinForms 形式的View 元素如何实现绑定操作，那么我们的WinForms 应用即可实现MVVM功能了。在WinForms 上，控件基本上都已经实现了绑定功能，它就是控件的 DataBindings，向它添加绑定即可，例如下面的例子：
this.textbox1.DataBindings.Add("Text", userEntity, "Name");
这样当文本框架输入的内容改变后，实体类对象 userEntity.Name 属性的值也会改变。如果userEntity是SOD实体类，所以userEntity.Name 改变，文本框的Text属性也会同步改变。
SOD框架的数据控件(WinForms,WebForms)都实现了 IDataControl 接口，它定义了几个重要的属性 LinkObject，LinkProperty ：
/// <summary>
    /// 数据映射控件接口
    /// </summary>
    public interface IDataControl
        /// <summary>
        /// 与数据库数据项相关联的数据
        /// </summary>
        string LinkProperty
        /// <summary>
        /// 与数据关联的表名
        /// </summary>
        string LinkObject
// 其它接口方法内容略… … 
我们可以使用 LinkObject 来指定要绑定的实体类对象，而LinkProperty 来指定要绑定的对象的属性，因此可以通过下面的代码实现WinForms 控件与SOD实体类的双向绑定：
public void BindDataControls(Control.ControlCollection controls)
            var dataControls = MyWinForm.GetIBControls(controls);
            foreach (IDataControl control in dataControls)
                //control.LinkObject 这里都是 "DataContext"
                object dataSource = GetInstanceByMemberName(control.LinkObject);
                if (control is TextBox)
                    ((TextBox)control).DataBindings.Add("Text", dataSource, control.LinkProperty);
                if (control is Label)
                    ((Label)control).DataBindings.Add("Text", dataSource, control.LinkProperty);
                if (control is ListBox)
                    ((ListBox)control).DataBindings.Add("SelectedValue", dataSource, control.LinkProperty, false, DataSourceUpdateMode.OnPropertyChanged);
        }
另外，我们可能还需要将 一些命令绑定到视图上，而要实现此功能也比较简单：
private Dictionary<object, CommandMethod> dictCommand;
public delegate void CommandMethod();
        public void BindCommandControls(Control control,CommandMethod command)
            if (control is Button)
                dictCommand.Add(control, command);
                ((Button)control).Click += (sender, e) => {
                    dictCommand[sender](); 
        }
经过这样的过程后，我们仅需要在窗体加载事件上写下面的几行代码就行了：
SubmitedUsersViewModel DataContext{get;set;}
       private void Form1_Load(object sender, EventArgs e)
            base.BindDataControls(this.Controls);
            base.BindCommandControls(this.button1, DataContext.SubmitCurrentUsers);
            base.BindCommandControls(this.button2, DataContext.UpdateUser);
            base.BindCommandControls(this.button3, DataContext.RemoveUser);
        }
上面的代码中，首先定义了一个视图模型对象 DataContext,在方法 BindDataControls 里面作为绑定到视图控件上的对象，它里面的 CurrentUser属性的Name属性绑定到了文本框控件上，所以 CurrentUser.Name 是作为复合属性来绑定的，对于标签控件和列表框控件，也是类似的过程，如下图:
这样，在视图上做简单的数据属性设置和写少量的code behind绑定代码，一个具有双向绑定功能的程序就好了。
MVVM示例解决方案
解决方案概览
为了向大家演示SOD框架对于MVVM的支持，我们搭建一个简单的解决方案，一共分为三个项目程序集，分别对应MVVM的三大部分：
WinFormMvvm:            WinForm 示例程序主程序，视图类所在程序集
WinFormMvvm.Model:      模型类程序集
WinFormMvvm.ViewModel:  视图模型程序集
搭建好的解决方案图如下：
注意：此解决方案是使用SOD Ver 5.5.5.1019 做的，因为这是目前nuget 上SOD的版本，最新的SOD框架已经把WinFormMvvm项目的 MvvmForm.cs 文件纳入到框架之内了。
 程序在App.config中指定了本次附加测试的数据库，数据库类型为 Access，默认的连接字符串可能要求Office 2007以上版本支持。
下面是App.config 的内容：
<?xml version="1.0" encoding="utf-8"?>
<configuration>
  <connectionStrings>
    <add name ="default" connectionString ="Provider=Microsoft.ACE.OLEDB.12.0;Jet OLEDB:Engine Type=6;Data Source=testdb.accdb" providerName="Access"/>
  </connectionStrings>
    <startup> 
        <supportedRuntime version="v4.0" sku=".NETFramework,Version=v4.5" />
    </startup>
  <runtime>
    <assemblyBinding xmlns="urn:schemas-microsoft-com:asm.v1">
      <dependentAssembly>
        <assemblyIdentity name="PWMIS.Core" publicKeyToken="17ba13a12b9fd814" culture="neutral" />
        <bindingRedirect oldVersion="0.0.0.0-5.5.5.1019" newVersion="5.5.5.1019" />
      </dependentAssembly>
    </assemblyBinding>
  </runtime>
</configuration>
如果你需要更低版本的 Access 数据库支持，或者换用其它数据库（比如 SqlServer)，请阅读参考下面步骤提供的信息：
1，打开下面链接：
   http://pwmis.codeplex.com/
2，看到内容章节“3，修改下App.config 文件的连接配置”；
3，点击本节下的链接“2.2.3 扩展数据访问类配置”。
创建MVVM的WinForm视图
这是一个简单的WinForm 窗体，有三个SOD“数据控件”，包括：一个标签控件显示用户的ID，文本框控件显示用户名，一个列表框控件显示已经有用户列表，三个按钮分别用来向列表添加，修改和删除数据。
对于数据控件，可以在此窗体设计器界面，打开“工具箱”，在“常规”选项卡里面，选择上下文菜单“选择项”，浏览到packages\PDF.NET.SOD.WinForm.Extensions.5.5.5.1020\lib目录，选择“Pwmis.Windows.dll” ，即可看到SOD的数据控件，然后拖拽到窗体上即可。
注意我们不会给这三个按钮控件直接设置单击事件，而是通过命令绑定的形式。例如对应添加按钮，我们如下绑定命令（视图模型的一个方法）：
base.BindCommandControls(this.button1, DataContext.SubmitCurrentUsers);
这会将添加用户的按钮控件的单击事件，绑定到DataContext的SubmitCurrentUsers 方法上。
而对于数据控件的绑定，只需要下面的一行代码：
base.BindDataControls(this.Controls);
前面已经说过，该方法会遍历方法上第一个参数里面的所有数据控件，找到LinkObject和LinkProperty属性，实现数据控件和视图模型对象的绑定，这里绑定的是 DataContext对象的CurrentUser对象的属性。
单击属性浏览器中数据控件的LinkProperty 属性旁边的“…”按钮，会弹出下面的“数据控件属性选择器”窗体：
由于这里我们要绑定的对象是当前窗体的DataContext对象，所以需要浏览选择到主程序集，这样在属性名称一栏，会显示此对象所有的属性和子属性。注意如果DataContext对象没有出现在列表里面，需要检查Form 窗体是否声明了 DataContext对象，并且需要首先编译一次程序集。最后，单击确定，我们就设置好了数据控件要绑定的信息。
创建MVVM的模型
我们的模型很简单，就是负责创建新用户，加载已有用户，添加，修改或者删除用户，并且这些操作都是针对数据库的，也就是我们通常的CRUD操作。由于是示例没有太多逻辑，我们直接看代码即可：
public class UserModel
        private static int index = 0;
        private LocalDbContext context;
        public UserModel()
            context = new LocalDbContext();
        public List<UserEntity> GetAllUsers()
            var list= OQL.From<UserEntity>().ToList(context.CurrentDataBase);
            int max = list.Max(p => p.ID);
            index = ++max;
            return list;
        public void UpdateUser(UserEntity user)
            int count= context.Update<UserEntity>(user);
        public void AddUsers(IList<UserEntity> users)
            int count = context.AddList(users);
        public void SubmitUser(UserEntity user)
           int count = context.Add(user);
        public void RemoveUser(UserEntity user)
            int count = context.Remove(user);
        public UserEntity CreateNewUser(string userName="NoName")
            return new UserEntity()
                 ID= ++index,
                 Name =userName
    }
用户模型类会使用用户实体类，它也很简单，只有一个ID属性和一个Name属性，详细内容如下：
public class UserEntity:EntityBase
       public UserEntity()
           TableName = "Tb_User";
           PrimaryKeys.Add("UserID");
        public int ID {
            get { return getProperty<int>("UserID"); }
            set { setProperty("UserID", value); }
        public string Name
            get { return getProperty<string>("UserName"); }
            set { setProperty("UserName", value); }
    }
该用户实体类虽然很简单，却可以直接提供给视图作为模型绑定的元素，因为SOD实体类都实现了“属性修改通知”接口，前面已经详细说明。
接下来就是操作此用户实体类的数据上下文了，用户模型类展示了如何使用它，但是它的定义却很简单：
    class LocalDbContext : DbContext
        public LocalDbContext()
            : base("default")
            //local 是连接字符串名字 
        protected override bool CheckAllTableExists()
            //创建用户表 
            CheckTableExists<UserEntity>();
            return true;
    }
至此，一个简单的MVVM模型类的全部定义就完成了。
创建MVVM的视图模型
视图模型是对视图的一个抽象，它封装了主要的视图处理逻辑，与MVP的Presenter不同，视图模型并不会包含详细视图元素的抽象，比如一个抽象的列表控件，而是对视图可能用到的数据进行封装，并且可能包含对后端MVVM的模型对象调用。
在本例中，我们的用户视图模型的功能也很简单，就是提供视图需要的用户列表和响应视图的增加，修改，删除用户的命令，详细代码如下
public class SubmitedUsersViewModel
        private UserModel model = new UserModel();
        public BindingList<UserEntity> Users { get; private set; }
        public UserEntity CurrentUser { get; private set; }
        UserEntity _selectUser;
        /// <summary>
        /// 当前选择的用户，如果设置，则会设置当前用户
        /// </summary>
        public UserEntity SelectedUser {
            get { return _selectUser; }
            set {
                _selectUser = value;
                this.CurrentUser.ID = value.ID;
                this.CurrentUser.Name = value.Name;
        int _selectedUserID;
        public int SelectedUserID
            get { return _selectedUserID; }
            set {
                _selectedUserID = value;
                var obj = this.Users.FirstOrDefault(p=>p.ID==value);
                if (obj != null)
                    this.CurrentUser.ID = obj.ID;
                    this.CurrentUser.Name = obj.Name;
                    _selectUser = this.CurrentUser;
        public SubmitedUsersViewModel()
            var data = model.GetAllUsers();
            Users = new BindingList<UserEntity>(data);
            CurrentUser = new UserEntity();
        public void UpdateUser()
            var obj = this.Users.FirstOrDefault(p => p.ID == this.CurrentUser.ID);
            if (obj != null)
                obj.Name = this.CurrentUser.Name;
                //更新后必须调用 ResetBindings 方法，否则控件上的数据会丢失一行
                this.Users.ResetBindings();
                model.UpdateUser(obj);
        public void UpdateUser(int id,string name)
            var obj = this.Users.FirstOrDefault(p => p.ID == id);
            if (obj != null)
                obj.Name = name;
                //更新后必须调用 ResetBindings 方法，否则控件上的数据会丢失一行
                this.Users.ResetBindings();
                model.UpdateUser(obj);
        public void SubmitUsers(UserEntity user)
            //UserEntity newUser = new UserEntity();
            //newUser.ID = user.ID;
            //newUser.Name = user.Name;
            //Users.Add(newUser);
            if (!Users.Contains(user))
                Users.Add(user);
                model.SubmitUser(user);            
        public void SubmitCurrentUsers()
            UserEntity newUser = model.CreateNewUser(CurrentUser.Name);
            SubmitUsers(newUser);
            CurrentUser.ID = newUser.ID;
        public void RemoveUser()
            if (SelectedUser == null)
                return;
            var obj = this.Users.FirstOrDefault(p => p.ID == SelectedUser.ID);
            if (obj != null)
                this.Users.Remove(obj);
                //更新后必须调用 ResetBindings 方法，否则控件上的数据会丢失一行
                this.Users.ResetBindings();
用户1177503

“老坛泡新菜”:SOD MVVM框架，让WinForms焕发新春

“老坛泡新菜”:SOD MVVM框架，让WinForms焕发新春

火热的MVVM框架

WinForms上的MVVM需求

SOD WinForms MVVM实现原理

MVVM示例解决方案

解决方案概览

创建MVVM的WinForm视图

创建MVVM的模型

创建MVVM的视图模型
