ORM之Dapper

来源:https://www.cnblogs.com/snailblog/archive/2019/09/13/11516315.html
-Advertisement-
Play Games

一、前言 上一篇【分層架構設計】我們已經有了架構的輪廓，現在我們就在這個輪廓裡面造輪子。項目要想開始，肯定先得確定ORM框架，目前市面上的ORM框架有很多，對於.net人員來說很容易就想到以ADO.NET為基礎所發展出來的ORM框架EntityFramework。不得不說EntityFramewor ...


一、前言

上一篇【分層架構設計】我們已經有了架構的輪廓，現在我們就在這個輪廓裡面造輪子。項目要想開始，肯定先得確定ORM框架，目前市面上的ORM框架有很多，對於.net人員來說很容易就想到以ADO.NET為基礎所發展出來的ORM框架EntityFramework。不得不說EntityFramework是一個功能很強大的ORM框架，到現在最新的EF分別是EF6（.Net Framework）和EF Core（.Net Core）兩個版本。

但是這裡我使用的另一個叫Dapper的ORM框架，原因是因為EF太重了，而Dapper是一個輕量級開源的ORM類，他是通過擴展IDbConnection提供一些有用的擴展方法去查詢您的資料庫，所以Ado.Net支持的資料庫，他都可以支持。在速度方面具有“King of Micro ORM”的頭銜，幾乎與使用原始的ADO.NET數據讀取器一樣快。第一次使用了他之後，就深深的喜歡上他了。

github地址：https://github.com/StackExchange/Dapper

Dapper文檔：https://dapper-tutorial.net/dapper

二、Dapper實現

2.1、Dapper的方法

從Dapper文檔中，我們知道，Dapper支持一下的方法：

Execute：執行一次或多次命令並返回受影響的行數，包括存儲過程
Query：執行查詢，返回類型為t的數據(返回數據為集合)
QueryFirst：執行查詢並映射第一個結果，如果沒有就為null
QueryFirstOrDefault：行查詢並映射第一個結果，如果序列不包含任何元素，則可以映射預設值
QuerySingle：行查詢並映射第一個結果，如果序列中沒有一個元素，則拋出異常
QuerySingleOrDefault：執行查詢並映射第一個結果，如果序列為空則映射預設值;如果序列中有多個元素，則此方法拋出異常
QueryMultiple：在同一命令中執行多個查詢並映射結果

Dapper還提供了上面方法相同功能的非同步方法，同時每個方法也支持多種形式的傳參。

2.2、Dapper的使用

在前面的項目中，我們在 “04-DataLayer”文件下麵添加類庫“PFT.Snail.DataAccess”。PFT.Snail.DataAccess主要是 用來完成Dapper方法的使用。

在PFT.Snail.DataAccess項目下麵創建文件“DapperSqlDB.cs”，代碼如下：

 public class DapperSqlDB
    {
        /// <summary>
        /// 連接字元串
        /// </summary>
        public string ConnectionString { get; set; }
        /// <summary>
        /// 資料庫連接時間
        /// </summary>
        private int _commondTimeout { get { return 1200; } }

        public DapperSqlDB()
        {
        }
        public DapperSqlDB(string connectionString)
        {
            ConnectionString = connectionString;
        }

        #region 查詢

        /// <summary>
        /// 查詢列表
        /// </summary>
        /// <typeparam name="T"></typeparam>
        /// <param name="sql"></param>
        /// <param name="param"></param>
        /// <returns></returns>
        public List<T> Query<T>(string sql, object param)
        {
            using (IDbConnection conn = new SqlConnection(ConnectionString))
            {
                conn.Open();
                return conn.Query<T>(sql, param, commandTimeout: _commondTimeout).ToList();
            }
        }

        /// <summary>
        /// 非同步查詢列表
        /// </summary>
        /// <typeparam name="T"></typeparam>
        /// <param name="sql"></param>
        /// <param name="param"></param>
        /// <returns></returns>
        public async Task<IEnumerable<T>> QueryAsync<T>(string sql, object param)
        {
            using (IDbConnection conn = new SqlConnection(ConnectionString))
            {
                conn.Open();
                return await conn.QueryAsync<T>(sql, param, commandTimeout: _commondTimeout);
            }
        }

        /// <summary>
        /// 查詢列表第一條數據
        /// </summary>
        /// <typeparam name="T"></typeparam>
        /// <param name="sql"></param>
        /// <param name="param"></param>
        /// <returns></returns>
        public T QueryFirstOrDefault<T>(string sql, object param)
        {
            using (IDbConnection conn = new SqlConnection(ConnectionString))
            {
                conn.Open();
                return conn.QueryFirstOrDefault<T>(sql, param, commandTimeout: _commondTimeout);
            }
        }

        /// <summary>
        /// 非同步查詢列表第一條數據
        /// </summary>
        /// <typeparam name="T"></typeparam>
        /// <param name="sql"></param>
        /// <param name="param"></param>
        /// <returns></returns>
        public async Task<T> QueryFirstOrDefaultAsync<T>(string sql, object param)
        {
            using (IDbConnection conn = new SqlConnection(ConnectionString))
            {
                conn.Open();
                return await conn.QueryFirstOrDefaultAsync<T>(sql, param, commandTimeout: _commondTimeout);
            }
        }

        /// <summary>
        /// 查詢選擇單個值
        /// </summary>
        /// <typeparam name="T"></typeparam>
        /// <param name="sql"></param>
        /// <param name="param"></param>
        /// <returns></returns>
        public T ExecuteScalar<T>(string sql, object param)
        {
            using (IDbConnection conn = new SqlConnection(ConnectionString))
            {
                conn.Open();
                return conn.ExecuteScalar<T>(sql, param, commandTimeout: _commondTimeout);
            }
        }

        /// <summary>
        /// 非同步查詢選擇單個值
        /// </summary>
        /// <typeparam name="T"></typeparam>
        /// <param name="sql"></param>
        /// <param name="param"></param>
        /// <returns></returns>
        public async Task<T> ExecuteScalarAsync<T>(string sql, object param)
        {
            using (IDbConnection conn = new SqlConnection(ConnectionString))
            {
                conn.Open();
                return await conn.ExecuteScalarAsync<T>(sql, param, commandTimeout: _commondTimeout);
            }
        }

        /*調用方式
         * var multi=DBSqlHelper.QueryMultiple("",null);
         * var invoice = multi.Read<Invoice>().First();
         * var invoiceItems = multi.Read<InvoiceItem>().ToList();
         */
        /// <summary>
        /// 執行多個查詢並映射結果
        /// </summary>
        /// <param name="sql"></param>
        /// <param name="param"></param>
        /// <returns></returns>
        public GridReader QueryMultiple(string sql, object param)
        {
            using (IDbConnection conn = new SqlConnection(ConnectionString))
            {
                conn.Open();
                return conn.QueryMultiple(sql, param, commandTimeout: _commondTimeout);
            }

        }

        /* 調用方式
         * await DBSqlHelper.QueryMultipleAsync(sql, para, async (reader) =>
         *  {
         *      rs.A= (await reader.ReadFirstAsync<SingleValue<decimal>>()).Value;
         *      rs.B= (await reader.ReadFirstAsync<SingleValue<decimal>>()).Value;
         *      ...
         *  });
         */
        /// <summary>
        /// 非同步執行多個查詢並映射結果
        /// </summary>
        /// <param name="sql"></param>
        /// <param name="param"></param>
        /// <param name="readerCallback"></param>
        /// <returns></returns>
        public async Task QueryMultipleAsync(string sql, object param, Action<GridReader> readerCallback)
        {
            using (IDbConnection conn = new SqlConnection(ConnectionString))
            {
                conn.Open();
                using (var reader = await conn.QueryMultipleAsync(sql, param, commandTimeout: _commondTimeout))
                {
                    if (readerCallback != null)
                    {
                        readerCallback(reader);
                    }
                }

            }
        }

        #endregion

        #region 執行sql

        /// <summary>
        /// 執行sql語句
        /// </summary>
        /// <param name="sql"></param>
        /// <param name="param"></param>
        /// <returns></returns>
        public int Execute(string sql, object param)
        {
            using (IDbConnection conn = new SqlConnection(ConnectionString))
            {
                conn.Open();
                return conn.Execute(sql, param, commandTimeout: _commondTimeout);
            }
        }

        /// <summary>
        /// 非同步執行sql語句
        /// </summary>
        /// <param name="sql"></param>
        /// <param name="param"></param>
        /// <returns></returns>
        public async Task<int> ExecuteAsync(string sql, object param)
        {
            using (IDbConnection conn = new SqlConnection(ConnectionString))
            {
                conn.Open();
                return await conn.ExecuteAsync(sql, param, commandTimeout: _commondTimeout);
            }
        }

        /// <summary>
        /// 執行sql語句（主要指存儲過程）
        /// </summary>
        /// <param name="sql"></param>
        /// <param name="param"></param>
        /// <returns></returns>
        public int Execute(string sql, object param, CommandType type)
        {
            using (IDbConnection conn = new SqlConnection(ConnectionString))
            {
                conn.Open();
                return conn.Execute(sql, param, commandTimeout: _commondTimeout, commandType: type);
            }
        }

        /// <summary>
        /// 非同步執行sql語句（主要指存儲過程）
        /// </summary>
        /// <param name="sql"></param>
        /// <param name="param"></param>
        /// <returns></returns>
        public async Task<int> ExecuteAsync(string sql, object param, CommandType type)
        {
            using (IDbConnection conn = new SqlConnection(ConnectionString))
            {
                conn.Open();
                return await conn.ExecuteAsync(sql, param, commandTimeout: _commondTimeout, commandType: type);
            }
        }
        #endregion





    }

同時Nuget添加System.Data.SqlClient和Dapper的引用。

上面已經實現了數據的增刪改查操作，但是再使用過程就會發現，沒有事務機制和分頁功能。

添加事務功能

在PFT.Snail.DataAccess中添加介面“ITransaction.cs”

public interface ITransaction
    {
        List<T> Query<T>(string sql, object param);
        T QueryFirstOrDefault<T>(string sql, object param);
        T ExecuteScalar<T>(string sql, object param);
        int Execute(string sql, object param);

    }

在“DapperSqlDB.cs”添加事務對象

        #region 事務方法

        /// <summary>
        /// 事務執行方法對象
        /// </summary>
        private class Transaction : IDisposable, ITransaction
        {
            private IDbConnection conn = null;
            private IDbTransaction tran = null;
            public Transaction(IDbConnection conn, IDbTransaction tran)
            {
                this.conn = conn;
                this.tran = tran;
            }


            List<T> ITransaction.Query<T>(string sql, object param)
            {
                return conn.Query<T>(sql, param, tran).ToList();
            }

            T ITransaction.QueryFirstOrDefault<T>(string sql, object param)
            {
                return conn.QueryFirstOrDefault<T>(sql, param, tran);
            }

            T ITransaction.ExecuteScalar<T>(string sql, object param)
            {
                return conn.ExecuteScalar<T>(sql, param, tran);
            }

            int ITransaction.Execute(string sql, object param)
            {
                return conn.Execute(sql, param, tran);
            }

            void IDisposable.Dispose()
            {
                if (this.tran != null)
                {
                    this.tran.Dispose();
                }

                if (this.conn != null)
                {
                    this.conn.Dispose();
                }
            }
        }

        #endregion

添加事務方法

/*調用方式
         * DBSqlHelper.ExecuteTransaction((trans) =>
         * {
         *     trans.Execute(sqlinsertct, selectedClass);
         *     trans.Execute(sqlinsertict, selectedClass);
         * });
         */
        /// <summary>
        /// 事務方法
        /// </summary>
        /// <param name="tranAction"></param>
        /// <param name="level"></param>
        /// <param name="newConnectionString"></param>
        public void ExecuteTransaction(Action<ITransaction> tranAction, IsolationLevel? level = null, string newConnectionString = null)
        {
            using (IDbConnection conn = new SqlConnection(ConnectionString))
            {
                conn.Open();
                IDbTransaction tran = null;
                if (level == null)
                {
                    tran = conn.BeginTransaction();
                }
                else
                {
                    tran = conn.BeginTransaction(level.Value);
                }
                using (Transaction tranHelper = new Transaction(conn, tran))
                {
                    try
                    {
                        tranAction(tranHelper);
                        tran.Commit();
                    }
                    catch
                    {
                        tran.Rollback();
                        throw;
                    }
                }
            }
        }

添加分頁功能

在“PFT.Snail.Dto”中添加“Common”文件夾，下麵在添加“PageResponse.cs”

/// <summary>
    /// 通用分頁返回
    /// </summary>
    /// <typeparam name="T"></typeparam>
    public class PageResponse<T>
    {
        /// <summary>
        /// 總條數
        /// </summary>
        public long TotalCount { get; set; }

        /// <summary>
        /// 返回
        /// </summary>
        public List<T> Items { get; set; }

        /// <summary>
        /// 當前頁
        /// </summary>
        public long PageIndex { get; set; }

        /// <summary>
        /// 每頁條數
        /// </summary>
        public long PageSize { get; set; }

        /// <summary>
        /// 總頁數
        /// </summary>
        public long TotalPages { get; set; }

        /// <summary>
        /// 返回篩選集合
        /// </summary>
        public Dictionary<string, List<string>> ResultFilter = new Dictionary<string, List<string>>();

    }

在“DapperSqlDB.cs”添加分頁功能

        /// <summary>
        /// Sqlserver 分頁查詢（只支持Sqlserver2012以上資料庫）
        /// </summary>
        /// <typeparam name="T"></typeparam>
        /// <param name="page"></param>
        /// <param name="sql"></param>
        /// <param name="param"></param>
        /// <returns></returns>
        public PageResponse<T> QueryPageSql<T>(PageRequest page, string sql, object param)
        {
            var pageResult = new PageResponse<T>();
            pageResult.PageIndex = page.PageIndex;

            var queryNumSql = new StringBuilder($"SELECT COUNT(1) FROM ({sql}) AS maptable");
            pageResult.TotalCount = ExecuteScalar<int>(queryNumSql.ToString(), param);
            if (pageResult.TotalCount == 0)
            {
                return pageResult;
            }

            var pageMinCount = (page.PageIndex - 1) * page.PageSize + 1;
            if (pageResult.TotalCount < pageMinCount)
            {
                page.PageIndex = (int)((pageResult.TotalCount - 1) / page.PageSize) + 1;
            }

            var querySql = new StringBuilder($@"SELECT maptable.* FROM ({sql}) AS maptable ");
            if (!string.IsNullOrWhiteSpace(page.SortBy))
            {
                querySql.AppendLine(page.GetOrderBySql());
            }
            querySql.AppendLine($" OFFSET {(page.PageIndex - 1) * page.PageSize} ROWS FETCH NEXT {page.PageSize} ROWS ONLY;");

            pageResult.Items = Query<T>(querySql.ToString(), param);
            return pageResult;
        }

分頁的代碼只支持SQl2012以上的版本，如果是一下的版本，可以自己重構代碼。

到現在才算把Dapper框架的運用方法全部實現了。

三、總結

雖然實現了Dapper框架的運用方法，但是在真實的項目中，運用這樣的方法或多或少有很多不便。同時在架構的設計來說，也不是太合理，因為Repository依賴DapperSqlDB的具體實現，需要抽象出介面。既然存在所說的問題，那為什麼不直接寫出最終方法呢？這是因為必須弄清楚Dapper的運用，我們才能夠對他進行定製化的優化。

  


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • 二叉堆【轉】
    什麼是二叉堆？ 二叉堆是一種特殊的堆。具有如下的特性： 1. 具有完全二叉樹的特性。 2. 堆中的任何一個父節點的值都大於等於它左右孩子節點的值(最大堆)，或者都小於等於它左右孩子節點的值（最小堆）。 這個為最大堆： 這個為最小堆： 我們把二叉堆的根節點稱之為堆頂。根據二叉堆的特性，堆頂要嘛是整個堆 ...
  • SpringMVC 視圖解析器 InternalResourceViewResolver
    SpringMVC 視圖解析器 InternalResourceViewResolver 視圖解析器流程 底層源碼分析 ...
  • day53-python之會話
    from django.shortcuts import render,redirect # Create your views here. import datetime def login(request): print("COOKIES",request.COOKIES) print("SES... ...
  • springboot向elk寫日誌
    springboot里連接elk里的logstash，然後寫指定index索引的日誌，而之後使用kibana去查詢和分析日誌，使用elasticsearch去保存日誌。 添加引用 添加配置 指定配置 logstash配置索引 kibana里建立索引 通過kiban菜單去建立索引：Management ...
  • C到C++的升級
    [TOC] 1. C與C++的關係 C++繼承了所有的C特性 C++在C的基礎上提供了更多的新的語法和特性 C++的設計目標是運行效率與開發效率的統一，其開發效率高於C語言 2. 變數聲明與定義 變數可以在使用時定義 C++更強調語言的實用性，所有的變數都可以在需要使用時再定義 C語言中的變數必須在 ...
  • 爬蟲（二）建立代理ip池
    之前我們說網站反爬蟲的一個常用方法是檢測ip，限制訪問頻率。所以我們要通過設置代理ip的辦法繞過這個限制。有不少提供免費代理ip的網站，像https://www.xicidaili.com/nt/，我們可以從網站上拿到很多代理ip。但是這些ip並不是每個都能用的，或者說，沒幾個能用的。 我們可以用b ...
  • 搭建Nuget伺服器（Nuget私服）
    一、前言 對公司或者對個人來說，經過一段時間的沉澱之後，都會有一些框架或者模塊，為了對這些框架或者模塊進行更好的管理和維護，也為了方便後面的開發或者其他同事，我們可以在我們本地或者內網搭建一個Nuget伺服器。當然也可以把相關的Package提交到Nuget官方上去，只是提交上之後，就相當於公開了。 ...
  • wpf 當DataGrid列模版是ComboBox時，顯示信息
    ​ 實際工作中，有時DataGrid控制項某一列顯示數據是從Enum集合裡面選擇出來的，那這時候設置列模版為ComboBox就能滿足需求。而關於顯示的實際內容，直接是Enum的string()返回值可能不太適合，這時候採用System.ComponentModel.Description是一個很好用的 ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發（一）：使用.NET MAUI開發第一個安卓APP
    移動開發（一）：使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說，近來想嘗試開發一款安卓APP，考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP，畢竟是使用Visual Studio開發工具，使用起來也比較的順手，結合微軟官方的教程進行了安卓 ...
  • wpf ToggleButton選中效果和一個登錄界面
    前言 QuestPDF 是一個開源 .NET 庫，用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫，它徹底改變了我們生成 PDF 文檔的方 ...
  • 彈幕樹洞項目功能新增篇
    項目地址 項目後端地址： https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址： ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址： http://tree ...
  • 第27篇 sqlserver2022詳細安裝步驟
    話不多說，直接開乾 一.下載 1.官方鏈接下載： https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe，運行開始下載SQL server； 二. ...
  • .NET 開源高性能 MQTT 類庫
    前言 隨著物聯網（IoT）技術的迅猛發展，MQTT（消息隊列遙測傳輸）協議憑藉其輕量級和高效性，已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫，為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog文檔翻譯系列（六） - 可用的接收器、增強器、格式化輸出
    Serilog支持多種接收器用於日誌存儲，增強器用於添加屬性，LogContext管理動態屬性，支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項，適用於不同需求。 ...
  • 警惕 Visual Studio 屬性求值副作用導致邏輯不符合預期
    目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據，爬取信息時需要模擬瀏覽器行為，否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下： 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • [使用目前最新版]HybridCLR6.9.0+YooAsset2.2.4實現純C# Unity熱更新方案 (一)
    1.前言 什麼是熱更新 游戲或者軟體更新時，無需重新下載客戶端進行安裝，而是在應用程式啟動的情況下，在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR，Xlua，ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles，Addressable， ...
  • 在 ASP.NET Core Web API 中使用操作篩選器統一處理通用操作
    本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺，其實像阿裡雲，騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後，它會送 ...
  • 第28篇 如何.net中實現高效可靠數據同步api
    通過以下方式可以高效，並保證數據同步的可靠性 1.API設計 使用RESTful設計，確保API端點明確，並使用適當的HTTP方法（如POST用於創建，PUT用於更新）。 設計清晰的請求和響應模型，以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證，確保接收到的數據符合預期格 ...
所有分類