一個通用數據庫操作組件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);