-
C#教程之C#教程之实现任何数据库类型的DbHelper帮助类
本站最新发布 C#从入门到精通
试听地址 https://www.xin3721.com/eschool/CSharpxin3721/
试听地址 https://www.xin3721.com/eschool/CSharpxin3721/
本文章为原创内容，如需转载，请注明作者及出处，谢谢！
一、在System.Data.Common命名空间下，存在这样的一个类：
//
// 摘要:
// 表示一组方法，这些方法用于创建提供程序对数据源类的实现的实例。
public abstract class DbProviderFactory
{
//
// 摘要:
// 初始化 System.Data.Common.DbProviderFactory 类的新实例。
protected DbProviderFactory();
//
// 摘要:
// 指定特定的 System.Data.Common.DbProviderFactory 是否支持 System.Data.Common.DbDataSourceEnumerator
// 类。
//
// 返回结果:
// 如果 System.Data.Common.DbProviderFactory 的实例支持 System.Data.Common.DbDataSourceEnumerator
// 类，则为 true；否则为 false。
public virtual bool CanCreateDataSourceEnumerator { get; }
//
// 摘要:
// 返回实现 System.Data.Common.DbCommand 类的提供程序的类的一个新实例。
//
// 返回结果:
// System.Data.Common.DbCommand 的新实例。
public virtual DbCommand CreateCommand();
//
// 摘要:
// 返回实现 System.Data.Common.DbCommandBuilder 类的提供程序的类的一个新实例。
//
// 返回结果:
// System.Data.Common.DbCommandBuilder 的新实例。
public virtual DbCommandBuilder CreateCommandBuilder();
//
// 摘要:
// 返回实现 System.Data.Common.DbConnection 类的提供程序的类的一个新实例。
//
// 返回结果:
// System.Data.Common.DbConnection 的新实例。
public virtual DbConnection CreateConnection();
//
// 摘要:
// 返回实现 System.Data.Common.DbConnectionStringBuilder 类的提供程序的类的一个新实例。
//
// 返回结果:
// System.Data.Common.DbConnectionStringBuilder 的新实例。
public virtual DbConnectionStringBuilder CreateConnectionStringBuilder();
//
// 摘要:
// 返回实现 System.Data.Common.DbDataAdapter 类的提供程序的类的一个新实例。
//
// 返回结果:
// System.Data.Common.DbDataAdapter 的新实例。
public virtual DbDataAdapter CreateDataAdapter();
//
// 摘要:
// 返回实现 System.Data.Common.DbDataSourceEnumerator 类的提供程序的类的一个新实例。
//
// 返回结果:
// System.Data.Common.DbDataSourceEnumerator 的新实例。
public virtual DbDataSourceEnumerator CreateDataSourceEnumerator();
//
// 摘要:
// 返回实现 System.Data.Common.DbParameter 类的提供程序的类的一个新实例。
//
// 返回结果:
// System.Data.Common.DbParameter 的新实例。
public virtual DbParameter CreateParameter();
//
// 摘要:
// 返回提供程序的类的新实例，该实例可实现提供程序的 System.Security.CodeAccessPermission 类的版本。
//
// 参数:
// state:
// System.Security.Permissions.PermissionState 值之一。
//
// 返回结果:
// 指定 System.Security.Permissions.PermissionState 的 System.Security.CodeAccessPermission
// 对象。
public virtual CodeAccessPermission CreatePermission(PermissionState state);
}
我们可以看到，在此类中，有很多用于创建数据库相关对象的类型，如DbConnection，DbCommand，DbDataAdapter等。
而且，实现诸如SqlConnection、SqlCommand、SqlDataAdapter（这里用的是SQL Server）的类型，都分别继承自DbConnection，DbCommand，DbDataAdapter，
因此，我们可以使用DbProviderFactory来创建我们想要的、可实现任何数据库的DbHelper。
二、实现基本的DbHelper帮助类
1、我们将DbHelper定义为抽象类，并在类中提供一个抽象可读属性，名称叫DbProviderFactory，返回类型为DbProviderFactory（注：名称与返回类型可以为一样，也可以不一样），
2、我们利用在该抽象类实现的子类中重写DbProviderFactory方法，并在子类的构造函数中为该属性赋值，该值就是已经实现了具体数据库类型的DbProviderFactory。
定义的代码参考如下：
public abstract class DbHelper
{
public abstract DbProviderFactory DbProviderFactory { get; }
}
3、我们为该抽象类编写一个构造函数，传进去的参数为连接字符串，并将其存储在可读的ConnectionString字段里，代码如下：
public abstract class DbHelper
{
public DbHelper(string connectionString)
{
ConnectionString = connectionString;
}
public string ConnectionString { get; }
public abstract DbProviderFactory DbProviderFactory { get; }
}
4、在DbHelper编写一些用于实现数据库相关操作的方法，这里就用到了DbProviderFactory类中的方法，以下方法仅供参考，具体请参照其他完整的DbHelp帮助类，
DbHelper完整代码如下：
//帮助类的基类(抽象类) public abstract class DbHelper { public DbHelper(string connectionString) { ConnectionString = connectionString; } public abstract DbProviderFactory DbProviderFactory { get; } public string ConnectionString { get; } //以下实现的帮助类方法，仅供该例子使用，具体请参照其他完整的DbHelp帮助类 private void ThrowExceptionIfLengthNotEqual(string[] sqls, params DbParameter[][] parameters) { if (parameters.GetLength(0) != 0 && sqls.Length != parameters.GetLength(0)) throw new ArgumentException($"一维数组{nameof(sqls)}的长度与二维数组{nameof(parameters)}长度的第一维长度不一致"); } private T[] Execute<T>(string[] sqls, CommandType commandType = CommandType.Text, ExecuteMode executeMode = ExecuteMode.NonQuery, params DbParameter[][] parameters) { ThrowExceptionIfLengthNotEqual(sqls, parameters); if(executeMode == ExecuteMode.NonQuery && typeof(T) != typeof(int)) throw new InvalidCastException("使用NonQuery模式时，必须将类型T指定为int"); using (DbConnection connection = DbProviderFactory.CreateConnection()) using (DbCommand command = DbProviderFactory.CreateCommand()) { connection.ConnectionString = ConnectionString; connection.Open(); command.Connection = connection; command.CommandType = commandType; DbTransaction transaction = connection.BeginTransaction(); command.Transaction = transaction; try { List<T> resultList = new List<T>(); for (int i = 0; i < sqls.Length; i++) { command.CommandText = sqls[i]; if (parameters.GetLength(0) != 0) { command.Parameters.Clear(); command.Parameters.AddRange(parameters[i]); } object result = null; switch (executeMode) { case ExecuteMode.NonQuery: result = command.ExecuteNonQuery(); break; case ExecuteMode.Scalar: result = command.ExecuteScalar(); break; default: throw new NotImplementedException(); } resultList.Add((T)Convert.ChangeType(result, typeof(T))); } transaction.Commit(); return resultList.ToArray(); } catch { transaction.Rollback(); throw; } } } public int ExecuteNonQuery(string sql, params DbParameter[] parameter) => ExecuteNonQuery(new string[] { sql }, new DbParameter[][] { parameter })[0]; public int[] ExecuteNonQuery(string[] sqls, params DbParameter[][] parameters)=> Execute<int>(sqls, CommandType.Text, ExecuteMode.NonQuery,parameters); public int ExecuteNonQueryWithProc(string sql, params DbParameter[] parameter) => ExecuteNonQueryWithProc(new string[] { sql }, new DbParameter[][] { parameter })[0]; public int[] ExecuteNonQueryWithProc(string[] sqls, params DbParameter[][] parameters) => Execute<int>(sqls, CommandType.StoredProcedure, ExecuteMode.NonQuery, parameters); public T ExecuteScalar<T>(string sql, params DbParameter[] parameter) => ExecuteNonQuery<T>(new string[] { sql }, new DbParameter[][] { parameter })[0]; public T[] ExecuteNonQuery<T>(string[] sqls, params DbParameter[][] parameters) => Execute<T>(sqls, CommandType.Text,ExecuteMode.Scalar, parameters); public T ExecuteScalarWithProc<T>(string sql, params DbParameter[] parameter) => ExecuteNonQuery<T>(new string[] { sql }, new DbParameter[][] { parameter })[0]; public T[] ExecuteNonQueryWithProc<T>(string[] sqls, params DbParameter[][] parameters) => Execute<T>(sqls, CommandType.StoredProcedure, ExecuteMode.Scalar, parameters); enum ExecuteMode { NonQuery,Scalar } private DataTable[] Fill(string[] selectSqls, CommandType commandType = CommandType.Text, params DbParameter[][] parameters) { ThrowExceptionIfLengthNotEqual(selectSqls, parameters); using (DbConnection connection = DbProviderFactory.CreateConnection()) using (DbDataAdapter adapter = DbProviderFactory.CreateDataAdapter()) using (DbCommand command = DbProviderFactory.CreateCommand()) { connection.ConnectionString = ConnectionString; connection.Open(); command.Connection = connection; command.CommandType = commandType; adapter.SelectCommand = command; List<DataTable> resultList = new List<DataTable>(); for (int i = 0; i < selectSqls.Length; i++) { command.CommandText = selectSqls[i]; if (parameters.GetLength(0) != 0) { command.Parameters.Clear(); command.Parameters.AddRange(parameters[i]); } DataTable table = new DataTable(); adapter.Fill(table); resultList.Add(table); } return resultList.ToArray(); } } public DataTable Fill(string selectSql, params DbParameter[] parameter) => Fill(new string[] { selectSql }, new DbParameter[][] { parameter })[0]; public DataTable[] Fill(string[] selectSqls, params DbParameter[][] parameters) => Fill(selectSqls, CommandType.Text, parameters); public DataTable FillWithProc(string selectSql, params DbParameter[] parameter) => FillWithProc(new string[] { selectSql }, new DbParameter[][] { parameter })[0]; public DataTable[] FillWithProc(string[] selectSqls, params DbParameter[][] parameters) => Fill(selectSqls, CommandType.StoredProcedure, parameters); }
三、实现具体的数据库帮助类
1、实现Sql Server的帮助类，具体方法：只要重写DbHelper类的DbProviderFactory属性并在构造函数为其赋值即可，其他的数据库帮助类亦是如此，
代码如下：
//用于Sql Server的帮助类
public class SqlClientHelper : DbHelper
{
public SqlClientHelper(string connectionString) : base(connectionString)
{
this.DbProviderFactory = SqlClientFactory.Instance;
}
public override DbProviderFactory DbProviderFactory { get; }
}
2、参照以上，实现SQLite帮助类如下：
//用于SQLite的帮助类
public class SQLiteHelper : DbHelper
{
public SQLiteHelper(string connectionString) : base(connectionString)
{
DbProviderFactory = SQLiteFactory.Instance;
}
public override DbProviderFactory DbProviderFactory { get; }
}
3、其他数据库的帮助类，正如以上所说的，只要重写DbHelper类的DbProviderFactory属性并在构造函数为其赋值即可。
四、示例演示
使用前，必须引用了System.Data.SQLite，具体请参考一下文章：
使用C#创建SQLite控制台应用程序
编写的客户端代码，如下：
class Program
{
//客户端调用
static void Main(string[] args)
{
string fileName = "Test.db";
if (File.Exists(fileName)) File.Delete(fileName);
SQLiteConnection.CreateFile(fileName);
SQLiteHelper helper = new SQLiteHelper($"Data Source = {fileName}");
helper.ExecuteNonQuery("CREATE TABLE IF NOT EXISTS Info(ID integer PRIMARY KEY AUTOINCREMENT, Guid text)");
List<string> sqlList = new List<string>();
for (int i = 0; i < 1000; i++)
{
sqlList.Add($"INSERT INTO Info VALUES(null,'{Guid.NewGuid()}')");
}
helper.ExecuteNonQuery(sqlList.ToArray());
DataTable table = helper.Fill("SELECT * FROM Info");
table.Rows.Cast<DataRow>().ToList().ForEach(x => Console.WriteLine($"{x[0]}\t{x[1]}"));
Console.ReadKey();
}
}
输出的结果如下：
五、完整代码如下：
using System; using System.Linq; using System.Collections.Generic; using System.Data; using System.Data.Common; using System.Data.SqlClient; using System.Data.SQLite; using System.IO; namespace ConsoleApp { class Program { //客户端调用 static void Main(string[] args) { string fileName = "Test.db"; if (File.Exists(fileName)) File.Delete(fileName); SQLiteConnection.CreateFile(fileName); SQLiteHelper helper = new SQLiteHelper($"Data Source = {fileName}"); helper.ExecuteNonQuery("CREATE TABLE IF NOT EXISTS Info(ID integer PRIMARY KEY AUTOINCREMENT, Guid text)"); List<string> sqlList = new List<string>(); for (int i = 0; i < 1000; i++) { sqlList.Add($"INSERT INTO Info VALUES(null,'{Guid.NewGuid()}')"); } helper.ExecuteNonQuery(sqlList.ToArray()); DataTable table = helper.Fill("SELECT * FROM Info"); table.Rows.Cast<DataRow>().ToList().ForEach(x => Console.WriteLine($"{x[0]}\t{x[1]}")); Console.ReadKey(); } } //用于Sql Server的帮助类 public class SqlClientHelper : DbHelper { public SqlClientHelper(string connectionString) : base(connectionString) { this.DbProviderFactory = SqlClientFactory.Instance; } public override DbProviderFactory DbProviderFactory { get; } } //用于SQLite的帮助类 public class SQLiteHelper : DbHelper { public SQLiteHelper(string connectionString) : base(connectionString) { DbProviderFactory = SQLiteFactory.Instance; } public override DbProviderFactory DbProviderFactory { get; } } //-------------------------------------------------------------------------------- //其他数据库的帮助类，只要重写DbHelper类的DbProviderFactory属性并在构造函数为其赋值即可 //-------------------------------------------------------------------------------- //帮助类的基类(抽象类) public abstract class DbHelper { public DbHelper(string connectionString) { ConnectionString = connectionString; } public abstract DbProviderFactory DbProviderFactory { get; } public string ConnectionString { get; } //以下实现的帮助类方法，仅供该例子使用，具体请参照其他完整的DbHelp帮助类 private void ThrowExceptionIfLengthNotEqual(string[] sqls, params DbParameter[][] parameters) { if (parameters.GetLength(0) != 0 && sqls.Length != parameters.GetLength(0)) throw new ArgumentException($"一维数组{nameof(sqls)}的长度与二维数组{nameof(parameters)}长度的第一维长度不一致"); } private T[] Execute<T>(string[] sqls, CommandType commandType = CommandType.Text, ExecuteMode executeMode = ExecuteMode.NonQuery, params DbParameter[][] parameters) { ThrowExceptionIfLengthNotEqual(sqls, parameters); if(executeMode == ExecuteMode.NonQuery && typeof(T) != typeof(int)) throw new InvalidCastException("使用NonQuery模式时，必须将类型T指定为int"); using (DbConnection connection = DbProviderFactory.CreateConnection()) using (DbCommand command = DbProviderFactory.CreateCommand()) { connection.ConnectionString = ConnectionString; connection.Open(); command.Connection = connection; command.CommandType = commandType; DbTransaction transaction = connection.BeginTransaction(); command.Transaction = transaction; try { List<T> resultList = new List<T>(); for (int i = 0; i < sqls.Length; i++) { command.CommandText = sqls[i]; if (parameters.GetLength(0) != 0) { command.Parameters.Clear(); command.Parameters.AddRange(parameters[i]); } object result = null; switch (executeMode) { case ExecuteMode.NonQuery: result = command.ExecuteNonQuery(); break; case ExecuteMode.Scalar: result = command.ExecuteScalar(); break; default: throw new NotImplementedException(); } resultList.Add((T)Convert.ChangeType(result, typeof(T))); } transaction.Commit(); return resultList.ToArray(); } catch { transaction.Rollback(); throw; } } } public int ExecuteNonQuery(string sql, params DbParameter[] parameter) => ExecuteNonQuery(new string[] { sql }, new DbParameter[][] { parameter })[0]; public int[] ExecuteNonQuery(string[] sqls, params DbParameter[][] parameters)=> Execute<int>(sqls, CommandType.Text, ExecuteMode.NonQuery,parameters); public int ExecuteNonQueryWithProc(string sql, params DbParameter[] parameter) => ExecuteNonQueryWithProc(new string[] { sql }, new DbParameter[][] { parameter })[0]; public int[] ExecuteNonQueryWithProc(string[] sqls, params DbParameter[][] parameters) => Execute<int>(sqls, CommandType.StoredProcedure, ExecuteMode.NonQuery, parameters); public T ExecuteScalar<T>(string sql, params DbParameter[] parameter) => ExecuteNonQuery<T>(new string[] { sql }, new DbParameter[][] { parameter })[0]; public T[] ExecuteNonQuery<T>(string[] sqls, params DbParameter[][] parameters) => Execute<T>(sqls, CommandType.Text,ExecuteMode.Scalar, parameters); public T ExecuteScalarWithProc<T>(string sql, params DbParameter[] parameter) => ExecuteNonQuery<T>(new string[] { sql }, new DbParameter[][] { parameter })[0]; public T[] ExecuteNonQueryWithProc<T>(string[] sqls, params DbParameter[][] parameters) => Execute<T>(sqls, CommandType.StoredProcedure, ExecuteMode.Scalar, parameters); enum ExecuteMode { NonQuery,Scalar } private DataTable[] Fill(string[] selectSqls, CommandType commandType = CommandType.Text, params DbParameter[][] parameters) { ThrowExceptionIfLengthNotEqual(selectSqls, parameters); using (DbConnection connection = DbProviderFactory.CreateConnection()) using (DbDataAdapter adapter = DbProviderFactory.CreateDataAdapter()) using (DbCommand command = DbProviderFactory.CreateCommand()) { connection.ConnectionString = ConnectionString; connection.Open(); command.Connection = connection; command.CommandType = commandType; adapter.SelectCommand = command; List<DataTable> resultList = new
栏目列表
最新更新
如何使用OS模块中的stat方法
Python os 模块
seek() 方法
python打开文件实例1
Python写入文件
什么是流？
文件操作如何进制逐行读取
Python相对路径
with创建临时运行环境
Python文件操作
.Net Standard（.Net Core）实现获取配置信息
Linux PXE + Kickstart 自动装机
Shell 编程 基础
Shell 编程 条件语句
CentOS8-网卡配置及详解
Linux中LVM逻辑卷管理
1.数码相框-相框框架分析(1)
Ubuntu armhf 版本国内源
Linux中raid磁盘阵列
搭建简易网站
access教程之Access简介
mysql 安装了最新版本8.x版本后的报错：
Mysql空间数据&空间索引(spatial)
如何远程连接SQL Server数据库的图文教程
复制SqlServer数据库的方法
搜索sql语句
sql中返回参数的值
sql中生成查询的模糊匹配字符串
数据定义功能
数据操作功能
