【转】C# 通用数据访问类（SqlHelper）

注:本文转自http://www.tzwhx.com/newOperate/html/3/31/312/13080.html
Visual C# 动态操作 SQL Server 数据库实例教程：通用数据访问类（SqlHelper）

本文介绍的通用数据库访问类，是本人的个人网站实际使用的一个基类，它是一组通用的访问数据库的代码集，在本人网站对数据库的访问绝大部分都使用这一个类。其主要功能有：

1.判断数据库是否存在？

2.判断数据库表是否存在？

3.判断数据库存储过程是否存在？

4.判断视图是否存在？

5.自动创建数据库

6.自动创建数据库表、存储过程

7.不带参数的 SQL 语句ExecuteNonQuery的执行方法

8.执行一条不返回结果的SqlCommand。通过指定专用的连接字符串，执行一个不需要返回值的SqlCommand命令。

9.执行一条不返回结果的SqlCommand。通过一个已经存在的数据库事件处理

10执行一条不返回结果的SqlCommand，通过一个已经存在的数据库事物处理

11.执行一条返回结果集的SqlCommand命令，通过专用的连接字符串。

12.执行一条返回第一条记录第一列的SqlCommand命令，通过专用的连接字符串。

13.执行一条返回第一条记录第一列的SqlCommand命令，通过已经存在的数据库连接。

其代码清单如下：

using System;
using System.Data;
using System.Configuration;
using System.Web;
using System.Web.Security;
using System.Collections;
using System.Data.SqlClient;

///

/// 数据库的通用访问代码
/// 此类为抽象类，不允许实例化，在应用时直接调用即可
///

public abstract class SqlHelper
{
//获取数据库连接字符串，其属于静态变量且只读，项目中所有文档可以直接使用，但不能修改
public static readonly string ConnectionStringLocalTransaction = ConfigurationManager.ConnectionStrings["MysqldataConnectionString"].ConnectionString;

// 哈希表用来存储缓存的参数信息，哈希表可以存储任意类型的参数。
private static Hashtable parmCache = Hashtable.Synchronized(new Hashtable());

///

///判断数据库是否存在
/// 通过指定专用的连接字符串，执行一个不需要返回值的SqlCommand命令。
///

///
/// 使用示例：
/// bool databaseExist = SqlHelper.CheckExistsDatebase(dataBaseNameStr);
///
///
///
public static bool CheckExistsDatebase(string dataBaseName)
{
string connstring = SqlHelper.ConnectionStringLocalTransaction;
String dataBaseNameStr = "select count(1) From master.dbo.sysdatabases where name='" + dataBaseName + "'";
using (SqlConnection con = new SqlConnection(connstring))
{

con.Open();
SqlCommand cmd = new SqlCommand(dataBaseNameStr, con);
int result = Convert.ToInt32(cmd.ExecuteScalar());
if (result == 0)
{
return false;
}
else
{
return true;
}
}
}
///

返回页头
///判断数据库表是否存在
/// 通过指定专用的连接字符串，执行一个不需要返回值的SqlCommand命令。
///

///
/// 使用示例：
/// bool databaseExist = SqlHelper.CheckExistsDatebase(dataBaseNameStr);
///
///
///
public static bool CheckExistsTable(string dataBaseNameStr, string tablename)
{
string connstring = "server=“服务器名”;database='" + dataBaseNameStr + "'" + ";Trusted_Connection=SSPI";
String tableNameStr = "select count(1) from sysobjects where name = '" + tablename + "'";
using (SqlConnection con = new SqlConnection(connstring))
{
con.Open();
SqlCommand cmd = new SqlCommand(tableNameStr, con);
int result = Convert.ToInt32(cmd.ExecuteScalar());
if (result == 0)
{
return false;
}
else
{
return true;
}
}
}
///

返回页头
///判断数据库存储过程是否存在
/// 通过指定专用的连接字符串，执行一个不需要返回值的SqlCommand命令。
///

///
/// 使用示例：
/// bool databaseExist = SqlHelper.CheckExistsDatebase(dataBaseNameStr);
///
///
///
///
public static bool CheckExistsProc(string dataBaseNameStr, string procName)
{
string connstring = "server=“服务器名”;database='" + dataBaseNameStr + "'" + ";Trusted_Connection=SSPI";
//String procNameStr = "select count(1) from sysobjects where name = '" + procName + "'";
String procNameStr = "select count(1) from sysobjects where name = '" + procName + "'" + " AND type = 'P'";
using (SqlConnection con = new SqlConnection(connstring))
{
con.Open();
SqlCommand cmd = new SqlCommand(procNameStr, con);
int result = Convert.ToInt32(cmd.ExecuteScalar());
if (result == 0)
{
return false;
//不存在
}
else
{
con.Close();
return true;
//存在
}
}
}
///

返回页头
///判断视图是否存在
///

///
/// 使用示例：
/// bool databaseExist = SqlHelper.CheckExistsDatebase(dataBaseNameStr);
///
///
///
///
public static bool CheckExistsView(string dataBaseNameStr, string tablename, string ViewName)
{
string connstring = "server=“服务器名”;database='" + dataBaseNameStr + "'" + ";Trusted_Connection=SSPI";
String viewNameStr = "select count(1) from sysobjects where name = '" + ViewName + "'" + " AND type = 'V'";
using (SqlConnection con = new SqlConnection(connstring))
{
con.Open();
SqlCommand cmd = new SqlCommand(viewNameStr, con);
int result = Convert.ToInt32(cmd.ExecuteScalar());
if (result == 0)
{
return false;
//不存在
}
else
{
con.Close();
return true;
//存在
}
}
}
///

返回页头
///调用ExecuteNonQuery()执行 创建数据库
/// 通过指定专用的连接字符串，执行一个不需要返回值的SqlCommand命令。
///

///
/// 使用示例：
/// SqlHelper.CreateSqlDatabase(connstring, "master", CreateStr);
///
///
///
///
///
public static bool CreateSqlDatabase(string connstring, string DatabaseName, string CreateStr)
{
//
using (SqlConnection conn = new System.Data.SqlClient.SqlConnection(connstring))
{
SqlCommand Command = new System.Data.SqlClient.SqlCommand(CreateStr, conn);
conn.Open();
Command.Connection.ChangeDatabase(DatabaseName);
try
{
Command.ExecuteNonQuery();
}
catch (System.Exception ex)
{
Command.Connection.Close();
throw ex;
}
finally
{
Command.Connection.Close();
}
}
return true;
}
///

///调用ExecuteNonQuery()执行 创建数据库表、存储过程
/// 通过指定专用的连接字符串，执行一个不需要返回值的SqlCommand命令。
///

///
/// 使用示例：
/// SqlHelper.CreateSqlTable(connstring, TableStr);
///
///
///
///
public static bool CreateSqlTable(string connstring, string CreateStr)
{
//
using (SqlConnection conn = new SqlConnection(connstring))
{
SqlCommand Command = new SqlCommand(CreateStr, conn);
conn.Open();
try
{
Command.ExecuteNonQuery();
return true;
}
catch (System.Exception ex)
{
return false;
}
finally
{
Command.Connection.Close();
}
}
}

///

///不带参数的 SQL 语句ExecuteNonQuery的执行方法
/// 通过指定专用的连接字符串，执行一个不需要返回值的SqlCommand命令。
/// 使用参数数组形式提供参数列表
///

///
/// 使用示例：
/// int result = ExecuteNonQuery(connString, CommandType.StoredProcedure, "PublishOrders", new SqlParameter("@prodid", 24));
///
///
///
///
///
/// 返回一个数值表示此SqlCommand命令执行后影响的行数
public static int ExecuteNonQuery(string connectionString, CommandType cmdType, string cmdText, params SqlParameter[] commandParameters)
{

SqlCommand cmd = new SqlCommand();
using (SqlConnection conn = new SqlConnection(connectionString))
{
//通过PrePareCommand方法将参数逐个加入到SqlCommand的参数集合中
PrepareCommand(cmd, conn, null, cmdType, cmdText, commandParameters);
int val = cmd.ExecuteNonQuery();

//清空SqlCommand中的参数列表
cmd.Parameters.Clear();
return val;
}
}

///

///执行一条不返回结果的SqlCommand，通过一个已经存在的数据库连接
/// 使用参数数组提供参数
///

///
/// 使用示例：
/// int result = ExecuteNonQuery(conn, CommandType.StoredProcedure, "PublishOrders", new SqlParameter("@prodid", 24));
///
///
///
///
///
/// 返回一个数值表示此SqlCommand命令执行后影响的行数
public static int ExecuteNonQuery(SqlConnection connection, CommandType cmdType, string cmdText, params SqlParameter[] commandParameters)
{

SqlCommand cmd = new SqlCommand();

PrepareCommand(cmd, connection, null, cmdType, cmdText, commandParameters);
int val = cmd.ExecuteNonQuery();
cmd.Parameters.Clear();
return val;
}

///

/// 执行一条不返回结果的SqlCommand，通过一个已经存在的数据库事物处理
/// 使用参数数组提供参数
///

///
/// 使用示例：
/// int result = ExecuteNonQuery(trans, CommandType.StoredProcedure, "PublishOrders", new SqlParameter("@prodid", 24));
///
///
///
///
///
/// 返回一个数值表示此SqlCommand命令执行后影响的行数
public static int ExecuteNonQuery(SqlTransaction trans, CommandType cmdType, string cmdText, params SqlParameter[] commandParameters)
{
SqlCommand cmd = new SqlCommand();
PrepareCommand(cmd, trans.Connection, trans, cmdType, cmdText, commandParameters);
int val = cmd.ExecuteNonQuery();
cmd.Parameters.Clear();
return val;
}

///

/// 执行一条返回结果集的SqlCommand命令，通过专用的连接字符串。
/// 使用参数数组提供参数
///

///
/// 使用示例：
/// SqlDataReader r = ExecuteReader(connString, CommandType.StoredProcedure, "PublishOrders", new SqlParameter("@prodid", 24));
///
///
///
///
///
/// 返回一个包含结果的SqlDataReader
public static SqlDataReader ExecuteReader(string connectionString, CommandType cmdType, string cmdText, params SqlParameter[] commandParameters)
{
SqlCommand cmd = new SqlCommand();
SqlConnection conn = new SqlConnection(connectionString);

// 在这里使用try/catch处理是因为如果方法出现异常，则SqlDataReader就不存在，
//CommandBehavior.CloseConnection的语句就不会执行，触发的异常由catch捕获。
//关闭数据库连接，并通过throw再次引发捕捉到的异常。
try
{
PrepareCommand(cmd, conn, null, cmdType, cmdText, commandParameters);
SqlDataReader rdr = cmd.ExecuteReader(CommandBehavior.CloseConnection);
cmd.Parameters.Clear();
return rdr;
}
catch
{
conn.Close();
throw;
}
}

///

/// 执行一条返回第一条记录第一列的SqlCommand命令，通过专用的连接字符串。
/// 使用参数数组提供参数
///

///
/// 使用示例：
/// Object obj = ExecuteScalar(connString, CommandType.StoredProcedure, "PublishOrders", new SqlParameter("@prodid", 24));
///
///
///
///
///
/// 返回一个object类型的数据，可以通过 Convert.To{Type}方法转换类型
public static object ExecuteScalar(string connectionString, CommandType cmdType, string cmdText, params SqlParameter[] commandParameters)
{
SqlCommand cmd = new SqlCommand();

using (SqlConnection connection = new SqlConnection(connectionString))
{
PrepareCommand(cmd, connection, null, cmdType, cmdText, commandParameters);
object val = cmd.ExecuteScalar();
cmd.Parameters.Clear();
return val;
}
}

///

/// 执行一条返回第一条记录第一列的SqlCommand命令，通过已经存在的数据库连接。
/// 使用参数数组提供参数
///

///
/// 使用示例：
/// Object obj = ExecuteScalar(connString, CommandType.StoredProcedure, "PublishOrders", new SqlParameter("@prodid", 24));
///
///
///
///
///
/// 返回一个object类型的数据，可以通过 Convert.To{Type}方法转换类型
public static object ExecuteScalar(SqlConnection connection, CommandType cmdType, string cmdText, params SqlParameter[] commandParameters)
{

SqlCommand cmd = new SqlCommand();

PrepareCommand(cmd, connection, null, cmdType, cmdText, commandParameters);
object val = cmd.ExecuteScalar();
cmd.Parameters.Clear();
return val;
}

///

/// 缓存参数数组
///

///
///
public static void CacheParameters(string cacheKey, params SqlParameter[] commandParameters)
{
parmCache[cacheKey] = commandParameters;
}

///

/// 获取被缓存的参数
///

///
/// 返回缓存的参数数组
public static SqlParameter[] GetCachedParameters(string cacheKey)
{
SqlParameter[] cachedParms = (SqlParameter[])parmCache[cacheKey];

if (cachedParms == null)
return null;

//新建一个参数的克隆列表
SqlParameter[] clonedParms = new SqlParameter[cachedParms.Length];

//通过循环为克隆参数列表赋值
for (int i = 0, j = cachedParms.Length; i < j; i++)
//使用clone方法复制参数列表中的参数
clonedParms[i] = (SqlParameter)((ICloneable)cachedParms[i]).Clone();

return clonedParms;
}

///

/// 为执行命令准备命令参数
///

///
///
///
///
///
///
private static void PrepareCommand(SqlCommand cmd, SqlConnection conn, SqlTransaction trans, CommandType cmdType, string cmdText, SqlParameter[] cmdParms)
{

//判断数据库连接状态
if (conn.State != ConnectionState.Open)
conn.Open();

cmd.Connection = conn;
cmd.CommandText = cmdText;

//判断是否需要事物处理
if (trans != null)
cmd.Transaction = trans;

cmd.CommandType = cmdType;

if (cmdParms != null)
{
foreach (SqlParameter parm in cmdParms)
cmd.Parameters.Add(parm);
}
}
}返回页头

以上代码中，大多数都加了注释，Using除处理对命名空间的引用外，当 Using用“{}”定义一个范围，在语句完成时会自动释放语句内所使用的资源。参数数据的添加由PrepareCommand方法来完成。