ASP.NET 一句代碼實現批量數據綁定

来源:http://www.cnblogs.com/licin/archive/2016/09/07/5849349.html
-Advertisement-
Play Games

摘要:對於一個以數據處理為主的應用中的UI層,我們往往需要編寫相當多的代碼去實現數據綁定。如果界面上的控制項和作為數據源的實體類型之間存儲某種約定的映射關係,我們就可以實現批量的數據綁定,作者開發了的插件正是用於此,本篇著重介紹如何通過這個組件來解決我們在進行數據綁定過程中的常見問題。 對於一個以數據 ...


摘要:對於一個以數據處理為主的應用中的UI層,我們往往需要編寫相當多的代碼去實現數據綁定。如果界面上的控制項和作為數據源的實體類型之間存儲某種約定的映射關係,我們就可以實現批量的數據綁定,作者開發了的插件正是用於此,本篇著重介紹如何通過這個組件來解決我們在進行數據綁定過程中的常見問題。

  對於一個以數據處理為主的應用中的UI層,我們往往需要編寫相當多的代碼去實現數據綁定。如果界面上的控制項和作為數據源的實體類型之間存儲某種約定的映射關係,我們就可以實現批量的數據綁定。為了驗證這種想法,我寫了一個小小的組件。這個小玩意僅僅是我花了兩個小時寫的,其中還有很多問題沒有解決,比如對於空值的處理,特殊控制項屬性值的HTML編碼問題,以及頻繁反射的性能問題,僅僅演示一種解決思路而已。本篇著重介紹如何通過這個組件來解決我們在進行數據綁定過程中的常見問題,下篇會介紹它的設計。[源代碼從這裡下載]

目錄: 
一、基於控制項ID/實體屬性名映射的數據綁定 
二、一句代碼實現批量數據綁定 
三、修正綁定數據的顯示格式 
四、過濾不需要綁定的屬性 
五、多個控制項對應同一個實體屬性

  一、基於控制項ID/實體屬性名映射的數據綁定

  我的這個組件暫時命名為DataBinder好了(註意和System.Web.UI.DataBinder區分),我們用它來將一個實體對象綁定給指定的容器控制項中的所有子控制項。下麵是DataBinder的定義,兩個BindData方法實現具體的綁定操作。

public class DataBinder
{
public event EventHandler<DataBindingEventArgs> DataItemBinding;
public event EventHandler<DataBindingEventArgs> DataItemBound;

public static IEnumerable<BindingMapping> BuildBindingMappings(Type entityType, Control container, string suffix = "");

public void BindData(object entity, Control container, string suffix = "");
public void BindData( object entity,IEnumerable<BindingMapping> bindingMappings);
}

  本文開頭所說,自動批量的數據綁定依賴於控制項和作為數據源實體類型的映射關係。在這裡,我直接採用控制項ID和實體屬性名之間的映射。也就是說,在對於界面上控制項進行命名的時候,應該根據對應的實體類型屬性名進行規範命名。

  另一方面,作為數據源的對象來說,它的所有屬性並不都是為數據綁定而涉及。為了讓DataBinder能夠自動篩選用於綁定的屬性,我在相應的屬性上應用了一個自定義特性:DataPropertyAttribute。比如,下麵的Customer對象會在後續的演示中用到,它的每一個數據屬性都應用了這樣一個DataPropertyAttribute特性。

public class Cutomer
{
[DataProperty]
public string ID { get; set; }
[DataProperty]
public string FirstName { get; set; }
[DataProperty]
public string LastName { get; set; }
[DataProperty]
public string Gender { get; set; }
[DataProperty]
public int? Age { get; set; }
[DataProperty]
public DateTime? BirthDay { get; set; }
[DataProperty]
public bool? IsVip { get; set; }
}

  二、一句代碼實現批量數據綁定

  現在我們就來演示如何通過我們定義的DataBinder實現“一句代碼的數據批量綁定”,而作為數據源就是我們上面定義的Customer對象。我們先來設計我們的頁面,下麵是主體部分的HTML,這是一個表格。需要註意的是:所有需要綁定到Customer對象的空間都和對應的屬性具有相同的ID。

<table>
<tr>
<td style="width:20%;text-align:right">ID:</td>
<td><asp:Label ID="ID" runat="server"></asp:Label></td>
</tr>
<tr>
<td style="width:20%;text-align:right">First Name:</td>
<td><asp:TextBox ID="FirstName" runat="server"></asp:TextBox></td>
</tr>
<tr>
<td style="width:20%;text-align:right">Last Name:</td>
<td><asp:TextBox ID="LastName" runat="server"></asp:TextBox></td>
</tr>
<tr>
<td style="width:20%;text-align:right">Gender:</td>
<td>
<asp:RadioButtonList ID="Gender" runat="server" RepeatDirection="Horizontal">
<asp:ListItem Text="Male" Value = "Male" />
<asp:ListItem Text="Female" Value = "Female" />
</asp:RadioButtonList>
</td>
</tr>
<tr>
<td style="width:20%;text-align:right">Age:</td>
<td><asp:TextBox ID="Age" runat="server"></asp:TextBox></td>
</tr>
<tr>
<td style="width:20%;text-align:right">Birthday:</td>
<td><asp:TextBox ID="Birthday" runat="server" Width="313px"></asp:TextBox></td>
</tr>
<tr>
<td style="width:20%;text-align:right">Is VIP:</td>
<td><asp:CheckBox ID="IsVip" runat="server"></asp:CheckBox></td>
</tr>
<tr>
<td colspan="2" align="center">
<asp:Button ID="ButtonBind" runat="server" Text="Bind" onclick="ButtonBind_Click" />
</td>
</tr>
</table>

  為了編成方便,將DataBinder對象作為Page類型的一個屬性,該屬性在構造函數中初始化。

public partial class Default : System.Web.UI.Page
{
public Artech.DataBinding.DataBinder DataBinder { get; private set; }
public Default()
{
this.DataBinder = new Artech.DataBinding.DataBinder();
}
}

  然後我將數據綁定操作實現的Bind按照的Click事件中,對應所有的代碼如下所示——真正的用於數據綁定的代碼只有一句。

protected void ButtonBind_Click(object sender, EventArgs e)
{
var customer = new Customer
{
ID = Guid.NewGuid().ToString(),
FirstName = "Zhang",
LastName = "San",
Age = 30,
Gender = "Male",
BirthDay = new DateTime(1981, 1, 1),
IsVip = true
};
this.DataBinder.BindData(customer, this);
}

  在瀏覽器中打開該Web頁面,點擊Bind按鈕,你會發現綁定的數據已經正確顯示在了對應的控制項中:

image  三、修正綁定數據的顯示格式

  雖然通過DataBinder實現了對多個控制項的批量綁定,但是並不完美。一個顯著的問題是:作為生日的欄位不僅僅顯示了日期,還顯示了時間。我們如何讓日期按照我們要求的格式進行顯示呢?DataBinder為了提供了三種選擇。

  如果你註意看DataBinder定義了,你會發現它定義了兩個事件:DataItemBinding和DataItemBound(命名有待商榷),它們分別在對某個控制項進行綁定之前和之後觸發。我們的第一種方案就是註冊DataItemBinding時間,為Birthday指定一個格式化字元串。假設我們需要的格式是“月-日-年”,那麼我們指定的格式化字元串:MM-dd-yyyy。事件註冊我方在了Page的構造函數中:

public Default()
{
this.DataBinder = new Artech.DataBinding.DataBinder();
this.DataBinder.DataItemBinding += (sender, args) =>
{
if (args.BindingMapping.Control == this.Birthday)
{
args.BindingMapping.FormatString = "MM-dd-yyyy";
}
};
}

  運行程式,你會發現作為生日的欄位已經按照我們希望的格式顯示出來:

image

  上面介紹了通過註冊DataItemBinding事件在綁定前指定格式化字元串的解決方案,你也可以通過註冊DataItemBound事件在綁定後修正顯示的日期格式,相應的代碼如下:

public Default()
{
this.DataBinder = new Artech.DataBinding.DataBinder();
this.DataBinder.DataItemBound += (sender, args) =>
{
if (args.BindingMapping.Control == this.Birthday && null != args.DataValue)
{
this.Birthday.Text = ((DateTime)Convert.ChangeType(args.DataValue, typeof(DateTime))).
ToString("MM-dd-yyyy");
}
};
}

  DataBinder定義了兩個BindData重載,我們使用的是通過指定數據源和容器控制項的方式,而另一個重載的參數為IEnumerable<BindingMapping>類型。而BindingMapping是我們自定義的類型,用於表示控制項和實體屬性之間的運行時映射關係。而這樣一個BindingMapping集合,可以通過DataBinder的靜態方法BuildBindingMappings來創建。BindingMapping具有一個FormatString表示格式化字元串(實際上面我們指定的格式化字元串就是為這個屬性指定的)。那麼,我們也可以通過下麵的代碼來進行數據綁定:

protected void ButtonBind_Click(object sender, EventArgs e)
{
var customer = new Customer
{
ID = Guid.NewGuid().ToString(),
FirstName = "Zhang",
LastName = "San",
Age = 30,
Gender = "Male",
BirthDay = new DateTime(1981, 1, 1),
IsVip = true
};
var bindingMappings = Artech.DataBinding.DataBinder.BuildBindingMappings(typeof(Customer), this);
bindingMappings.Where(mapping => mapping.Control == this.Birthday).First().FormatString = "MM-dd-yyyy";
this.DataBinder.BindData(customer, bindingMappings);
}

  四、過濾不需要綁定的屬性

  在預設的情況下,第一個BindData方法(指定容器控制項)會遍歷實體的所有屬性,將其綁定到對應的控制項上。可能在有的時候,對於某些特殊的屬性,我們不需要進行綁定。比如,某個控制項的ID雖然符合實體屬性的映射,但是它們表示的其實根本不是相同性質的數據。

  為瞭解決在這個問題,在BindingMapping類型中定義了一個布爾類型的AutomaticBind屬性。如果你在綁定前將該屬性設置成False,那麼基於該BindingMapping的數據綁定將被忽略。如果你調用BindData(object entity, Control container, string suffix = "")這個重載,你可以通過註冊DataItemBinding事件將相應BindingMapping的AutomaticBind屬性設置成False。如果你調用BindData( object entity,IEnumerable<BindingMapping> bindingMappings)這個重載,你只需要在調用之間將相應BindingMapping的AutomaticBind屬性設置成False。

  我們將我們的程式還原成最初的狀態,現在通過註冊BindingMapping事件將基於Birthday的BindingMapping的AutomaticBind屬性設置成False:

public Default()
{
this.DataBinder = new Artech.DataBinding.DataBinder();
this.DataBinder.DataItemBinding += (sender, args) =>
{
if (args.BindingMapping.Control == this.Birthday)
{
args.BindingMapping.AutomaticBind = false;
}
};
}

  程式執行後,Birthday對應的TextBox將不會被綁定:

image  五、多個控制項對應同一個實體屬性

  在上面的例子中,我們的控制項的ID和對應的實體屬性是相同的。但是在很多情況下,相同的頁面上有不止一個控制項映射到實體的同一個屬性上。而控制項ID的唯一性決定了我們不能為它們起相同的ID。在這種情況下,我們採用“基於尾碼”的映射。也就是為,在為控制項進行命名的時候,通過“實體屬性名+尾碼”形式來指定。

  如果你仔細看了DataBinder的定義,不論是實例方法BindData(接受Control類型參數的),還是靜態方法BuildBindingMappings,都具有一個預設參數suffix,這就是為這種情況設計的。在預設的情況下,這個參數的值為空字元串,所以我們需要控制項和實體屬性具有相同的名稱。如果控制項是基於“實體屬性名+尾碼”來命名的,就需要顯式指定這個參數了。為了演示這種情況,我們將例子中的所有需要綁定的空間ID加上一個“_Xyz”字元作為尾碼。

<table>
<tr>
<td style="width:20%;text-align:right">ID:</td>
<td><asp:Label ID="ID_Xyz" runat="server"></asp:Label></td>
</tr>
<tr>
<td style="width:20%;text-align:right">First Name:</td>
<td><asp:TextBox ID="FirstName_Xyz" runat="server"></asp:TextBox></td>
</tr>
<tr>
<td style="width:20%;text-align:right">Last Name:</td>
<td><asp:TextBox ID="LastName_Xyz" runat="server"></asp:TextBox></td>
</tr>
<tr>
<td style="width:20%;text-align:right">Gender:</td>
<td>
<asp:RadioButtonList ID="Gender_Xyz" runat="server" RepeatDirection="Horizontal">
<asp:ListItem Text="Male" Value = "Male" />
<asp:ListItem Text="Female" Value = "Female" />
</asp:RadioButtonList>
</td>
</tr>
<tr>
<td style="width:20%;text-align:right">Age:</td>
<td><asp:TextBox ID="Age_Xyz" runat="server"></asp:TextBox></td>
</tr>
<tr>
<td style="width:20%;text-align:right">Birthday:</td>
<td><asp:TextBox ID="Birthday_Xyz" runat="server" Width="313px"></asp:TextBox></td>
</tr>
<tr>
<td style="width:20%;text-align:right">Is VIP:</td>
<td><asp:CheckBox ID="IsVip_Xyz" runat="server"></asp:CheckBox></td>
</tr>
<tr>
<td colspan="2" align="center">
<asp:Button ID="ButtonBind" runat="server" Text="Bind" onclick="ButtonBind_Click" />
</td>
</tr>
</table>

  如果採用指定容器控制項進行直接綁定的話,就可以這樣編程:

protected void ButtonBind_Click(object sender, EventArgs e)
{
var customer = new Customer
{
ID = Guid.NewGuid().ToString(),
FirstName = "Zhang",
LastName = "San",
Age = 30,
Gender = "Male",
BirthDay = new DateTime(1981, 1, 1),
IsVip = true
};
this.DataBinder.BindData(customer, this, "_Xyz");
}

  如果通過預先創建的BindingMapping集合進行數據綁定,那麼代碼將是這樣:

protected void ButtonBind_Click(object sender, EventArgs e)
{
var customer = new Customer
{
ID = Guid.NewGuid().ToString(),
FirstName = "Zhang",
LastName = "San",
Age = 30,
Gender = "Male",
BirthDay = new DateTime(1981, 1, 1),
IsVip = true
};

var bindingMappings = Artech.DataBinding.DataBinder.BuildBindingMappings(typeof(Customer), this, "_Xyz");
this.DataBinder.BindData(customer, bindingMappings);
}
您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • .NetCore中的日誌(1)日誌組件解析 0x00 問題的產生 日誌記錄功能在開發中很常用,可以記錄程式運行的細節,也可以記錄用戶的行為。在之前開發時我一般都是用自己寫的小工具來記錄日誌,輸出目標包含控制台、文本文件、資料庫,一般都是創建全局的Logger,在需要記錄日誌的地方調用相應的Logge ...
  • 一.類自動屬性 1 public class Person 2 { 3 //自動屬性 4 public string Name { get; set; } 5 6 private int _age; 7 8 public int age { 9 get { return _age; } 10 set ...
  • 接上一篇:ABP教程(三)- 開始一個簡單的任務管理系統 – 後端編碼 1.實現UI端的增刪改查 1.1添加增刪改查代碼 打開SimpleTaskSystem.sln解決方案,添加一個“包含視圖的MVC 5控制器(使用EntityFramework)”TaskController控制器,添加成功後我 ...
  • 流:(I/O)輸入輸出流 分類:文件流,記憶體流,網路流 流的操作一般要放在try catch裡面,操作文件網路容易出現異常 命名空間:using system .IO;using system .Text; //二進位轉換需要的命名空間 一:類:FileStream:文件流 1.構造:一般用第三個重 ...
  • 文件及文件夾操作: C/S:WinForm可以操作客戶端文件 Client ServerB/S:Brower Server 命名空間:using system .IO; 1. File類: 創建:File.Create(路徑);創建文件,返回FileStream FileStream fs = Fi ...
  • 1 using System; 2 using System.Collections.Generic; 3 using System.ComponentModel; 4 using System.Drawing; 5 using System.Data; 6 using System.Linq; 7 ...
  • 進程:進程是一個具有獨立功能的程式關於某個數據集合的一次運行活動。它可以申請和擁有系統資源,是一個動態的概念,是一個活動的實體。Process 類,用來操作進程。 命名空間:using System.Diagnostics; Process.Start("calc"); //計算器Process.S ...
  • 基本共識: ConfigurationManager 自帶緩存,且不支持 寫入。 如果 通過 文本寫入方式 修改 配置文件,程式 無法刷新載入 最新配置。 PS. Web.config 除外:Web.config 修改後,網站會重啟 (即 Web 程式 也無法在 運行時 刷新配置)。 為什麼要在程式 ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發(一):使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說,近來想嘗試開發一款安卓APP,考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP,畢竟是使用Visual Studio開發工具,使用起來也比較的順手,結合微軟官方的教程進行了安卓 ...
  • 前言 QuestPDF 是一個開源 .NET 庫,用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫,它徹底改變了我們生成 PDF 文檔的方 ...
  • 項目地址 項目後端地址: https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址: ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址: http://tree ...
  • 話不多說,直接開乾 一.下載 1.官方鏈接下載: https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe,運行開始下載SQL server; 二. ...
  • 前言 隨著物聯網(IoT)技術的迅猛發展,MQTT(消息隊列遙測傳輸)協議憑藉其輕量級和高效性,已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫,為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog支持多種接收器用於日誌存儲,增強器用於添加屬性,LogContext管理動態屬性,支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項,適用於不同需求。 ...
  • 目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據,爬取信息時需要模擬瀏覽器行為,否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下: 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • 1.前言 什麼是熱更新 游戲或者軟體更新時,無需重新下載客戶端進行安裝,而是在應用程式啟動的情況下,在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR,Xlua,ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles,Addressable, ...
  • 本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺,其實像阿裡雲,騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後,它會送 ...
  • 通過以下方式可以高效,並保證數據同步的可靠性 1.API設計 使用RESTful設計,確保API端點明確,並使用適當的HTTP方法(如POST用於創建,PUT用於更新)。 設計清晰的請求和響應模型,以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證,確保接收到的數據符合預期格 ...