sqlhelper.cs

完整的数据公共类

using System;
using System.Data;
using System.Data.SqlClient;
using System.Collections;
using System.Configuration;

namespace Lhtdco.SZOnline.DBUtility
{    
    /// <summary>
    /// 数据库操作类
    /// </summary>
    public abstract class SqlHelper
    {
        
        // 数据库连接字符串
        public static readonly string ConnectionString = String.Empty ;// ConfigurationManager.ConnectionStrings["SQLConnString"].ConnectionString;
        //public static readonly string ConnectionString = "Server=XHL;database=Center2006;uid=sa;pwd=lhtdco";

        // 存储缓存参数的 HashTable
        private static Hashtable parmCache = Hashtable.Synchronized(new Hashtable());

        // 因为此类提供的都是静态方法,为了防止此类被以"new SqlHelper()"方式构造,我们将此类的默认构造函数私有化.
        private SqlHelper() { }

        #region  === ExecuteNonQuery === 

        /// <summary>
        /// 执行命令并返回影响的记录数.
        /// </summary>
        /// <param name="connectionString">一个有效的数据库连接串</param>
        /// <param name="commandType">命令类型</param>
        /// <param name="commandText">T-SQL语句或存储过程名</param>
        /// <param name="commandParameters">SqlParamters 集合</param>
        /// <returns>受影响的记录条数</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(cmd, conn, null, cmdType, cmdText, commandParameters);
                int val = cmd.ExecuteNonQuery();
                cmd.Parameters.Clear();
                return val;
            }
        }

        /// <summary>
        /// 执行命令并返回影响的记录数.
        /// </summary>
        /// <param name="conn">一个有效的数据库连接</param>
        /// <param name="commandType">命令类型</param>
        /// <param name="commandText">T-SQL语句或存储过程名</param>
        /// <param name="commandParameters">SqlParamters 集合</param>
        /// <returns>受影响的记录条数</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>
        /// 执行命令并返回影响的记录数.
        /// </summary>
        /// <param name="trans">一个存在的事务</param>
        /// <param name="commandType">命令类型</param>
        /// <param name="commandText">T-SQL语句或存储过程名</param>
        /// <param name="commandParameters">SqlParamters 集合</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;
        }

        #endregion

        #region === ExecuteReader === 

        /// <summary>
        /// Execute a SqlCommand that returns a resultset against the database specified in the connection string 
        /// using the provided parameters.
        /// </summary>
        /// <param name="connectionString">a valid connection string for a SqlConnection</param>
        /// <param name="commandType">the CommandType (stored procedure, text, etc.)</param>
        /// <param name="commandText">the stored procedure name or T-SQL command</param>
        /// <param name="commandParameters">an array of SqlParamters used to execute the command</param>
        /// <returns>A SqlDataReader containing the results</returns>
        public static SqlDataReader ExecuteReader(string connectionString, CommandType cmdType, string cmdText, params SqlParameter[] commandParameters) {
            SqlCommand cmd = new SqlCommand();
            SqlConnection conn = new SqlConnection(connectionString);

            // we use a try/catch here because if the method throws an exception we want to 
            // close the connection throw code, because no datareader will exist, hence the 
            // commandBehaviour.CloseConnection will not work
            try 
            {
                PrepareCommand(cmd, conn, null, cmdType, cmdText, commandParameters);
                SqlDataReader rdr = cmd.ExecuteReader(CommandBehavior.CloseConnection);
                cmd.Parameters.Clear();
                return rdr;
            }
            catch 
            {
                conn.Close();
                throw;
            }
        }

        #endregion

        #region === ExecuteScalar ===

        /// <summary>
        /// 返回查询结果中的第一行的第一列
        /// </summary>
        /// <param name="connectionString">一个有效的数据库连接串</param>
        /// <param name="commandType">命令类型</param>
        /// <param name="commandText">T-SQL语句或存储过程名</param>
        /// <param name="commandParameters">SqlParamters 集合</param>
        /// <returns>查询结果中的第一行的第一列数据</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>
        /// 返回查询结果中的第一行的第一列
        /// </summary>
        /// <param name="conn">一个有效的数据库连接</param>
        /// <param name="commandType">命令类型</param>
        /// <param name="commandText">T-SQL语句或存储过程名</param>
        /// <param name="commandParameters">SqlParamters 集合</param>
        /// <returns>查询结果中的第一行的第一列数据</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;
        }

        #endregion

        /// <summary>
        /// 将参数数组添加到缓存中
        /// </summary>
        /// <param name="cacheKey">缓存关键字</param>
        /// <param name="cmdParms">要缓存的参数数组</param>
        public static void CacheParameters(string cacheKey, params SqlParameter[] commandParameters) {
            parmCache[cacheKey] = commandParameters;
        }

        /// <summary>
        /// 取回缓存中的相应参数
        /// </summary>
        /// <param name="cacheKey">缓存关键字</param>
        /// <returns>Cached SqlParamters 数组</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++)
                clonedParms[i] = (SqlParameter)((ICloneable)cachedParms[i]).Clone();

            return clonedParms;
        }

        /// <summary>
        /// 准备一条命令信息
        /// </summary>
        /// <param name="cmd">SqlCommand 对象</param>
        /// <param name="conn">SqlConnection 对象</param>
        /// <param name="trans">SqlTransaction 对象</param>
        /// <param name="cmdType">SqlCommand 类型</param>
        /// <param name="cmdText">命令内容</param>
        /// <param name="cmdParms">SqlParameters 数组</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);
            }
        }
    }
}