SQLHelper类方法介绍及简单使用

引言

做.NET开发的话，想必大家对SQLHelper.cs这个类都不会陌生。很早之前微软就发布了SQLHelper.cs，如果想要了解它的详细信息可以参考我的另一篇博客：http://blog.csdn.net/u013201439/article/details/50700111。
SQLHelper.cs类中的方法有很多，刚接触的话会感觉无从下手，不知道从哪儿看起，今天的文章主要介绍SQLHelper类的方法，然后分析整理一下。

说明

SQLHelper.cs文件中包含了两个类，分别是SqlHelper和SqlHelperParameterCache。

//
public sealed class SqlHelper{}
public sealed class SqlHelperParameterCache{}

这两个类前面都用了sealed修饰符来修饰，表示其是一个密封类，不能作为基类，不能为其他类所继承。

SqlHelper 类提供了一组静态方法，可以用来向 SQL Server 数据库发出许多各种不同类型的命令。

SqlHelperParameterCache 类提供命令参数缓存功能，可以用来提高性能。该类由许多 Execute 方法（尤其是那些只运行存储过程的重写方法）在内部使用。数据访问客户端也可以直接使用它来缓存特定命令的特定参数集。

这次我们把SqlHelperParameterCache先放到一边，来分析SqlHelper类。

方法

SqlHelper

私有方法有四个，AssignParameterValues方法有一个重载：

AttachParameters：添加参数数组到指定的SqlCommand中
AssignParameterValues：为SqlParameters（参数）数组赋值
PrepareCommand：用于对SqlCommand（命令）的属性（如连接、事务环境等）进行初始化。

公有方法有十三个：这当中每个查询数据库的方法用到了大量的重载，每个方法用到了八个左右的重载。

ExecuteNonQuery

此方法用于执行不返回任何行或值的命令。这些命令通常用于执行数据库更新，但也可用于返回存储过程的输出参数。

ExecuteDataset

此方法返回DataSet对象，该对象包含由某一命令返回的结果集。

ExecuteReader

此方法用于返回SqlDataReader对象，该对象包含由某一命令返回的结果集。

ExecuteScalar

此方法返回一个值。该值始终是该命令返回的第一行的第一列。

ExecuteXmlReader

此方法返回 FOR XML 查询的 XML 片段。

FillDataset

此方法向DataSet填充数据。

UpdateDataset

此方法用于执行向DataSet增、删、改的命令。

CreateCommand

此方法用于创建SqlCommand。

分析

下面我们以ExecuteNonQuery()方法为例来分析下：

我们上面看到的是ExecuteNonQuery()的九个重载方法，其中前三个是准备查询，中间三个是执行查询，后面三个则是用于SQL事务查询。再细分，#2-1执行的是无参数的SQL语句，而#2-2执行的是包含参数数组的SQL语句（参数数组可以为空），#2-3执行的则是无返回值的存储过程。实际上，#1-1和#1-3重载是为了方便无参数的SQL语句，而#1-3和#2-3重载只是为了方便调用存储过程，他们的本质还是和#1-2和#2-2一样。下面是针对重载方法的一些简单使用。

下面我们会使用ExecuteNonQuery来执行带参数的SQL语句，可以通过F11来逐语句来查看执行过程，会有助于我们理解SQLHelper类的使用。

#region RegisterUser 注册用户
        /// <summary>
        /// 注册用户
        /// </summary>
        /// <param name="userinfo">userinfo实体</param>
        /// <returns>注册成功返回True，失败返回False</returns>
        public bool RegisterUser(JFEntity.UserInfo userinfo)
        {
            string sql = @"INSERT INTO T_User VALUES(@userID,@userName,@userSex,@userPassword,@userLevel)";
            SqlParameter[] sqlparamter = new SqlParameter[] 
            {
                new SqlParameter("@userID", SqlDbType.Int),
                new SqlParameter("@userName", SqlDbType.Char,30),
                new SqlParameter("@userSex", SqlDbType.Char,6),
                new SqlParameter("@userPassword", SqlDbType.Char,16),
                new SqlParameter("@userLevel", SqlDbType.Char,8),
            };
            sqlparamter[0].Value = userinfo.userID;
            sqlparamter[1].Value = userinfo.userName;
            sqlparamter[2].Value = userinfo.userSex;
            sqlparamter[3].Value = userinfo.userPassword;
            sqlparamter[4].Value = userinfo.userLevel;
            int result = SqlHelper.ExecuteNonQuery(SqlHelper.connectionString, CommandType.Text, sql, sqlparamter);
            if (result != 0)
            {
                return true;//注册成功
            }
            else
            {
                return false;//注册失败
            }
        }
        #endregion

小结

我们常用到的方法有：
ExecuteNonQuery()
ExecuteDataset()
ExecuteReader()
ExecuteScalar()

参考资料：
sqlhelper 使用指南
SqlHelper类中文注释和使用方法