牛腩——SQLhelper

前言

机房重构的时候用到了sqlhelper，现在学习牛腩又重新接触到了sqlhelper。机房的时候知道slqherlper要写4个方法，一个查询的，一个增删改的，这两个都分带参数和不带参数两种情况。但是没有想过为什么每个方法要传一个string类型的语句，一个类型，和参数。这次牛腩老师展示了sqlhelper从初级到一步步重构成完美助手类的过程。

Step 1: SQL and Connection

其实sqlhelper就是把D层每个方法都要连接数据库，到数据库里执行增删查改的基础操作给抽象出一个类。符合面向对象的思想。

能使sql运行起来最基础，最简陋 ，最本质的东西就是建好connection连接并打开，写好sql语句，并把这两个东西当做参数传给一个叫SqlCommand的鬼东西。

 string connstr = @"server = bonie\sqlexpress;database = NewsSystem; uid = sa; pwd = summer";
 SqlConnection conn = new SqlConnection(connstr);
 conn.Open();
 SqlCommand cmd = new SqlCommand(sql, conn);
 res = cmd.ExecuteNonQuery();

这里写代码片

Step 2: 改造Connection

把Connection写到构造函数里

sqlhelper里的四个方法都要创建connetion连接并打开。在vb.net中可以把这些公共用到的东西写到类的最开始，在C#里让类初始化的时候就执行的东西需要写到构造函数里。
把打开connection写成一个方法，就像单例一样，保证在connection没有打开的情况下打开connection。

 public class SQLHelper
        {
            //把方法都用到的连接，命令都写到构造函数中
            private SqlConnection conn = null;
            private SqlCommand cmd = null;
            private SqlDataReader sdr = null;
            public SQLHelper()
            {
                string connstr = @"server = bonie\sqlexpress;database = NewsSystem; uid = sa; pwd = summer";
                SqlConnection conn = new SqlConnection(connstr);
            }
       //把创建打开连接抽出来
        private SqlConnection GetConn()
        {
            if (conn.State == ConnectionState.Closed)
            {
                conn.Open();
            }
            return conn;
        }


  public int ExecuteNonQuery(string cmdText, CommandType cmdType)
{
      int res;
      try
      {
          using (SqlCommand cmd = new SqlCommand(cmdText, GetConn()))
          {
              cmd.CommandType = cmdType;
              res = cmd.ExecuteNonQuery();
          }

加入配置文件

进一步解耦，把connectionstring 写到web的config里面。

<configuration>
  <add name ="connStr" connectionString ="server = bonie\sqlexpress;database = NewsSystem; uid = sa; pwd = summer"/>
</configuration>

改过后的SQLhelper

 public class SQLHelper
        {
            #region 构造函数初始化命令字符串，并应用配置文件

            //构造函数初始化命令字符串，并应用配置文件
            private SqlConnection conn = null;
            private SqlCommand cmd = null;
            private SqlDataReader sdr = null;
            public SQLHelper()
            {
                string connStr = ConfigurationManager.ConnectionStrings["connStr"].ConnectionString;
                SqlConnection conn = new SqlConnection(connStr);
            }

Step3: 改造sql

之前传入这四个方法的就是一个sql语句。sql用拼接字符串容易造成sql注入，所以sql里要加入参数SQLParameter。此外，D层传入不仅知识sql语句也可以是存储过程，所以这四个方法还要加入一个参数就是commandtype。

   #region 该方法执行带参数的增删改命令内容
            /// <summary>
            ///  该方法执行带参数的增删改命令内容
            /// </summary>
            /// <param name="cmdText">增删改命令内容</param>
            /// <param name="cmdType">命令类型</param>
            /// <param name="paras">参数集合</param>
            /// <returns>返回更新的记录数</returns>
            public int ExecuteNonQuery(**string cmdText, CommandType cmdType, SqlParameter[] paras**)
            {
                int res;
                try
                {
                    using (cmd = new SqlCommand(cmdText, GetConn()))
                    {
                        cmd.Parameters.AddRange(paras);
                        cmd.CommandType = cmdType;
                        res = cmd.ExecuteNonQuery();
                    }
                }
                catch (Exception ex)
                {
                    throw ex;
                }
                finally
                {
                    if (conn.State == ConnectionState.Open)
                    {
                        conn.Close();
                    }
                }

                return res;
            }
            #endregion

补充-关闭连接

除了上面的try catch 方法，在查询方法中可以用using来关闭connection 。

     //用using sdr执行完会自动释放资源，并且连带conn 也会关闭
                using (sdr = cmd.ExecuteReader(CommandBehavior.CloseConnection))
                {
                    dt.Load(sdr);
                }

                return dt;
            }

小结

看了牛腩，像是观看了丑小鸭变天鹅的一个过程。一开始的代码肯定是以实现主要功能为主，小鸭虽丑，五脏俱全；然后就是一步步的整容了，就变成白天鹅了。（总结出一条真理：重构就是整容。）