摘要：Data Access Application Block 是一個 .NET 組件，包含優化的數據訪問代碼，可以幫助用戶調用存儲過程以及向 SQL Server 數據庫發出 SQL 文本命令。它返回 SqlDataReader、DataSet 和 XmlReader 對象。您可以在自己的 .NET 應用程序中將其作為構造塊來使用，以減少需要創建、測試和維護的自定義代碼的數量。您可以下載完整的 C# 和 Visual Basic .NET 源代碼以及綜合文檔。
簡介
您是否正在從事 .NET 應用程序數據訪問代碼的設計和開發？您是否覺得自己總是在反復編寫相同的數據訪問代碼？您是否曾經將數據訪問代碼包裝在 Helper 函數中，以便能夠在一行中調用存儲過程？如果是，那麼 Microsoft? Data Access Application Block for .NET 正是為您設計的。
Data Access Application Block 將訪問 Microsoft SQL Server 數據庫的性能和資源管理方面的最佳經驗封裝在一起。您可以很方便地在自己的 .NET 應用程序中將其作為構造塊使用，從頁減少了需要創建、測試和維護的自定義代碼的數量。
尤其是，Data Access Application Block 可以幫助您：
調用存儲過程或 SQL 文本命令。指定參數詳細信息。返回 SqlDataReader、DataSet 或 XmlReader 對象。例如，在引用了 Data Access Application Block 的應用程序中，您可以簡單地在一行代碼中調用存儲過程並生成 DataSet，如下所示：
[Visual Basic]
Dim ds As DataSet = SqlHelper.ExecuteDataset( _
connectionString, _
CommandType.StoredProcedure, _
"getProductsByCategory", _
new SqlParameter("@CategoryID", categoryID))
[C#]
DataSet ds = SqlHelper.ExecuteDataset(
connectionString,
CommandType.StoredProcedure,
"getProductsByCategory",
new SqlParameter("@CategoryID", categoryID));
注意： Application Block for .NET（用於 .NET 的應用程序塊）是基於對成功的 .NET 應用程序進行詳細研究而設計的。它以源代碼的形式提供，您可以原樣使用，也可以針對自己的應用程序進行自定義。該應用程序塊並不代表未來 Microsoft ADO.NET 程序庫的發展方向。Microsoft ADO.NET 程序庫是為在各種使用情況下實現對數據訪問行為的精確控制而建立的。將來的 ADO.NET 版本可能會使用不同的模型來實現這個方案。
本概述的其余部分包括以下內容：
Data Access Application Block 包括哪些內容？
下載和安裝 Data Access Application Block
使用 Data Access Application Block
內部設計
常見問題
反饋和支持
合作者
Data Access Application Block 包括哪些內容？
提供了 Data Access Application Block 的源代碼以及快速入門示例應用程序，您可以使用這些應用程序測試其功能。Data Access Application Block 還包括綜合文檔，可以幫助您使用和了解所提供的代碼。
Visual Studio .NET 項目
提供了 Data Access Application Block 的 Microsoft Visual Basic? .NET 和 Microsoft Visual C#? 源代碼，以及每種語言的快速入門示例客戶端應用程序，您可以使用這些應用程序測試常見的方案。這有助於加深您對 Data Access Application Block 的工作原理的了解。您還可以自定義源代碼以滿足自己的需要。
您可以編譯 Visual Basic 和 C# Microsoft.ApplicationBlocks.Data 項目，以生成一個名為 Microsoft.ApplicationBlocks.Data.dll 的程序集。該程序集包括一個 SqlHelper 類（其中包含用於執行數據庫命令的核心功能）和一個 SqlhelperParameterCache 類（提供參數發現和緩存功能）。
文檔
Data Access Application Block 的文檔主要包括以下內容：
使用 Data Access Application Block 開發應用程序。本部分包括快速入門示例，其中包含多種常見的使用情況，可以幫助您快速輕松地掌握 Data Access Application Block（數據訪問應用程序塊）的使用。Data Access Application Block 的設計與實現。本部分包括背景設計原理信息，以便用戶深入了解 Data Access Application Block 的設計與實現。部署和運行。本部分包括安裝信息，其中包含部署和更新選項以及與安全性有關的信息。參考。本部分包含綜合的 API 參考，其中詳細介紹了構成 Data Access Application Block 的類和接口。系統要求
要運行 Data Access Application Block，需要滿足以下要求：
Microsoft Windows? 2000、Windows XP Professional .NET Framework SDK（英文）的 RTM 版本 Visual Studio? .NET 的 RTM 版本（推薦，但不必需） SQL Server 7.0 或更高版本的數據庫服務器 下載並安裝 Data Access Application Block
您可以獲取一個包含已簽名的 Data Access Application Block 程序集和綜合文檔的 Windows 安裝程序文件。
安裝進程將在您的“程序”菜單中創建一個 Microsoft Application Blocks for .NET（用於 .NET 的 Microsoft 應用程序塊）子菜單。該子菜單中有一個 Data Access（數據訪問）子菜單，其中包括用於啟動文檔的選項和用於啟動 Data Access Application Block Visual Studio .NET 解決方案的選項。
請轉到 MSDN Downloads（英文）進行下載。
使用 Data Access Application Block
本節討論如何使用 Data Access Application Block 來執行數據庫命令和管理參數。圖 1 顯示了 Data Access Application Block 的主要元素。
圖 1：Data Access Application Block
SqlHelper 類提供了一組靜態方法，可以用來向 SQL Server 數據庫發出許多各種不同類型的命令。
SqlHelperParameterCache 類提供命令參數緩存功能，可以用來提高性能。該類由許多 Execute 方法（尤其是那些只運行存儲過程的重寫方法）在內部使用。數據訪問客戶端也可以直接使用它來緩存特定命令的特定參數集。
使用 SqlHelper 類執行命令
SqlHelper 類提供了五種 Shared (Visual Basic) 或 static (C#) 方法，它們是：ExecuteNonQuery、ExecuteDataset、ExecuteReader、ExecuteScalar 和 ExecuteXmlReader。實現的每種方法都提供一組一致的重載。這提供了一種很好的使用 SqlHelper 類來執行命令的模式，同時為開發人員選擇訪問數據的方式提供了必要的靈活性。每種方法的重載都支持不同的方法參數，因此開發人員可以確定傳遞連接、事務和參數信息的方式。類中實現的所有方法都支持以下重載：
[Visual Basic]
Execute* (ByVal connection As SqlConnection, _
ByVal commandType As CommandType, _
ByVal CommandText As String)
Execute* (ByVal connection As SqlConnection, _
ByVal commandType As CommandType, _
ByVal commandText As String, _
ByVal ParamArray commandParameters() As SqlParameter)
Execute* (ByVal connection As SqlConnection, _
ByVal spName As String, _
ByVal ParamArray parameterValues() As Object)
Execute* (ByVal transaction As SqlTransaction, _
ByVal commandType As CommandType, _
ByVal commandText As String)
Execute* (ByVal transaction As SqlTransaction, _
ByVal commandType As CommandType, _
ByVal commandText As String, _
ByVal ParamArray commandParameters() As SqlParameter)
Execute* (ByVal transaction As SqlTransaction, _
ByVal spName As String, _
ByVal ParamArray parameterValues() As Object)
[C#]
Execute* (SqlConnection connection, CommandType commandType,
string commandText)
Execute* (SqlConnection connection, CommandType commandType,
string commandText, params SqlParameter[] commandParameters)
Execute* (SqlConnection connection, string spName,
params object[] parameterValues)
Execute* (SqlConnection connection,
CommandType commandType, string commandText)
Execute* (SqlConnection connection,
CommandType commandType, string commandText,
params SqlParameter[] commandParameters)
Execute* (SqlConnection connection,
string spName, params object[] parameterValues)
除這些重載以外，除 ExecuteXmlReader 之外的其他方法還提供了另一種重載：允許將連接信息作為連接字符串而不是連接對象來傳遞，如下面的方法簽名所示：
[Visual Basic]
Execute* (ByVal connectionString As String, _
ByVal commandType As CommandType, _
ByVal commandText As String)
Execute* (ByVal connectionString As String, _
ByVal commandType As CommandType, _
ByVal commandText As String, _
ByVal ParamArray commandParameters() As SqlParameter)
Execute* (ByVal connectionString As String, _
ByVal spName As String, _
ByVal ParamArray parameterValues() As Object)
[C#]
Execute* (string connectionString, CommandType commandType,
string commandText)
Execute* (string connectionString, CommandType commandType,
string commandText,
params SqlParameter[] commandParameters)
Execute* (string connectionString, string spName,
params object[] parameterValues)
注意： ExecuteXmlReader 不支持連接字符串，因為：與 SqlDataReader 對象不同，XmlReader 對象在 XmlReader 關閉時沒有提供自動關閉連接的方法。如果客戶端傳遞了連接字符串，那麼當客戶端完成對 XmlReader 的操作後，將無法關閉與 XmlReader 相關聯的連接對象。
通過參考 Data Access Application Block 程序集並導入 Microsoft.ApplicationBlocks.Data 命名空間，您可以輕松編寫使用任何一種 SqlHelper 類方法的代碼，如下面的代碼示例所示：
[Visual Basic]
Imports Microsoft.ApplicationBlocks.Data
[C#]
using Microsoft.ApplicationBlocks.Data;
導入命名空間後，您可以調用任何 Execute* 方法，
如下面的代碼示例所示：
[Visual Basic]
Dim ds As DataSet = SqlHelper.ExecuteDataset( _
"SERVER=(local);DATABASE=Northwind;INTEGRATED SECURITY=True;",
_
CommandType.Text, "SELECT * FROM Products")
[C#]
DataSet ds = SqlHelper.ExecuteDataset(
"SERVER=DataServer;DATABASE=Northwind;INTEGRATED
SECURITY=sspi;", _
CommandType.Text, "SELECT * FROM Products");
使用 SqlHelperParameterCache 類管理參數
SqlHelperParameterCache 類提供了三種可以用來管理參數的公共共享方法。它們是：
CacheParameterSet。用於將 SqlParameters 數組存儲到緩存中。GetCachedParameterSet。用於檢索緩存的參數數組的副本。GetSpParameterSet。一種重載方法，用於檢索指定存儲過程的相應參數（首先查詢一次數據庫，然後緩存結果以便將來查詢）。緩存和檢索參數
通過使用 CacheParameterSet 方法，可以緩存 SqlParameter 對象數組。此方法通過將連接字符串和命令文本連接起來創建一個鍵，然後將參數數組存儲在 Hashtable 中。
要從緩存中檢索參數，請使用 GetCachedParameterSet 方法。此方法將返回一個 SqlParameter 對象數組，這些對象已使用緩存（與傳遞給該方法的連接字符串和命令文本相對應）中的參數的名稱、值、方向和數據類型等進行了初始化。
注意： 用作參數集的鍵的連接字符串通過簡單的字符串比較進行匹配。用於從 GetCachedParameterSet 中檢索參數的連接字符串必須與用來通過 CacheParameterSet 來存儲這些參數的連接字符串完全相同。語法不同的連接字符串即使語義相同，也不會被認為是匹配的。
以下代碼顯示了如何使用 SqlHelperParameterCache 類來緩存和檢索 Transact-SQL 語句的參數。
[Visual Basic]
' 初始化連接字符串和命令文本
' 它們將構成用來存儲和檢索參數的鍵
Const CONN_STRING As String = _
"SERVER=(local); DATABASE=Northwind; INTEGRATED SECURITY=True;"
Dim sql As String = _
"SELECT ProductName FROM Products " + _
"WHERE Category=@Cat AND SupplierID = @Sup"
' 緩存參數
Dim paramsToStore(1) As SqlParameter
paramsToStore(0) = New SqlParameter("@Cat", SqlDbType.Int)
paramsToStore(1) = New SqlParameter("@Sup", SqlDbType.Int)
SqlHelperParameterCache.CacheParameterSet(CONN_STRING, _
sql, _
paramsToStore)
' 從緩存中檢索參數
Dim storedParams(1) As SqlParameter
storedParams = SqlHelperParameterCache.GetCachedParameterSet( _
CONN_STRING, sql)
storedParams(0).Value = 2
storedParams(1).Value = 3
' 在命令中使用參數
Dim ds As DataSet
ds = SqlHelper.ExecuteDataset(CONN_STRING, _
CommandType.Text, _
sql, storedParams)
[C#]
// 初始化連接字符串和命令文本
// 它們將構成用來存儲和檢索參數的鍵
const string CONN_STRING =
"SERVER=(local); DATABASE=Northwind; INTEGRATED SECURITY=True;";
string spName = "SELECT ProductName FROM Products " +
"WHERE Category=@Cat AND SupplierID = @Sup";
// 緩存參數
SqlParameter[] paramsToStore = new SqlParameter[2];
paramsToStore[0] = New SqlParameter("@Cat", SqlDbType.Int);
paramsToStore[1] = New SqlParameter("@Sup", SqlDbType.Int);
SqlHelperParameterCache.CacheParameterSet(CONN_STRING,
sql,
paramsToStore);
// 從緩存中檢索參數
SqlParameter storedParams = new SqlParameter[2];
storedParams = SqlHelperParameterCache.GetCachedParameterSet(
CONN_STRING, sql);
storedParams(0).Value = 2;
storedParams(1).Value = 3;
// 在命令中使用參數
DataSet ds;
ds = SqlHelper.ExecuteDataset(CONN_STRING,
CommandType.StoredProcedure,
sql, storedParams);
檢索存儲過程參數
SqlHelperParameterCache 還提供了針對特定存儲過程檢索參數數組的方法。一種名為 GetSpParameterSet 的重載方法提供了此功能，它包含兩種實現。該方法嘗試從緩存中檢索特定存儲過程的參數。如果這些參數尚未被緩存，則使用 .NET 的 SqlCommandBuilder 類從內部檢索，並將它們添加到緩存中，以便用於後續的檢索請求。然後，為每個參數指定相應的參數設置，最後將這些參數以數組形式返回給客戶端。以下代碼顯示了如何檢索 Northwind 數據庫中 SalesByCategory 存儲過程的參數。
[Visual Basic]
' 初始化連接字符串和命令文本
' 它們將構成用來存儲和檢索參數的鍵
Const CONN_STRING As String = _
"SERVER=(local); DATABASE=Northwind; INTEGRATED SECURITY=True;"
Dim spName As String = "SalesByCategory"
' 檢索參數
Dim storedParams(1) As SqlParameter
storedParams = SqlHelperParameterCache.GetSpParameterSet( _
CONN_STRING, spName)
storedParams(0).Value = "Beverages"
storedParams(1).Value = "1997"
' 在命令中使用參數
Dim ds As DataSet
ds = SqlHelper.ExecuteDataset(CONN_STRING, _
CommandType.StoredProcedure, _
spName, storedParams)
[C#]
// 初始化連接字符串和命令文本
// 它們將構成用來存儲和檢索參數的鍵
const string CONN_STRING =
"SERVER=(local); DATABASE=Northwind; INTEGRATED SECURITY=True;";
string spName = "SalesByCategory";
// 檢索參數
SqlParameter storedParams = new SqlParameter[2];
storedParams = SqlHelperParameterCache.GetSpParameterSet(
CONN_STRING, spName);
storedParams[0].Value = "Beverages";
storedParams[1].Value = "1997";
// 在命令中使用參數
DataSet ds;
ds = SqlHelper.ExecuteDataset(CONN_STRING,
CommandType.StoredProcedure,
spName, storedParams);
內部設計
Data Access Application Block 包含了完整的源代碼和有關其設計的綜合指南。本節介紹有關主要實現的詳細信息。
SqlHelper 類實現詳細信息
SqlHelper 類用於通過一組靜態方法來封裝數據訪問功能。該類不能被繼承或實例化，因此將其聲明為包含專用構造函數的不可繼承類。
在 SqlHelper 類中實現的每種方法都提供了一組一致的重載。這提供了一種很好的使用 SqlHelper 類來執行命令的模式，同時為開發人員選擇訪問數據的方式提供了必要的靈活性。每種方法的重載都支持不同的方法參數，因此開發人員可以確定傳遞連接、事務和參數信息的方式。在 SqlHelper 類中實現的方法包括：
ExecuteNonQuery。此方法用於執行不返回任何行或值的命令。這些命令通常用於執行數據庫更新，但也可用於返回存儲過程的輸出參數。ExecuteReader。此方法用於返回 SqlDataReader 對象，該對象包含由某一命令返回的結果集。ExecuteDataset。此方法返回 DataSet 對象，該對象包含由某一命令返回的結果集。ExecuteScalar。此方法返回一個值。該值始終是該命令返回的第一行的第一列。ExecuteXmlReader。此方法返回 FOR XML 查詢的 XML 片段。除了這些公共方法外，SqlHelper 類還包含一些專用函數，用於管理參數和准備要執行的命令。不管客戶端調用什麼樣的方法實現，所有命令都通過 SqlCommand 對象來執行。在 SqlCommand 對象能夠被執行之前，所有參數都必須添加到 Parameters 集合中，並且必須正確設置 Connection、CommandType、CommandText 和 Transaction 屬性。SqlHelper 類中的專用函數主要用於提供一種一致的方式，以便向 SQL Server 數據庫發出命令，而不考慮客戶端應用程序調用的重載方法實現。SqlHelper 類中的專用實用程序函數包括：
AttachParameters：該函數用於將所有必要的 SqlParameter 對象連接到正在運行的 SqlCommand。AssignParameterValues：該函數用於為 SqlParameter 對象賦值。PrepareCommand：該函數用於對命令的屬性（如連接、事務環境等）進行初始化。ExecuteReader：此專用 ExecuteReader 實現用於通過適當的 CommandBehavior 打開 SqlDataReader 對象，以便最有效地管理與閱讀器關聯的連接的有效期。SqlHelperParameterCache 類實現詳細信息
參數數組緩存在專用 Hashtable 中。從緩存中檢索的參數進行內部復制，這樣客戶端應用程序能夠更改參數值以及進行其他操作，而不會影響緩存的參數數組。專用共享函數 CloneParameters 可以實現此目的。
常見問題
此版本包含哪些新增功能？
與 Data Access Application Block Beta 2.0 版本相比，該 RTM 版本包含以下新增功能和變化：
SqlHelper 類方法的事務型重載不再需要 SqlConnection 參數。在此版本中，連接信息從 SqlTransaction 對象中派生，因此不必在方法簽名中包含 SqlConnection 對象參數。現在，GetSpParameterSet 方法使用 ADO.NET CommandBuilder 類的 DeriveParameters 方法來確定存儲過程所需要的參數。這比 Beta 2.0 版本中直接通過查詢數據庫來檢索信息的效率更高。可以使用 XCOPY 部署方法來部署 Data Access Application Block 程序集嗎？
可以。Microsoft.ApplicationBlocks.Data.dll 程序集在編譯後可以使用 XCOPY 進行部署。
什麼時候應該使用 ExecuteDataset 方法，什麼時候應該使用 ExecuteReader 方法？
這個問題實際上是什麼時候應該返回 DataSet 對象中的多個數據行，什麼時候應該使用 DataReader。答案取決於您的應用程序的特定需要，以及您在靈活性和原始性能之間的取捨。DataSet 為您提供數據的靈活的且斷開連接的關系視圖，而 DataReader 為您提供性能卓越的、只讀的、僅向前光標。
有關 DataSet 和 DataReader 的全面比較，請參閱 Data Access Architecture Guide（英文）。
如何使用 ExecuteDataset 返回包含多個表的數據集？
通過創建一個可以返回多個行集的存儲過程（通過執行多個 SELECT 語句或者對其他存儲過程進行嵌套調用），並使用 ExecuteDataset 方法執行該過程，您可以檢索包含多個表的數據集。
例如，假設您的數據庫包含以下存儲過程。
CREATE PROCEDURE GetCategories
AS
SELECT * FROM Categories
GO
CREATE PROCEDURE GetProducts
AS
SELECT * FROM Products
您可以創建一個主存儲過程來對這些過程進行嵌套調用，如下面的代碼示例所示。
CREATE PROCEDURE GetCategoriesAndProducts
AS
BEGIN
EXEC GetCategories
EXEC GetProducts
END
使用 ExecuteDataset 方法執行此主存儲過程將返回一個 DateSet，其中包含兩個表：一個表包含分類數據，另一個表包含產品數據。
注意： ExecuteDataset 方法不提供為返回的表指定自定義名稱的方法。第一個表的編號始終為 0，名稱為 Table，第二個表的編號為 1，名稱為 Table1，依此類推。
還有其他的應用程序塊嗎？
Data Access Application Block 是即將發布的幾個應用程序塊之一。這些應用程序塊可以解決開發人員在不同項目中遇到的共同問題。它們可以快速方便地插入到 .NET 應用程序中。
反饋和支持
如果您對 Data Access Application Block 有任何問題、意見和建議，請向 [email protected] 發送電子郵件，我們將及時提供反饋。
Application Blocks for .NET 旨在協助開發 .NET 分布式應用程序。示例代碼和文檔都按原樣提供。盡管已經過測試並被認為是穩定的代碼集，但我們並不象傳統的 Microsoft 產品那樣對其提供支持。
我們還創建了一個新聞組，可以幫助您使用 Application Blocks for .NET（.NET 應用程序塊）。您可以通過新聞組在聯機的開放論壇中向同行、同事和 Microsoft 支持專家咨詢。
其他人也可以從您的問題和評論中獲益，我們的開發小組將每天查看新聞組：
新聞組：基於 Web 的讀者
http://msdn.microsoft.com/newsgroups/loadframes.asp?icp=msdn&slcid=us&newsgroup=microsoft.public.dotnet.distributed_apps（英文）
新聞組：NNTP 讀者
news://msnews.microsoft.com/microsoft.public.dotnet.distributed_apps（英文）
您想學習和利用 .NET 的功能嗎？歡迎您與 Microsoft Technology Centers 的技術專家並肩工作，您將學到最好的開發經驗。有關詳細信息，請訪問 http://www.microsoft.com/business/services/mtc.asp（英文）。
您需要更多的幫助嗎？請訪問新增的客戶支持服務 Advisory Services，該解決方案可以滿足您小規模的咨詢需要。有關 Advisory Services 的詳細信息，請訪問 http://support.microsoft.com/default.aspx?scid=FH;EN-US;offer58&FR=0&SD=GN&LN=EN-US&CT=SD&SE=NONA（英文）。
更多信息
Data Access Application Block 的設計和開發是建立在 Data Access in .NET Architecture Guide（英文）中討論的最佳開發經驗和通用設計原則基礎之上的。請閱讀該指南，以了解有關數據訪問的詳細信息。
合作者
衷心感謝以下投稿人和審閱人：Susan Warren、Brad Abrams、Andy Dunn、Michael Day、Mark Ashton、Gregory Leake、Steve Busby、Kenny Jones、David Schleifer、Andrew Roubin (Vorsite Corp.)、Jeffrey Richter (Wintellect)、Bernard Chen (Sapient) 和 Matt Drucker (Turner Broadcasting)。
同時感謝內容組的以下成員：Tina Burden (Entirenet)、Shylender Ramamurthy (Infosys Technologies Ltd) 和 Filiberto Selvas Patino。
