Dot Net? : [轉貼]輕鬆玩轉Typed DataSet

一、創建 Typed DataSet

1. 在 Visual Studio .NET 中，創建一個新項目或打開一個現有項目。

2. 為項目添加一個現有的
XSD 架構，或在組件設計器中創建一個新的 XSD 架構。

Written by: Rickie Lee

Dec. 08, 2004

本文繼續前面《 輕鬆玩轉 Typed DataSet, Part I 》，這裡演練如何通過批註（ Annotations ）來定製類型化 DataSet ，並調用定製的 Typed DataSet 。

三、通過批註（ Annotations ）來定製類型化 DataSet

批註使您能夠在不修改基礎架構的情況下修改類型化 DataSet 中元素的名稱。如果修改基礎架構中元素的名稱，則會使類型化
DataSet 引用不存在於數據源中的對象，並且會丟失對存在於數據源中的對象的引用。

利用批註，您可以使用更有意義的名稱來自定義類型化 DataSet 中對象的名稱，從而使代碼更易於閱讀，類型化 DataSet 更易於為客戶端使用，同時保持基礎架構不變。

將 VS.Net IDE 默認的 DataSet 窗口切換到 XML 窗口。

1. 默認創建的 VS.Net IDE 自動生成的 Orders table 的架構元素

上述 XML Schema 會生成 OrdersRow 這一對象名稱 OrderDataSet.OrdersRow ，還有一個名為 Orders 的 DataRowCollection Class （
OrderDataSet.Orders ）。

通過批註架構並標識 DataRow 和 DataRowCollection 對象的新名稱，使上述對象名稱更有意義。

首先需要在 schema header 中增加 namespace 引用，允許定製元素屬性，如下所示：

< xs:schema id ="AnnotationTypedDataset" targetNamespace ="http://tempuri.org/AnnotationTypedDataset.xsd"

elementFormDefault ="qualified" attributeFormDefault ="qualified" xmlns
="http://tempuri.org/AnnotationTypedDataset.xsd"

xmlns : mstns ="http://tempuri.org/AnnotationTypedDataset.xsd" xmlns : xs ="http://www.w3.org/2001/XMLSchema"

xmlns : msdata ="urn:schemas-microsoft-com:xml-msdata" xmlns : codegen ="urn:schemas-microsoft-com:xml-msprop" >

下面是上一架構的批註版本：

將 Order 的值指定為 typedName 將生成 DataRow 對象名稱 Order 。將 Orders 的值指定為 typedPlural 則會保留 DataRowCollection 名稱 Orders 。

下表顯示可用的批註 (From MSDN):

下表顯示可為 nullValue 批註指定的值 （ FROM MSDN ） :

下面是 OrderDetails 架構的批註版本：

通過
typedParent 和 typedChildren 屬性更改 Order/OrderDetails 對象的引用方法：

< xs:keyref name ="OrdertoOrderDetails" refer ="AnnotationTypedDatasetKey1" codegen:typedParent="Order" codegen:typedChildren="GetOrderDetails">

< xs:selector xpath =".//mstns:OrderDetails" />

< xs:field xpath ="mstns:OrderID" />

xs:keyref
>

這樣 Order 對象就產生一個 GetOrderDetails() 方法，沿著 Relationship 向下導航到 OrderDetail 對象， OrderDetails 對象生成一個 Order() 方法，沿著 Relationship 向上導航到 Order 對象。

四、調用定製的 Typed DataSet

如下是調用上述通過 Annotation 定製的 Typed DataSet ， Code snippet 如下所示：

AnnotationTypedDataset theOrderDS = new AnnotationTypedDataset();

string strSelectOrders = "Select * From Orders ";

strSelectOrders += "Select * From [Order Details]";

SqlHelper.FillDataset(connStr, CommandType.Text, strSelectOrders, theOrderDS, new string[] {"Orders", "OrderDetails"});

StringBuilder strResults = new StringBuilder();

foreach( AnnotationTypedDataset.Order theOrder in theOrderDS.Orders )

{

strResults.Append(theOrder.OrderID.ToString() + " "

+ theOrder.CustomerID.ToString() + " "

+ theOrder.EmployeeID.ToString() + Environment.NewLine);

strResults.Append("Order Details: ");

strResults.Append(theOrder.GetChildRows("OrdertoOrderDetails").Length.ToString() + " ");

strResults.Append(theOrder. GetOrderDetails ().Length.ToString());

strResults.Append(Environment.NewLine);

}

txtResults.Text = strResults.ToString();

代碼比較簡單，上述代碼調用了 SqlHelper Class （ Microsoft Data Access Application Block ）的 FillDataset 方法，來完成 DataSet 的填充。與調用默認的 Typed DataSet 代碼相比較有細微差別。

Any questions or errors, please leave comments below. Thanks.

References:

1. MSDN

2. Rickie, 輕鬆玩轉 Typed DataSet, Part I

Written by: Rickie Lee

Dec. 10, 2004

本文繼續前面《 輕鬆玩轉 Typed DataSet, Part II 》，這裡演練在使用 Typed DataSet 過程中，如何有效地 Debug 程序中出現的錯誤。最常見的錯誤 Exception 應該是：

An unhandled exception of type 'System.Data.ConstraintException' occurred in system.data.dll

Additional information: Failed to enable constraints. One or more rows contain values violating non-null, unique, or foreign-key constraints.

顯然，通過 VS.Net IDE 顯式的上述 Exception 信息，很難判斷到底錯誤在什麼地方。這裡提供的一個有效的方法來 Debug ，盡快找到 Bug 的真正原因，並加以解決。

private void PrintAllErrs(DataSet myDataSet)

{

DataRow[] rowsInError;

foreach(DataTable myTable in myDataSet.Tables)

{

// Test if the table has errors. If not, skip it.

if(myTable.HasErrors)

{

// Get an array of all rows with errors.

rowsInError = myTable.GetErrors();

Console.WriteLine(myTable.TableName + " " + rowsInError.Length.ToString()

+ " " + rowsInError[0].RowError);

// Print the error of each column in each row.

/*for(int i = 0; i< rowsInError.Length; i++)

{

foreach(DataColumn myCol in myTable.Columns)

{

Console.WriteLine(myCol.ColumnName + " " +

rowsInError[i].GetColumnError(myCol));

}

// Clear the row errors

rowsInError[i].ClearErrors();

}*/

}

}

}

通過上面的 PrintAllErrs() 方法，明確輸出錯誤的信息，其中註釋的 for 語句根據時間情況來確定是否需要。

下面演示如何使用上述 Code snippet ，下面的代碼與前面的 post 《 輕鬆玩轉 Typed DataSet, Part II 》相關，更詳細的信息，請參考《 輕鬆玩轉 Typed DataSet, Part II 》：

AnnotationTypedDataset theOrderDS = new AnnotationTypedDataset();

try

{

string strSelectOrders = "Select top 5 * From Orders ";

strSelectOrders += "Select * From [Order Details]";

SqlHelper.FillDataset(connStr, CommandType.Text, strSelectOrders, theOrderDS, new string[] {"Orders", "OrderDetails"});

StringBuilder strResults = new StringBuilder();

foreach(AnnotationTypedDataset.Order theOrder in theOrderDS.Orders)

{

strResults.Append(theOrder.OrderID.ToString() + " "

+ theOrder.CustomerID.ToString() + " "

+ theOrder.EmployeeID.ToString() + Environment.NewLine);

strResults.Append("Order Details: ");

strResults.Append(theOrder.GetChildRows("OrdertoOrderDetails").Length.ToString() + " ");

strResults.Append(theOrder.GetOrderDetails().Length.ToString());

strResults.Append(Environment.NewLine);

}

txtResults.Text = strResults.ToString();

}

catch

{

PrintAllErrs(theOrderDS);

}

異常 Exception 輸出結果：

OrderDetails 2141 ForeignKeyConstraint OrdertoOrderDetails requires the child key values (10253) to exist in the parent table.

包含有錯誤的 table name ，錯誤的 Rows 總數，並輸出第 1 行錯誤的具體信息，如果要輸出所有行的錯誤信息，則需要開發 PrintAllErrs() 方法的 for 循環。

通過上面輸出的錯誤信息，可以很快發現是上面的 SQL 語句有問題，子表 OrderDetails 的 key 值在父表 Orders 不存在。

Any questions or errors, please leave comments below. Thanks.

References:

1. Rickie, 輕鬆玩轉 Typed DataSet, Part I

2. Rickie, 輕鬆玩轉 Typed DataSet, Part II

3. MSDN, DataTable.GetErrors Method, http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpref/html/frlrfSystemDataDataTableClassGetErrorsTopic.asp

Written by: Rickie Lee

Dec. 11, 2004

1. Typed DataSet 相關文件及其作用

按照《
輕鬆玩轉 Typed DataSet, Part I 》中所提及的 使用 Visual Studio .NET 從 XSD 架構文件創建有類型的 DataSet ， 一個典型的 Typed DataSet 包含如下 3 個文件，通過點擊右邊 Solution Explorer 上的 Show all files 可以看到：

（ 1 ） XSD

XSD 文件存放定義 typed DataSet Schema 的 XML 內容，可以通過 Annotation
來定製 typed DataSet ，更詳細信息請參考《 輕鬆玩轉 Typed DataSet, Part II 》。

（ 2 ） Class file （如 CS ）

Class 文件創建 typed DataSet ，一般由 VS.Net 或 xsd.exe 命令行工具自動生成，包括繼承 DataSet 的 Typed DataSet Class 信息。該 class 文件實際上包括一系列繼承並擴展
DataSet, DataRow 和 EventArgs 的 classes ，因為上述繼承關係， Typed DataSet 仍然保留有 untyped DataSet 的所有特性，並沒有丟失任何特性。

如在引用 Typed DataSet 中 DataTable 對象時，你既可以使用 Tables 集合對象，也可以直接引用對應的屬性 Property ，代碼如下所示：

AnnotationTypedDataset.Orders

AnnotationTypedDataset.Tables[「Orders」]

（ 3 ） XSX

XSX （ XML Schema Extended ）文件由 XML Schema Designer 自動生成，包含 Designer 界面上布局或可視化信息。

2. Typed DataSet 在多層企業級系統中的應用

當在多層的企業級應用系統中採用 Typed DataSet 時，通常要求 Typed DataSet 在全部或多數 tiers 中可以使用。因此，一般情況下將 Typed DataSet 及其相關文件存放最低的層次，這樣其他引用該層的項目和 assemblies 就可以引用 Typed DataSet
對象了。

Typed DataSet 的用法示例：

(1) 定位 Typed DataSet 中的 OrderDetailsRow 數據行

OrdersDataSet.OrderDetailsRow oRow;

oRow = oDs.OrderDetails.FindByOrderIDProductID(

nOrderID_OrderDetail, nProductID_Original);

(2) 檢測是否列 Column 中包含 null 值

if(!oDs.Orders[0].IsOrderDateNull())

{

oDs.Orders[0].SetOrderDateNull();

}

(3) 循環 Orders 所有數據行及其關聯的 Order Details 記錄

foreach(OrdersDataSet.OrdersRow oOrderRow in oDs.Orders)

{

Debug.WriteLine("OrderID = " + oOrderRow.OrderID);

foreach(OrdersDataSet.OrderDetailsRow oOrderDetailRow in

oOrderRow.GetOrderDetailsRows())

{

Debug.WriteLine(" — " + oOrderDetailRow.ProductName);

}

}

需要注意的是：如果後台的 Database structure 發生變化，則需要同步 Typed DataSet 的 Schema 信息。在這樣情況下，即使採用 Untyped DataSet ，你也需要改變一些 Client 端代碼。但使用 Typed DataSet 的好處是，編譯器能夠標識出用戶代碼中大部分需要修改的地方，因為編譯器能夠對 Typed DataSet 在編譯期間進行類型安全檢查，而 untyped DataSet 則只能在 runtime 期間發現錯誤並拋出異常。

References:

1. Rickie, 輕鬆玩轉 Typed DataSet, Part I

2. Rickie, 輕鬆玩轉 Typed DataSet, Part II

3. Rickie, 輕鬆玩轉 Typed DataSet, Part III

4. John Papa, Efficient Coding With Strongly Typed DataSets,
http://msdn.microsoft.com/msdnmag/issues/04/12/DataPoints/default.aspx