C#操作sql通用類 SQLHelper
2018-07-20 來源：open-open
using System;
using System.Data;
using System.Configuration;
using System.Web;
using System.Web.Security;
using System.Collections;
using System.Data.SqlClient;
/// <summary>
/// 數(shù)據(jù)庫的通用訪問代碼
/// 此類為抽象類，不允許實(shí)例化，在應(yīng)用時直接調(diào)用即可
/// </summary>
public abstract class SqlHelper
{
//獲取數(shù)據(jù)庫連接字符串，其屬于靜態(tài)變量且只讀，項(xiàng)目中所有文檔可以直接使用，但不能修改
public static readonly string ConnectionStringLocalTransaction = ConfigurationManager.ConnectionStrings["pubsConnectionString"].ConnectionString;
// 哈希表用來存儲緩存的參數(shù)信息，哈希表可以存儲任意類型的參數(shù)。
private static Hashtable parmCache = Hashtable.Synchronized(new Hashtable());
/// <summary>
///執(zhí)行一個不需要返回值的SqlCommand命令，通過指定專用的連接字符串。
/// 使用參數(shù)數(shù)組形式提供參數(shù)列表
/// </summary>
/// <remarks>
/// 使用示例：
/// int result = ExecuteNonQuery(connString, CommandType.StoredProcedure, "PublishOrders", new SqlParameter("@prodid", 24));
/// </remarks>
/// <param name="connectionString">一個有效的數(shù)據(jù)庫連接字符串</param>
/// <param name="commandType">SqlCommand命令類型 (存儲過程， T-SQL語句， 等等。)</param>
/// <param name="commandText">存儲過程的名字或者 T-SQL 語句</param>
/// <param name="commandParameters">以數(shù)組形式提供SqlCommand命令中用到的參數(shù)列表</param>
/// <returns>返回一個數(shù)值表示此SqlCommand命令執(zhí)行后影響的行數(shù)</returns>
public static int ExecuteNonQuery(string connectionString, CommandType cmdType, string cmdText, params SqlParameter[] commandParameters)
{
SqlCommand cmd = new SqlCommand();
using (SqlConnection conn = new SqlConnection(connectionString))
{
//通過PrePareCommand方法將參數(shù)逐個加入到SqlCommand的參數(shù)集合中
PrepareCommand(cmd, conn, null, cmdType, cmdText, commandParameters);
int val = cmd.ExecuteNonQuery();
//清空SqlCommand中的參數(shù)列表
cmd.Parameters.Clear();
return val;
}
}
/// <summary>
///執(zhí)行一條不返回結(jié)果的SqlCommand，通過一個已經(jīng)存在的數(shù)據(jù)庫連接
/// 使用參數(shù)數(shù)組提供參數(shù)
/// </summary>
/// <remarks>
/// 使用示例：
/// int result = ExecuteNonQuery(conn, CommandType.StoredProcedure, "PublishOrders", new SqlParameter("@prodid", 24));
/// </remarks>
/// <param name="conn">一個現(xiàn)有的數(shù)據(jù)庫連接</param>
/// <param name="commandType">SqlCommand命令類型 (存儲過程， T-SQL語句， 等等。)</param>
/// <param name="commandText">存儲過程的名字或者 T-SQL 語句</param>
/// <param name="commandParameters">以數(shù)組形式提供SqlCommand命令中用到的參數(shù)列表</param>
/// <returns>返回一個數(shù)值表示此SqlCommand命令執(zhí)行后影響的行數(shù)</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>
/// 執(zhí)行一條不返回結(jié)果的SqlCommand，通過一個已經(jīng)存在的數(shù)據(jù)庫事物處理
/// 使用參數(shù)數(shù)組提供參數(shù)
/// </summary>
/// <remarks>
/// 使用示例：
/// int result = ExecuteNonQuery(trans, CommandType.StoredProcedure, "PublishOrders", new SqlParameter("@prodid", 24));
/// </remarks>
/// <param name="trans">一個存在的 sql 事物處理</param>
/// <param name="commandType">SqlCommand命令類型 (存儲過程， T-SQL語句， 等等。)</param>
/// <param name="commandText">存儲過程的名字或者 T-SQL 語句</param>
/// <param name="commandParameters">以數(shù)組形式提供SqlCommand命令中用到的參數(shù)列表</param>
/// <returns>返回一個數(shù)值表示此SqlCommand命令執(zhí)行后影響的行數(shù)</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>
/// 執(zhí)行一條返回結(jié)果集的SqlCommand命令，通過專用的連接字符串。
/// 使用參數(shù)數(shù)組提供參數(shù)
/// </summary>
/// <remarks>
/// 使用示例：
/// SqlDataReader r = ExecuteReader(connString, CommandType.StoredProcedure, "PublishOrders", new SqlParameter("@prodid", 24));
/// </remarks>
/// <param name="connectionString">一個有效的數(shù)據(jù)庫連接字符串</param>
/// <param name="commandType">SqlCommand命令類型 (存儲過程， T-SQL語句， 等等。)</param>
/// <param name="commandText">存儲過程的名字或者 T-SQL 語句</param>
/// <param name="commandParameters">以數(shù)組形式提供SqlCommand命令中用到的參數(shù)列表</param>
/// <returns>返回一個包含結(jié)果的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處理是因?yàn)槿绻椒ǔ霈F(xiàn)異常，則SqlDataReader就不存在，
//CommandBehavior.CloseConnection的語句就不會執(zhí)行，觸發(fā)的異常由catch捕獲。
//關(guān)閉數(shù)據(jù)庫連接，并通過throw再次引發(fā)捕捉到的異常。
try
{
PrepareCommand(cmd, conn, null, cmdType, cmdText, commandParameters);
SqlDataReader rdr = cmd.ExecuteReader(CommandBehavior.CloseConnection);
cmd.Parameters.Clear();
return rdr;
}
catch
{
conn.Close();
throw;
}
}
/// <summary>
/// 執(zhí)行一條返回第一條記錄第一列的SqlCommand命令，通過專用的連接字符串。
/// 使用參數(shù)數(shù)組提供參數(shù)
/// </summary>
/// <remarks>
/// 使用示例：
/// Object obj = ExecuteScalar(connString, CommandType.StoredProcedure, "PublishOrders", new SqlParameter("@prodid", 24));
/// </remarks>
/// <param name="connectionString">一個有效的數(shù)據(jù)庫連接字符串</param>
/// <param name="commandType">SqlCommand命令類型 (存儲過程， T-SQL語句， 等等。)</param>
/// <param name="commandText">存儲過程的名字或者 T-SQL 語句</param>
/// <param name="commandParameters">以數(shù)組形式提供SqlCommand命令中用到的參數(shù)列表</param>
/// <returns>返回一個object類型的數(shù)據(jù)，可以通過 Convert.To{Type}方法轉(zhuǎn)換類型</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>
/// 執(zhí)行一條返回第一條記錄第一列的SqlCommand命令，通過已經(jīng)存在的數(shù)據(jù)庫連接。
/// 使用參數(shù)數(shù)組提供參數(shù)
/// </summary>
/// <remarks>
/// 使用示例：
/// Object obj = ExecuteScalar(connString, CommandType.StoredProcedure, "PublishOrders", new SqlParameter("@prodid", 24));
/// </remarks>
/// <param name="conn">一個已經(jīng)存在的數(shù)據(jù)庫連接</param>
/// <param name="commandType">SqlCommand命令類型 (存儲過程， T-SQL語句， 等等。)</param>
/// <param name="commandText">存儲過程的名字或者 T-SQL 語句</param>
/// <param name="commandParameters">以數(shù)組形式提供SqlCommand命令中用到的參數(shù)列表</param>
/// <returns>返回一個object類型的數(shù)據(jù)，可以通過 Convert.To{Type}方法轉(zhuǎn)換類型</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>
/// 緩存參數(shù)數(shù)組
/// </summary>
/// <param name="cacheKey">參數(shù)緩存的鍵值</param>
/// <param name="cmdParms">被緩存的參數(shù)列表</param>
public static void CacheParameters(string cacheKey, params SqlParameter[] commandParameters)
{
parmCache[cacheKey] = commandParameters;
}
/// <summary>
/// 獲取被緩存的參數(shù)
/// </summary>
/// <param name="cacheKey">用于查找參數(shù)的KEY值</param>
/// <returns>返回緩存的參數(shù)數(shù)組</returns>
public static SqlParameter[] GetCachedParameters(string cacheKey)
{
SqlParameter[] cachedParms = (SqlParameter[])parmCache[cacheKey];
if (cachedParms == null)
return null;
//新建一個參數(shù)的克隆列表
SqlParameter[] clonedParms = new SqlParameter[cachedParms.Length];
//通過循環(huán)為克隆參數(shù)列表賦值
for (int i = 0, j = cachedParms.Length; i < j; i++)
//使用clone方法復(fù)制參數(shù)列表中的參數(shù)
clonedParms[i] = (SqlParameter)((ICloneable)cachedParms[i]).Clone();
return clonedParms;
}
/// <summary>
/// 為執(zhí)行命令準(zhǔn)備參數(shù)
/// </summary>
/// <param name="cmd">SqlCommand 命令</param>
/// <param name="conn">已經(jīng)存在的數(shù)據(jù)庫連接</param>
/// <param name="trans">數(shù)據(jù)庫事物處理</param>
/// <param name="cmdType">SqlCommand命令類型 (存儲過程， T-SQL語句， 等等。)</param>
/// <param name="cmdText">Command text，T-SQL語句 例如 Select * from Products</param>
/// <param name="cmdParms">返回帶參數(shù)的命令</param>
private static void PrepareCommand(SqlCommand cmd, SqlConnection conn, SqlTransaction trans, CommandType cmdType, string cmdText, SqlParameter[] cmdParms)
{
//判斷數(shù)據(jù)庫連接狀態(tài)
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);
}
}
}
標(biāo)簽： 代碼 數(shù)據(jù)庫
版權(quán)申明：本站文章部分自網(wǎng)絡(luò)，如有侵權(quán)，請聯(lián)系：west999com@outlook.com
特別注意：本站所有轉(zhuǎn)載文章言論不代表本站觀點(diǎn)！
本站所提供的圖片等素材，版權(quán)歸原作者所有，如需使用，請與原作者聯(lián)系。
最新資訊
熱門推薦