C#封装CRUD到SqlHelper类解读

1、简单说明一下，一般情况下，数据库连接字符串是在App.config文件中进行配置，然后再在代码中进行引用。因此，我们在这里先看一下App.config文件。

首先看需要添加的内容：

参数说明：

name：表示键值，在代码中需要通过这键值来找到对应的连接字符串信息。

connectionString：链接数据库的字符串信息。Server：数据库服务器，Database：数据库，uid：数据库账户名，pwd：数据库密码

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <startup>
        <supportedRuntime version="v4.0" sku=".NETFramework,Version=v4.5" />
    </startup>
  <!--这个写数据库链接配置信息，自己手动添加，严格区分大小写-->
  <connectionStrings>
    <add name="mssql" connectionString="Server=.;Database=db_test;uid=sa;pwd=123456"/>
  </connectionStrings>
  <!--这个写数据库链接配置信息，自己手动添加，严格区分大小写-->
</configuration>

2、接下就是代码了，介绍都在注释里，直接看代码吧。

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

namespace SQLHelper
{
    /// <summary>
    /// 为了方便调用，一般将SqlHelper类写为静态类
    /// </summary>
    public static class SqlHelper
    {
        //需要添加引用--框架，System.Configuration，添加再using
        private static readonly string conStr = ConfigurationManager.ConnectionStrings["mssql"].ConnectionString;
        /// <summary>
        /// 封装增加、删、改方法，方法名可以随便写，但是为了方便查看，用了和SqlCommand类一一样的方法名
        /// </summary>
        /// <param name="sql">SQL语句</param>
        /// <param name="pms">SQL参数，因为不知道会有多少个参数，所以用可变参数params</param>
        /// <returns>受影响的行数</returns>
        public static int ExecuteNonQuery(string sql, params SqlParameter[] pms)
        {

            using (SqlConnection conn = new SqlConnection(conStr))
            {
                using (SqlCommand cmd = new SqlCommand(sql, conn))
                {
                    if (pms != null)
                    {
                        cmd.Parameters.AddRange(pms);
                    }
                    conn.Open();

                    return cmd.ExecuteNonQuery();
                }
            }

        }

        /// <summary>
        /// 查询单个结果，一般和聚合函数 一起使用
        /// </summary>
        /// <param name="sql">查询的SQL语句</param>
        /// <param name="pms">SQL参数</param>
        /// <returns>返回查询对象，查询结果第一行第一列</returns>
        public static object ExecuteScalar(string sql, params SqlParameter[] pms)
        {

            using (SqlConnection conn = new SqlConnection(conStr))
            {
                using (SqlCommand cmd = new SqlCommand(sql, conn))
                {
                    if (pms != null)
                    {
                        cmd.Parameters.AddRange(pms);
                    }
                    conn.Open();

                    return cmd.ExecuteScalar();
                }
            }

        }

        /// <summary>
        /// 查询多行
        /// </summary>
        /// <param name="sql">SQL语句</param>
        /// <param name="pms">SQL参数</param>
        /// <returns>返回SqlDataReader对象</returns>
        public static SqlDataReader ExcuteReader(string sql, params SqlParameter[] pms)
        {

            //这里不能用using，不然在返回SqlDataReader时候会报错，因为返回时候已经在using中关闭了。
            //事实上，在使用数据库相关类中，SqlConnection是必须关闭的，但是其他可以选择关闭，因为CG回自动回收
            SqlConnection conn = new SqlConnection(conStr);
            using (SqlCommand cmd = new SqlCommand(sql, conn))
            {
                if (pms != null)
                {
                    cmd.Parameters.AddRange(pms);
                }
                try
                {
                    conn.Open();
                    //传入System.Data.CommandBehavior.CloseConnection枚举是为了让在外面使用完毕SqlDataReader后，只要关闭了SqlDataReader就会关闭对应的SqlConnection
                    return cmd.ExecuteReader(System.Data.CommandBehavior.CloseConnection);
                }
                catch
                {
                    conn.Close();
                    conn.Dispose();
                    throw;
                }
            }
        }
    }
}