SqlHelper.cs

 

Code
  1using System;
  2using System.Data;
  3using System.Configuration;
  4using System.Web;
  5using System.Collections;
  6using System.Collections.Generic;
  7using System.Data.SqlClient;
  8
  9namespace Chapter2.SQLServerDAL
 10{
 11    /**//// <summary>
 12    /// 数据库的通用访问代码
 13    /// 此类为抽象类，不允许实例化，在应用时直接调用即可
 14    /// </summary>
 15    public abstract class SqlHelper
 16    {
 17        //获取数据库连接字符串，其属于静态变量且只读，项目中所有文档可以直接使用，但不能修改
 18        public static readonly string ConnectionStringLocalTransaction = ConfigurationManager.ConnectionStrings[1].ConnectionString;
 19        
 20
 21        // 哈希表用来存储缓存的参数信息，哈希表可以存储任意类型的参数。
 22        private static Hashtable parmCache = Hashtable.Synchronized(new Hashtable());
 23
 24        /**//// <summary>
 25        ///执行一个不需要返回值的SqlCommand命令，通过指定专用的连接字符串。
 26        /// 使用参数数组形式提供参数列表 
 27        /// </summary>
 28        /// <remarks>
 29        /// 使用示例：
 30        ///  int result = ExecuteNonQuery(connString, CommandType.StoredProcedure, "PublishOrders", new SqlParameter("@prodid", 24));
 31        /// </remarks>
 32        /// <param name="connectionString">一个有效的数据库连接字符串</param>
 33        /// <param name="commandType">SqlCommand命令类型 (存储过程， T-SQL语句， 等等。)</param>
 34        /// <param name="commandText">存储过程的名字或者 T-SQL 语句</param>
 35        /// <param name="commandParameters">以数组形式提供SqlCommand命令中用到的参数列表</param>
 36        /// <returns>返回一个数值表示此SqlCommand命令执行后影响的行数</returns>
 37        public static int ExecuteNonQuery(string connectionString, CommandType cmdType, string cmdText, params SqlParameter[] commandParameters)
 38        {
 39
 40            SqlCommand cmd = new SqlCommand();
 41
 42            using (SqlConnection conn = new SqlConnection(connectionString))
 43            {
 44                //通过PrePareCommand方法将参数逐个加入到SqlCommand的参数集合中
 45                PrepareCommand(cmd, conn, null, cmdType, cmdText, commandParameters);
 46                int val = cmd.ExecuteNonQuery();
 47
 48                //清空SqlCommand中的参数列表
 49                cmd.Parameters.Clear();
 50                return val;
 51            }
 52        }
 53
 54        /**//// <summary>
 55        ///执行一条不返回结果的SqlCommand，通过一个已经存在的数据库连接 
 56        /// 使用参数数组提供参数
 57        /// </summary>
 58        /// <remarks>
 59        /// 使用示例：  
 60        ///  int result = ExecuteNonQuery(conn, CommandType.StoredProcedure, "PublishOrders", new SqlParameter("@prodid", 24));
 61        /// </remarks>
 62        /// <param name="conn">一个现有的数据库连接</param>
 63        /// <param name="commandType">SqlCommand命令类型 (存储过程， T-SQL语句， 等等。)</param>
 64        /// <param name="commandText">存储过程的名字或者 T-SQL 语句</param>
 65        /// <param name="commandParameters">以数组形式提供SqlCommand命令中用到的参数列表</param>
 66        /// <returns>返回一个数值表示此SqlCommand命令执行后影响的行数</returns>
 67        public static int ExecuteNonQuery(SqlConnection connection, CommandType cmdType, string cmdText, params SqlParameter[] commandParameters)
 68        {
 69
 70            SqlCommand cmd = new SqlCommand();
 71
 72            PrepareCommand(cmd, connection, null, cmdType, cmdText, commandParameters);
 73            int val = cmd.ExecuteNonQuery();
 74            cmd.Parameters.Clear();
 75            return val;
 76        }
 77
 78        /**//// <summary>
 79        /// 执行一条不返回结果的SqlCommand，通过一个已经存在的数据库事物处理 
 80        /// 使用参数数组提供参数
 81        /// </summary>
 82        /// <remarks>
 83        /// 使用示例： 
 84        ///  int result = ExecuteNonQuery(trans, CommandType.StoredProcedure, "PublishOrders", new SqlParameter("@prodid", 24));
 85        /// </remarks>
 86        /// <param name="trans">一个存在的 sql 事物处理</param>
 87        /// <param name="commandType">SqlCommand命令类型 (存储过程， T-SQL语句， 等等。)</param>
 88        /// <param name="commandText">存储过程的名字或者 T-SQL 语句</param>
 89        /// <param name="commandParameters">以数组形式提供SqlCommand命令中用到的参数列表</param>
 90        /// <returns>返回一个数值表示此SqlCommand命令执行后影响的行数</returns>
 91        public static int ExecuteNonQuery(SqlTransaction trans, CommandType cmdType, string cmdText, params SqlParameter[] commandParameters)
 92        {
 93            SqlCommand cmd = new SqlCommand();
 94            PrepareCommand(cmd, trans.Connection, trans, cmdType, cmdText, commandParameters);
 95            int val = cmd.ExecuteNonQuery();
 96            cmd.Parameters.Clear();
 97            return val;
 98        }
 99
100        /**//// <summary>
101        /// 执行一条返回结果集的SqlCommand命令，通过专用的连接字符串。
102        /// 使用参数数组提供参数
103        /// </summary>
104        /// <remarks>
105        /// 使用示例：  
106        ///  SqlDataReader r = ExecuteReader(connString, CommandType.StoredProcedure, "PublishOrders", new SqlParameter("@prodid", 24));
107        /// </remarks>
108        /// <param name="connectionString">一个有效的数据库连接字符串</param>
109        /// <param name="commandType">SqlCommand命令类型 (存储过程， T-SQL语句， 等等。)</param>
110        /// <param name="commandText">存储过程的名字或者 T-SQL 语句</param>
111        /// <param name="commandParameters">以数组形式提供SqlCommand命令中用到的参数列表</param>
112        /// <returns>返回一个包含结果的SqlDataReader</returns>
113        public static SqlDataReader ExecuteReader(string connectionString, CommandType cmdType, string cmdText, params SqlParameter[] commandParameters)
114        {
115            SqlCommand cmd = new SqlCommand();
116            SqlConnection conn = new SqlConnection(connectionString);
117
118            // 在这里使用try/catch处理是因为如果方法出现异常，则SqlDataReader就不存在，
119            //CommandBehavior.CloseConnection的语句就不会执行，触发的异常由catch捕获。
120            //关闭数据库连接，并通过throw再次引发捕捉到的异常。
121            try
122            {
123                PrepareCommand(cmd, conn, null, cmdType, cmdText, commandParameters);
124                SqlDataReader rdr = cmd.ExecuteReader(CommandBehavior.CloseConnection);
125                cmd.Parameters.Clear();
126                return rdr;
127            }
128            catch
129            {
130                conn.Close();
131                throw;
132            }
133        }
134
135        /**//// <summary>
136        /// 执行一条返回第一条记录第一列的SqlCommand命令，通过专用的连接字符串。 
137        /// 使用参数数组提供参数
138        /// </summary>
139        /// <remarks>
140        /// 使用示例：  
141        ///  Object obj = ExecuteScalar(connString, CommandType.StoredProcedure, "PublishOrders", new SqlParameter("@prodid", 24));
142        /// </remarks>
143        /// <param name="connectionString">一个有效的数据库连接字符串</param>
144        /// <param name="commandType">SqlCommand命令类型 (存储过程， T-SQL语句， 等等。)</param>
145        /// <param name="commandText">存储过程的名字或者 T-SQL 语句</param>
146        /// <param name="commandParameters">以数组形式提供SqlCommand命令中用到的参数列表</param>
147        /// <returns>返回一个object类型的数据，可以通过 Convert.To{Type}方法转换类型</returns>
148        public static object ExecuteScalar(string connectionString, CommandType cmdType, string cmdText, params SqlParameter[] commandParameters)
149        {
150            SqlCommand cmd = new SqlCommand();
151
152            using (SqlConnection connection = new SqlConnection(connectionString))
153            {
154                PrepareCommand(cmd, connection, null, cmdType, cmdText, commandParameters);
155                object val = cmd.ExecuteScalar();
156                cmd.Parameters.Clear();
157                return val;
158            }
159        }
160
161        /**//// <summary>
162        /// 执行一条返回第一条记录第一列的SqlCommand命令，通过已经存在的数据库连接。
163        /// 使用参数数组提供参数
164        /// </summary>
165        /// <remarks>
166        /// 使用示例： 
167        ///  Object obj = ExecuteScalar(connString, CommandType.StoredProcedure, "PublishOrders", new SqlParameter("@prodid", 24));
168        /// </remarks>
169        /// <param name="conn">一个已经存在的数据库连接</param>
170        /// <param name="commandType">SqlCommand命令类型 (存储过程， T-SQL语句， 等等。)</param>
171        /// <param name="commandText">存储过程的名字或者 T-SQL 语句</param>
172        /// <param name="commandParameters">以数组形式提供SqlCommand命令中用到的参数列表</param>
173        /// <returns>返回一个object类型的数据，可以通过 Convert.To{Type}方法转换类型</returns>
174        public static object ExecuteScalar(SqlConnection connection, CommandType cmdType, string cmdText, params SqlParameter[] commandParameters)
175        {
176
177            SqlCommand cmd = new SqlCommand();
178
179            PrepareCommand(cmd, connection, null, cmdType, cmdText, commandParameters);
180            object val = cmd.ExecuteScalar();
181            cmd.Parameters.Clear();
182            return val;
183        }
184        /**//// <summary>
185        /// 缓存参数数组
186        /// </summary>
187        /// <param name="cacheKey">参数缓存的键值</param>
188        /// <param name="cmdParms">被缓存的参数列表</param>
189        public static void CacheParameters(string cacheKey, params SqlParameter[] commandParameters)
190        {
191            parmCache[cacheKey] = commandParameters;
192        }
193
194        /**//// <summary>
195        /// 获取被缓存的参数
196        /// </summary>
197        /// <param name="cacheKey">用于查找参数的KEY值</param>
198        /// <returns>返回缓存的参数数组</returns>
199        public static SqlParameter[] GetCachedParameters(string cacheKey)
200        {
201            SqlParameter[] cachedParms = (SqlParameter[])parmCache[cacheKey];
202
203            if (cachedParms == null)
204                return null;
205
206            //新建一个参数的克隆列表
207            SqlParameter[] clonedParms = new SqlParameter[cachedParms.Length];
208
209            //通过循环为克隆参数列表赋值
210            for (int i = 0, j = cachedParms.Length; i < j; i++)
211                //使用clone方法复制参数列表中的参数
212                clonedParms[i] = (SqlParameter)((ICloneable)cachedParms[i]).Clone();
213
214            return clonedParms;
215        }
216
217        /**//// <summary>
218        /// 为执行命令准备参数
219        /// </summary>
220        /// <param name="cmd">SqlCommand 命令</param>
221        /// <param name="conn">已经存在的数据库连接</param>
222        /// <param name="trans">数据库事物处理</param>
223        /// <param name="cmdType">SqlCommand命令类型 (存储过程， T-SQL语句， 等等。)</param>
224        /// <param name="cmdText">Command text，T-SQL语句 例如 Select * from Products</param>
225        /// <param name="cmdParms">返回带参数的命令</param>
226        private static void PrepareCommand(SqlCommand cmd, SqlConnection conn, SqlTransaction trans, CommandType cmdType, string cmdText, SqlParameter[] cmdParms)
227        {
228
229            //判断数据库连接状态
230            if (conn.State != ConnectionState.Open)
231                conn.Open();
232
233            cmd.Connection = conn;
234            cmd.CommandText = cmdText;
235
236            //判断是否需要事物处理
237            if (trans != null)
238                cmd.Transaction = trans;
239
240            cmd.CommandType = cmdType;
241
242            if (cmdParms != null)
243            {
244                foreach (SqlParameter parm in cmdParms)
245                    cmd.Parameters.Add(parm);
246            }
247        }
248    }
249}
250