之前四篇介绍了一个国内开发者开发的优秀框架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(); } }