机房重构之SqlHelper应用

由于机房重构过程中每个功能的实现都会涉及到数据库的链接访问，代码重复率非常高，耗时耗力，还会使系统出现代码冗余，是一件非常讨人厌的工作。进而把这些重复的代码抽象成一个类，以直接调用的方式来满足需求。

SqlHelper是一个基于·NET Framework的数据库操作组件，组件中包含数据库操作方法。SqlHelper用于简化重复的去写那些数据库连接（SqlConnection）,SqlCommand,SqlDataReader等等。SqlHelper 封装后通常是只需要给方法传入一些参数如数据库连接字符串、SQL参数等，就可以访问数据库了。

这是最近的知识的梳理，初次使用，总结的比较简单，欢迎斧正。

SqlHelper中有两种方法，对数据库的查询和增删改，每种方法都有有参和无参两大类：

以下是在本次机房重构中SqlHelper的代码：

Imports System.Data
Imports System.Data.SqlClient
Imports System.Configuration          '添加必要引用

Public Class SqlHelper
 '定义变量
    '获得数据库链接字符串
    Private ReadOnly strConnection As String = ("server=192.168.24.68;Database=机房重构.NET;User=sa;Password=123456;")
   '设置链接
    Dim conn As SqlConnection = New SqlConnection(strConnection)
    '定义Command命令
    Dim cmd As New SqlCommand
    ' <summary>    
    ' 执行增删改三个操作,(有参)返回值为Boolean类型,确认是否执行成功    
    ' </summary>    
    ' <param name="cmdText">需要执行语句,一般是Sql语句,也有存储过程</param>    
    ' <param name="cmdType">判断Sql语句的类型,一般都不是存储过程</param>    
    ' <param name="paras">参数数组,无法确认有多少参数</param>    
    ' <returns></returns>    
    ' <remarks></remarks>
    Public Function ExecAddDelUpdate(ByVal cmdText As String, ByVal cmdType As CommandType, ByVal paras As SqlParameter()) As Integer
        '将传入的值，分别为cmd的属性赋值
        cmd.Parameters.AddRange(paras)        '将参数传入
        cmd.CommandType = cmdType             '设置一个值，解释cmdText
        cmd.Connection = conn                 '设置连接，全局变量
        cmd.CommandText = cmdText             '设置SQL语句
        Try
            conn.Open()                       '打开链接
            Return cmd.ExecuteNonQuery()      '执行增删改操作
        Catch ex As Exception
            Throw                         '如果出错就抛出
        Finally
            cmd.Parameters.Clear()            '清除参数
            Call CloseConn(conn)
            Call CloseCmd(cmd)
        End Try
    End Function

    ' <summary>    
    ' 执行增删改三个操作,(无参)    
    ' </summary>    
    ' <param name="cmdText">需要执行语句,一般是Sql语句,也有存储过程</param>    
    ' <param name="cmdType">判断Sql语句的类型,一般都不是存储过程</param>    
    ' <returns>Interger,受影响的行数</returns>    
    ' <remarks>2013年2月2日8:19:59</remarks>   

 Public Function ExecAddDelUpdateNo(ByVal cmdText As String, ByVal cmdType As CommandType) As Integer

        '为要执行的命令cmd赋值
        cmd.CommandText = cmdText               '传入查询语句
        cmd.CommandType = cmdType               '设置Sql语句如何解释
        cmd.Connection = conn                   '设置连接

        '执行操作
        Try
            conn.Open()
            Return cmd.ExecuteNonQuery
        Catch ex As Exception
            Return 0
        Finally
            Call CloseConn(conn)
            Call CloseCmd(cmd)
        End Try

    End Function
    ' <summary>    
    ' 执行查询的操作,(有参),参数不限    
    ' </summary>    
    ' <param name="cmdText">需要执行语句,一般是Sql语句,也有存储过程</param>    
    ' <param name="cmdType">判断Sql语句的类型,一般都不是存储过程</param>    
    ' <param name="paras">传入的参数</param>    
    ' <returns></returns>    
    ' <remarks></remarks> 

    Public Function ExecSeletct(ByVal cmdText As String, ByVal cmdType As CommandType, ByVal paras As SqlParameter()) As DataTable

        Dim sqlAdpter As SqlDataAdapter            '是 DataSet和 SQL Server之间的桥接器，用于检索和保存数据
        Dim dt As New DataTable
        Dim ds As New DataSet

        '还是给cmd赋值
        cmd.CommandText = cmdText                  '设置查询语句
        cmd.CommandType = cmdType                  '设置Cmd对象的类型
        cmd.Connection = conn                      '数据库连接语句
        cmd.Parameters.AddRange(paras)             '传入参数
        sqlAdpter = New SqlDataAdapter(cmd)        '实例化适配器

        Try
            sqlAdpter.Fill(ds)                     '用adapter将dataSet填充
            dt = ds.Tables(0)                      'dataTable是dataSet的第一个表
            cmd.Parameters.Clear()                 '清除参数
        Catch ex As Exception
            MsgBox("查询失败", CType(vbOKOnly + MsgBoxStyle.Exclamation, MsgBoxStyle), "警告！")
        Finally
            Call CloseCmd(cmd)                     '最后一定要释放cmd
        End Try

        Return dt      '返回查到的数据

    End Function

    ' <summary>    
    ' 执行查询的操作,(无参)    
    ' </summary>    
    ' <param name="cmdText">需要执行语句,一般是Sql语句,也有存储过程</param>    
    ' <param name="cmdType">判断Sql语句的类型,一般都不是存储过程</param>    
    ' <returns>dataTable,查询到的表格</returns>    
    ' <remarks></remarks>   

    Public Function ExecSelectNo(ByVal cmdText As String, ByVal cmdType As CommandType) As DataTable

        Dim sqlAdapter As SqlDataAdapter
        Dim ds As New DataSet

        '给cmd赋值
        cmd.CommandText = cmdText
        cmd.CommandType = cmdType
        cmd.Connection = conn

        sqlAdapter = New SqlDataAdapter(cmd)         '实例化适配器

        Try
            sqlAdapter.Fill(ds)                      '用adapter将dataSet填充
            Return ds.Tables(0)                      '返回dataSet的第一个表
        Catch ex As Exception
            Return Nothing
        Finally
            Call CloseCmd(cmd)                       '关闭cmd
        End Try

    End Function

    ' <summary>    
    ' 关闭连接    
    ' </summary>    
    ' <param name="conn">需要关闭的连接</param>    
    ' <remarks></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></remarks>    

    Public Sub CloseCmd(ByVal cmd As SqlCommand)

        If Not IsNothing(cmd) Then                      '如果cmd命令还存在
            cmd.Dispose()                               '释放资源
            cmd = Nothing                               '不指向原对象
        End If

    End Sub

End Class