【机房重构】sqlHelper

    机房重构中每一个功能都会涉及到对数据库的访问，在D层中会发现有很多重复的代码，在第一次敲机房的时候一些简单的重复一般封装成一个函数进行调用，这次机房重构也是一样把一些重复的代码进行封装以减少代码量。

    如何进行封装就要看一下这些重复的代码是什么，在机房中每个功能是如何与数据库打交道的，通过对机房中每个功能与数据库的交互得到下面四种情况。

  1.带有参数的增删改操作，例如机房收费系统中的充值，返回值为DataTable。

  2没有参数的增删改操作，例如机房中的注册功能。

  3.带有参数的查询操作，例如机房中的查询卡号是否存在，返回值为Boolean.

  4.没有参数的查询操作，例如机房中的查询基本数据，返回值为Boolean.

   下面我们就详细的看一下sqlHelper的内容

Imports System.Data
Imports System.Data.SqlClient
Imports System.Configuration

'************************************************* 
'作者：www  
'说明：封装增删改查的操作，在DAL层之间调用即可
'创建日期：2015-3-29
'版本号：1.00
'**********************************************

Public Class sqlHelper

    '定义变量 
    '获得数据库连接字符串
    Private ReadOnly strConnection As String = ConfigurationSettings.AppSettings("ConnStr")
    '设置连接
    Dim conn As SqlConnection = New SqlConnection(strConnection)
    '定义cmd 命令
    Dim cmd As New SqlCommand

    ''' <summary>
    ''' 执行增删改三个操作，（有参）返回值为Boolean类型，确认是否执行成功
    ''' </summary>
    '''<param name="cmdText">需要执行语句，一般是Sql语句，也有存储过程</param>
    ''' <param name="paras">参数数组，无法确认有多少参数</param>
    ''' <returns></returns>
    '''<remarks>2015-3-29 14:47:15</remarks>
    Public Function ExecAddDelUpdate(ByVal cmdText As String, ByVal cmdType As CommandType, ByVal paras As SqlParameter()) As Boolean
        '将传入的值，分别为cmd的属性赋值
        cmd.Parameters.AddRange(paras)         '将参数传入
        cmd.CommandType = cmdType              '设置一个值，解释cmdText
        cmd.Connection = conn                  '设置连接，全局变量 
        cmd.CommandText = cmdText              '设置查询的语句

        Try
            conn.Open()                      '打开连接
            Return cmd.ExecuteNonQuery()     '执行增删改操作
            cmd.Parameters.Clear()          '清除参数
        Catch ex As Exception
            MsgBox(ex.Message, , "数据库操作") '如果出错，返回0
            Return False
        Finally
            Call CloseConn(conn)
            Call CloseCmd(cmd)
        End Try
    End Function
    ''' <summary>
    ''' 执行增删改三个操作，（无参）返回值为Boolean类型，确认是否执行成功
    ''' </summary>
    '''<param name="cmdText">需要执行语句，一般是Sql语句，也有存储过程</param>
    ''' <returns>Interger,受影响的行数</returns>
    '''<remarks>2015-3-29 16:37:37</remarks>
    Public Function ExecAddDelUpdateNo(ByVal cmdText As String, ByVal cmdType As CommandType) As Boolean
        '为要执行的命令cmd赋值
        cmd.CommandText = cmdText    '先是查询的sql语句
        cmd.CommandType = cmdType    '设置Sql语句如何解释
        cmd.Connection = conn '设置连接
        '执行操作
        Try
            conn.Open()
            Return cmd.ExecuteNonQuery()

        Catch ex As Exception
            MsgBox(ex.Message, , "数据库操作") '如果出错，返回0
            Return False
        Finally
            Call CloseConn(conn)
            Call CloseCmd(cmd)
        End Try
    End Function

    ''' <summary>
    ''' 执行查询操作，（有参），返回值为datatable类型，参数不限
    ''' </summary>
    '''<param name="cmdText">需要执行语句，一般是Sql语句，也有存储过程</param>
    '''<param name="paras">传入的参数</param> 
    ''' <returns></returns>
    '''<remarks>2015-3-29 16:40:16</remarks>
    Public Function ExecSelect(ByVal cmdText As String, ByVal cmdType As CommandType, ByVal paras As SqlParameter()) As DataTable

        Dim sqlAdapter As SqlDataAdapter
        Dim dt As New DataTable
        Dim ds As New DataSet

        '给cmd赋值
        cmd.CommandText = cmdText
        cmd.CommandType = cmdType
        cmd.Connection = conn
        cmd.Parameters.AddRange(paras)  '参数添加
        sqlAdapter = New SqlDataAdapter(cmd)   '实例化adapter
        Try
            sqlAdapter.Fill(ds)  '用adapter将dataset填充
            dt = ds.Tables(0)
            cmd.Parameters.Clear()

        Catch ex As Exception
            'MsgBox(" 查询失败", CType(vbOKOnly + MsgBoxStyle.Exclamation, MsgBoxStyle), "警告")
            MsgBox(ex.Message, , "数据库操作")  '如果出错，返回0

        Finally
            Call CloseCmd(cmd)
        End Try
        Return dt

    End Function
    ''' <summary>
    ''' 执行查询操作，（无参），返回值为datatable类型
    ''' </summary>
    '''<param name="cmdText">需要执行语句，一般是Sql语句，也有存储过程</param>
    '''<param name="cmdType">判断Sql语句的类型，一般都不是存储过程</param> 
    ''' <returns>dataTable,查询到的表格</returns>
    '''<remarks>2015-3-29 17:00:23</remarks>
    Public Function ExecSelectNo(ByVal cmdText As String, ByVal cmdType As CommandType) As DataTable
        Dim sqlAdapter As SqlDataAdapter
        Dim dt As New DataTable
        Dim ds As New DataSet
        '给cmd赋值
        cmd.CommandText = cmdText
        cmd.CommandType = cmdType
        cmd.Connection = conn
        sqlAdapter = New SqlDataAdapter(cmd)  '实例化adapter
        Try
            sqlAdapter.Fill(ds)     '用adapter将dataset填充
            dt = ds.Tables(0)       'datatable为dataSet的第一个表
        Catch ex As Exception
            MsgBox(ex.Message, , "数据库操作")  '如果出错，返回0
        Finally
            Call CloseCmd(cmd)

        End Try
        Return dt
    End Function

    ''' <summary>
    ''' 关闭连接
    ''' </summary>
    '''<param name="conn ">需要关闭的连接</param>
    '''<remarks>2015-3-29 17:22:31</remarks>
    Public Sub CloseConn(ByVal conn As SqlConnection)
        If (conn.State <> ConnectionState.Closed) Then '如果没有关闭
            conn.Close()                               '关闭连接
            conn = Nothing                             '不指向原对象
        End If
    End Sub
    ''' <summary>
    ''' 关闭命令
    ''' </summary>
    '''<param name="cmd ">需要关闭的命令 </param>
    '''<remarks>2015-3-29 17:22:31</remarks>
    Public Sub CloseCmd(ByVal cmd As SqlCommand)
        If Not IsNothing(cmd) Then  '如果cmd命令存在
            cmd.Dispose()           '销毁
            cmd = Nothing
        End If
    End Sub
End Class

    sqlHelper将这些方法进行封装，使用时只需在D层中进行调用即可，有参数的要进行传参，以有参数的插入为例，代码如下：

<span style="font-family:KaiTi_GB2312;font-size:24px;"> Sql = "Insert into Card_Info(CardNo,StudentNo,RegisterDate,RegisterTime,Balance,IsCheck,userID,Type,Status) Values(@CardNo,@StudentNo,@Date,@Time,@Balance,@Check,@ID,@Type,@Status)"
            table = sqlHelper.ExecAddDelUpdate(Sql, CommandType.Text, sqlParams)</span>

总结：

    当写代码一直进行重复性的工作时就要想想有没有解决的方法，我们要注意减少代码的重复量。机房重构中还有很多值得我我们思考的地方，哪些地方可以使用设计模式，怎么样去进行解耦，怎么样封装更好，值得我们好好的去思考体会。