利用反射实现页面控件与实体之间的绑定

前言：

     在项目开发过程中，有一项任务是我们要反复执行的：获取窗体控件的值，然后赋值到实体，再把实体值保存到数据库；load的时候，还有获取实体，再把实体属性值赋值到控件。如下所示：

 1、获取窗体控件的值，然后赋值到实体

    public partial class TestEdit : Page
    {
        private readonly StudentService service = new StudentService();
        private Student student = new Student();

        protected void Page_Load(object sender, EventArgs e)
        {
            if (!IsPostBack && !string.IsNullOrEmpty(Request["ID"]))
            {
                student = service.GetStudentById(Request["ID"]);
                if (student == null)
                    return;

                txtName.Text = student.Name;
                ddlSex.SelectedValue = student.Sex;
                txtAge.Text = student.Age.ToString();
                ddlDegree.SelectedValue = student.Degree;

                //省略其他
            }
        }

        protected void BtnSave_Click(object sender, EventArgs e)
        {

            student.Name = txtName.Text;
            student.Sex = ddlSex.SelectedValue;
            student.Age = int.Parse(txtAge.Text);
            student.Degree = ddlDegree.SelectedValue;
            //省略其他

            service.Save(student);
        }
    }

想象一下，如果1个表有几十上百个字段，这样赋值是多么繁琐的事情呀。 

下面，我就跟大家讲一下，如果利用反射实现ASP.NET控件与实体之间的绑定，如果你还不熟悉反射，园子里关于反射的文章也比较多，可以去找。

 

正文：

    一、下面先看一下利用反射后的代码：   

    public partial class TestEdit : Page
    {
        private readonly StudentService service = new StudentService();
        private Student student = new Student();

        protected void Page_Load(object sender, EventArgs e)
        {
            if (!IsPostBack && !string.IsNullOrEmpty(Request["ID"]))
            {
                student = service.GetStudentById(Request["ID"]);
                ExtensionService.BindObjectToControls(student, this);
            }
        }

        protected void BtnSave_Click(object sender, EventArgs e)
        {
            ExtensionService.BindControlsToObject(student, this);
            service.Save(student);
        }
    }

通过前后代码的对比，是不是简洁了很多？

 

    二、开始搭建我们的程序

     说明：为了简单介绍这个例子，没有用ORM技术，直接用sql操作Access数据库

    （1）、项目结构： 

DBTest.accdb：为access数据库，有一个表TBL_Student，结构如下

 

DBHelper.cs：操作数据库帮助类

ExtensionService.cs：关键类，封装反射相关方法

Student.cs：实体类

StudentService.cs：Student服务类，操作Student实体

TestEdit.aspx：测试页面

（2）关键代码讲解

1、ExtensionService类主要包含2个方法，直接上代码

    public static class ExtensionService
    {
        /// <summary>
        /// 将控件值绑定到业务对象
        /// </summary>
        /// <param name="obj">业务对象</param>
        /// <param name="container">窗体或控件容器</param>
        public static void BindControlsToObject(object obj, Control container)
        {
            if (obj == null) return;
            Type objType = obj.GetType();

            PropertyInfo[] objPropertyArray = objType.GetProperties();

            foreach (PropertyInfo propertyInfo in objPropertyArray)
            {
                //根据对象属性去查找控件
                Control control = container.FindControl(propertyInfo.Name);

                if (control == null) continue;

                // ListControl是CheckBoxList、DropDownList、ListBox 和 RadioButtonList 的基类
                if (control is ListControl)
                {
                    var listControl = (ListControl)control;
                    if (listControl.SelectedItem != null)
                    {
                        var stringBuilder = new StringBuilder();
                        for (int i = 0; i < listControl.Items.Count; i++)
                        {
                            if (listControl.Items[i].Selected)
                            {
                                stringBuilder.Append(listControl.Items[i].Value).Append(",");
                            }
                        }

                        Type propertyType = propertyInfo.PropertyType;

                        if (propertyType.IsGenericType && propertyType.GetGenericTypeDefinition() == typeof(Nullable<>))
                        {
                            //判断是否为 System.Nullable 类型
                            propertyType = propertyType.GetGenericArguments()[0];

                            if (string.IsNullOrEmpty(stringBuilder.ToString()))
                            {
                                propertyInfo.SetValue(obj, null, null);
                                continue;
                            }
                        }
                        object objValue = Convert.ChangeType(stringBuilder.ToString().Trim(','), propertyType);
                        propertyInfo.SetValue(obj, objValue, null);
                    }
                }
                else
                {
                    Type controlType = control.GetType();
                    PropertyInfo[] controlPropertyArray = controlType.GetProperties();

                    GetControlProperty(obj, propertyInfo, control, controlPropertyArray);

                }
            }
        }

        /// <summary>
        /// 将对象值绑定到页面控件(进行中)
        /// </summary>
        /// <param name="obj">业务对象</param>
        /// <param name="container">窗体或控件容器</param>
        public static void BindObjectToControls(object obj, Control container)
        {
            if (obj == null) return;
            Type objType = obj.GetType();

            PropertyInfo[] objPropertyArray = objType.GetProperties();
            foreach (PropertyInfo propertyInfo in objPropertyArray)
            {
                //根据对象属性去查找控件
                Control control = container.FindControl(propertyInfo.Name);

                if (control == null) continue;

                if (control is ListControl)
                {
                    var listControl = (ListControl)control;
                    string propertyValue = propertyInfo.GetValue(obj, null).ToString();
                    string[] values = propertyValue.Split(',');
                    if (values.Length == 0) continue;

                    foreach (string value in values)
                    {
                        ListItem listItem = listControl.Items.FindByValue(value);
                        if (listItem != null)
                        {
                            listItem.Selected = true;
                        }
                    }
                }
                else
                {
                    Type controlType = control.GetType();
                    PropertyInfo[] controlPropertyArray = controlType.GetProperties();
                    SetControlProperty(obj, propertyInfo, control, controlPropertyArray);

                }
            }
        }

        /// <summary>
        /// 将实体对象的属性值赋值给页面控件
        /// </summary>
        /// <param name="obj"></param>
        /// <param name="objProperty"></param>
        /// <param name="control"></param>
        /// <param name="controlPropertyArray"></param>
        private static void SetControlProperty(object obj, PropertyInfo objProperty, Control control, IEnumerable<PropertyInfo> controlPropertyArray)
        {
            Dictionary<string, Type> list = GetPropertyList();

            foreach (var dict in list)
            {
                // 在整个控件属性中进行迭代,检查控件匹配名称和类型的属性
                var propertys = from p in controlPropertyArray
                                where p.Name == dict.Key && p.PropertyType == dict.Value
                                select p;

                if (propertys.Count() == 0)
                    continue;

                PropertyInfo controlProperty = propertys.First();

                controlProperty.SetValue(control, Convert.ChangeType(objProperty.GetValue(obj, null), dict.Value), null);

            }

        }

        /// <summary>
        /// 获取页面控件的值，并赋值给实体对象
        /// </summary>
        /// <param name="obj"></param>
        /// <param name="objProperty"></param>
        /// <param name="control"></param>
        /// <param name="controlPropertyArray"></param>
        private static void GetControlProperty(object obj, PropertyInfo objProperty, Control control, IEnumerable<PropertyInfo> controlPropertyArray)
        {
            //控件值属性集合及其类型
            Dictionary<string, Type> list = GetPropertyList();

            foreach (var dict in list)
            {
                // 检查控件匹配名称和类型的属性
                var propertys = from p in controlPropertyArray
                                where p.Name == dict.Key && p.PropertyType == dict.Value
                                select p;

                if (propertys.Count() == 0)
                    continue;

                PropertyInfo controlProperty = propertys.First();
                // 将控件的属性设置为
                // 业务对象属性值
                Type propertyType = objProperty.PropertyType;

                try
                {
                    //判断是否为 System.Nullable 类型
                    if (propertyType.IsGenericType && propertyType.GetGenericTypeDefinition() == typeof(Nullable<>))
                    {
                        propertyType = propertyType.GetGenericArguments()[0];

                        if (string.IsNullOrEmpty(controlProperty.GetValue(control, null).ToString()))
                        {
                            //当属性的类型为 System.Nullable，且值为空/null时，设置属性值为null
                            objProperty.SetValue(obj, null, null);

                            //赋值成功时，退出循环
                            break;
                        }
                    }

                    object objValue = Convert.ChangeType(controlProperty.GetValue(control, null), propertyType);
                    objProperty.SetValue(obj, objValue, null);
                    //赋值成功时，退出循环
                    break;

                }
                catch (Exception e)
                {
                    throw new Exception(e.Message);
                }
            }
        }

        private static Dictionary<string, Type> GetPropertyList()
        {
            var list = new Dictionary<string, Type>();
            list.Add("Checked", typeof(bool));
            list.Add("Value", typeof(String));
            list.Add("Text", typeof(String));
            return list;
        }
    }

如果不了解反射的人，建议先去学习反射相关内容

BindControlsToObject(object obj, Control container)将控件值绑定到业务对象，代码相关地方都有注释，这里就不介绍了。

BindObjectToControls(object obj, Control container)将对象值绑定到页面控件

2、TestEdit.aspx页面

        <table border="0">
            <tr>
                <td>
                    用户名
                </td>
                <td>
                    <asp:TextBox runat="server" ID="Name"></asp:TextBox>
                </td>
            </tr>
            <tr>
                <td>
                    性别
                </td>
                <td>
                    <asp:RadioButtonList ID="Sex" runat="server">
                        <asp:ListItem Value="男" Selected="True" Text="男"></asp:ListItem>
                        <asp:ListItem Value="女" Text="女"></asp:ListItem>
                    </asp:RadioButtonList>
                </td>
            </tr>
            <tr>
                <td>
                    学位
                </td>
                <td>
                    <asp:DropDownList runat="server" ID="Degree">
                        <asp:ListItem Value="小学" Text="小学"></asp:ListItem>
                        <asp:ListItem Value="初中" Text="初中"></asp:ListItem>
                        <asp:ListItem Value="高中" Text="高中"></asp:ListItem>
                        <asp:ListItem Value="大学" Text="大学"></asp:ListItem>
                    </asp:DropDownList>
                </td>
            </tr>
            <tr>
                <td>
                    爱好
                </td>
                <td>
                    <asp:CheckBoxList runat="server" ID="Hobby">
                        <asp:ListItem Value="篮球">篮球</asp:ListItem>
                        <asp:ListItem Value="排球">排球</asp:ListItem>
                        <asp:ListItem Value="奶茶">奶茶</asp:ListItem>
                    </asp:CheckBoxList>
                </td>
            </tr>
            <tr>
                <td>
                    年龄
                </td>
                <td>
                    <asp:TextBox runat="server" ID="Age"></asp:TextBox>
                </td>
            </tr>
            <tr>
                <td colspan="2">
                    <asp:Button runat="server" ID="BtnSave" Text="保存" OnClick="BtnSave_Click" />
                </td>
            </tr>
        </table>

 

需注意的是，控件的ID要与绑定对象的属性一样，如：<asp:TextBox runat="server" ID="Name"></asp:TextBox>，Name为Student的属性。

后台代码：

    public partial class TestEdit : Page
    {
        private readonly StudentService service = new StudentService();
        private Student student = new Student();

        protected void Page_Load(object sender, EventArgs e)
        {
            if (!IsPostBack && !string.IsNullOrEmpty(Request["ID"]))
            {
                student = service.GetStudentById(Request["ID"]);

                //将对象值绑定到页面控件
                ExtensionService.BindObjectToControls(student, this);
            }
        }

        protected void BtnSave_Click(object sender, EventArgs e)
        {
            //将控件值绑定到业务对象
            ExtensionService.BindControlsToObject(student, this);
            service.Save(student);
        }
    }

 

终于把相关的代码写完了O(∩_∩)O哈哈~，下面进行测试

3、测试

打开TestEdit.aspx，录入相关信息，如下图：

保存成功，Student表多了一条记录，如下：

最后，在地址栏输入http://localhost:4500/TestEdit.aspx?ID=7，回车，刚才录入的数据就出来了

 

结束语：

   第一次写博客，希望各位大牛指点。 

作者：pengjunshe
出处：http://www.cnblogs.com/pengjunshe/archive/2012/08/03/2621419.html