快捷導(dǎo)航

輕量級(jí)ORM框架Dapper應(yīng)用之實(shí)現(xiàn)DTO

更新時(shí)間：2022年03月09日 14:04:29 作者：.NET開發(fā)菜鳥

本文詳細(xì)講解了使用Dapper實(shí)現(xiàn)DTO的方法，文中通過示例代碼介紹的非常詳細(xì)。對(duì)大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值，需要的朋友可以參考下

一、什么是DTO

先來(lái)看看百度百科的解釋：

數(shù)據(jù)傳輸對(duì)象（DTO)(Data Transfer Object)，是一種設(shè)計(jì)模式之間傳輸數(shù)據(jù)的軟件應(yīng)用系統(tǒng)。數(shù)據(jù)傳輸目標(biāo)往往是數(shù)據(jù)訪問對(duì)象從數(shù)據(jù)庫(kù)中檢索數(shù)據(jù)。數(shù)據(jù)傳輸對(duì)象與數(shù)據(jù)交互對(duì)象或數(shù)據(jù)訪問對(duì)象之間的差異是一個(gè)以不具有任何行為除了存儲(chǔ)和檢索的數(shù)據(jù)（訪問和存取器）。

二、為什么需要DTO

在一個(gè)軟件系統(tǒng)的實(shí)現(xiàn)中，我們常常需要訪問數(shù)據(jù)庫(kù)，并將從數(shù)據(jù)庫(kù)中所取得的數(shù)據(jù)顯示在用戶界面上。這樣做的一個(gè)問題是：用于在用戶界面上展示的數(shù)據(jù)模型和從數(shù)據(jù)庫(kù)中取得的數(shù)據(jù)模型常常具有較大區(qū)別。在這種情況下，我們常常需要向服務(wù)端發(fā)送多個(gè)請(qǐng)求才能將用于在頁(yè)面中展示的數(shù)據(jù)湊齊。

三、使用Dapper實(shí)現(xiàn)DTO

使用Dapper可以直接返回DTO類型，包括兩種方式：

新建Category、ProductDetail和ProductDTO實(shí)體類：

Category實(shí)體類定義如下：

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;

namespace DapperConvertDto
{
    public class Category
    {
        public int CategoryId { get; set; }
        public string CategoryName { get; set; }
    }
}

ProductDetail實(shí)體類定義如下：

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;

namespace DapperConvertDto
{
    public class ProductDetail
    {
        public int ProductId { get; set; }

        public string ProductName { get; set; }

        public double Price { get; set; }

        public int CategoryId { get; set; }
    }
}

ProductDTO實(shí)體類定義如下：

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;

namespace DapperConvertDto
{
    public class ProductDto
    {
        public int ProductId { get; set; }

        public string ProductName { get; set; }

        public double ProductPrice { get; set; }

        public string CategoryName { get; set; }
    }
}

ProductDTO實(shí)體類中的ProductPrice對(duì)應(yīng)ProductDetail表的Price，CategoryName對(duì)應(yīng)Category表的CategoryName。

方式一：直接在SQL語(yǔ)句中使用as

using System;
using System.Collections.Generic;
using System.Data.SqlClient;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using Dapper;

namespace DapperConvertDto
{
    class Program
    {
        static void Main(string[] args)
        {
            // 數(shù)據(jù)庫(kù)連接
            string strCon = @"Initial Catalog=StudentSystem;     Integrated Security=False;User Id=sa;Password=1qaz@WSX;Data Source=127.0.0.1;Failover Partner=127.0.0.1;Application Name=TransForCCT";
            SqlConnection conn = new SqlConnection(strCon);

            // 方式一：直接在SQL語(yǔ)句中使用as，將查詢的字段轉(zhuǎn)換成DTO類型的屬性
            string strSql = @" SELECT p.ProductId,p.ProductName,p.Price AS ProductPrice,c.CategoryName FROM Category c INNER JOIN ProductDetail p ON c.CategoryId=p.CategoryId ";
            ProductDto product = conn.Query<ProductDto>(strSql).FirstOrDefault<ProductDto>();
        }
    }
}

結(jié)果：

從截圖中看出，返回的就是想要的DTO類型。

方式二：使用委托的方式進(jìn)行映射，分別把Category和ProductDetail實(shí)體類里的屬性，映射成ProductDTO類型的屬性：

using System;
using System.Collections.Generic;
using System.Data.SqlClient;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using Dapper;

namespace DapperConvertDto
{
    class Program
    {
        static void Main(string[] args)
        {
            // 數(shù)據(jù)庫(kù)連接
            string strCon = @"Initial Catalog=StudentSystem;     Integrated Security=False;User Id=sa;Password=1qaz@WSX;Data Source=127.0.0.1;Failover Partner=127.0.0.1;Application Name=TransForCCT";
            SqlConnection conn = new SqlConnection(strCon);

            // 方式一：直接在SQL語(yǔ)句中使用as，將查詢的字段轉(zhuǎn)換成DTO類型的屬性
            string strSql = @" SELECT p.ProductId,p.ProductName,p.Price AS ProductPrice,c.CategoryName FROM Category c INNER JOIN ProductDetail p ON c.CategoryId=p.CategoryId ";
            ProductDto product = conn.Query<ProductDto>(strSql).FirstOrDefault<ProductDto>();

            // 方式二：使用委托進(jìn)行自定義映射
            string strSql2 = @" SELECT p.ProductId,p.ProductName,p.Price,c.CategoryName FROM Category c INNER JOIN ProductDetail p ON c.CategoryId=p.CategoryId ";
            // 定義映射的委托
            Func<ProductDetail, Category, ProductDto> map = (p, c) =>
            {
                ProductDto dto = new ProductDto();
                dto.ProductId = p.ProductId;
                dto.ProductName = p.ProductName;
                dto.ProductPrice = p.Price;
                dto.CategoryName = c.CategoryName;
                return dto;
            };
            // splitOn表示查詢的SQL語(yǔ)句中根據(jù)哪個(gè)字段進(jìn)行分割
            string splitOn = "CategoryName";
            List<ProductDto> list = conn.Query<ProductDetail, Category, ProductDto>(strSql2, map, splitOn: splitOn).ToList<ProductDto>();
        }
    }
}

結(jié)果：

注意：

1、splitOn

splitOn表示查詢的SQL語(yǔ)句中按照哪個(gè)字段進(jìn)行分割，splitOn的順序是從右向左的，遇到splitOn設(shè)置的字段接結(jié)束，把從右邊開始到設(shè)置的這個(gè)字段歸為同一個(gè)實(shí)體。例如：上面的例子中，splitOn設(shè)置為CategoryName，則表示從右邊開始，到CategoryName為止的所有字段都是屬于Category這個(gè)實(shí)體的，剩余的字段都是屬于ProductDetail實(shí)體的。

2、注意委托中實(shí)體類的前后順序

委托中實(shí)體類的前后順序一定要和查詢的SQL語(yǔ)句中字段的前后順序一致，上面的例子中先查詢的ProductDetail、后查詢的Category，那么定義委托的時(shí)候，要先寫ProductDetail，后寫Category，如果委托中實(shí)體類的順序錯(cuò)了，那么不會(huì)得到映射的數(shù)據(jù)，看下面的例子：

using System;
using System.Collections.Generic;
using System.Data.SqlClient;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using Dapper;

namespace DapperConvertDto
{
    class Program
    {
        static void Main(string[] args)
        {
            // 數(shù)據(jù)庫(kù)連接
            string strCon = @"Initial Catalog=StudentSystem;     Integrated Security=False;User Id=sa;Password=1qaz@WSX;Data Source=127.0.0.1;Failover Partner=127.0.0.1;Application Name=TransForCCT";
            SqlConnection conn = new SqlConnection(strCon);

            // 方式一：直接在SQL語(yǔ)句中使用as，將查詢的字段轉(zhuǎn)換成DTO類型的屬性
            string strSql = @" SELECT p.ProductId,p.ProductName,p.Price AS ProductPrice,c.CategoryName FROM Category c INNER JOIN ProductDetail p ON c.CategoryId=p.CategoryId ";
            ProductDto product = conn.Query<ProductDto>(strSql).FirstOrDefault<ProductDto>();

            // 方式二：使用委托進(jìn)行自定義映射
            string strSql2 = @" SELECT p.ProductId,p.ProductName,p.Price,c.CategoryName FROM Category c INNER JOIN ProductDetail p ON c.CategoryId=p.CategoryId ";
            // 定義映射的委托
            //Func<ProductDetail, Category, ProductDto> map = (p, c) =>
            //{
            //    ProductDto dto = new ProductDto();
            //    dto.ProductId = p.ProductId;
            //    dto.ProductName = p.ProductName;
            //    dto.ProductPrice = p.Price;
            //    dto.CategoryName = c.CategoryName;
            //    return dto;
            //};

            // 錯(cuò)誤的委托
            Func<Category, ProductDetail, ProductDto> map = (c,p) =>
            {
                ProductDto dto = new ProductDto();
                dto.ProductId = p.ProductId;
                dto.ProductName = p.ProductName;
                dto.ProductPrice = p.Price;
                dto.CategoryName = c.CategoryName;
                return dto;
            };

            // splitOn表示查詢的SQL語(yǔ)句中根據(jù)哪個(gè)字段進(jìn)行分割
            string splitOn = "CategoryName";
            List<ProductDto> list = conn.Query< Category, ProductDetail, ProductDto>(strSql2, map, splitOn: splitOn).ToList<ProductDto>();
        }
    }
}

結(jié)果：