C#操作sql通用类 SQLHelper

usingSystem;

usingSystem.Data;

usingSystem.Configuration;

usingSystem.Web;

usingSystem.Web.Security;

usingSystem.Collections;

usingSystem.Data.SqlClient;

 

/// <summary>

/// 数据库的通用访问代码

/// 此类为抽象类，不允许实例化，在应用时直接调用即可

/// </summary>

publicabstract class SqlHelper

{

    //获取数据库连接字符串，其属于静态变量且只读，项目中所有文档可以直接使用，但不能修改

    publicstatic readonly string ConnectionStringLocalTransaction = ConfigurationManager.ConnectionStrings["pubsConnectionString"].ConnectionString;

 

    // 哈希表用来存储缓存的参数信息，哈希表可以存储任意类型的参数。

    privatestatic Hashtable parmCache = Hashtable.Synchronized(newHashtable());

 

    /// <summary>

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

    /// 使用参数数组形式提供参数列表

    /// </summary>

    /// <remarks>

    /// 使用示例：

    ///  int result = ExecuteNonQuery(connString, CommandType.StoredProcedure, "PublishOrders", new SqlParameter("@prodid", 24));

    /// </remarks>

    /// <param name="connectionString">一个有效的数据库连接字符串</param>

    /// <param name="commandType">SqlCommand命令类型 (存储过程， T-SQL语句， 等等。)</param>

    /// <param name="commandText">存储过程的名字或者 T-SQL 语句</param>

    /// <param name="commandParameters">以数组形式提供SqlCommand命令中用到的参数列表</param>

    /// <returns>返回一个数值表示此SqlCommand命令执行后影响的行数</returns>

    publicstatic int ExecuteNonQuery(stringconnectionString, CommandType cmdType, stringcmdText, paramsSqlParameter[] commandParameters)

    {

 

        SqlCommand cmd = newSqlCommand();

 

        using(SqlConnection conn = newSqlConnection(connectionString))

        {

            //通过PrePareCommand方法将参数逐个加入到SqlCommand的参数集合中

            PrepareCommand(cmd, conn, null, cmdType, cmdText, commandParameters);

            intval = cmd.ExecuteNonQuery();

 

            //清空SqlCommand中的参数列表

            cmd.Parameters.Clear();

            returnval;

        }

    }

     

    /// <summary>

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

    /// 使用参数数组提供参数

    /// </summary>

    /// <remarks>

    /// 使用示例： 

    ///  int result = ExecuteNonQuery(conn, CommandType.StoredProcedure, "PublishOrders", new SqlParameter("@prodid", 24));

    /// </remarks>

    /// <param name="conn">一个现有的数据库连接</param>

    /// <param name="commandType">SqlCommand命令类型 (存储过程， T-SQL语句， 等等。)</param>

    /// <param name="commandText">存储过程的名字或者 T-SQL 语句</param>

    /// <param name="commandParameters">以数组形式提供SqlCommand命令中用到的参数列表</param>

    /// <returns>返回一个数值表示此SqlCommand命令执行后影响的行数</returns>

    publicstatic int ExecuteNonQuery(SqlConnection connection, CommandType cmdType, stringcmdText, paramsSqlParameter[] commandParameters)

    {

 

        SqlCommand cmd = newSqlCommand();

 

        PrepareCommand(cmd, connection, null, cmdType, cmdText, commandParameters);

        intval = cmd.ExecuteNonQuery();

        cmd.Parameters.Clear();

        returnval;

    }

 

    /// <summary>

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

    /// 使用参数数组提供参数

    /// </summary>

    /// <remarks>

    /// 使用示例：

    ///  int result = ExecuteNonQuery(trans, CommandType.StoredProcedure, "PublishOrders", new SqlParameter("@prodid", 24));

    /// </remarks>

    /// <param name="trans">一个存在的 sql 事物处理</param>

    /// <param name="commandType">SqlCommand命令类型 (存储过程， T-SQL语句， 等等。)</param>

    /// <param name="commandText">存储过程的名字或者 T-SQL 语句</param>

    /// <param name="commandParameters">以数组形式提供SqlCommand命令中用到的参数列表</param>

    /// <returns>返回一个数值表示此SqlCommand命令执行后影响的行数</returns>

    publicstatic int ExecuteNonQuery(SqlTransaction trans, CommandType cmdType, stringcmdText, paramsSqlParameter[] commandParameters)

    {

        SqlCommand cmd = newSqlCommand();

        PrepareCommand(cmd, trans.Connection, trans, cmdType, cmdText, commandParameters);

        intval = cmd.ExecuteNonQuery();

        cmd.Parameters.Clear();

        returnval;

    }

 

    /// <summary>

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

    /// 使用参数数组提供参数

    /// </summary>

    /// <remarks>

    /// 使用示例： 

    ///  SqlDataReader r = ExecuteReader(connString, CommandType.StoredProcedure, "PublishOrders", new SqlParameter("@prodid", 24));

    /// </remarks>

    /// <param name="connectionString">一个有效的数据库连接字符串</param>

    /// <param name="commandType">SqlCommand命令类型 (存储过程， T-SQL语句， 等等。)</param>

    /// <param name="commandText">存储过程的名字或者 T-SQL 语句</param>

    /// <param name="commandParameters">以数组形式提供SqlCommand命令中用到的参数列表</param>

    /// <returns>返回一个包含结果的SqlDataReader</returns>

    publicstatic SqlDataReader ExecuteReader(stringconnectionString, CommandType cmdType, stringcmdText, paramsSqlParameter[] commandParameters)

    {

        SqlCommand cmd = newSqlCommand();

        SqlConnection conn = newSqlConnection(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();

            returnrdr;

        }

        catch

        {

            conn.Close();

            throw;

        }

    }

 

    /// <summary>

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

    /// 使用参数数组提供参数

    /// </summary>

    /// <remarks>

    /// 使用示例： 

    ///  Object obj = ExecuteScalar(connString, CommandType.StoredProcedure, "PublishOrders", new SqlParameter("@prodid", 24));

    /// </remarks>

    /// <param name="connectionString">一个有效的数据库连接字符串</param>

    /// <param name="commandType">SqlCommand命令类型 (存储过程， T-SQL语句， 等等。)</param>

    /// <param name="commandText">存储过程的名字或者 T-SQL 语句</param>

    /// <param name="commandParameters">以数组形式提供SqlCommand命令中用到的参数列表</param>

    /// <returns>返回一个object类型的数据，可以通过 Convert.To{Type}方法转换类型</returns>

    publicstatic object ExecuteScalar(stringconnectionString, CommandType cmdType, stringcmdText, paramsSqlParameter[] commandParameters)

    {

        SqlCommand cmd = newSqlCommand();

 

        using(SqlConnection connection = newSqlConnection(connectionString))

        {

            PrepareCommand(cmd, connection, null, cmdType, cmdText, commandParameters);

            objectval = cmd.ExecuteScalar();

            cmd.Parameters.Clear();

            returnval;

        }

    }

 

    /// <summary>

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

    /// 使用参数数组提供参数

    /// </summary>

    /// <remarks>

    /// 使用示例：

    ///  Object obj = ExecuteScalar(connString, CommandType.StoredProcedure, "PublishOrders", new SqlParameter("@prodid", 24));

    /// </remarks>

    /// <param name="conn">一个已经存在的数据库连接</param>

    /// <param name="commandType">SqlCommand命令类型 (存储过程， T-SQL语句， 等等。)</param>

    /// <param name="commandText">存储过程的名字或者 T-SQL 语句</param>

    /// <param name="commandParameters">以数组形式提供SqlCommand命令中用到的参数列表</param>

    /// <returns>返回一个object类型的数据，可以通过 Convert.To{Type}方法转换类型</returns>

    publicstatic object ExecuteScalar(SqlConnection connection, CommandType cmdType, stringcmdText, paramsSqlParameter[] commandParameters)

    {

 

        SqlCommand cmd = newSqlCommand();

 

        PrepareCommand(cmd, connection, null, cmdType, cmdText, commandParameters);

        objectval = cmd.ExecuteScalar();

        cmd.Parameters.Clear();

        returnval;

    }

 

    /// <summary>

    /// 缓存参数数组

    /// </summary>

    /// <param name="cacheKey">参数缓存的键值</param>

    /// <param name="cmdParms">被缓存的参数列表</param>

    publicstatic void CacheParameters(stringcacheKey, paramsSqlParameter[] commandParameters)

    {

        parmCache[cacheKey] = commandParameters;

    }

 

    /// <summary>

    /// 获取被缓存的参数

    /// </summary>

    /// <param name="cacheKey">用于查找参数的KEY值</param>

    /// <returns>返回缓存的参数数组</returns>

    publicstatic SqlParameter[] GetCachedParameters(stringcacheKey)

    {

        SqlParameter[] cachedParms = (SqlParameter[])parmCache[cacheKey];

 

        if(cachedParms == null)

            returnnull;

 

        //新建一个参数的克隆列表

        SqlParameter[] clonedParms = newSqlParameter[cachedParms.Length];

 

        //通过循环为克隆参数列表赋值

        for(inti = 0, j = cachedParms.Length; i < j; i++)

            //使用clone方法复制参数列表中的参数

            clonedParms[i] = (SqlParameter)((ICloneable)cachedParms[i]).Clone();

 

        returnclonedParms;

    }

 

    /// <summary>

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

    /// </summary>

    /// <param name="cmd">SqlCommand 命令</param>

    /// <param name="conn">已经存在的数据库连接</param>

    /// <param name="trans">数据库事物处理</param>

    /// <param name="cmdType">SqlCommand命令类型 (存储过程， T-SQL语句， 等等。)</param>

    /// <param name="cmdText">Command text，T-SQL语句 例如 Select * from Products</param>

    /// <param name="cmdParms">返回带参数的命令</param>

    privatestatic void PrepareCommand(SqlCommand cmd, SqlConnection conn, SqlTransaction trans, CommandType cmdType,stringcmdText, 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 incmdParms)

                cmd.Parameters.Add(parm);

        }

    }

}