SqlHelper类的实现

namespace SqlHelper类的实现
{
    public abstract class SqlHelper
    {
        //获取数据库连接字符串，其属于静态变量且只读的，项目中所有文档可以直接使用，但不能修改
        public static readonly string conStrLocal = ConfigurationManager.ConnectionStrings["AppStr"].ConnectionString;
        //哈希表用来存储缓存的参数信息，哈希表可以存储任意类型的参数
        private static Hashtable parmCache = Hashtable.Synchronized(new Hashtable());

        //执行一个不需要返回结果的SqlCommand的命令，使用参数数组形式提供参数|通过专用的连接字符串|返回一个数值表示此Sqlcommand命令执行后影响的行数
        /* 给定连接的数据库用假设参数执行一个sql命令（不返回数据集）*/
        //示例： int result = ExecuteNonQuery(connString, CommandType.StoredProcedure, "PublishOrders", new SqlParameter("@prodid", 24));
        public static int ExecuteNonQuery(string conStr,CommandType cmdType,string cmdText,params SqlParameter[] values)
        {
            SqlCommand cmd = new SqlCommand();
            using(SqlConnection conn=new SqlConnection(conStr))
            {
                //通过PrepareCommand方法将参数逐个加入到Sqlcommand的参数集合中
                PrepareCommand(cmd, conn,null,cmdType, cmdText, values);
                int val = cmd.ExecuteNonQuery();
                //清空Sqlcommand中的参数列表
                cmd.Parameters.Clear();
                return val;
            }
        }
        //执行一个不需要返回结果的Sqlcommand，使用参数数组形式提供参数|通过一个已经存在的数据库连接|返回一个数值表示此SqlCommand命令执行后影响的行数
        //示例：int result = ExecuteNonQuery(conn, CommandType.StoredProcedure, "PublishOrders", new SqlParameter("@prodid", 24));
        public static int ExecuteNonQuery(SqlConnection connection, CommandType cmdType, string cmdText, params SqlParameter[] values)
        {
            SqlCommand cmd = new SqlCommand();
            PrepareCommand(cmd, connection,null,cmdType, cmdText, values);
            int val = cmd.ExecuteNonQuery();
            cmd.Parameters.Clear();
            return val;
        }
        //执行一条不返回结果的Sqlcommand，使用参数数组形式提供参数|通过一个已经存在的数据库事物处理|返回一个数值表示此SqlCommand命令执行后影响的行数
        //示例：int result = ExecuteNonQuery(trans, CommandType.StoredProcedure, "PublishOrders", new SqlParameter("@prodid", 24));
        public static int ExecuteNonQuery(SqlTransaction trans, CommandType cmdType, string cmdText, params SqlParameter[] values)
        {
            SqlCommand cmd = new SqlCommand();
            PrepareCommand(cmd, trans.Connection,trans,cmdType, cmdText, values);
            int val = cmd.ExecuteNonQuery();
            cmd.Parameters.Clear();
            return val;
        }
        //为执行命令准备参数,cmd是Sqlcommand命令，conn已经存在的数据库连接，trans数据库事物处理，cmdType是SqlCommand命令类型(存储过程，T-SQL语句等)，cmdText是T-SQL如：CommandText=Select*from Products
        //cmdParms是返回带参数的命令
        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);
                }
            }
        }
        //执行一条返回结果集的SqlCommand命令，使用参数数组提供参数|通过专用的连接字符串|返回一个包含结果的SqlDataReader
        //SqlDataReader r = ExecuteReader(connString, CommandType.StoredProcedure, "PublishOrders", new SqlParameter("@prodid", 24));
        public static SqlDataReader ExecuteReader(string conStr, CommandType cmdType, string cmdText, params SqlParameter[] values)
        {
            SqlCommand cmd=new SqlCommand();
            SqlConnection conn = new SqlConnection(conStr);
            try
            {
                PrepareCommand(cmd, conn,null,cmdType, cmdText, values);
                SqlDataReader reader = cmd.ExecuteReader(CommandBehavior.CloseConnection); // 在这里使用try/catch处理是因为如果方法出现异常，则SqlDataReader就不存在，
                //CommandBehavior.CloseConnection的语句就不会执行，触发的异常由catch捕获。//关闭数据库连接，并通过throw再次引发捕捉到的异常。
                cmd.Parameters.Clear();
                return reader;
            }
            catch
            {
                conn.Close();
                throw;
            }
        }
        //执行一条返回第一条记录第一列的SqlCommand命令，使用参数数组提供参数|通过专用的连接字符串(一个有效的连接字符串)|返回一个object类型的数据，可以通过Convert.To{Type}方法转换类型
        //示例：Object obj = ExecuteScalar(connString, CommandType.StoredProcedure, "PublishOrders", new SqlParameter("@prodid", 24));
        public static object ExecuteScalar(string conStr, CommandType cmdType, string cmdText, params SqlParameter[] values)
        {
            SqlCommand cmd = new SqlCommand();
            using (SqlConnection conn = new SqlConnection(conStr))
            {
                PrepareCommand(cmd, conn, null, cmdType, cmdText, values);
                object val = cmd.ExecuteScalar();
                cmd.Parameters.Clear();
                return val;
            }
        }
        //执行一条返回第一条记录第一列的SqlCommand命令，使用参数数组提供参数|通过已经存在的数据库连接(指定的数据库连接)|返回一个object类型的数据，可以通过 Convert.To{Type}方法转换类型
        //示例：Object obj = ExecuteScalar(connString, CommandType.StoredProcedure, "PublishOrders", new SqlParameter("@prodid", 24));
        public static object ExecuteScalar(SqlConnection conn, CommandType cmdType, string cmdText, params SqlParameter[] values)
        {
            SqlCommand cmd = new SqlCommand();
            PrepareCommand(cmd, conn, null, cmdType, cmdText, values);
            object val = cmd.ExecuteScalar();
            cmd.Parameters.Clear();
            return val;
        }
        //将参数集合添加到缓存(缓存参数数组)，cacheKey参数缓存的键值|values被缓存的参数列表
        public static void CacheParameters(string cacheKey, params SqlParameter[] values)
        {
            parmCache[cacheKey] = values;
        }
        //找回缓存参数集合(获取被缓存的参数)，cacheKey用于查找参数的key值(关键字)|返回缓存的参数数组
        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;
        }
        //返回一个DataSet表集合,t通过指定的数据库连接
        public static DataSet GetDataSet(SqlConnection conn, CommandType cmdType, string cmdText, params SqlParameter[] values)
        {
            SqlCommand cmd = new SqlCommand();
            try
            {
                PrepareCommand(cmd,conn,null,cmdType, cmdText, values);
                SqlDataAdapter adapter = new SqlDataAdapter();
                DataSet ds = new DataSet();
                adapter.SelectCommand = cmd;
                adapter.Fill(ds);
                return ds;
            }
            catch
            {
                conn.Close();
                throw;
            }
        }
    }
}