牛腩新闻发布系统：SQLHelper重构

前言：上一篇博客中我们提到了SQLHelper以及对其初步的使用，既然只是初步的使用，那么肯定有很多地方在标准上是不完善的，今天我们就来讲一讲如何将SQLHelper重构使其可用性更强。

 

首先我们看一下SQLHelper原来的代码：

/*
 * 创建人：任博扬
 * 创建时间：2019-6-2 11：33
 * 说明：数据库助手
 * 版权所有：牛腩@www.tg029.com(众志网)
 */
 
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using System.Data;
using System.Data.SqlClient;

namespace DAL
{
    public class SQLHelper
    {
        //该方法执行传入的SQL语句
        public static int test()
        {
            string connStr = "server=RBY;database=newssystem;uid=sa;pwd=123456";//数据库连接字符串
            SqlConnection conn = new SqlConnection(connStr);                    //创建数据库连接
            conn.Open();                                                        //打开连接
            string sql = "insert into category(name) values ('测试新闻')";       //sql语句                                                        
            SqlCommand cmd = new SqlCommand(sql, conn);                         //创建sql命令执行对象
            int res = cmd.ExecuteNonQuery();//ExecuteNonQuery()返回一个int型整数，在SQL Server中所执行的语句导致几行受影响，返回的整数就是几
            conn.Close();                                                       //关闭连接
            return res;
        }
    }
}

重构思路：

1.由于上一篇博客的目的是测试SQLHelper是否可用，因此方法名为test()，但实际这段代码是为了插入数据，而我们知道方法名是为了体现这个方法的作用，并且首字母都需要大写，因此我们将方法名改为ExecuteNonQuery()（PS：SQL语句中，ExecuteNonQuery用来执行增删改方法）

2.在开头我们就定义好各种对数据库进行调用的语句，后面再用到的时候就不需要加上前面的类名了：

private SqlConnection conn = null;
private SqlCommand cmd = null;
private SqlDataReader sdr = null;

3.另外，大部分情况下我们是需要在外部实例化SQLHelper的，而并非向我这样将方法定义成静态方法，因此我们将static删去，在SQLHelper中加入构造方法代码：

//构造方法重构SQLHelper
public SQLHelper()
{
        string connStr ="server=RBY;database=newssystem;uid=sa;pwd=123456";
        conn = new SqlConnection(connStr);//创建数据库连接
}

*目的：当我们在SQLHelper中有较多的方法时，这段构造方法就可以解决问题，如果重复写下创建数据库连接的代码，实在是显得太低级了...

4.既然将sql语句写在了方法外面，我们现在就要在ExecuteNonQuery()方法中写入参数sql：

public int ExecuteNonQuery(string sql)

5.打开连接与关闭连接的语句在每个方法中也会有重复，我们针对这两个问题做出重构。在视频中有两种思路：

5.1 打开连接，我们用GetConn()方法：

//打开数据库连接的方法
private SqlConnection GetConn()
{
        if(conn.State==ConnectionState.Closed)//如果连接为关闭状态
        {
            conn.Open();//打开连接
        }
        return conn;
}

关闭连接，我们使用try、catch和finally解决：

public int ExecuteNonQuery(string sql)
{
        int res;
        //检查异常
        try
        {
            cmd = new SqlCommand(sql, GetConn());//创建sql命令执行对象
            res = cmd.ExecuteNonQuery();//ExecuteNonQuery()返回一个int型整数，在SQL Server中所执行的语句导致几行受影响，返回的整数就是几
        }
        //处理异常
        catch (Exception ex)
        {
            //引发异常
            throw ex;
        }
        //无论是否异常都将执行
        finally
        {
            if(conn.State==ConnectionState.Open)
            {
                conn.Close();//关闭连接
            } 
        }                                                      
        return res;
}

 

5.2 加入了using方法（这里是另一个方法，是针对查询数据库的语句，不要和前面弄混）

public DataTable ExecuteQuery(string sql)
{
        DataTable dt = new DataTable();
        cmd = new SqlCommand(sql, GetConn());//创建sql命令执行对象
        //当运行完using里的代码后sdr会关闭，conn也会关闭
        using (sdr = cmd.ExecuteReader(CommandBehavior.CloseConnection))
        {
            dt.Load(sdr);
        }
        return dt;
}

6.最后，我们在sql语句上也可以继续重构：先添加Configuration的引用，之后再将sql语句放到XXX（自己的Web端的项目名）.config文件中（这个是可以从外部打开做修改的，如果我们不将这行代码放到外部，那么当SQL Server的用户名或密码做出修改时，我们整体的系统都需要在修改之后重新生成，这样是很耗费尽力的！）：

//构造方法重构SQLHelper
public SQLHelper()
{
        //将数据库连接字符串中的信息写入外部文档Web.config中，解耦
        string connStr = ConfigurationManager.ConnectionStrings["connStr"].ConnectionString;
        conn = new SqlConnection(connStr);//创建数据库连接
}

  <appSettings/>
  <connectionStrings>
    <add name="connStr" connectionString="server=RBY;database=newssystem;uid=sa;pwd=123456"/>
  </connectionStrings>

这样代码的冗余就会减少很多了。