440 技術社區[雲棲]

sqlhelper使用指南

摘要：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 版本可能會使用不同的模型來實現這個方案

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 的全麵比較，請參閱（英文）。

如何使用 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，依此類推。

最後更新：2017-04-02 00:06:29

sqlhelper使用指南

簡介

使用 SqlHelper 類執行命令

使用 SqlHelperParameterCache 類管理參數

緩存和檢索參數

檢索存儲過程參數

內部設計

SqlHelper 類實現詳細信息

SqlHelperParameterCache 類實現詳細信息

常見問題

此版本包含哪些新增功能？

可以使用 XCOPY 部署方法來部署 Data Access Application Block 程序集嗎？

什麼時候應該使用 ExecuteDataset 方法，什麼時候應該使用 ExecuteReader 方法？

如何使用 ExecuteDataset 返回包含多個表的數據集？

上一篇： ThreadStatic

下一篇：關於將臨時變量置為null是否有助於快速垃圾回收

相關內容

熱門內容

最新內容

sqlhelper使用指南

簡介

使用 SqlHelper 類執行命令

使用 SqlHelperParameterCache 類管理參數

緩存和檢索參數

檢索存儲過程參數

內部設計

SqlHelper 類實現詳細信息

SqlHelperParameterCache 類實現詳細信息

常見問題

此版本包含哪些新增功能？

可以使用 XCOPY 部署方法來部署 Data Access Application Block 程序集嗎？

什麼時候應該使用 ExecuteDataset 方法，什麼時候應該使用 ExecuteReader 方法？

如何使用 ExecuteDataset 返回包含多個表的數據集？

上一篇： ThreadStatic

下一篇： 關於將臨時變量置為null是否有助於快速垃圾回收

相關內容

熱門內容

最新內容

下一篇：關於將臨時變量置為null是否有助於快速垃圾回收