编写SQLServer数据库访问类 SQLHelper

<connectionStrings>
    <add name="connString" connectionString="Server=.;DataBase=BooksDB;Uis=sa;password=123456"/>
  </connectionStrings>

记得App.config配置数据库连接字符串

先在SQLHelper里封装好数据库连接字符串（红框内要跟config文件里的定义的name保持一致），之后分为四个模块编写SQLHelper类。

1、封装格式化SQL语句执行的各种方法
下面这几个方法可以实现对数据库的增删改查，基本上每行都有注释。

public static int Update(string sql) {
            //初始化数据库连接
            SqlConnection conn = new SqlConnection(connString);
            //初始化带有sql语句和相应数据库的实例
            SqlCommand cmd = new SqlCommand(sql, conn);
            try
            {
                //打开数据连接
                conn.Open();
                //返回受影响的行数
                return cmd.ExecuteNonQuery();
            }
            catch (Exception ex)
            {
                //定义错误信息
                string errorInfo = "调用public static int Update(string sql)方法时发生错误：" + ex.Message;
                //将异常信息写入日志
                WriteLog(errorInfo);
                //反馈 提示错误信息
                throw new Exception(errorInfo);
            }
            finally {
                //关闭数据连接
                conn.Close();
            }
        }
        public static SqlDataReader GetReader(string sql)
        {
            //初始化数据库连接
            SqlConnection conn = new SqlConnection(connString);
            //初始化带有sql语句和相应数据库的实例
            SqlCommand cmd = new SqlCommand(sql, conn);
            try
            {
                //打开数据库连接
                conn.Open();
                //将SQL语句发送到指定连接　生成一个SqlDataReader对象
                return cmd.ExecuteReader(CommandBehavior.CloseConnection);
            }
            catch (Exception ex)
            {
                //关闭数据库连接
                conn.Close();
                //定义错误信息
                string errorInfo = "调用public static SqlDataReader GetReader(string sql)方法时发生错误：" + ex.Message;
                //将异常信息写入日志
                WriteLog(errorInfo);
                //反馈 提示错误信息
                throw new Exception(errorInfo);
            }
        }
        public static object GetSingleResult(string sql)
        {
            //初始化数据库连接
            SqlConnection conn = new SqlConnection(connString);
            //初始化带有sql语句和相应数据库的实例
            SqlCommand cmd = new SqlCommand(sql, conn);
            try
            {
                //打开数据库连接
                conn.Open();
                //返回查询到的结果集的第一行的第一列
                return cmd.ExecuteScalar();
            }
            catch (Exception ex)
            {
                //定义错误信息
                string errorInfo = "调用public static object GetSingleResult(string sql)方法时发生错误：" + ex.Message;
                //将异常信息写入日志
                WriteLog(errorInfo);
                //反馈 提示错误信息
                throw new Exception(errorInfo);
            }
            finally
            {
                //关闭数据库连接
                conn.Close();
            }

        }

2、封装带参数SQL语句执行的各种方法
这里面就是对第一个里面封装的三个方法的重载，多了个参数而已。

public static int Update(string sql, SqlParameter[] param)
        {
            //初始化数据库连接
            SqlConnection conn = new SqlConnection(connString);
            //初始化带有sql语句和相应数据库的实例
            SqlCommand cmd = new SqlCommand(sql, conn);
            try
            {
                //打开数据连接
                conn.Open();
                //封装参数
                cmd.Parameters.AddRange(param);
                //返回受影响的行数
                return cmd.ExecuteNonQuery();
            }
            catch (Exception ex)
            {
                //将异常信息写入日志
                //WriteLog(ex.Message);
                //反馈 提示错误信息
                //throw new Exception("调用public static int Update(string sql,SqlParameter[] param)方法时发生错误：" + ex.Message);

                //定义错误信息
                string errorInfo = "调用public static int Update(string sql)方法时发生错误：" + ex.Message;
                //将异常信息写入日志
                WriteLog(errorInfo);
                //反馈 提示错误信息
                throw new Exception(errorInfo);
            }
            finally
            {
                //关闭数据连接
                conn.Close();
            }
        }
        public static SqlDataReader GetReader(string sql, SqlParameter[] param)
        {
            //初始化数据库连接
            SqlConnection conn = new SqlConnection(connString);
            //初始化带有sql语句和相应数据库的实例
            SqlCommand cmd = new SqlCommand(sql, conn);
            try
            {
                //打开数据库连接
                conn.Open();
                //封装参数
                cmd.Parameters.AddRange(param);
                //将SQL语句发送到指定连接　生成一个SqlDataReader对象
                return cmd.ExecuteReader(CommandBehavior.CloseConnection);
            }
            catch (Exception ex)
            {
                //关闭数据库连接
                conn.Close();
                //定义错误信息
                string errorInfo = "调用public static SqlDataReader GetReader(string sql, SqlParameter[] param)方法时发生错误：" + ex.Message;
                //将异常信息写入日志
                WriteLog(errorInfo);
                //反馈 提示错误信息
                throw new Exception(errorInfo);
            }
        }
        public static object GetSingleResult(string sql, SqlParameter[] param)
        {
            //初始化数据库连接
            SqlConnection conn = new SqlConnection(connString);
            //初始化带有sql语句和相应数据库的实例
            SqlCommand cmd = new SqlCommand(sql, conn);
            try
            {
                //打开数据库连接
                conn.Open();
                //封装参数
                cmd.Parameters.AddRange(param);
                //返回查询到的结果集的第一行的第一列
                return cmd.ExecuteScalar();
            }
            catch (Exception ex)
            {
                //定义错误信息
                string errorInfo = "调用public static object GetSingleResult(string sql, SqlParameter[] param)方法时发生错误：" + ex.Message;
                //将异常信息写入日志
                WriteLog(errorInfo);
                //反馈 提示错误信息
                throw new Exception(errorInfo);
            }
            finally
            {
                //关闭数据库连接
                conn.Close();
            }

        }

3、封装调用存储过程执行的各种方法
这个就不可以针对上面的方法进行重载了，因为sql语句换成了存储过程的名称了。

public static int UpdateByProcedure(string spName, SqlParameter[] param)
        {
            //初始化数据库连接
            SqlConnection conn = new SqlConnection(connString);
            //初始化带有sql语句和相应数据库的实例
            SqlCommand cmd = new SqlCommand(spName, conn);
            try
            {
                //打开数据连接
                conn.Open();
                //声明当前操作是存储过程
                cmd.CommandType = CommandType.StoredProcedure;
                //封装参数
                cmd.Parameters.AddRange(param);
                //返回受影响的行数
                return cmd.ExecuteNonQuery();
            }
            catch (Exception ex)
            {
                //定义错误信息
                string errorInfo = "调用public static int UpdateByProcedure(string spName, SqlParameter[] param)方法时发生错误：" + ex.Message;
                //将异常信息写入日志
                WriteLog(errorInfo);
                //反馈 提示错误信息
                throw new Exception(errorInfo);
            }
            finally
            {
                //关闭数据连接
                conn.Close();
            }
        }
        public static SqlDataReader GetReaderByProcedure(string spName, SqlParameter[] param)
        {
            //初始化数据库连接
            SqlConnection conn = new SqlConnection(connString);
            //初始化带有sql语句和相应数据库的实例
            SqlCommand cmd = new SqlCommand(spName, conn);
            try
            {
                //打开数据库连接
                conn.Open();
                //声明当前操作是存储过程
                cmd.CommandType = CommandType.StoredProcedure;
                //封装参数
                cmd.Parameters.AddRange(param);
                //将SQL语句发送到指定连接　生成一个SqlDataReader对象
                return cmd.ExecuteReader(CommandBehavior.CloseConnection);
            }
            catch (Exception ex)
            {
                //关闭数据库连接
                conn.Close();
                //定义错误信息
                string errorInfo = "调用public static SqlDataReader GetReaderByProcedure(string spName, SqlParameter[] param)方法时发生错误：" + ex.Message;
                //将异常信息写入日志
                WriteLog(errorInfo);
                //反馈 提示错误信息
                throw new Exception(errorInfo);
            }
        }
        public static object GetSingleResultByProcedure(string spName, SqlParameter[] param)
        {
            //初始化数据库连接
            SqlConnection conn = new SqlConnection(connString);
            //初始化带有sql语句和相应数据库的实例
            SqlCommand cmd = new SqlCommand(spName, conn);
            try
            {
                //打开数据库连接
                conn.Open();
                //声明当前操作是存储过程
                cmd.CommandType = CommandType.StoredProcedure;
                //封装参数
                cmd.Parameters.AddRange(param);
                //返回查询到的结果集的第一行的第一列
                return cmd.ExecuteScalar();
            }
            catch (Exception ex)
            {
                //定义错误信息
                string errorInfo = "调用public static object GetSingleResultByProcedure(string spName, SqlParameter[] param)方法时发生错误：" + ex.Message;
                //将异常信息写入日志
                WriteLog(errorInfo);
                //反馈 提示错误信息
                throw new Exception(errorInfo);
            }
            finally
            {
                //关闭数据库连接
                conn.Close();
            }

        }

4、其它方法
这个方法里我只封装一个错误信息写入日志的方法，如果有别的需要重复调用的可以封装在这里面

/// <summary>
        /// 错误信息写入日志
        /// </summary>
        /// <param name="log">错误信息</param>
        private static void WriteLog(string log)
        {
            //定义文件流
            FileStream fs = new FileStream("sqlhelper.log", FileMode.Append);
            //实例化指定的文件
            StreamWriter sw = new StreamWriter(fs);
            //将字符串写入文件
            sw.WriteLine(DateTime.Now.ToString() + "" + log);
            //关闭写入流
            sw.Close();
            //关闭文件流
            fs.Close();
        }

最后还有个关于使用事务来实现对数据库操作的例子

1、启用事务提交多条带参数的SQL语句

/// <summary>
        /// 启用事务提交多条带参数的SQL语句
        /// </summary>
        /// <param name="mainSql">主表SQL语句</param>
        /// <param name="mainParam">主表SQL语句对应的参数</param>
        /// <param name="detailSql">明细表SQL语句</param>
        /// <param name="detailParam">明细表SQL语句对应的参数数据集合</param>
        /// <returns>返回事务是否执行成功</returns>
        public static bool UpdateByTran(string mainSql, SqlParameter[] mainParam, string detailSql, List<SqlParameter[]> detailParam)
        {
            //初始化数据库连接
            SqlConnection conn = new SqlConnection(connString);
            //初始化带有sql语句和相应数据库的实例
            SqlCommand cmd = new SqlCommand();
            cmd.Connection = conn;
            try
            {
                //打开数据库连接
                conn.Open();
                //开始事务
                cmd.Transaction = conn.BeginTransaction();
                if (mainSql != null && mainSql.Length != 0)
                {
                    cmd.CommandText = mainSql;
                    cmd.Parameters.AddRange(mainParam);
                    cmd.ExecuteNonQuery();
                }
                foreach (SqlParameter[] param in detailParam)
                {
                    cmd.CommandText = detailSql;
                    //必须要清楚以前的参数
                    cmd.Parameters.Clear();
                    cmd.Parameters.AddRange(param);
                    cmd.ExecuteNonQuery();
                }
                //提交事务
                cmd.Transaction.Commit();
                return true;
            }
            catch (Exception ex)
            {
                if (cmd.Transaction != null)//判断事务是否执行
                {
                    //回滚事务
                    cmd.Transaction.Rollback();
                }
                //定义错误信息
                string errorInfo = "调用public static bool UpdateByTran(string mainSql, SqlParameter[] mainParam, string detailSql, List<SqlParameter[]> detailParam)方法时发生错误：" + ex.Message;
                //将异常信息写入日志
                WriteLog(errorInfo);
                //反馈 提示错误信息
                throw new Exception(errorInfo);
            }
            finally
            {
                if (cmd.Transaction != null)//判断事务是否执行
                {
                    cmd.Transaction = null;//清空事务
                }
                //关闭数据库连接
                conn.Close();
            }
        }

2、启用事务调用带参数的存储过程

/// <summary>
        /// 启用事务调用带参数的存储过程
        /// </summary>
        /// <param name="procedureName">存储过程名称</param>
        /// <param name="paramArray">存储过程参数数组集合</param>
        /// <returns>返回基于事务的存储过程调用是否成功</returns>
        public static bool UpdateByTran(string procedureName,List<SqlParameter[]> paramArray)
        {
            //初始化数据库连接
            SqlConnection conn = new SqlConnection(connString);
            //初始化带有sql语句和相应数据库的实例
            SqlCommand cmd = new SqlCommand();
            cmd.Connection = conn;
            try
            {
                //打开数据库连接
                conn.Open();
                cmd.CommandType = CommandType.StoredProcedure;//声明当前操作是调用存储过程
                cmd.CommandText = procedureName;
                //开始事务
                cmd.Transaction = conn.BeginTransaction();
                foreach (SqlParameter[] param in paramArray)
                {
                    //必须要清楚以前的参数
                    cmd.Parameters.Clear();
                    cmd.Parameters.AddRange(param);
                    cmd.ExecuteNonQuery();
                }
                //提交事务
                cmd.Transaction.Commit();
                return true;
            }
            catch (Exception ex)
            {
                if (cmd.Transaction != null)//判断事务是否执行
                {
                    //回滚事务
                    cmd.Transaction.Rollback();
                }
                //定义错误信息
                string errorInfo = "调用public static bool UpdateByTran(string procedureName,List<SqlParameter[]> paramArray)方法时发生错误：" + ex.Message;
                //将异常信息写入日志
                WriteLog(errorInfo);
                //反馈 提示错误信息
                throw new Exception(errorInfo);
            }
            finally
            {
                if (cmd.Transaction != null)//判断事务是否执行
                {
                    cmd.Transaction = null;//清空事务
                }
                //关闭数据库连接
                conn.Close();
            }
        }

以前都是用别人写好的SQLHelper类，这一次通过在网上学习然后自己动手尝试编写SQLHelper类，虽然自己还不完全熟练，但是内心也是很满足的，希望可以帮助到大家！