C#写一套最全的SQL server帮助类（包括增删改查）

Posted 2023-04-21 大师兄117

我定义了一系列静态方法，用于执行SQL Server数据库的增删改查等操作。
其中：
ExecuteNonQuery方法用于执行指定的SQL语句并返回受影响的行数；
ExecuteScalar方法用于执行指定的SQL语句并返回查询结果的第一行第一列；
ExecuteDataTable方法用于执行指定的SQL语句并返回一个数据表；
ExecuteReader方法用于执行指定的SQL语句并返回一个DataReader对象。
Insert方法用于向指定的表中插入一条记录，并返回新记录的ID值（如果有自增字段）；
Update方法用于更新指定表中满足条件的记录，并返回受影响的行数；
Delete方法用于删除指定表中满足条件的记录，并返回受影响的行数。
在这些方法中，我们使用了ADO.NET的相关技术，包括SqlConnection、SqlCommand、SqlDataAdapter、DataSet等类，以及SqlParameter对象来

一、下面是一套SQL Server的帮助类，包括增删改查等操作，并且带有详细注释。

using System;
using System.Collections.Generic;
using System.Data;
using System.Data.SqlClient;

public class SqlserverHelper

    private static string connectionString = "Data Source=服务器名称;Initial Catalog=数据库名称;User ID=用户名;Password=密码";  // 数据库连接字符串

    /// <summary>
    /// 执行指定的SQL语句并返回受影响的行数
    /// </summary>
    /// <param name="sql">要执行的SQL语句</param>
    /// <returns>受影响的行数</returns>
    public static int ExecuteNonQuery(string sql)
    
        using (SqlConnection conn = new SqlConnection(connectionString))
        
            conn.Open();          // 打开数据库连接
            SqlCommand cmd = new SqlCommand(sql, conn);
            int count = cmd.ExecuteNonQuery();   // 执行SQL语句并返回受影响的行数
            return count;         // 返回受影响的行数
        
    

    /// <summary>
    /// 执行指定的SQL语句并返回查询结果的第一行第一列
    /// </summary>
    /// <param name="sql">要执行的SQL语句</param>
    /// <returns>查询结果的第一行第一列</returns>
    public static object ExecuteScalar(string sql)
    
        using (SqlConnection conn = new SqlConnection(connectionString))
        
            conn.Open();          // 打开数据库连接
            SqlCommand cmd = new SqlCommand(sql, conn);
            object obj = cmd.ExecuteScalar();   // 执行SQL语句并返回查询结果的第一行第一列
            return obj;           // 返回查询结果的第一行第一列
        
    

    /// <summary>
    /// 执行指定的SQL语句并返回一个数据表
    /// </summary>
    /// <param name="sql">要执行的SQL语句</param>
    /// <returns>查询结果的数据表</returns>
    public static DataTable ExecuteDataTable(string sql)
    
        using (SqlConnection conn = new SqlConnection(connectionString))
        
            conn.Open();          // 打开数据库连接
            SqlDataAdapter adapter = new SqlDataAdapter(sql, conn);
            DataSet ds = new DataSet();
            adapter.Fill(ds);     // 执行SQL语句并将查询结果填充到DataSet对象中
            return ds.Tables[0];  // 返回查询结果的数据表
        
    

    /// <summary>
    /// 执行指定的SQL语句并返回一个DataReader对象
    /// </summary>
    /// <param name="sql">要执行的SQL语句</param>
    /// <returns>查询结果的DataReader对象</returns>
    public static SqlDataReader ExecuteReader(string sql)
    
        SqlConnection conn = new SqlConnection(connectionString);
        conn.Open();              // 打开数据库连接
        SqlCommand cmd = new SqlCommand(sql, conn);
        SqlDataReader reader = cmd.ExecuteReader(CommandBehavior.CloseConnection);   // 执行SQL语句并返回DataReader对象
        return reader;            // 返回查询结果的DataReader对象
    

    /// <summary>
    /// 向指定的表中插入一条记录，并返回新记录的ID值（如果有自增字段）
    /// </summary>
    /// <param name="tableName">要插入记录的表名称</param>
    /// <param name="fields">要插入记录的字段和值的集合</param>
    /// <returns>新记录的ID值（如果有自增字段）</returns>
    public static int Insert(string tableName, Dictionary<string, object> fields)
    
        string sql = "insert into " + tableName + "(";
        string values = ") values (";
        SqlCommand cmd = new SqlCommand();
        foreach (KeyValuePair<string, object> field in fields)
        
            sql += "[" + field.Key + "],";
            values += "@" + field.Key + ",";
            cmd.Parameters.AddWithValue("@" + field.Key, field.Value);
        
        sql = sql.TrimEnd(\',\') + values.TrimEnd(\',\') + ")";
        sql += ";select @@identity";    // 如果有自增字段，则返回新记录的ID值
        cmd.Connection = new SqlConnection(connectionString);
        cmd.CommandText = sql;
        cmd.Connection.Open();     // 打开数据库连接
        int newId;
        if (cmd.ExecuteScalar() != DBNull.Value)
        
            newId = Convert.ToInt32(cmd.ExecuteScalar());
        
        else
        
            newId = 0;   // 如果没有自增字段，则返回0
        
        cmd.Connection.Close();    // 关闭数据库连接
        return newId;              // 返回新记录的ID值
    

    /// <summary>
    /// 更新指定表中满足条件的记录，并返回受影响的行数
    /// </summary>
    /// <param name="tableName">要更新记录的表名称</param>
    /// <param name="fields">要更新的字段和值的集合</param>
    /// <param name="conditions">更新条件的字段和值的集合</param>
    /// <returns>受影响的行数</returns>
    public static int Update(string tableName, Dictionary<string, object> fields, Dictionary<string, object> conditions)
    
        string sql = "update " + tableName + " set ";
        SqlCommand cmd = new SqlCommand();
        foreach (KeyValuePair<string, object> field in fields)
        
            sql += "[" + field.Key + "]=@" + field.Key + ",";
            cmd.Parameters.AddWithValue("@" + field.Key, field.Value);
        
        sql = sql.TrimEnd(\',\');
        if (conditions != null && conditions.Count > 0)
        
            sql += " where ";
            foreach (KeyValuePair<string, object> condition in conditions)
            
                sql += "[" + condition.Key + "]=@" + condition.Key + " and ";
                cmd.Parameters.AddWithValue("@" + condition.Key, condition.Value);
            
            sql = sql.TrimEnd(\' \', \'a\', \'n\', \'d\');
        
        cmd.Connection = new SqlConnection(connectionString);
        cmd.CommandText = sql;
        cmd.Connection.Open();     // 打开数据库连接
        int count = cmd.ExecuteNonQuery();   // 执行SQL语句并返回受影响的行数
        cmd.Connection.Close();    // 关闭数据库连接
        return count;              // 返回受影响的行数
    

    /// <summary>
    /// 删除指定表中满足条件的记录，并返回受影响的行数
    /// </summary>
    /// <param name="tableName">要删除记录的表名称</param>
    /// <param name="conditions">删除条件的字段和值的集合</param>
    /// <returns>受影响的行数</returns>
    public static int Delete(string tableName, Dictionary<string, object> conditions)
    
        string sql = "delete from " + tableName;
        SqlCommand cmd = new SqlCommand();
        if (conditions != null && conditions.Count > 0)
        
            sql += " where ";
            foreach (KeyValuePair<string, object> condition in conditions)
            
                sql += "[" + condition.Key + "]=@" + condition.Key + " and ";
                cmd.Parameters.AddWithValue("@" + condition.Key, condition.Value);
            
            sql = sql.TrimEnd(\' \', \'a\', \'n\', \'d\');
        
        cmd.Connection = new SqlConnection(connectionString);
        cmd.CommandText = sql;
        cmd.Connection.Open();     // 打开数据库连接
        int count = cmd.ExecuteNonQuery();   // 执行SQL语句并返回受影响的行数
        cmd.Connection.Close();    // 关闭数据库连接
        return count;              // 返回受影响的行数
    

二、每一个方法的调用。

在这个示例中，我首先调用ExecuteNonQuery方法向数据库中插入一条记录，并输出插入的行数；
然后调用ExecuteScalar方法查询了数据库中记录的总数，并输出结果；
接下来，我使用ExecuteDataTable方法查询了符合条件的记录，并通过遍历数据表的方式输出所有记录的信息。
然后使用ExecuteReader方法查询了所有的记录，并通过遍历DataReader对象的方式输出所有记录的信息。
请注意，在使用完DataReader对象后必须调用其Close()方法关闭它。
接着使用Insert方法向数据库中插入了一条记录，并获得了新记录的ID值（如果有自增字段）；
还使用Update方法更新了符合条件的记录，并输出了更新的行数；
最后，使用Delete方法删除了符合条件的记录，并输出了删除的行数。
当然，这些示例只是演示了如何使用SqlHelper类中的每一个方法。
在实际应用中，将根据具体的需求来调用它们并处理查询结果。

    static void Main(string[] args)
        
            // 执行指定的SQL语句并返回受影响的行数
            int count = SqlserverHelper.ExecuteNonQuery("insert into [User](UserName, Password) values(\'admin\', \'123456\')");
            Console.WriteLine("受影响的行数：" + count);

            // 执行指定的SQL语句并返回查询结果的第一行第一列
            object obj = SqlserverHelper.ExecuteScalar("select count(*) from [User]");
            Console.WriteLine("记录总数：" + obj);

            // 执行指定的SQL语句并返回一个数据表
            DataTable dt = SqlserverHelper.ExecuteDataTable("select * from [User] where UserName=\'admin\'");
            foreach (DataRow row in dt.Rows)
            
                Console.WriteLine("用户名：" + row["UserName"] + " 密码：" + row["Password"]);
            

            // 执行指定的SQL语句并返回一个DataReader对象
            SqlDataReader reader = SqlserverHelper.ExecuteReader("select * from [User]");
            while (reader.Read())
            
                Console.WriteLine("用户名：" + reader["UserName"] + " 密码：" + reader["Password"]);
            
            reader.Close();

            // 向指定的表中插入一条记录，并返回新记录的ID值（如果有自增字段）
            Dictionary<string, object> fields = new Dictionary<string, object>();
            fields.Add("UserName", "test");
            fields.Add("Password", "123456");
            int newId = SqlserverHelper.Insert("User", fields);
            Console.WriteLine("新记录的ID值：" + newId);

            // 更新指定表中满足条件的记录，并返回受影响的行数
            Dictionary<string, object> conditions = new Dictionary<string, object>();
            conditions.Add("UserName", "test");
            Dictionary<string, object> newFields = new Dictionary<string, object>();
            newFields.Add("Password", "654321");
            int updateCount = SqlserverHelper.Update("User", newFields, conditions);
            Console.WriteLine("更新记录的数量：" + updateCount);

            // 删除指定表中满足条件的记录，并返回受影响的行数
            Dictionary<string, object> delConditions = new Dictionary<string, object>();
            delConditions.Add("UserName", "test");
            int delCount = SqlserverHelper.Delete("User", delConditions);
            Console.WriteLine("删除记录的数量：" + delCount);

            Console.ReadKey();
        

 

C#操作SQL Server通用类

using System;

using System.Data;

using System.Configuration;

using System.Web;

using System.Web.Security;

using System.Collections;

using System.Data.SqlClient;

 

/// <summary>

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

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

/// </summary>

public abstract class SqlHelper

{

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

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

 

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

    private static Hashtable parmCache = Hashtable.Synchronized(new Hashtable());

 

    /// <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>

    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;

        }

    }

     

    /// <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>

    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;

    }

 

    /// <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>

    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;

    }

 

    /// <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>

    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;

        }

    }

 

    /// <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>

    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;

        }

    }

 

    /// <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>

    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;

    }

 

    /// <summary>

    /// 缓存参数数组

    /// </summary>

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

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

    public static void CacheParameters(string cacheKey, params SqlParameter[] commandParameters)

    {

        parmCache[cacheKey] = commandParameters;

    }

 

    /// <summary>

    /// 获取被缓存的参数

    /// </summary>

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

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

    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;

    }

 

    /// <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>

    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);

        }

    }

}