一个通用数据库操作组件DBUtil(c#)、支持SqlServer、Oracle、Mysql、postgres、Access、SQLITE

DBUtil 使用说明

• 源码（.net framework）：https://github.com/jackletter/DBUtil
• 源码（.net standard）：https://github.com/jackletter/DBUtil.Standard

一、简介

这是一个.net下操作数据库(结构数据库)的工具类库，支持sqlserver、oracle、mysql、postgres、sqlite、access等常见数据库。

注意：它并不是一个orm工具(常见的orm框架如：EF、NHibernate等)。本框架与dapper相比更加轻量，你可一看做是DbHelper的扩展封装。

二、快速示例 

2.1 引入DBUtil依赖

1. 首先打开vs(推荐vs2019)，新建控制台应用程序(.net framework)

2. 添加依赖方法1：打开工具>NuGet包管理器>程序包管理器控制台，输入：

Install-Package DBUtil -Version 1.0.0

3. 添加依赖方法2：使用可视化的nuget管理窗口搜索“DBUtil”，选择安装即可！

2.2 准备数据库

自行准备吧。

2.3 增删改查代码

    //创建数据库操作对象
    DBUtil.IDbAccess iDb = DBUtil.IDBFactory.CreateIDB("Data Source=.;Initial Catalog=JACKOA;User ID=sa;Password=xx;","SQLSERVER");

    //1.快速查询
    Console.WriteLine(iDb.GetFirstColumnString("select Name from SysUser"));

    //2.执行sql语句
    Console.WriteLine(iDb.ExecuteSql("updatetest set CaseNo=CaseNo+'e'"));

    //3.执行带参数的SQL语句
    Console.WriteLine(iDb.ExecuteSql("update test set CaseNo=@case",newIDataParameter[] { iDb.CreatePara("case","123") }));

     //4.添加数据
     Hashtable ht = newSystem.Collections.Hashtable();
     ht.Add("CaseNo", "456");
     ht.Add("Name", "ji");
     Console.WriteLine(iDb.AddData("test",ht));

     //5.修改数据
     Hashtable ht2 = newSystem.Collections.Hashtable();
     ht2.Add("Name", "jiko");
     Console.WriteLine(iDb.UpdateData("test",ht2," and CaseNo='123'"));

     //6.删除数据
     Console.WriteLine(iDb.DeleteTableRow("test"," and id=11"));

      //7.一般查询
      Console.WriteLine(iDb.GetDataSet("select * from sysuser").Tables[0].Rows.Count);

三、数据库访问对象

    在这个组件设计中，所有的数据库操作方法都被集成在了一个对象上：IDbAccess。它是一个接口，定义了公共的数据库访问方法，如：增删改查、事务控制等。具体的实现由SqlServerIDbAccess、MySqlIDbAccess、PostgreSqlIDbAccess、OracleIDbAccess、AccessIDbAccess、SQLiteIDbAccess等实现，它们分别对应着一种数据库。

    在所有的数据库操作之前，都必须先创建IDbAccess对象，创建的方法如下：

DBUtil.IDbAccess iDb = DBUtil.IDBFactory.CreateIDB("Data Source=.;Initial Catalog=JACKOA;User ID=sa;Password=xx;","SQLSERVER");

你所需的参数有两个：

1. 数据库的类型字符串

    SQLSERVER、ORACLE、MYSQL、POSTGRESQL、ACCESS、SQLITE

2. 数据库连接字符串

参考以下示例：

SQLSERVER: Data Source=.;Initial Catalog=JACKOA;User ID=sa;Password=xx;
ORACLE: Data Source=ORCLmyvm2;Password=sys123;User ID=sys;DBA Privilege=SYSDBA;
MYSQL: Data Source=localhost;Initial Catalog=test;User ID=root;Password=xxxx;
POSTGRESQL: Server=localhost;Port=5432;UserId=postgres;Password=xxxx;Database=test
ACCESS: Provider=Microsoft.Jet.OLEDB.4.0;Data Source=G:\work\Multiplan.mdb;
ACCESS: Provider=Microsoft.ACE.OLEDB.12.0;Data Source=C:\Users\Administrator\Desktop\demo.accdb;
 SQLITE: Data Source=f:\demo.db;

3. sqlite数据库

sqlite数据库存储是单个文件存储的，所以在访问之前你需要先创建它，参照如下代码：

//如果没有数据库文件,要先创建
DBUtil.IDBFactory.CreateSQLiteDB("d:\\demo.db");
//可以使用下面方法获取连接字符串
string str = DBUtil.IDBFactory.GetSQLiteConnectionString("d:\\demo.db");
//创建IDbAccess 
DBUtil.IDbAccess iDb = DBUtil.IDBFactory.CreateIDB(str, "SQLITE");
//新建表并插入数据
iDb.ExecuteSql(@"
create table test(
id int primary key,
name varchar(50)
);
insert into test values(1,'张三');
insert into test values(2,'李四');
");
//执行查询
string name = iDb.GetFirstColumnString("select name from test");
Console.WriteLine(name);

四、增删改查方法

4.1 增加数据（AddData）

DBUtil.IDbAccess iDb = DBUtil.IDBFactory.CreateIDB(@"Data Source=d:\demo.db;", "SQLITE");
iDb.ExecuteSql(@"
create table test2(
id int primary key,
name varchar(50),
createtime timestamp,
largefield blob
)");
Hashtable ht = new Hashtable();
 ht.Add("id", 1);
ht.Add("name", "李四");
 ht.Add("createtime", DateTime.Now);
ht.Add("largefield", System.Text.Encoding.UTF8.GetBytes("我的密码是：xxxxxx"));
iDb.AddData("test2", ht);
Console.WriteLine(iDb.GetFirstColumnString("select name from test2"));
Console.WriteLine(iDb.GetFirstColumnString("select createtime from test2"));            Console.WriteLine(System.Text.Encoding.UTF8.GetString(iDb.GetFirstColumn("select largefield from test2") as byte[]));
Console.WriteLine("ok");
Console.ReadLine();

4.2 删除数据（DeleteTableRow）

iDb.DeleteTableRow("test2", "and id=1");

4.3 更新数据（UpdateData）

Hashtable ht = new Hashtable();
ht.Add("name", "王五");
iDb.UpdateData("test2", ht, "and id=1");

4.4 更新或添加数据（UpdateOrAdd）

Hashtable ht = new Hashtable();
ht.Add("id", 1);
ht.Add("name", "王五");
iDb.UpdateOrAdd("test2", ht, "and id=1");

4.5 查询数据

4.5.1 获取第一个值

string str=iDb.GetFirstColumnString("select name from test2");
object obj= iDb.GetFirstColumnString("select largefield  from test2");

4.5.2 获取表

//一张表
DataTable dt = iDb.GetDataTable("select * from test2");
//多张表
DataSet ds = iDb.GetDataSet("select * from test2;select * from test2;");

4.6 参数化sql语句

iDbAccess的大部分方法都是直接参数化查询的，参照如下代码：

DataTable dt = iDb.GetDataTable(string.Format("select * from test2 where name like {0}", iDb.paraPrefix + "name"), new IDbDataParameter[] {
      iDb.CreatePara("name","%小%")
 });

五、查询分页

每个数据库的分页方法不同，比如：

sqlserver： top分页、row_number() over()分页、fetch分页

mysql：limit分页

等等。。。

在这个组件中设计为：根据指定的查询语句和分页参数生成分页的查询语句，参照以下代码：

DBUtil.IDbAccess iDb = DBUtil.IDBFactory.CreateIDB(@"Data Source=localhost;Initial Catalog=imgserver2;User ID=root;Password=123456;", "MYSQL");
string selectSql = "select * from test2";
string orderSql = "order by id desc";
int pageSize = 10;
int pageIndex = 1;
string sqlFinal = iDb.GetSqlForPageSize(selectSql, orderSql, pageSize, pageIndex);
Console.WriteLine(sqlFinal);//select * from test2 order by id desc limit 0,10

六、事务控制

iDb.BeginTrans();//开启事务
IDbTransaction tran= iDb.tran;//获得事务对象
iDb.Commit();//提交事务
iDb.Rollback();//回滚事务
bool b = iDb.IsTran;//是否开启了事务

七、测试是否连接成功

DBUtil.IDbAccess iDb = DBUtil.IDBFactory.CreateIDB(@"Data Source=localhost;Initial Catalog=imgserver2;User ID=root;Password=1234567;", "MYSQL");
DBUtil.Result res = iDb.OpenTest();
if (res.Success)
{
    Console.WriteLine("连接成功！");
}
else
{
    Console.WriteLine("连接失败：" + res.Data);
}
Console.WriteLine("ok");
Console.ReadLine();

八、使iDbAccess对象保持打开状态

默认情况下，每进行一次数据库的操作都会打开和关闭数据库。在密集的操作下这种方法并不推荐。

可以通过IsKeepConnect 属性使数据的链接一直保持

iDb.IsKeepConnect = true;//保持连接的打开状态

九、获取日期型过滤字符串

string filter=iDb.GetDateFilter("end", "2016-12-1", "2017-01-01", true, false);//返回 and end>='2016-12-1' and end<'2017-01-01'

十、判断表、视图、字段是否存在

bool b=iDb.JudgeTableOrViewExist("test");//判断test表是否存在
bool b2 = iDb.JudgeColumnExist("test", "id");//判断test表中是否有列id

十一、ID和自动编号生成控制

11.1 说明

数据库表的ID的生成是一个常见的问题，常见的有表字段设置为自增、设为序列、程序控制ID生成。下面分别说说这三种模式：

1)  表字段自增：这种办法最根本的缺陷在于：“不能在数据插入到表之前获取对应的ID”，试想一下：如果你在插入数据之前还要用到这个ID做其他的工作该怎么办？数据迁移的时候也会遇到麻烦，但是可以通过关闭自增后再进行插入，sqlserver2014中的是：SET IDENTITY_INSERT test ON，sqlserver2008的还未测试。

2) 序列法：在oracle中可以新建一个序列控制ID的生成（sqlserver中好像也开始支持了），这种方法其实已经解决了绝大部分问题了，但是在每次生成ID之前你还是需要访问一遍数据库，如果需要批量生成的时候性能肯定受影响（不知道序列支不支持批量生成）。

3) 程序控制ID生成法：这个组件是用的这种方法生成ID的，它可以解决上述提到的问题。它的原理是：

    你在程序中通过指定表名和字段名来获取ID，程序中进行判断当前内存中是否缓存了这个ID，如果缓存了ID的话就直接自增并返回，如果没有缓存ID的话就通过表名和字段名去数据库里面去查找最大的ID，然后自增并返回。

    优点：

        1. ID可以随时生成，不用非得向表中插入数据。

        2. 在批量生成ID时，性能很高（完全碾压从数据库生成的）

        3. 可以针对一个表的多个字段进行生成（一般用不到）

        4. 兼容各种数据库，你不用再为ID配置各种生成策略

    缺点：

        1. 因为ID的生成缓存到了程序中，所以针对一张表必须保证只有一个服务器会进行ID的生成，否则会出现重复的ID

    注意：

        有人可能已经注意到问题，分布式的ID是怎么生成（1个数据库，多个服务器）？这里我提供一个思路，但是这个组件中并没有实现：针对不同的服务器预先设置ID的前缀，比如服务器A的ID 生成从1开始，服务器B的ID 生成从100 0000开始，这样就不会重叠了。如果担心数据量太大，那么你就不能在用int类型的ID了，你应该使用字符串唯一编号。这个组件中也实现了唯一编号的生成控制，原理和ID一样的都是在程序中缓存，只不过使用的时候要配置编号生成的规则...

11.2 扩展说明

    这个组件默认使用的生成控制器是SimpleIDSNOManager,如果需要扩展(比如使用redis控制生成等)可以自定义实现IDSNOManager,并在应用程序启动时书写：IDBFactory. IDSNOManage= new 自定义实现();

11.3 使用方法

  11.3.1 ID操作

     //生成下一个ID
     int id = iDb.IDSNOManager.NewID(iDb, "test", "id");
     //强制从数据库中生成ID
     int id2 = iDb.IDSNOManager.NewIDForce(iDb, "test", "id");
     //重置ID生成的进度
     iDb.IDSNOManager.ResetID("test", "id", 1);
     //显示当前控制的所有ID进度
     iDb.IDSNOManager.ShowCurrentIDs(null,null);

  11.3.2 自动编号操作

 

    //生成下一个编号
      iDb.IDSNOManager.NewSNO(iDb, "test", "caseno", new List<SerialChunk>(){
           new SerialChunk("prefix_GWFW","Text[GWFW][4]"),
           new SerialChunk("RiQiCtr","DateTime[yyyyMMdd][8][incycle]"),
           new SerialChunk("SerialNo","SerialNo[1,1,5,,day]")
      });
    //获取当前编号的生成进度
    List<string[]> li = iDb.IDSNOManager.ShowCurrentSNOs(null, null, null);
    //重置当前的编号生成
    List<SerialChunk> li = new List<SerialChunk>();
    li.Add(new SerialChunk(“prefix_GWFW”,null));
    li.Add(new SerialChunk(“RiQiCtr”,null));
    li.Add(new SerialChunk(“SerialNo”,null));
    iDb.IDSNOManager.ResetSNO(tableName, colName, li, null);
    iDb.IDSNOManager.NewSNO(iDb, "test", "caseno", new List<SerialChunk>(){
    new SerialChunk("prefix_GWFW","Text[GWFW][4]"),
    new SerialChunk("RiQiCtr","DateTime[yyyyMMdd][8][incycle]"),
    new SerialChunk("SerialNo","SerialNo[1,1,5,,day]")
    });
    //获取当前编号的生成进度
    List<string[]> li = iDb.IDSNOManager.ShowCurrentSNOs(null, null, null);
    //重置当前的编号生成
    List<SerialChunk> li = new List<SerialChunk>();
    li.Add(new SerialChunk(“prefix_GWFW”,null));
    li.Add(new SerialChunk(“RiQiCtr”,null));
    li.Add(new SerialChunk(“SerialNo”,null));
    iDb.IDSNOManager.ResetSNO(tableName, colName, li, null);