利用反射實現頁面控件與實體之間的綁定

前言：

     在項目開發過程中，有一項任務是我們要反復執行的：獲取窗體控件的值，然后賦值到實體，再把實體值保存到數據庫；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