//SqlHelper的目的是从数据库获得信息或将信息保存到数据库。本实例的SqlHelper主要功能如下。
//(1)执行不返回数据的T-Sql命令。例如修改会员卡信息、添加会员资料等。
//(2)返回一个字段的T-Sql命令。例如获取会员卡类型的积分规则。
//(3)返回一组数据。例如获取会员资料、获取所有会员卡类型等。
//(4)缓存参数列表。在执行一条语句时,可能有多个参数,为了提高速度,将参数缓存。
//(5)读取缓存的参数。
/// <summary>
/// 数据库的通用访问代码
/// 此类为抽象类,不允许实例化,在应用时直接调用即可
/// </summary>
public abstract class SqlHelper
{
//获取数据库链接字符串,其数据静态变量且只读,项目中所有文档可以直接使用,但不能修改
public static readonly string conStr = ConfigurationManager.ConnectionStrings["MsSqlSever"].ConnectionString;
//哈希表用来存储缓存的参数信息,哈希表可以存储任意类型的参数
private static Hashtable parmCache = Hashtable.Synchronized(new Hashtable());
/// <summary>
/// 执行一个不需要返回值的SqlCommand命令,通过指定专用的链接字符串。使用参数数组形式提供参数列表
/// 如:int result=ExecuteNonQuery(connString,CommandType.StoredProcedure,"PublishOrders",new SqlParameter("@prodid",24));
/// </summary>
/// <param name="connectionString">一个有效的数据库链接字符串</param>
/// <param name="cmdType">SqlCommand命令类型(存储过程,T-Sql语句,等等</param>
/// <param name="cmdText">存储过程的名字或者T-Sql语句</param>
/// <param name="parms">以数组形式提供SqlCommand命令中用到的参数列表</param>
/// <returns>返回一个数组表示此SqlCommand命令执行后影响的行数</returns>
public static int ExecuteNonQuery(string connectionString, CommandType cmdType, string cmdText, params SqlParameter[] parms)
{
SqlCommand cmd = new SqlCommand();
using (SqlConnection conn = new SqlConnection(connectionString))
{
//通过PrepareCommand方法将参数逐个加入到SqlCommand的参数集合中
PrepareCommand(cmd, conn, null, cmdType, cmdText, parms);
int val = cmd.ExecuteNonQuery();
//清空SqlCommand中的参数列表
cmd.Parameters.Clear();
return val;
}
}
/// <summary>
/// 执行一条不返回结果的SqlCommand,通过一个已经存在的数据库链接。使用参数数组提供参数
/// 如: int result=ExecuteNonQuery(conn,CommandType.StoredProcedure,"PublishOrders",new SqlParameter("@prodid",24));
/// </summary>
/// <param name="connection">一个现有的数据库链接</param>
/// <param name="cmdType">SqlCommand命令(存储过程,T-Sql语句,等等)</param>
/// <param name="cmdText">存储过程的名字或者T-SQL语句</param>
/// <param name="commandParameters">以数组形式提供SqlCommand命令中用到的参数列表</param>
/// <returns>返回一个数值表示此SqlCommand命令执行后影响的行数</returns>
public static int ExecuteNonQuery(SqlConnection connection, CommandType cmdType, string cmdText, params SqlParameter[] commandParameters)
{
SqlCommand cmd = new SqlCommand();
PrepareCommand(cmd, connection, null, cmdType, cmdText, commandParameters);
int val = cmd.ExecuteNonQuery();
cmd.Parameters.Clear();
return val;
}
/// <summary>
/// 执行一条不返回结果的SqlCommand,通过一个已经存在的数据库事物处理。使用参数数组提供参数
/// </summary>
/// <param name="trans">一个存在的sql事物处理</param>
/// <param name="cmdType">SqlCommand类型(存储过程,T-SQL语句,等等)</param>
/// <param name="cmdText">存储过程的名字或者T-SQL语句</param>
/// <param name="commandParameters">以数组形式提供SqlCommand命令中用到的参数列表</param>
/// <returns></returns>
public static int ExecuteNonQuery(SqlTransaction trans, CommandType cmdType, string cmdText, params SqlParameter[] commandParameters)
{
SqlCommand cmd = new SqlCommand();
PrepareCommand(cmd, trans.Connection, trans, cmdType, cmdText, commandParameters);
int val = cmd.ExecuteNonQuery();
cmd.Parameters.Clear();
return val;
}
/// <summary>
/// 执行一条返回结果集的SqlCommand命令,通过专用的链接字符串。使用参数数组提供参数
/// 如:SqlDataReader r=ExecuteReader(connString,CommandType.StoredProcedure,"PublishOrders",new SqlParameter("@prodid",24));
/// </summary>
/// <param name="connectionString">一个有效的数据库连接字符串</param>
/// <param name="cmdType">SqlCommand命令类型(存储过程,T-SQL语句,等等。) </param>
/// <param name="cmdText">存储过程的名字或者T-SQL语句</param>
/// <param name="commandParameters">以数组形式提供SqlCommand命令中用到的参数列表</param>
/// <returns>返回一个包含结果的SqlDataReader</returns>
public static SqlDataReader ExecuteReader(string connectionString, CommandType cmdType, string cmdText, params SqlParameter[] commandParameters)
{
SqlCommand cmd = new SqlCommand();
SqlConnection conn = new SqlConnection(connectionString);
// 在这里使用try/catch处理是因为如果方法出现异常,则SqlDataReader就不存在,
//CommandBehavior.CloseConnection的语句就不会执行,触发的异常由catch捕获。
//关闭数据库连接,并通过throw再次引发捕捉到的异常。
try
{
PrepareCommand(cmd, conn, null, cmdType, cmdText, commandParameters);
SqlDataReader rdr = cmd.ExecuteReader(CommandBehavior.CloseConnection);
cmd.Parameters.Clear();
return rdr;
}
catch
{
conn.Close();
conn.Dispose();
throw;
}
}
/// <summary>
/// 执行一条返回第一条记录第一列的SqlCommand命令,通过专用的链接字符串。使用参数数组提供参数
/// 如:object obj=ExecuteScalar(connString,CommandType,StoredProcedure,"PublishOrders",new SqlParameter("@prodid",24));
/// </summary>
/// <param name="connectionString">一个有效的数据库链接字符串</param>
/// <param name="cmdType">SqlCommand命令类型(存储过程,T-Sql语句,等等)</param>
/// <param name="cmdText">存储过程的名字或者T-Sql语句</param>
/// <param name="commandParameters">以数组形式提供SqlCommand命令中用到的参数列表</param>
/// <returns>返回一个object类型的数据,可以通过Convert.To{Type}方法转换类型</returns>
public static object ExecuteScalar(string connectionString, CommandType cmdType, string cmdText, params SqlParameter[] commandParameters)
{
SqlCommand cmd = new SqlCommand();
using (SqlConnection connection = new SqlConnection(connectionString))
{
PrepareCommand(cmd, connection, null, cmdType, cmdText, commandParameters);
object val = cmd.ExecuteScalar();
cmd.Parameters.Clear();
return val;
}
}
/// <summary>
/// 执行一条返回第一条记录第一列的SqlCommand命令,通过已经存在数据链接。使用参数数组提供参数
/// 如:object obj=ExecuteScalar(connString,CommandType.StoredProcedure,"PublishOrders",new SqlParameter("@prodid",24));
/// </summary>
/// <param name="connection">一个已经存在的数据库链接</param>
/// <param name="cmdType">SqlCommand命令类型(存储过程,T-SQL语句,等等)</param>
/// <param name="cmdText">存储过程的名字或者T-SQL语句</param>
/// <param name="commandParameters">以数组形式提供SqlCommand命令中用到的参数列表</param>
/// <returns>返回一个object类型的数据,可以通过Convert.To{Type}方法转换类型</returns>
public static object ExecuteScalar(SqlConnection connection, CommandType cmdType, string cmdText, params SqlParameter[] commandParameters)
{
SqlCommand cmd = new SqlCommand();
PrepareCommand(cmd, connection, null, cmdType, cmdText, commandParameters);
object val = cmd.ExecuteScalar();
cmd.Parameters.Clear();
return val;
}
/// <summary>
/// 缓存参数数组
/// </summary>
/// <param name="cacheKey">参数缓存的键值</param>
/// <param name="commandParameters">被缓存的参数列表</param>
public static void CacheParameters(string cacheKey, params SqlParameter[] commandParameters)
{
parmCache[cacheKey] = commandParameters;
}
/// <summary>
/// 获取被缓存的参数
/// </summary>
/// <param name="cacheKey">用于查找参数的KEY值</param>
/// <returns>返回缓存的参数数组</returns>
public static SqlParameter[] GetCachedParameters(string cacheKey)
{
SqlParameter[] cachedParms = (SqlParameter[])parmCache[cacheKey];
if (cachedParms == null) return null;
//新建一个参数的克隆列表
SqlParameter[] clonedParms = new SqlParameter[cachedParms.Length];
//通过循环为克隆参数列表赋值
for (int i = 0, j = cachedParms.Length; i < j; i++)
{
//使用clone方法复制参数列表中的参数
clonedParms[i] = (SqlParameter)((ICloneable)cachedParms[i]).Clone();
}
return clonedParms;
}
/// <summary>
/// 为执行命令准备参数
/// </summary>
/// <param name="cmd">SqlCommand命令</param>
/// <param name="conn">已经存在的数据库链接</param>
/// <param name="trans">数据库事务处理</param>
/// <param name="cmdType">SqlCommand命令类型(存储过程,T-SQL语句,等等)</param>
/// <param name="cmdText">CommandText,T-SQL语句</param>
/// <param name="cmdParms">返回带参数的命令</param>
private static void PrepareCommand(SqlCommand cmd, SqlConnection conn, SqlTransaction trans, CommandType cmdType, string cmdText, SqlParameter[] cmdParms)
{
//判断数据库链接状态
if (conn.State != ConnectionState.Open)
{
conn.Open();
}
cmd.Connection = conn;
cmd.CommandText = cmdText;
//判断是否需要事务处理
if (trans != null)
{
cmd.Transaction = trans;
}
cmd.CommandType = cmdType;
if (cmdParms != null)
{
foreach (SqlParameter parm in cmdParms)
{
cmd.Parameters.Add(parm);
}
}
}
}