0. 前言

之前四篇介紹了一個國內開發者開發的優秀框架SqlSugar，給我們眼前一亮的感覺，這一篇，我們將試試另一個出鏡率比較高的ORM框架-Dapper，

Dapper是一個輕量級的ORM框架，其以高速、簡單易用為特點，在某些時候，效率甚至可以與ADO.NET 媲美，那么，吹得天花亂墜，就讓我們實際看看它的表現吧，

1. 開始使用

照例，先創建一個專案：DapperDemo

dotnet new console --name DapperDemo

然后切換到目錄里：

cd DapperDemo

添加包支持：

dotnet add package Dapper

如果不出意外的話，目前專案中已經安裝好了Dapper，現在就讓我們開始愉快的使用吧，

首先，需要注意的一點是，與其他的ORM框架不同的是，Dapper需要我們手動創建一個IConnection，Dapper的所有操作都是依托于IConnection來操作，而且Dapper將其支持的方法封裝成了IConnection的擴展方法，

所以，在使用之前我們需要先創建一個IConnection，為了方便演示，我把之前SqlSugar演示用過的測驗資料庫拿過來了，是一個SQLite，所以我們需要先安裝一個SQLite的驅動：

dotnet add package Microsoft.Data.SQLite

在Program.cs中引入兩個包：

using Microsoft.Data.Sqlite;
using Dapper;

在Main方法里創建一個IConnection：

using(var connection = new SqliteConnection("Data Source=./demo.db"))
{
    
}

2. 多資料查詢

Dapper的查詢相當簡單：

var result = connection.Query("select * from Persion");

傳入一個SQL陳述句，回傳一個可列舉物件，如果不指定型別，將回傳型別為dynamic的串列，我們來看一下Query方法的相關宣告：

public static IEnumerable<dynamic> Query(this IDbConnection cnn, string sql, object param = null, IDbTransaction transaction = null, bool buffered = true, int? commandTimeout = null, CommandType? commandType = null);

public static IEnumerable<T> Query<T>(this IDbConnection cnn, string sql, object param = null, IDbTransaction transaction = null, bool buffered = true, int? commandTimeout = null, CommandType? commandType = null);

public static IEnumerable<TReturn> Query<TReturn>(this IDbConnection cnn, string sql, Type[] types, Func<object[], TReturn> map, object param = null, IDbTransaction transaction = null, bool buffered = true, string splitOn = "Id", int? commandTimeout = null, CommandType? commandType = null);

我們就以最常用的三個為例，給大伙分析一下引數以及呼叫方式：

cnn 一個資料庫連接，所以Dapper不負責管理資料庫連接，這部分由我們手動管理
sql 傳入的SQL陳述句，Dapper以IDbConnection為基礎，以SQL為執行命令，所以必須我們來傳入SQL陳述句
param 一個可以為Null的Object型別，表示SQL的引數化，Dapper對引數化做了一些優化，在SQL的引數化里，引數名映射到了object的屬性上，
transaction 表示是否有IConnection級別的事務，默認為null，傳入后該指令會被事務包含
buffered 快取
commandTimeout 命令執行是否超時以及超時時間
commandType 表示命令模式有 Text 普通模式，StoredProcedure 存盤程序，TableDirect 表查詢
splitOn 默認情況下以Id 作為兩個物件之間的區分

3. 單資料查詢

Dapper在資料查詢方面不僅支持集合作為查詢結果，還可以獲取單個資料，

一共有四種方式獲取單資料：

public static T QueryFirst<T>(this IDbConnection cnn, string sql, object param = null, IDbTransaction transaction = null, int? commandTimeout = null, CommandType? commandType = null);
public static T QueryFirstOrDefault<T>(this IDbConnection cnn, string sql, object param = null, IDbTransaction transaction = null, int? commandTimeout = null, CommandType? commandType = null);

QueryFirst 表示獲取第一條查詢結果，如果沒有結果，則會拋出一個例外，

QueryFirstOrDefault 與QueryFirst一樣，但不同的是，如果沒有則不會拋出例外，而是直接回傳一個該型別的默認值，數值型別的默認值為(0)，參考型別的默認值為Null，

public static T QuerySingle<T>(this IDbConnection cnn, string sql, object param = null, IDbTransaction transaction = null, int? commandTimeout = null, CommandType? commandType = null);
public static T QuerySingleOrDefault<T>(this IDbConnection cnn, string sql, object param = null, IDbTransaction transaction = null, int? commandTimeout = null, CommandType? commandType = null);

QuerySingle也能查詢單條資料作為結果，但與QueryFirst不同的是QuerySingle查詢時，如果資料存在多行將會拋出例外，如果不想要例外則可以使用QuerySingleOrDefault作為查詢方法，

4. QueryMultiple

這個另外一種查詢方式，對于SQL陳述句來說，沒有明顯的限制，所以我們有時候可以傳入多個查詢SQL陳述句進去，然后分別獲取來自各個表的查詢資料：

string sql = "SELECT * FROM Invoice WHERE InvoiceID = @InvoiceID; SELECT * FROM InvoiceItem WHERE InvoiceID = @InvoiceID;";

using (var connection = My.ConnectionFactory())
{
    connection.Open();

    using (var multi = connection.QueryMultiple(sql, new {InvoiceID = 1}))
    {
        var invoice = multi.Read<Invoice>().First();
        var invoiceItems = multi.Read<InvoiceItem>().ToList();
    }
}

看一下它的基本引數和方法宣告：

public static GridReader QueryMultiple(this IDbConnection cnn, string sql, object param = null, IDbTransaction transaction = null, int? commandTimeout = null, CommandType? commandType = null);

這個方法回傳一個GridReader，通過Read方法獲取需要的資料，

5. 不只是查詢

Dapper當然不只有查詢這一項功能，Dapper支持使用存盤程序、insert、update、delete等其他的SQL陳述句進行操作資料庫，使用方式：

string sql = "Invoice_Insert";

using (var connection = My.ConnectionFactory())
{
    var affectedRows = connection.Execute(sql,
        new {Kind = InvoiceKind.WebInvoice, Code = "Single_Insert_1"},
        commandType: CommandType.StoredProcedure);
    var affectedRows2 = connection.Execute(sql,
        new[]
        {
            new {Kind = InvoiceKind.WebInvoice, Code = "Many_Insert_1"},
            new {Kind = InvoiceKind.WebInvoice, Code = "Many_Insert_2"},
            new {Kind = InvoiceKind.StoreInvoice, Code = "Many_Insert_3"}
        },
        commandType: CommandType.StoredProcedure
    );
}

示例就是使用存盤程序的例子，

string sql = "INSERT INTO Customers (CustomerName) Values (@CustomerName);";

using (var connection = new SqlConnection(FiddleHelper.GetConnectionStringSqlServerW3Schools()))
{
    var affectedRows = connection.Execute(sql, new {CustomerName = "Mark"});

    Console.WriteLine(affectedRows);

    var customer = connection.Query<Customer>("Select * FROM CUSTOMERS WHERE CustomerName = 'Mark'").ToList();

    FiddleHelper.WriteTable(customer);
}
//== 多次插入
string sql = "INSERT INTO Customers (CustomerName) Values (@CustomerName);";

using (var connection = new SqlConnection(FiddleHelper.GetConnectionStringSqlServerW3Schools()))
{
    connection.Open();

    var affectedRows = connection.Execute(sql,
    new[]
    {
    new {CustomerName = "John"},
    new {CustomerName = "Andy"},
    new {CustomerName = "Allan"}
    }
);

這是執行插入的示例，

string sql = "UPDATE Categories SET Description = @Description WHERE CategoryID = @CategoryID;";

using (var connection = new SqlConnection(FiddleHelper.GetConnectionStringSqlServerW3Schools()))
{            
    var affectedRows = connection.Execute(sql,new {CategoryID = 1, Description = "Soft drinks, coffees, teas, beers, mixed drinks, and ales"});

    Console.WriteLine(affectedRows);
}

更新，

string sql = "DELETE FROM Customers WHERE CustomerID = @CustomerID";

using (var connection = new SqlConnection(FiddleHelper.GetConnectionStringSqlServerW3Schools()))
{            
    var affectedRows = connection.Execute(sql, new {CustomerID = 1});

    Console.WriteLine(affectedRows);
}

洗掉，

Execute沒什么好說的，基本就是執行SQL陳述句的形式完成增刪改成等操作，

值得注意的是：

public static IDataReader ExecuteReader(this IDbConnection cnn, string sql, object param = null, IDbTransaction transaction = null, int? commandTimeout = null, CommandType? commandType = null);

回傳一個IDataReader實體，這個實體可以給DataTable填充資料，使用方法如下：

DataTable table = new DataTable();
table.Load(reader);

以及：

public static T ExecuteScalar<T>(this IDbConnection cnn, string sql, object param = null, IDbTransaction transaction = null, int? commandTimeout = null, CommandType? commandType = null);

這個方法是回傳查詢結果的第一行第一列的元素，

6. 總結

如果單說Dapper的話，并沒有太多好說的，不過Dapper是真的快，在實際開發中有時候會用Dapper作為EF Core的一個補充，

當然了，Dapper還有很多其他的插件，使用那些插件可以為Dappe帶來非一般的提升，我們下一篇將介紹一下Dapper的插件，

更多內容煩請關注我的博客《高先生小屋》

file

轉載請註明出處，本文鏈接：https://www.uj5u.com/net/30384.html

標籤：C#

上一篇：.NET ValueTuple使用WhenAll獲取多個任務結果

下一篇：C#實作密文解密