1.NetDh框架之數據庫操作層--Dapper簡單封裝，可支持多庫實例、多種數據庫類型等(附源碼和示例代碼)

1.NetDh框架開始的需求場景

需求場景：

1.之前公司有不同.net項目組，有的項目是用SqlServer做數據庫，有的項目是用Oracle，后面也有可能會用到Mysql等，而且要考慮后續擴展成主從庫、多庫的需求。(其實不管有沒有這個需求，Dapper的封裝應當像NetDh框架里封裝的那樣使用)；

2.涉及日志操作類的設計，需要記錄用戶操作日志、記錄系統異常日志等；

3.涉及緩存操作類的設計，這點不用需求都應該當考慮，不管是小項目的內存緩存還是大項目中的Redis/Memcache等；

4.涉及二次開發模式簡單的設計。因為多個客戶需要同一個項目產品，但是客戶之間對該產品的需求點又有些不一樣。

 

本文先講為了第1點需求而封裝的數據庫操作類，其它三點在接下來文章中也會介紹。

 

2.ORM框架Dapper介紹

Dapper是輕量級高效的框架，它高效原因是利用Emit技術+各種解析緩存+DataReader。

Dapper可以在所有Ado.net Providers下工作，包括SQL Server, Oracle, MySQL , SQLite, PostgreSQL, sqlce, firebird 等，這些數據庫操作類都有實現IDbConnection接口。你看源碼會發現，Dapper提供的public方法大都是對IDbConnection的擴展。 

DapperExtensions是Dapper的第三方插件之一（NetDh框架是用Dapper+DapperExtensions的組合)，Dapper常用的代碼是 Query<T>(selectSql..)把數據庫獲取的記錄轉成實體類對象，而DapperExtensions是封裝了Dapper，支持諸如 Get<T>(id)、Insert<T>、Update<T>等函數，可以讓你不寫sql就能簡單操作數據庫數據。

 

3.數據庫操作類-在Dapper+DapperExtensions基礎上封裝

3.1.總體說明

如上圖，NetDh框架是把Dapper(.net4.5.1)目前最新源碼和DapperExtensions源碼合並在同一個程序集，然后添加到解決方案。有源碼就可以隨便調試，深入了解Dapper和學習Dapper。

在NetDh.DbUtility程序集中，DbHandleBase是個抽象基類，它封裝了“數據庫常用的操作函數”，如下圖:

DbHandleBase基類封裝了Dapper+DapperExtensions，如果要實現SqlServerHandle操作類，那么只要繼承DbHandleBase，然后重寫基類的CreateConnection抽象函數（為了獲取連接對象），即可擁有這些“數據庫常用的操作函數”。其它數據庫類型也一樣，很簡單吧。到底有多么簡單，我們看下SqlServerHandle類，如下圖

一個override CreateConnection搞定，每個數據庫的連接對象不一樣，因此這個是必要的override。

說明，在NetDh代碼中，Oracle操作類不使用微軟早期的OracleClient（微軟已經不維護），而是使用Oracle官方ODP.NET(nuget下載  Oracle.ManagedDataAccess.dll)，不用再安裝OraInsClient和配置tnsnames.ora。

 

另外，用了Dapper(ORM)一般就是不用ExecuteDataTable和ExecuteDataset，為什么DbHandleBase還開放出來，原因:

(1)winform項目中的Grid經常要用到DataTable的DataView；

(2)sql的參數統一簡單寫法，由dapper處理;

(3)Dapper做了各種解析緩存。

貼個DbHandleBase中的ExecuteDataTable的代碼及其注釋:

        /*
         * 說明:winform中經常會用到DataTable的DataView，方便Grid展示與過濾，因此開放ExecuteDataTable和ExecuteDataset；
         * 如果是B/S系統，建議用以上的Query系列函數。
         */

        /// <summary>
        /// 執行sql語句，並返回DataTable(適用於Dapper支持的所有數據庫類型)
        /// </summary>
        /// <param name="sql">sql語句</param>
        /// <param name="param">匿名對象的參數，可以簡單寫，比如 new {Name="user1"} 即可，會統一處理參數和參數的size</param>
        public virtual DataTable ExecuteDataTable(string sql, dynamic param = null, int? cmdTimeout = DEFAULTTIMEOUT, IDbTransaction tran = null, CommandType? cmdType = null)
        {
            sql = CheckSql(sql);
            var conn = CreateConnectionAndOpen();
            try
            {
                //這邊用Dapper的ExecuteReader，統一了函數參數寫法，不用使用SqlParameter。
                using (var reader = conn.ExecuteReader(sql, (object)param, tran, cmdTimeout, cmdType))
                {
                    var dataTable = DataReaderToDataTable(reader);
                    return dataTable;
                }
            }
            finally
            {
                conn.CloseIfOpen();
            }
        }

 

3.2.調用數據庫操作類的示例代碼

以SqlServer數據庫為例，以下直接上代碼，代碼中的注釋很詳細也很有幫助。

值得一提的是：當取數條件比較復雜或者需要關聯多表時，許多人還是不寫sql而是喜歡用ORM的Linq表達式。建議簡單的單表CRUD操作不用寫sql，而比較復雜的業務邏輯建議是寫sql，一是sql語法簡單明了通用，每批技術員都看得懂；二是你可以對復雜的業務邏輯明確執行什么用的sql語句，怎么樣的執行計划。如果你Linq寫得復雜，都不知道ORM會給你生成什么樣的sql出來。

   /// <summary>
    /// NetDh模塊使用示例代碼
    /// </summary>
    public class NetDhExample
    {
        #region 用全局靜態變量實現單例。
        /// <summary>
        /// 服務端使用數據庫操作對象，前端不可直接使用
        /// </summary>
        public static DbHandleBase DbHandle { get; set; }

        //說明:如果你有多庫，比如讀寫分離中的只讀庫，則再定義一個數據庫操作對象即可。
        public static DbHandleBase ReadDbHandle { get; set; }
      
        #endregion
        /// <summary>
        /// 靜態構造函數，只會初始化一次
        /// </summary>
        static NetDhExample()
        {          
            //初始化數據庫操作對象
            DbHandle = new SqlServerHandle(connStr);
            //如果有多庫，可再new個對象
            //ReadDbHandle = new SqlServerHandle(connStrForRead);
        }
        /// <summary>
        /// 模塊使用的示例代碼
        /// </summary>
        public static void TestMain()
        {          

            #region 數據庫交互(sqlserver+Dapper+DapperExtension)
            //---------CRUD操作--------
            //實體類中的第一個Id或者以Id結尾的字段，會被默認當作主鍵，Dapper不僅建議你的表主鍵為Id或以Id結尾的字段，
            //而且Dapper默認主鍵字段在數據庫表里有默認值(比如有設置為自增長)，關於為什么建議用自增長主鍵，可以翻一下我之前的博客文章《SQL Server索引原理解析》。
            //如果表中的主鍵不符合此規定（比如表主鍵是MainKey字段)，則需要自定義Map映射，參考以下的“DapperExtensions進階”
            var user = DbHandle.Get<TbUser>(1);//這邊1產生的是 where Id=1 的條件
            //Get<TbUser>是DapperExtensions的功能，不是Dapper的功能。
            //Get<TbUser>這種寫法類似select *，並不是好作法，但是它寫法方便，只取一筆影響不大。一般是select你要的字段，而不是select所有字段。具體問題具體分析。

            user.Name = "new name";
            DbHandle.Update(user);
            /* 注意如果用實體類去update，就算只更新一個字段，DapperExtension也會生成除了id主鍵之外的所有字段的更新。
             * 多余的更新會增加數據庫開銷，尤其有非聚集索引字段。因此，建議如果要用此Update函數，則只用於基礎表。
             */

            var lastInsertId = DbHandle.Insert(user);//返回lastInsertId。因為它生成的語句包含：SELECT CAST(SCOPE_IDENTITY()  AS BIGINT) AS [Id]
            /* DbHandle.Insert(user);是不會報主鍵重復。以下是DbHandle.Insert產生的語法（來自SQL Server Profiler工具），
             * 不會生成主鍵Id的Insert。因為Dapper默認你的主鍵如果是整形則是KeyType.Identity類型(即默認主鍵字段在數據庫表里有默認值,比如有設置為自增長)，
             *  DbHandle.Insert(user) DapperExtensions產生的sql語句：
             exec sp_executesql N'INSERT INTO [TbUser] ([TbUser].[Name], [TbUser].[Age], [TbUser].[Remark], [TbUser].[Department], [TbUser].[CreateTime]) VALUES (@Name, @Age, @Remark, @Department, @CreateTime);
SELECT CAST(SCOPE_IDENTITY()  AS BIGINT) AS [Id]',N'@CreateTime datetime,@Department nvarchar(200),@Age decimal(6,4),@Name nvarchar(200),@Remark nvarchar(4000)',@CreateTime='2018-06-07 20:05:33.630',@Department=N'D1',@Age=30,@Name=N'new name',@Remark=N'remark1'
             */

            user.Id = 1001;
            DbHandle.Delete(user);
            //DbHandle.Delete(user);只和主鍵Id有關。產生的sql:exec sp_executesql N'DELETE FROM [TbUser] WHERE ([TbUser].[Id] = @Id_0)',N'@Id_0 int',@Id_0=1001
            DbHandle.Delete(new TbUser() { Id = 1001 });

            //---------------------
            //1.使用DapperExtensions過濾條件取Id<100的TbUser降序數據列表
            var filter = Predicates.Field<TbUser>(f => f.Id, Operator.Lt, 100);
            var sort = new List<ISort> { Predicates.Sort<TbUser>(f => f.Id, false) };//false降序
            var users2 = DbHandle.GetList<TbUser>(filter, sort);
            //如果需要多個過濾條件需要用到PredicatesGroup嵌套，這是DapperExtensions的功能（不是Dapper原生功能）。
            //復雜的sql建議用直接寫sql（如下簡潔版），直接寫復雜sql的優點：select字段可選、sql執行計划可控。

            //2.使用sql取Id<100的TbUser降序數據列表（簡潔版）可以指定只取你要的字段Id,Name。簡單明了通用。
            var uses = DbHandle.Query<TbUser>("select Id,Name from TbUser where Id<@maxId order by Id desc", new { maxId = 100 });

            //winform中經常會用到DataTable的DataView，方便Grid展示與過濾，因此開放ExecuteDataTable和ExecuteDataset
            var table = DbHandle.ExecuteDataTable("select Id,Name from TbUser where Id<100 order by Id desc");

            //---------分頁--------
            //1.單表分頁（第3頁，一頁10筆） DapperExtension支持單表
            var pageUsers = DbHandle.GetPageByModel<TbUser>(null, sort, 2, 10);//參數startPageIndex第1頁是從0開始

            //2.sqlserver 自己sql分頁（第3頁，一頁10筆），並且獲取表記錄總數 
            var pageSql = @" select top 10 * from(
select (row_number() over(order by Id))as rowId,* from TbUser where Id<@maxId) as a where a.rowId >20 order by a.rowId;
select count(1) from TbUser";
            var dataset = DbHandle.ExecuteDataSet(pageSql, new { maxId = 1000 });

            //3.封裝的sql分頁，為了支持不同數據庫分頁寫法不同（第3頁，一頁10筆），並且獲取表記錄總數，適合較復雜的分頁
            var pageSql1 = DbHandle.GetPageSql("select * from TbUser A where A.Id<@maxId", "order by A.Id", 2, 10, "select count(1) from TbUser");//參數startPageIndex第1頁是從0開始
            dataset = DbHandle.ExecuteDataSet(pageSql1, new { maxId = 1000 });
            //---------多表關聯--------
            //select的字段並沒有對應的實體類時，可用QueryDynamics。DbHandle也支持返回IEnumerable<Hashtable>的QueryHashtables，方便轉為json格式
            var dyObj = DbHandle.QueryDynamics("select A.Name,B.Amount from TbUser A inner join TbOrder B on B.Uid=A.Id where A.Id=@Id", new { Id = 10 });


            //---------使用存儲過程--------
            //執行存儲過程就是把函數參數CommandType設置為CommandType.StoredProcedure即可，存儲過程的參數傳遞直接 new {@p=value}

            #endregion

            #region DapperExtensions進階--自定義Map映射。
            /*項目起初，規范好表設計，一般是不會用到自定義Map映射。如果是現有項目，可酌情考慮*/
            //自定義Map，具體參考TbUser.cs里的代碼說明

            //以下這句是初始化，告訴DapperExtensions
            DapperExtensions.DapperExtensions.SetMappingAssemblies(new[] { typeof(TbUserMapper).Assembly });
            //DapperExtensions.DapperExtensions.SqlDialect = new DapperExtensions.Sql.SqlServerDialect();//DapperExtensions默認就是SqlServerDialect

            #endregion
          
        }
    }

3.3.DapperExtensions進階--自定義Map映射

比如你的實體類名是TbUser，而對應的數據庫表名是UserTable，或者實體類的某個屬性名和數據庫表字段名不一樣，則需要Map映射，映射支持以下幾種情況，看代碼和注釋：

   #region 如果需要自定義Map映射,可參考：
    public class TbUserMapper : ClassMapper<TbUser>
    {
        public TbUserMapper()
        {
            //1.use different table name
            Table("UserTable");//把實體類的數據庫表名指定為UserTable

            //2.use a custom schema
            //Schema("not_dbo_schema");

            //3.have a custom primary key
            //KeyType.Assigned說明主鍵在數據庫表無默認值（比如是非自增長的主鍵）
            //KeyType.Identity說明主鍵在數據庫表有默認值（比如是自增長的主鍵）
            //Map(x => x.MainKey).Key(KeyType.Assigned);

            //4.Use a different name property from database column
            //Map(x => x.Remark).Column("Bar");//把實體類的Remark屬性指定為數據庫表Bar字段

            //5.Ignore this property entirely
            //Map(x => x.SecretDataMan).Ignore();//忽略實體類中的SecretDataMan字段，即它不是數據庫表字段。

            //optional, map all other columns
            AutoMap();
        }
        //啟動程序時，執行以下定義：
        //DapperExtensions.DapperExtensions.SetMappingAssemblies(new[] { typeof(TbUserMapper).Assembly });
        //當你有很多個Model類都有自定義Map時，而且這些自定Map都在同一個程序集，那么只要上面那一句就可以了。它會檢索整個Assemble去查找出所有繼承ClassMapper的類。

    }
    #endregion

 怎么讓你自定義的映射生效呢，上面代碼最后一段就是：

//啟動程序時，執行以下定義：
DapperExtensions.DapperExtensions.SetMappingAssemblies(new[] { typeof(TbUserMapper).Assembly });

3.4.源碼

國外有github，國內有碼雲，在國內使用碼雲速度非常快。NetDh框架源碼放在碼雲上:

https://gitee.com/donghan/NetDh-Framework