//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);
}
}
}
}