三層架構中使用實體類填充泛型集合代替DataTable解決方案(ASP.NET+C#)

用三層架構開發專案，經常會遇到如下場景：

D層負責與資料庫互動，一般是得到DataTable或DataSet物件，然後返回給B層，B層進行類似的處理來讀取資料：dt.Rows[0][“xxx”];或者dt.Rows[0][1];(強烈不建議使用)。

有時DataTable也會被傳到UI層，與控制元件進行繫結，顯示資料。例如ASP.NET的repeater控制元件提取資料：<%# Eval(“xxx”)%>。

無論是何種情況，使用DataTable不可避免的要填寫讀取的欄位，這樣做的壞處不言而喻：

| 非常容易寫錯，而且編譯器不檢查。

| 必須瞭解資料庫的結構。

| 不符合面向物件程式設計思想。

| DataTable為弱型別，無法直觀的看出欄位的資料型別。

這個問題一直困擾著我，這次藉著重構機房收費系統的機會，研究了一下這個問題，找到了一種比較好的解決方案：在D層把DataTable轉換成單個實體類，再把實體類填充到泛型集合中。

核心思想如圖：

實體類即資料庫的對映，因此實體類中的屬性和資料庫表中的欄位是相對應的。把DataTable中的每一行記錄視為一個實體類，把其中的欄位讀取出來，存放到實體類的屬性中，再把所有的實體類存在泛型集合中。因此，DataTable中有多少個記錄，泛型集合中就有多少個實體類，每個實體類的屬性和DataTable的欄位是相對應的。

試想一下，這樣一來，傳到B層或U層的將是一個實體類集合，讀取資料將會是如下場景：list[0].xxx;

這樣做的優點如下：

| 編寫B層的人員無需手動填寫需要的欄位，直接按一下點，全都提示出來了，想用哪個用哪個，不會出現寫錯的情況。

| 不必瞭解資料庫結構。

| 符合面向物件思想。

| 實體類的屬性是強型別，每個欄位的型別都是已知的。

那麼用程式碼如何實現呢？下面一一列舉。

注意：以下程式碼僅僅是為了模擬，有些不規範的地方，程式碼註釋中有提示，切勿模仿！

實體類程式碼：

[csharp] view plain copy print ?

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
namespace Entity
{
/// <summary>
/// Users表實體類
/// </summary>
public class Users
{
private long _id;
private string _userName;
private string _passWord;
public long id
{
set {_id = value; }
get { return _id; }
}
public string userName
{
set { _userName = value; }
get { return _userName; }
}
public string passWord
{
set { _passWord = value; }
get { return _passWord; }
}
}
}

將DataTable轉換成List<T>泛型集合助手類，這個類我放在了Entity實體類層中：

[csharp] view plain copy print ?

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Data;
using System.Data.SqlClient;
using System.Reflection;
namespace Entity
{
/// <summary>
/// 將DataTable轉換成泛型集合IList<>助手類
/// </summary>
public class ConvertHelper
{
/// <summary>
/// 單表查詢結果轉換成泛型集合
/// </summary>
/// <typeparam name="T">泛型集合型別</typeparam>
/// <param name="dt">查詢結果DataTable</param>
/// <returns>以實體類為元素的泛型集合</returns>
public static IList<T> convertToList<T>(DataTable dt) where T : new()
{
// 定義集合
List<T> ts = new List<T>();
// 獲得此模型的型別
Type type = typeof(T);
//定義一個臨時變數
string tempName = string.Empty;
//遍歷DataTable中所有的資料行
foreach (DataRow dr in dt.Rows)
{
T t = new T();
// 獲得此模型的公共屬性
PropertyInfo[] propertys = t.GetType().GetProperties();
//遍歷該物件的所有屬性
foreach (PropertyInfo pi in propertys)
{
tempName = pi.Name;//將屬性名稱賦值給臨時變數
//檢查DataTable是否包含此列（列名==物件的屬性名）
if (dt.Columns.Contains(tempName))
{
// 判斷此屬性是否有Setter
if (!pi.CanWrite) continue;//該屬性不可寫，直接跳出
//取值
object value = dr[tempName];
//如果非空，則賦給物件的屬性
if (value != DBNull.Value)
pi.SetValue(t, value, null);
}
}
//物件新增到泛型集合中
ts.Add(t);
}
return ts;
}
}
}

ASP.NET Web頁面後臺程式碼(aspx.cs)：

[csharp] view plain copy print ?

using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.UI;
using System.Web.UI.WebControls;
using Entity;
using System.Data;
using System.Data.SqlClient;
public partial class _Default : System.Web.UI.Page
{
protected void Page_Load(object sender, EventArgs e)
{
if (!Page.IsPostBack)
{
DataTable dt = new DataTable();
IList<Users> users = new List<Users>();
//注意：只是為了演示，才在這讀資料庫的！
//在專案中千萬不要這麼做！另外sql連結字串也不應該寫在程式中，而且要加密。
SqlConnection sqlCon = new SqlConnection("server=192.168.24.177;database=testDB;uid=sa;pwd=123");
SqlCommand sqlCmd = new SqlCommand("select userName,passWord from t_testTable", sqlCon);
SqlDataReader sqlRd;
sqlCon.Open();
sqlRd = sqlCmd.ExecuteReader();
dt.Load(sqlRd); //DataTable構造完成，在這僅僅是為了演示，構造DataTable
sqlCon.Close();
users = ConvertHelper.convertToList<Users>(dt); //獲取DataTable轉換成的泛型集合
repUsers.DataSource = users;
repUsers.DataBind();
}
}
}

ASP.NET Web頁面前臺程式碼(aspx)：
[html] view plain copy print ?

<%@ Page Language="C#" AutoEventWireup="true" CodeFile="Default.aspx.cs" Inherits="_Default" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head runat="server">
<title></title>
</head>
<body>
<form id="frmDefault" runat="server">
<div>
<asp:Repeater ID="repUsers" runat="server">
<ItemTemplate>
<table>
<tr>
<td><%# ((Entity.Users)Container.DataItem).id.ToString() %></td>
<td><%# ((Entity.Users)Container.DataItem).userName %></td>
<td><%# ((Entity.Users)Container.DataItem).passWord %></td>
</tr>
</table>
</ItemTemplate>
</asp:Repeater>
</div>
</form>
</body>
</html>

這段程式碼在Web後臺讀取了資料中的資料，當然，只是為了模擬，這樣寫是非常不可取的。得到DataTable後利用ConvertHelper轉換助手類的convertToList方法將DataTable轉換成本例中的Users型別的泛型集合。最後把該集合與Repeater控制元件繫結，顯示資料。

Repeater之類的控制元件均支援繫結集合，而且支援的如此完美。個人認為介面顯示那段程式碼是最漂亮的。

例如：<%#((Entity.Users)Container.DataItem).id.ToString() %>。這和以往的顯示方法大不相同。首先，沒有使用Eval。資料是從Container.DataItem屬性中讀取的，強制轉換為實體類型別，然後直接呼叫實體類的id屬性。整個程式碼行雲流水般使用，完全不需要參照資料庫，想用哪個屬性用哪個。另外，這樣讀取效率比用Eval高。

在此，需要說明的是，我在這寫的DataTable到List<T>的類是比較可靠的。類似ConvertHelper.convertToList<Users>(dt)，想把DataTable轉換成哪種實體類，呼叫方法的時候泛型引數(尖括號裡的)就寫哪個實體類，在這是Users。簡單說一下它的轉換原理。

它會自動獲取實體類的屬性名，然後DataTable中匹配有沒有該名稱的欄位，有的話就賦值。DataTable中的每一行記錄都這樣處理。

基於以上原理，使用本方法必須滿足以下條件，也可以說是注意事項吧：

| 實體類的屬性名必須和資料庫表中的欄位名一模一樣。

| 想用這種方法把DataTable轉換成實體類，必須有已知的實體類和DataTable中的資料想對應，也就是說必須明確你要轉換成的實體類型別，否則沒辦法指定泛型集合的型別，也就沒辦法呼叫。

| 各個表的欄位儘量區別開來，不要相同。比如A表有個name欄位，B表也有一個name欄位，就不合理了。

相信你看到這已經躍躍欲試了。可仔細思考一下，會發現一個大問題：這裡涉及的僅僅是單表查詢，聯合查詢顯然搞不定。

聯合查詢搞不定的主要原因是它的資料來自多個表，沒有實體類與之對應，沒有實體類就沒有辦法轉換。

目前比普遍的解決方案就是建立一個包含多個表的實體類，只要實體類中包含聯合查詢的這些表就可以，實體類中表示的表多了沒事。但是，很多種聯合查詢，就要建立很多實體類，這也是沒有辦法的事。

也有比較變態的方法就是建立一個通用實體類，包含所有表的欄位。

要想用此方法，建立新的實體類是必然的了。但即使是這樣，我們也可以節省程式碼，避免重複。

節省程式碼首先想到的是繼承，可惜C#不支援多重繼承，兩個以上實體類組合成一個實體類就沒轍了。用介面雖然可以實現多重繼承，但顯然不合理，介面不是幹這個用的，這樣一點程式碼也沒省下，反而麻煩了。

經過網友RenYue的提示，用聚合解決是種比較好的方案。

聚合核心思想是：假如五個表聯合查詢，那麼新建一個實體類，這個新實體類的屬性是這個五個表對應的實體類，即用實體類封裝實體類，我們暫且叫它聚合實體類。

這個想法很好，很好的複用了程式碼，但是實現起來比較複雜。剛剛提供的單個表查詢的轉換方法(convertToList)，顯然滿足不了。

經過研究，我確定沒辦法寫一個通用的多表查詢轉換方法。但是可以實現確定個數的轉換方法。我寫了一個兩個表聯合查詢的轉換方法。

把DataTable每一行記錄中的欄位分解給所屬表對應的實體類，然後把這些實體類橫向聚合到聚合實體類的屬性中。如圖：

為了演示，程式做如下變動：

在Entity專案中新增一個LoginLog類，使用者登入日誌：

[csharp] view plain copy print ?

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
namespace Entity
{
/// <summary>
/// LoginLog表實體類
/// </summary>
public class LoginLog
{
private long _id;
private string _userName;
private DateTime _loginTime;
private DateTime _logoutTime;
public long id
{
get { return _id; }
set { _id = value; }
}
public string userName
{
get { return _userName; }
set { _userName = value; }
}
public DateTime loginTime
{
get { return _loginTime; }
set { _loginTime = value; }
}
public DateTime logoutTime
{
get { return _logoutTime; }
set { _logoutTime = value; }
}
}
}

在Entity專案中新增一個UsersJionLog類，該實體類用於Users表和LoginLog表聯合查詢，它的屬性是Users類和LoginLog類：

[csharp] view plain copy print ?

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
namespace Entity
{
/// <summary>
/// UsersJionLog表實體類，該實體類用於Users表和LoginLog表聯合查詢
/// </summary>
public class UsersJionLog
{
private Users _users;
private LoginLog _loginLog;
public Users users
{
set { _users = value; }
get { return _users; }
}
public LoginLog loginLog
{
set { _loginLog = value; }
get { return _loginLog; }
}
}
}

在ConvertHelper類中新增兩個表聯合查詢的轉換方法：

[csharp] view plain copy print ?

/// <summary>
/// 兩表查詢結果轉換成泛型集合
/// </summary>
/// <typeparam name="T">包含了兩個表的實體類，聚合實體類</typeparam>
/// <typeparam name="U">實體類中的第一個實體類</typeparam>
/// <typeparam name="V">實體類中的第二個實體類</typeparam>
/// <param name="dt">從資料庫中查詢獲得的DataTable</param>
/// <returns>以實體類為元素的泛型集合</returns>
public static IList<T> convertToJiontList<T, U, V>(DataTable dt)
where T : new()
where U : new()
where V : new()
{
//定義一個聚合實體類泛型集合，用來做返回值
List<T> ts = new List<T>();
//定義一個泛型集合元素，用來填充集合
T t = new T();
//獲取聚合實體類的屬性
PropertyInfo[] propertys = t.GetType().GetProperties();
//利用單錶轉換，把DataTable資料填充到聚合實體類中第一個實體類
IList<U> uList = new List<U>();
uList = convertToList<U>(dt);
//利用單錶轉換，把DataTable資料填充到聚合實體類中第二個實體類
IList<V> vList = new List<V>();
vList = convertToList<V>(dt);
//經過以上兩步，uList和vList兩個集合的長度肯定是相同的
//把兩個實體類填充到聚合實體類中
for (int i = 0; i < uList.Count; i++)
{
propertys[0].SetValue(t, uList[i], null); //取uList中第i個元素，填充到聚合實體類的第一個屬性中
propertys[1].SetValue(t, vList[i], null); //取vList中第i個元素，填充到聚合實體類的第二個屬性中
ts.Add(t); //向聚合實體類集合中新增元素
}
return ts;
}

ASP.NET Web後臺(aspx.cs)程式碼：

[csharp] view plain copy print ?

using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.UI;
using System.Web.UI.WebControls;
using Entity;
using System.Data;
using System.Data.SqlClient;
public partial class _Default : System.Web.UI.Page
{
protected void Page_Load(object sender, EventArgs e)
{
if (!Page.IsPostBack)
{
DataTable dt = new DataTable();
IList<UsersJionLog> usersJionLog = new List<UsersJionLog>();
//注意：只是為了演示，才在這讀資料庫的！
//在專案中千萬不要這麼做！另外sql連結字串也不應該寫在程式中，而且要加密。
SqlConnection sqlCon = new SqlConnection("server=192.168.24.177;database=testDB;uid=sa;pwd=123");
SqlCommand sqlCmd = new SqlCommand("select t_Users.userName,t_LoginLog.loginTime,t_LoginLog.logoutTime from t_Users join t_LoginLog on t_LoginLog.userName = t_Users.userName where t_Users.userName = 'admin'", sqlCon);
SqlDataReader sqlRd;
sqlCon.Open();
sqlRd = sqlCmd.ExecuteReader();
dt.Load(sqlRd); //DataTable構造完成，在這僅僅是為了演示，構造DataTable
sqlCon.Close();
usersJionLog = ConvertHelper.convertToJiontList<UsersJionLog,Users,LoginLog>(dt);
repUsers.DataSource = usersJionLog;
repUsers.DataBind();
}
}
}

ASP.NET Web前臺(aspx)：

[html] view plain

三層架構中使用實體類填充泛型集合代替DataTable解決方案(ASP.NET+C#)

三層架構中使用實體類填充泛型集合代替DataTable解決方案(ASP.NET+C#)

淺談三層架構中的實體類(C#)

JavaWeb三層架構中Service和Dao層物件單例化可行性

橋接模式的應用之三層架構中的業務邏輯層(BLL)與資料訪問層(DAL)的解耦

C#泛型入門學習泛型類、泛型集合、泛型方法、泛型約束、泛型委託

EF-DbUpdateException--實體類和資料庫列不對應的解決方案

C#非泛型集合類與泛型集合類的區別

關於C#三層架構增刪改查中的“刪除”問題

關於C#三層架構增刪改查中的“查詢”問題

【Web篇08】Web中MVC設計理念 & 經典三層架構 & 五大主流框架

hibernate中實體類的三種狀態和crud操作

MVC 三層架構在各框架中的特徵

.net中的三層架構簡介

C#中的三層架構+工廠模式BLL、DAL、IDAL、MODEL、DBUtility、DALFactory層級

三層架構之抽象父類SQLHelper

在winform中使用三層架構學習總結

簡單區分軟體開發中幾個概念：C/S結構和B/S結構、三層結構和兩層結構、MVC和三層架構

三層架構——三層登入類圖與序列圖

ASP.NET中如何搭建三層架構

Entity Framework 三層架構--持久層使用封裝之實體模型

三層架構中使用實體類填充泛型集合代替DataTable解決方案(ASP.NET+C#)

相關推薦