SqlHelper.cs详解：微软官方示例与中文注释

5星 · 超过95%的资源需积分: 17 106 浏览量更新于2024-07-31 收藏 546KB PDF 举报

"SqlHelper.cs是一个.NET类库中的核心组件，它提供了一种简化数据库交互的方法，特别是在ASP.NET应用中。这个类由飞晏博客整理并发布，旨在简化对SQL Server的访问，使用了ADO.NET的SqlCommand和SqlParameter对象。以下是对SqlHelper类的详细说明和关键方法的解读。首先，SqlHelper是一个密封类，意味着它不能被继承。它包含一个构造函数，虽然没有在给出的部分中显示具体实现，但通常会在构造函数中初始化连接字符串，这是通过System.Configuration.ConfigurationManager.ConnectionStrings属性获取的，这里引用了一个名为"testConnectionString"的配置项。类中的静态常量`connectionString`存储了与数据库服务器的连接信息，这在执行SQL查询时至关重要。在实际应用中，你需要根据实际情况替换为你的数据库连接字符串。 `AttachParameters`方法是SqlHelper的核心功能之一，它接收一个SqlCommand对象和一个SqlParameter数组。它的作用是将这些参数数组中的值（包括DBNull.Value，即NULL值）动态绑定到SqlCommand的参数列表中。这样做的好处在于，可以避免SQL注入攻击，并且确保了在执行命令时传递正确的参数值，即使有些参数可能没有设置默认值。 `AttachParameters`方法内部的逻辑检查了SqlCommand对象和SqlParameter数组是否为空，然后逐一将参数值设置到SqlCommand上。如果遇到DBNull.Value，它会明确地表示该参数值为NULL，而不是让数据库使用默认值。这种做法提高了代码的安全性和可读性。除了SqlHelper类，还提到了其他的辅助类如OleDbHelper.cs、OdbcHelper.cs和XMLHelper.cs，分别用于不同的数据库类型（如ODBC和OLEDB）以及XML相关的操作。这些类都是为了提供针对不同数据库接口和数据格式的通用数据库操作支持。 SqlHelper.cs是一个非常实用的工具类，它简化了数据库操作的编写，降低了出错的可能性，并有助于提高代码的可维护性。在ASP.NET项目中，它经常被用来执行存储过程、查询数据或插入、更新和删除记录等任务。通过合理利用这些类，开发者能够专注于业务逻辑，而无需过多关注底层的数据库细节。"

/// <param name="transaction">一个有效的数据库连接对象</param>

/// <param name="spName">存储过程名</param>

/// <param name="parameterValues">分配给存储过程输入参数的对象数组</param>

/// <returns>返回受影响的行数</returns>

public static int ExecuteNonQuery(SqlTransaction transaction, string spName, params object[]

parameterValues)

{

// ExecuteNonQuery #9

if (transaction == null) throw new ArgumentNullException("transaction");

if (transaction != null && transaction.Connection == null) throw new ArgumentException("The

transaction was rollbacked or commited, please provide an open transaction.", "transaction");

if (spName == null || spName.Length == 0) throw new ArgumentNullException("spName");

// 如果有参数值

if ((parameterValues != null) && (parameterValues.Length > 0))

{

// 从缓存中加载存储过程参数,如果缓存中不存在则从数据库中检索参数信息并加载到

缓存中.

SqlParameter[] commandParameters =

SqlHelperParameterCache.GetSpParameterSet(transaction.Connection, spName);

// 给存储过程参数赋值

AssignParameterValues(commandParameters, parameterValues);

// 调用重载方法

return ExecuteNonQuery(transaction, CommandType.StoredProcedure, spName,

commandParameters);

}

else

{

// 没有参数值

return ExecuteNonQuery(transaction, CommandType.StoredProcedure, spName);

}

#endregion ExecuteNonQuery命令

#region ExecuteDataset方法

/// <summary>

/// 执行指定数据库连接字符串的命令,返回DataSet.

/// </summary>

/// <remarks>

/// 示例:

/// DataSet ds = ExecuteDataset(connString, CommandType.StoredProcedure, "GetOrders");

/// </remarks>

/// <param name="connectionString">一个有效的数据库连接字符串</param>

/// <param name="commandType">命令类型(存储过程,命令文本或其它)</param>

/// <param name="commandText">存储过程名称或T-SQL语句</param>

/// <returns>返回一个包含结果集的DataSet</returns>

public static DataSet ExecuteDataset(string connectionString, CommandType commandType, string

commandText)

{

// ExecuteDataset #1

return ExecuteDataset(connectionString, commandType, commandText, (SqlParameter[])null);

}

/// <summary>

/// 执行指定数据库连接字符串的命令,返回DataSet.

/// </summary>

/// <remarks>

/// 示例:

/// DataSet ds = ExecuteDataset(connString, CommandType.StoredProcedure, "GetOrders", new

SqlParameter("@prodid", 24));

/// </remarks>

/// <param name="connectionString">一个有效的数据库连接字符串</param>

/// <param name="commandType">命令类型(存储过程,命令文本或其它)</param>

/// <param name="commandText">存储过程名称或T-SQL语句</param>

/// <param name="commandParameters">SqlParamters参数数组</param>

/// <returns>返回一个包含结果集的DataSet</returns>

public static DataSet ExecuteDataset(string connectionString, CommandType commandType, string

commandText, params SqlParameter[] commandParameters)

{

// ExecuteDataset #2

if (connectionString == null || connectionString.Length == 0) throw new

ArgumentNullException("connectionString");

using (SqlConnection connection = new SqlConnection(connectionString))

{

connection.Open();

return ExecuteDataset(connection, commandType, commandText, commandParameters);

}

/// <summary>

/// 执行指定数据库连接字符串的命令,直接提供参数值,返回DataSet.

/// </summary>

/// <remarks>

/// 此方法不提供访问存储过程输出参数和返回值.

/// 示例:

/// DataSet ds = ExecuteDataset(connString, "GetOrders", 24, 36);

/// </remarks>

/// <param name="connectionString">一个有效的数据库连接字符串</param>

/// <param name="spName">存储过程名</param>

/// <param name="parameterValues">分配给存储过程输入参数的对象数组</param>

/// <returns>返回一个包含结果集的DataSet</returns>

public static DataSet ExecuteDataset(string connectionString, string spName, params object[]

parameterValues)

{

// ExecuteDataset #3

if (connectionString == null || connectionString.Length == 0) throw new

ArgumentNullException("connectionString");

if (spName == null || spName.Length == 0) throw new ArgumentNullException("spName");

if ((parameterValues != null) && (parameterValues.Length > 0))

{

// 从缓存中检索存储过程参数

SqlParameter[] commandParameters =

SqlHelperParameterCache.GetSpParameterSet(connectionString, spName);

// 给存储过程参数分配值

AssignParameterValues(commandParameters, parameterValues);

return ExecuteDataset(connectionString, CommandType.StoredProcedure, spName,

commandParameters);

}

else

{

return ExecuteDataset(connectionString, CommandType.StoredProcedure, spName);

}

/// <summary>

/// 执行指定数据库连接对象的命令,返回DataSet.

/// </summary>

/// <remarks>

/// 示例:

/// DataSet ds = ExecuteDataset(conn, CommandType.StoredProcedure, "GetOrders");

/// </remarks>

/// <param name="connection">一个有效的数据库连接对象</param>

/// <param name="commandType">命令类型 (存储过程,命令文本或其它)</param>

/// <param name="commandText">存储过程名或T-SQL语句</param>

剩余62页未读，继续阅读

jack4238

粉丝: 13
资源: 81

SqlHelper.cs详解：微软官方示例与中文注释

sqlHelper.cs和systemError.cs

SQLHELPER.CS类英文文档

Asp.Net数据库帮助类 SQLHelper.cs

sqlhelper.cs

对象引用对于非静态的字段、方法或属性“SqlHelper.StuUpdate(Students)”是必需的 BLL G:\QBY\vs2019\ASP\Blibli三层架构\UI\BLL\StuBLL.cs 25 活动

DataTable dt = SqlHelper.ExecuteDataset(sql, CommandType.Text).Tables[0];如果是update的话无法找到表0怎么解决

SqlHelper.count

default boolean removeById(Serializable id) { return SqlHelper.retBool(this.getBaseMapper().deleteById(id)); }

严重性 代码 说明 项目 文件 行 禁止显示状态 错误 CS0117 “ConfigurationManager”未包含“ConnectionStrings”的定义 DAL C:\Users\BL27\Desktop\记录\AirPresureSystem\DAL\SQLHelper.cs 14 活动

default boolean updateById(T entity) { return SqlHelper.retBool(this.getBaseMapper().updateById(entity)); }

最新资源

严重性代码说明项目文件行禁止显示状态错误 CS0117 “ConfigurationManager”未包含“ConnectionStrings”的定义 DAL C:\Users\BL27\Desktop\记录\AirPresureSystem\DAL\SQLHelper.cs 14 活动