.NET中封装SqlHelper

SqlHelper是一个基于.NET Framework的数据库操作组件，将操作数据库常用的方法封装到SqlHelper中，可以提高代码编写效率，减少冗余代码。下面将详细示例一个自己封装的SqlHelper，并展示如何使用它。

1、因为连接字符串可能会根据不同需求而经常发生改变，所以要在App.config的xml文件中写上连接字符串。当连接字符串发生改变时，无需更改项目中的源代码，只要更改配置文件即可。如下：

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
  <startup>
    <supportedRuntime version="v4.0" sku=".NETFramework,Version=v4.6.1" />
  </startup>
  <!--以下，是连接字符串-->
  <connectionStrings>
    <add  name="mssqlserver" connectionString="Data Source=fuqin-pc;Initial Catalog=PhoneNumManager;Integrated Security=true"/>
  </connectionStrings>
  <!--以上-->
</configuration>

2、创建一个类，命名为SqlHelper

3、封装SqlHelper。注意：封装ExecuteReader：因为这个方法涉及到连接池的问题。所以和以上的两种方法有一定的差别，放一段代码。在这里创建连接对象的时候不能using起来，using被翻译成try  {  }finally { }，在返回cmd.ExecuteReader的时候不能把连接关了，所以不能将SqlConnection conn = new SqlConnection(constr);给using起来。如果部using起来，那每次调用这个方法都会有一个对象放在连接池里面，所以可以在返回的cmd.ExecuteReader里面写上一个重载cmd.ExecuteReader(System.Data.CommandBehavior.CloseConnection);这样在返回的后关闭reader的同时将conn这个连接对象给关闭。由于创建连接对象的时候没有using起来，所以在返回的时候可能报异常，因此要将打开连接和返回这两条语句给try起来。

using System;
using System.Collections.Generic;
using System.Configuration;
using System.Data;
using System.Data.SqlClient;
using System.Linq;
using System.Text;
using System.Threading.Tasks;

namespace 绑定DataGridView
{
    /// <summary>
    /// 因为SqlHelper不需要创建对象，所以将其设置为静态类
    /// </summary>
    public static class SqlHelper
    {
        /*
         * 连接字符串只需要在类的内部被访问，且不能随意更改连接字符串的内容，所以将其设为私有的只读字段
         * ConfigurationManager类需要添加引用System.Configuration,并导入命名空间
         */
        private static readonly string constr = ConfigurationManager.ConnectionStrings["mssqlserver"].ConnectionString;
        /// <summary>
        /// 用来执行增删改的方法
        /// </summary>
        /// <param name="sql">要传入的sql语句</param>
        /// <param name="pms">sql语句中的参数</param>
        /// <returns>返回影响的行数</returns>
        public static int ExecuteNonQuery(string sql, params SqlParameter[] pms)
        {
            using (SqlConnection con = new SqlConnection(constr))
            {
                using (SqlCommand cmd = new SqlCommand(sql, con))
                {
                    if (pms != null)
                    {
                        cmd.Parameters.AddRange(pms);
                    }
                    con.Open();
                    return cmd.ExecuteNonQuery();
                }
            }
        }
        /*
         * 用来执行返回单个结果的方法
         */
        public static object ExecuteScalar(string sql, params SqlParameter[] pms)
        {
            using (SqlConnection con = new SqlConnection(constr))
            {
                using (SqlCommand cmd = new SqlCommand(sql, con))
                {
                    if (pms != null)
                    {
                        cmd.Parameters.AddRange(pms);
                    }
                    con.Open();
                    return cmd.ExecuteScalar();
                }
            }
        }
        /*
         * 用来执行返回多行多列的方法
         */
        public static SqlDataReader ExecuteReader(string sql, params SqlParameter[] pms)
        {
            SqlConnection con = new SqlConnection(constr);
            using (SqlCommand cmd = new SqlCommand(sql, con))
            {
                if (pms != null)
                {
                    cmd.Parameters.AddRange(pms);
                }
                try
                {
                    con.Open();
                    /*
                     * System.Data.CommandBehavior.CloseConnection这个枚举参数，表示将来使用完毕SqlDataReader后，在关闭reader的同时，在SqlDataReader内部会将关联的Connection对象也关闭掉
                     */
                    return cmd.ExecuteReader(System.Data.CommandBehavior.CloseConnection);
                }
                catch
                {
                    con.Close();
                    con.Dispose();
                    throw;
                }
            }
        }
        /*
         * ExecuteAdapter的方法,返回的类是DataTable的类型。
         */
        public static DataTable ExecuteDataTable(string sql, params SqlParameter[] pms)
        {
            DataTable dataTable = new DataTable();
            using (SqlDataAdapter adapter=new SqlDataAdapter(sql,constr))
            {
                if (pms != null) adapter.SelectCommand.Parameters.AddRange(pms);
                adapter.Fill(dataTable);
            }
            return dataTable;
        }
        
    }
}

至此，完成了整个SqlHelper的封装，类中共封装了四个常用的方法。