• 调用存储过程或 SQL 文本命令。
  • 指定参数详细信息。
  • 返回 SqlDataReader、DataSet 或 XmlReader 对象。

     

    sqlhelper使用指南 - manna24 - 踏云飞舞[C#]

    sqlhelper使用指南 - manna24 - 踏云飞舞DataSet ds = SqlHelper.ExecuteDataset( 

    sqlhelper使用指南 - manna24 - 踏云飞舞      connectionString,

    sqlhelper使用指南 - manna24 - 踏云飞舞      CommandType.StoredProcedure,

    sqlhelper使用指南 - manna24 - 踏云飞舞      "getProductsByCategory",

    sqlhelper使用指南 - manna24 - 踏云飞舞      new SqlParameter("@CategoryID", categoryID)); 

    sqlhelper使用指南 - manna24 - 踏云飞舞

     

    SqlHelper 类提供了五种 Shared (Visual Basic) 或 static (C#) 方法,它们是:ExecuteNonQuery、ExecuteDataset、ExecuteReader、ExecuteScalar 和 ExecuteXmlReader。实现的每种方法都提供一组一致的重载。这提供了一种很好的使用 SqlHelper 类来执行命令的模式,同时为开发人员选择访问数据的方式提供了必要的灵活性。每种方法的重载都支持不同的方法参数,因此开发人员可以确定传递连接、事务和参数信息的方式。类中实现的所有方法都支持以下重载:

    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 之外的其他方法还提供了另一种重载:允许将连接信息作为连接字符串而不是连接对象来传递,如下面的方法签名所示:

    sqlhelper使用指南 - manna24 - 踏云飞舞[C#]

    sqlhelper使用指南 - manna24 - 踏云飞舞Execute* (string connectionString, CommandType commandType, 

    sqlhelper使用指南 - manna24 - 踏云飞舞          string commandText)

    sqlhelper使用指南 - manna24 - 踏云飞舞

    sqlhelper使用指南 - manna24 - 踏云飞舞Execute* (string connectionString, CommandType commandType, 

    sqlhelper使用指南 - manna24 - 踏云飞舞          string commandText, 

    sqlhelper使用指南 - manna24 - 踏云飞舞          params SqlParameter[] commandParameters)

    sqlhelper使用指南 - manna24 - 踏云飞舞

    sqlhelper使用指南 - manna24 - 踏云飞舞Execute* (string connectionString, string spName, 

    sqlhelper使用指南 - manna24 - 踏云飞舞          params object[] parameterValues)

    sqlhelper使用指南 - manna24 - 踏云飞舞

    ExecuteXmlReader 不支持连接字符串,因为:与 SqlDataReader 对象不同,XmlReader 对象在 XmlReader 关闭时没有提供自动关闭连接的方法。如果客户端传递了连接字符串,那么当客户端完成对 XmlReader 的操作后,将无法关闭与 XmlReader 相关联的连接对象。

    通过参考 Data Access Application Block 程序集并导入 Microsoft.ApplicationBlocks.Data 命名空间,您可以轻松编写使用任何一种 SqlHelper 类方法的代码,如下面的代码示例所示:

    sqlhelper使用指南 - manna24 - 踏云飞舞[C#]

    sqlhelper使用指南 - manna24 - 踏云飞舞using Microsoft.ApplicationBlocks.Data;

    sqlhelper使用指南 - manna24 - 踏云飞舞

    导入命名空间后,您可以调用任何 Execute* 方法,如下面的代码示例所示:

    sqlhelper使用指南 - manna24 - 踏云飞舞[C#]

    sqlhelper使用指南 - manna24 - 踏云飞舞DataSet ds = SqlHelper.ExecuteDataset( 

    sqlhelper使用指南 - manna24 - 踏云飞舞   "SERVER=DataServer;DATABASE=Northwind;INTEGRATED

    sqlhelper使用指南 - manna24 - 踏云飞舞     SECURITY=sspi;", _

    sqlhelper使用指南 - manna24 - 踏云飞舞   CommandType.Text, "SELECT * FROM Products");

    sqlhelper使用指南 - manna24 - 踏云飞舞

    使用 SqlHelperParameterCache 类管理参数

    SqlHelperParameterCache 类提供了三种可以用来管理参数的公共共享方法。它们是:

    • CacheParameterSet。用于将 SqlParameters 数组存储到缓存中。
    • GetCachedParameterSet。用于检索缓存的参数数组的副本。
    • GetSpParameterSet。一种重载方法,用于检索指定存储过程的相应参数(首先查询一次数据库,然后缓存结果以便将来查询)。

     

    缓存和检索参数

    通过使用 CacheParameterSet 方法,可以缓存 SqlParameter 对象数组。此方法通过将连接字符串和命令文本连接起来创建一个键,然后将参数数组存储在 Hashtable 中。

    要从缓存中检索参数,请使用 GetCachedParameterSet 方法。此方法将返回一个 SqlParameter 对象数组,这些对象已使用缓存(与传递给该方法的连接字符串和命令文本相对应)中的参数的名称、值、方向和数据类型等进行了初始化。

    sqlhelper使用指南 - manna24 - 踏云飞舞[C#]

    sqlhelper使用指南 - manna24 - 踏云飞舞// 初始化连接字符串和命令文本

    sqlhelper使用指南 - manna24 - 踏云飞舞// 它们将构成用来存储和检索参数的键

    sqlhelper使用指南 - manna24 - 踏云飞舞const string CONN_STRING =

    sqlhelper使用指南 - manna24 - 踏云飞舞  "SERVER=(local); DATABASE=Northwind; INTEGRATED SECURITY=True;";

    sqlhelper使用指南 - manna24 - 踏云飞舞string spName = "SELECT ProductName FROM Products " + 

    sqlhelper使用指南 - manna24 - 踏云飞舞                "WHERE Category=@Cat AND SupplierID = @Sup";

    sqlhelper使用指南 - manna24 - 踏云飞舞

    sqlhelper使用指南 - manna24 - 踏云飞舞// 缓存参数

    sqlhelper使用指南 - manna24 - 踏云飞舞SqlParameter[] paramsToStore = new SqlParameter[2];

    sqlhelper使用指南 - manna24 - 踏云飞舞paramsToStore[0] = New SqlParameter("@Cat", SqlDbType.Int);

    sqlhelper使用指南 - manna24 - 踏云飞舞paramsToStore[1] = New SqlParameter("@Sup", SqlDbType.Int);

    sqlhelper使用指南 - manna24 - 踏云飞舞SqlHelperParameterCache.CacheParameterSet(CONN_STRING, 

    sqlhelper使用指南 - manna24 - 踏云飞舞                                          sql, 

    sqlhelper使用指南 - manna24 - 踏云飞舞                                          paramsToStore);

    sqlhelper使用指南 - manna24 - 踏云飞舞

    sqlhelper使用指南 - manna24 - 踏云飞舞// 从缓存中检索参数

    sqlhelper使用指南 - manna24 - 踏云飞舞SqlParameter storedParams = new SqlParameter[2];

    sqlhelper使用指南 - manna24 - 踏云飞舞storedParams = SqlHelperParameterCache.GetCachedParameterSet(

    sqlhelper使用指南 - manna24 - 踏云飞舞                                              CONN_STRING, sql);

    sqlhelper使用指南 - manna24 - 踏云飞舞storedParams(0).Value = 2;

    sqlhelper使用指南 - manna24 - 踏云飞舞storedParams(1).Value = 3;

    sqlhelper使用指南 - manna24 - 踏云飞舞

    sqlhelper使用指南 - manna24 - 踏云飞舞// 在命令中使用参数

    sqlhelper使用指南 - manna24 - 踏云飞舞DataSet ds;

    sqlhelper使用指南 - manna24 - 踏云飞舞ds = SqlHelper.ExecuteDataset(CONN_STRING, 

    sqlhelper使用指南 - manna24 - 踏云飞舞                              CommandType.StoredProcedure,

    sqlhelper使用指南 - manna24 - 踏云飞舞                              sql, storedParams);

    sqlhelper使用指南 - manna24 - 踏云飞舞

    检索存储过程参数

    SqlHelperParameterCache 还提供了针对特定存储过程检索参数数组的方法。一种名为 GetSpParameterSet 的重载方法提供了此功能,它包含两种实现。该方法尝试从缓存中检索特定存储过程的参数。如果这些参数尚未被缓存,则使用 .NET 的 SqlCommandBuilder 类从内部检索,并将它们添加到缓存中,以便用于后续的检索请求。然后,为每个参数指定相应的参数设置,最后将这些参数以数组形式返回给客户端。以下代码显示了如何检索 Northwind 数据库中 SalesByCategory 存储过程的参数。

    sqlhelper使用指南 - manna24 - 踏云飞舞[C#]

    sqlhelper使用指南 - manna24 - 踏云飞舞// 初始化连接字符串和命令文本

    sqlhelper使用指南 - manna24 - 踏云飞舞// 它们将构成用来存储和检索参数的键

    sqlhelper使用指南 - manna24 - 踏云飞舞const string CONN_STRING = 

    sqlhelper使用指南 - manna24 - 踏云飞舞  "SERVER=(local); DATABASE=Northwind; INTEGRATED SECURITY=True;";

    sqlhelper使用指南 - manna24 - 踏云飞舞string spName = "SalesByCategory";

    sqlhelper使用指南 - manna24 - 踏云飞舞

    sqlhelper使用指南 - manna24 - 踏云飞舞// 检索参数

    sqlhelper使用指南 - manna24 - 踏云飞舞SqlParameter storedParams = new SqlParameter[2];

    sqlhelper使用指南 - manna24 - 踏云飞舞storedParams = SqlHelperParameterCache.GetSpParameterSet(

    sqlhelper使用指南 - manna24 - 踏云飞舞                                          CONN_STRING, spName);

    sqlhelper使用指南 - manna24 - 踏云飞舞storedParams[0].Value = "Beverages";

    sqlhelper使用指南 - manna24 - 踏云飞舞storedParams[1].Value = "1997";

    sqlhelper使用指南 - manna24 - 踏云飞舞

    sqlhelper使用指南 - manna24 - 踏云飞舞// 在命令中使用参数

    sqlhelper使用指南 - manna24 - 踏云飞舞DataSet ds;

    sqlhelper使用指南 - manna24 - 踏云飞舞ds = SqlHelper.ExecuteDataset(CONN_STRING, 

    sqlhelper使用指南 - manna24 - 踏云飞舞                              CommandType.StoredProcedure,

    sqlhelper使用指南 - manna24 - 踏云飞舞                              spName, storedParams);

    sqlhelper使用指南 - manna24 - 踏云飞舞

     

    内部设计

    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 Architecture Guide(英文)。

    如何使用 ExecuteDataset 返回包含多个表的数据集?

    通过创建一个可以返回多个行集的存储过程(通过执行多个 SELECT 语句或者对其他存储过程进行嵌套调用),并使用 ExecuteDataset 方法执行该过程,您可以检索包含多个表的数据集。

    例如,假设您的数据库包含以下存储过程。

     

    sqlhelper使用指南 - manna24 - 踏云飞舞CREATE PROCEDURE GetCategories

    sqlhelper使用指南 - manna24 - 踏云飞舞AS

    sqlhelper使用指南 - manna24 - 踏云飞舞SELECT * FROM Categories

    sqlhelper使用指南 - manna24 - 踏云飞舞GO

    sqlhelper使用指南 - manna24 - 踏云飞舞CREATE PROCEDURE GetProducts

    sqlhelper使用指南 - manna24 - 踏云飞舞AS

    sqlhelper使用指南 - manna24 - 踏云飞舞SELECT * FROM Products

    sqlhelper使用指南 - manna24 - 踏云飞舞

    您可以创建一个主存储过程来对这些过程进行嵌套调用,如下面的代码示例所示

    sqlhelper使用指南 - manna24 - 踏云飞舞CREATE PROCEDURE GetCategoriesAndProducts

    sqlhelper使用指南 - manna24 - 踏云飞舞AS

    sqlhelper使用指南 - manna24 - 踏云飞舞BEGIN

    sqlhelper使用指南 - manna24 - 踏云飞舞  EXEC GetCategories

    sqlhelper使用指南 - manna24 - 踏云飞舞  EXEC GetProducts

    sqlhelper使用指南 - manna24 - 踏云飞舞END

    sqlhelper使用指南 - manna24 - 踏云飞舞

    使用 ExecuteDataset 方法执行此主存储过程将返回一个 DateSet,其中包含两个表:一个表包含分类数据,另一个表包含产品数据。

  • posted on 2009-08-28 15:47  superlee  阅读(378)  评论(0编辑  收藏  举报