[C#]实现任何数据库类型的DbHelper帮助类
2018-07-17 14:49
323 查看
本文章为原创内容，如需转载，请注明作者及出处，谢谢！
一、在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 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);
}
}
View Code
内容来自用户分享和网络整理，不保证内容的准确性，如有侵权内容，可联系管理员处理 
相关文章推荐
- [C#]Winform开发框架中实现同时兼容多种数据库类型处理
- C# 数据库sql中用参数的方法来执行UPDATE命令,实现更新dataTime类型
- 【C#】对异步请求处理程序IHttpAsyncHandler的理解和分享一个易用性封装 【手记】走近科学之为什么明明实现了IEnumerable<T>的类型却不能调用LINQ扩展方法 【手记】手机网页弹出层后屏蔽底层的滑动响应 【手记】ASP.NET提示“未能创建类型”处理 【Web】一个非常简单的移动web消息框 【手记】解决EXCEL跑SQL遇“查询无法运行或数据库表无法打开...”
- 工厂提供器DbProviderFactory 实现多种数据库类型类型的DBhelper
- 用C#实现winform对数据库读写图片
- 用C#实现的数据库抽象工厂(一)
- 如何在C#代码中实现在Sqlserver2000中添加用户？以及附加数据库？
- Json.net实现方便的Json转C#（dynamic动态类型）对象
- echart实现数据库取值绘制三种类型的图
- 数据库中的数据类型和C#的数据类型的映射
- c#将Excel数据导入到数据库的实现代码（OleDb）
- c#将Excel数据导入到数据库的实现代码
- C#实现文件数据库
- Winform开发框架中实现同时兼容多种数据库类型处理
- Json.net实现方便的Json转C#（dynamic动态类型）对象
- 不用任何库函数实现以单词为单位的字符串逆转算法(C#)
- c#实现隐式的用户自定义类型转换（关键字implicit operator）
- C#备份及还原数据库的实现代码（粗略） // 利用C#还原数据库（SQL SERVER）备份文件到指定路径
- c#实例化继承类，必须对被继承类的程序集做引用 .net core Redis分布式缓存客户端实现逻辑分析及示例demo 数据库笔记之索引和事务 centos 7下安装python 3.6笔记 你大波哥~ C#开源框架（转载） JSON C＃ Class Generator ---由json字符串生成C＃实体类的工具
- 如何在C#语言中实现int类型的数字以字符类型输出