Dapper简易教程,环境下三个简练对象映射的框架

正文源自: 

本博客小编与Github上小编(cnxy)实为同2个作者。由于小编翻译水平有限,文本中错误难免,欢迎指正!

 

特性


Dapper
是三个单独的文书,能够放进你的连串中用来扩张你的IDbConnection接口.

它提供了多少个臂膀:

正文内容

  • 特点
  • 性能
  • 参数化的询问
  • List 支持
  • 缓存和非缓存的 readers
  • 几个映射
  • 五个结果
  • 存款和储蓄进程
  • Ansi Strings 和 varchar
  • 限定和注意事项
  • Dapper 能运作在作者的 db 提供者上吗?
  • 有例子的完全例子列表吗?
  • 何人在运用 Dapper?
  • 参考

跳槽了,新集团的数量库层,准确地说,数据库层和持久层使用
Dapper,那东西确实很便宜~个人觉得那种方便性展示在三点:

  1. 能很有利地实行数据库 DML 和 DLL 操作。比如,当您执行八个带参数的 SQL
    时,SQL
    中的变量能与您传递给它的实业或匿名对象中的属性,自定匹配。而我们领悟,带参数的
    SQL,能增进数据库执行 SQL 的频率;
  2. 能很有益于地将数据库检索结果映射为面向对象的指标。从数据库中的检索结果,平日是张二维表,如
    DataTable,而应用程序中是实体类,以及实体类的成团,那么 Dapper
    能够将 DataTable 自动地照耀成为实体类的集纳;
  3. 能很方便地书写 SQL 语句。比如,写多个 SQL,用分号分隔。

本文内容

  • 特点
  • 性能
  • 参数化的查询
  • List 支持
  • 缓存和非缓存的 readers
  • 八个映射
  • 四个结实
  • 仓库储存进程
  • Ansi Strings 和 varchar
  • 界定和注意事项
  • Dapper 能运作在自身的 db 提供者上吧?
  • 有例子的完整例子列表吗?
  • 何人在选用 Dapper?
  • 参考

跳槽了,新集团的多寡库层,准确地说,数据库层和持久层使用
Dapper,那东西确实很便宜~个人觉得这种方便性彰显在三点:

  1. 能很有利地实行数据库 DML 和 DLL 操作。比如,当您执行3个带参数的 SQL
    时,SQL
    中的变量能与你传递给它的实业或匿名对象中的属性,自定匹配。而大家通晓,带参数的
    SQL,能增加数据库执行 SQL 的作用;
  2. 能很有益于地将数据库检索结果映射为面向对象的对象。从数据库中的检索结果,常常是张2维表,如
    DataTable,而应用程序中是实体类,以及实体类的成团,那么 Dapper
    能够将 DataTable 自动地照耀成为实体类的集纳;
  3. 能很方便地书写 SQL 语句。比如,写多少个 SQL,用分号分隔。

本文翻译自:StackExchange.Dapper

施行3个询问,并将结果映射到一个强类型集合中


在意:全部扩充方法若是连接已经打开,假设老是关闭,他们将会失利。

public static IEnumerable<T> Query<T>(this IDbConnection cnn, string sql, object param = null, SqlTransaction transaction = null, bool buffered = true)

动用例子:

public class Dog{    public int? Age { get; set; }    public Guid Id { get; set; }    public string Name { get; set; }    public float? Weight { get; set; }    public int IgnoredProperty { get { return 1; } }}            var guid = Guid.NewGuid();var dog = connection.Query<Dog>("select Age = @Age, Id = @Id", new { Age = (int?)null, Id = guid });dog.Count()    .IsEqualTo(1);dog.First().Age    .IsNull();dog.First().Id    .IsEqualTo;

下载 Demo

下载 Demo

原版教程源自:Dapper Tutorial

履行三个查询,并将结果映射到3个动态类型集合中


该办法将推行SQL和再次来到一个动态集合。

public static IEnumerable<dynamic> Query (this IDbConnection cnn, string sql, object param = null, SqlTransaction transaction = null, bool buffered = true)

使用例子:

var rows = connection.Query("select 1 A, 2 B union all select 3, 4");((int)rows[0].A)   .IsEqualTo(1);((int)rows[0].B)   .IsEqualTo(2);((int)rows[1].A)   .IsEqualTo(3);((int)rows[1].B)    .IsEqualTo(4);

(该下载包蕴 Dapper 项目,项目中有 Dapper 的测试示例和属性测试例子)

(该下载包涵 Dapper 项目,项目中有 Dapper 的测试示例和个性测试例子)

汉语教程源自:中文Dapper教程.GitBook

实践一个命令,不回去结果


public static int Execute(this IDbConnection cnn, string sql, object param = null, SqlTransaction transaction = null)

选择例子:

connection.Execute(@"  set nocount on   create table #t   set nocount off   insert #t   select @a a union all select @b   set nocount on   drop table #t", new {a=1, b=2 })   .IsEqualTo(2);

(Dapper 的以身作则使用 SQLServer 数据库,笔者个人的言传身教是 MySQL)

(Dapper 的以身作则使用 SQLServer 数据库,小编个人的言传身教是 MySQL)

中文教程PDF:dapper-tutorial-cn

多次实施二个限令


相同的占位符允许您方便有效的累累推行3个命令.

选取例子:

connection.Execute(@"insert MyTable(colA, colB) values ",    new[] { new { a=1, b=1 }, new { a=2, b=2 }, new { a=3, b=3 } }  ).IsEqualTo(3); // 3 行 被插入: "1,1", "2,2" and "3,3"

特点


Dapper 只有贰个文书,你能够把它拖到你的品类中,来增添你的
IDbConnection 接口。

它提供了3地点的救助:

特点


Dapper 只有多个文本,你能够把它拖到你的种类中,来扩展你的
IDbConnection 接口。

它提供了三上边的扶植:

Dapper – .Net版本的归纳对象映射器

性能


Dapper的多个重大本性是性质。以下目标呈现对数据库执行500次SELECT语句并回到数据映射到指标,须求多久。

性子测试分为多个表格:

  • POCO类别化框架帮助从数据库到静态类型化对象,通过采纳原有的SQL。
  • 动态类别化框架扶助回到动态目的的列表。
  • 优良的框架使用。平时典型框架使用分裂于最棒的使用质量明智。常常它不会提到编写制定SQL。

施行3个查询,并把结果映射到1个强类型 list

瞩目:全部的扩大方法都假使数据库连接已打开,假若关闭连接,它们将破产。

public static IEnumerable<T> Query<T>(this IDbConnection cnn, string sql, object param = null, SqlTransaction transaction = null, bool buffered = true)

用法:

public class Dog

{

    public int? Age { get; set; }

    public Guid Id { get; set; }

    public string Name { get; set; }

    public float? Weight { get; set; }

 

    public int IgnoredProperty { get { return 1; } }

}            

 

var guid = Guid.NewGuid();

var dog = connection.Query<Dog>("select Age = @Age, Id = @Id", new { Age = (int?)null, Id = guid });

 

dog.Count()

    .IsEqualTo(1);

 

dog.First().Age

    .IsNull();

 

dog.First().Id

    .IsEqualTo(guid);

实践三个查询,并把结果映射到3个强类型 list

专注:全部的增加方法都假诺数据库连接已打开,即便关闭连接,它们将退步。

public static IEnumerable<T> Query<T>(this IDbConnection cnn, string sql, object param = null, SqlTransaction transaction = null, bool buffered = true)

用法:

public class Dog

{

    public int? Age { get; set; }

    public Guid Id { get; set; }

    public string Name { get; set; }

    public float? Weight { get; set; }

 

    public int IgnoredProperty { get { return 1; } }

}            

 

var guid = Guid.NewGuid();

var dog = connection.Query<Dog>("select Age = @Age, Id = @Id", new { Age = (int?)null, Id = guid });

 

dog.Count()

    .IsEqualTo;

 

dog.First().Age

    .IsNull();

 

dog.First().Id

    .IsEqualTo;

亚洲必赢官网,批零表明

请见 stackexchange.github.io/Dapper

500次查询映射的性质-POCO种类化

Method

Duration

Remarks

Hand coded (using aSqlDataReader)

47ms

Can be faster

DapperExecuteMapperQuery

49ms

ServiceStack.OrmLite(QueryById)

50ms

PetaPoco

52ms

BLToolkit

80ms

SubSonic CodingHorror

107ms

NHibernate SQL

104ms

Linq 2 SQLExecuteQuery

181ms

Entity frameworkExecuteStoreQuery

631ms

实施四个询问,并把结果映射到一个动态 object 的 list

public static IEnumerable<dynamic> Query (this IDbConnection cnn, string sql, object param = null, SqlTransaction transaction = null, bool buffered = true)

该措施将履行 SQL,并回到三个动态 list,即 var 变量。

用法:

var rows = connection.Query("select 1 A, 2 B union all select 3, 4");

 

((int)rows[0].A)

   .IsEqualTo(1);

 

((int)rows[0].B)

   .IsEqualTo(2);

 

((int)rows[1].A)

   .IsEqualTo(3);

 

((int)rows[1].B)

    .IsEqualTo(4);

rows[0] 那种访问方式会出错,不明了示例是怎么给的~

推行一个查询,并把结果映射到一个动态 object 的 list

public static IEnumerable<dynamic> Query (this IDbConnection cnn, string sql, object param = null, SqlTransaction transaction = null, bool buffered = true)

该办法将履行 SQL,并赶回1个动态 list,即 var 变量。

用法:

var rows = connection.Query("select 1 A, 2 B union all select 3, 4");

 

((int)rows[0].A)

   .IsEqualTo;

 

((int)rows[0].B)

   .IsEqualTo;

 

((int)rows[1].A)

   .IsEqualTo;

 

((int)rows[1].B)

    .IsEqualTo;

rows[0] 那种访问格局会出错,不明白示例是怎么给的~

组件

Nuget稳定版:

https://www.nuget.org/packages/Dapper

Visual Studio 程序包管理器控制台:

PM> Install-Package Dappe

特点

Dapper是一个Dapper简易教程,环境下三个简练对象映射的框架。NuGet库,您能够将其添加到项目中,以扩充您的IDbConnection接口。

它提供了三个应用办法:

500次查询映射的性子-动态类型体系化

Method

Duration

Remarks

DapperExecuteMapperQuery

48ms

Massive

52ms

Simple.Data

履行1个不回去结果的 Command

public static int Execute(this IDbConnection cnn, string sql, object param = null, SqlTransaction transaction = null)

用法:

connection.Execute(@"

  set nocount on 

  create table #t(i int) 

  set nocount off 

  insert #t 

  select @a a union all select @b 

  set nocount on 

  drop table #t", new {a=1, b=2 })

   .IsEqualTo(2);

施行一个不回去结果的 Command

public static int Execute(this IDbConnection cnn, string sql, object param = null, SqlTransaction transaction = null)

用法:

connection.Execute(@"

  set nocount on 

  create table #t 

  set nocount off 

  insert #t 

  select @a a union all select @b 

  set nocount on 

  drop table #t", new {a=1, b=2 })

   .IsEqualTo;

进行贰个查询并将结果映射到强类型列表

public static IEnumerable<T> Query<T>(this IDbConnection cnn, string sql, object param = null, SqlTransaction transaction = null, bool buffered = true)

示例:

public class Dog
{
    public int? Age { get; set; }
    public Guid Id { get; set; }
    public string Name { get; set; }
    public float? Weight { get; set; }

    public int IgnoredProperty { get { return 1; } }
}

var guid = Guid.NewGuid();
var dog = connection.Query<Dog>("select Age = @Age, Id = @Id", new { Age = (int?)null, Id = guid });

Assert.Equal(1,dog.Count());
Assert.Null(dog.First().Age);
Assert.Equal(guid, dog.First().Id);

500次询问映射的属性-经典框架使用

Method Duration Remarks
Linq 2 SQL CompiledQuery 81ms Not super typical involves complex code
NHibernate HQL 118ms
Linq 2 SQL 559ms
Entity framework 859ms
SubSonic ActiveRecord.SingleOrDefault 3619ms

再3推行贰个 Command


同一的签订契约也足以让您方便高效地对2个下令执行数十三遍,例如批量加载数据(bulk-load
data)。

用法:

connection.Execute(@"insert MyTable(colA, colB) values (@a, @b)",

    new[] { new { a=1, b=1 }, new { a=2, b=2 }, new { a=3, b=3 } }

  ).IsEqualTo(3); // 3 rows inserted: "1,1", "2,2" and "3,3"

对任何类型达成 TIEnumerable 的参数都能够推行。

往往执行一个 Command


1律的署名也能够让你方便快速地对3个发令执行多次,例如批量加载数据(bulk-load
data)。

用法:

connection.Execute(@"insert MyTable(colA, colB) values ",

    new[] { new { a=1, b=1 }, new { a=2, b=2 }, new { a=3, b=3 } }

  ).IsEqualTo; // 3 rows inserted: "1,1", "2,2" and "3,3"

对其余项目完毕 TIEnumerable 的参数都得以执行。

施行三个查询并将其映射到动态目的列表

public static IEnumerable<dynamic> Query (this IDbConnection cnn, string sql, object param = null, SqlTransaction transaction = null, bool buffered = true)

本条方法会执行SQL语句,并回到3个动态列表。

示例:

var rows = connection.Query("select 1 A, 2 B union all select 3, 4");

Assert.Equal(1, (int)rows[0].A);
Assert.Equal(2, (int)rows[0].B);
Assert.Equal(3, (int)rows[1].A);
Assert.Equal(4, (int)rows[1].B);

参数化查询


参数字传送递匿名类。那允许你命名参数不难和使你能够简单剪切和粘贴SQL代码片段在询问分析器和周转它们。

new {A = 1, B = "b"} // A 会被映射出参数 @A, B 对应 @B 

性能


Dapper 的重中之重特点是性质。以下数据显示对多个数据库执行 SELECT 出 500
条,并把数量映射到对象中供给多久。

属性测试分为多个地点:

  • POCO 类别化框架,支持从数据库得到静态类型的靶子。使用原有的 SQL。
  • 动态类别化框架,帮助回到对象的动态列表。
  • 卓越的框架用法。往往不会涉及编写制定 SQL。

性能


Dapper 的要紧特征是性质。以下数据突显对叁个数据库执行 SELECT 出 500
条,并把数据映射到对象中需求多久。

本性测试分为四个地点:

  • POCO 连串化框架,援助从数据库得到静态类型的目的。使用原有的 SQL。
  • 动态连串化框架,帮衬回到对象的动态列表。
  • 典型的框架用法。往往不会涉及编写制定 SQL。

履行不回来结果的通令

public static int Execute(this IDbConnection cnn, string sql, object param = null, SqlTransaction transaction = null)

示例:

var count = connection.Execute(@"
  set nocount on
  create table #t(i int)
  set nocount off
  insert #t
  select @a a union all select @b
  set nocount on
  drop table #t", new {a=1, b=2 });
Assert.Equal(2, count);

聚集参数的支撑


Dapper允许您通过IEnumerable,自动化您的查询参数.

应用例子:

connection.Query<int>("select * from (select 1 as Id union all select 2 union all select 3) as X where Id in @Ids", new { Ids = new int[] { 1, 2, 3 });

将会被分析成这样:

select * from (select 1 as Id union all select 2 union all select 3) as X where Id in (@Ids1, @Ids2, @Ids3)" // @Ids1 = 1 , @Ids2 = 2 , @Ids2 = 3

Performance of SELECT mapping over 500 iterations – POCO 序列化

方法

持续时间(毫秒)

备注

Hand coded (using a SqlDataReader)

47

Can be faster

Dapper ExecuteMapperQuery

49

同上

ServiceStack.OrmLite (QueryById)

50

同上

PetaPoco 

52

同上

BLToolkit

80

同上

SubSonic CodingHorror

107

同上

NHibernate SQL

104

同上

Linq 2 SQL ExecuteQuery

181

同上

Entity framework ExecuteStoreQuery

631

同上

Performance of SELECT mapping over 500 iterations – POCO 序列化

方法

持续时间

备注

Hand coded (using a SqlDataReader)

47

Can be faster

Dapper ExecuteMapperQuery

49

同上

ServiceStack.OrmLite (QueryById)

50

同上

PetaPoco 

52

同上

BLToolkit

80

同上

SubSonic CodingHorror

107

同上

NHibernate SQL

104

同上

Linq 2 SQL ExecuteQuery

181

同上

Entity framework ExecuteStoreQuery

631

同上

反复执行命令

还允许使用相同的参数签名方便有效地频仍执行命令(例如批量加载数据)

示例:

var count = connection.Execute(@"insert MyTable(colA, colB) values (@a, @b)",
    new[] { new { a=1, b=1 }, new { a=2, b=2 }, new { a=3, b=3 } }
  );
Assert.Equal(3, count); // 插入3行: "1,1", "2,2" 与 "3,3"

那适用于已经完结IEnumerable接口的集合对象T。

缓冲和无缓冲的读者


Dapper的默许行为是实践sql和缓冲整个reader在重返。那是美好的在多数状态下,因为它最大限度地回落共享锁在数据库和削减了数据库在网络上的岁月。

而是当执行查询您恐怕供给减小内部存款和储蓄器占用并基于须要只加载对象。

Performance of SELECT mapping over 500 iterations – dynamic 序列化

方法

持续时间(毫秒)

备注

Dapper ExecuteMapperQuery (dynamic)

48

 

Massive

52

 

Simple.Data

95

 

Performance of SELECT mapping over 500 iterations – dynamic 序列化

方法

持续时间

备注

Dapper ExecuteMapperQuery

48

 

Massive

52

 

Simple.Data

95

 

性能

Dapper的一个最首要天性是性质。
以下度量准则呈现了对DB执行500个SELECT说话并将重临的数码映射到对象所需的时日。

属性测试分为一个列表:

  • 支撑从数据库中提取静态类型对象框架的POCO连串化,使用原生SQL语句。
  • 支撑回到动态指标列表框架的动态连串化。
  • 优秀的框架用法:经常典型的框架使用与一级使用质量明显例外,并且它不会提到编写制定SQL语句。

多个映射


Dapper允许单个记录映射到五个目的。这是三个重视特性,假使您想幸免无关的询问和心弛神往加载关联的指标。

动用例子:

var sql = @"select * from #Posts p left join #Users u on u.Id = p.OwnerId Order by p.Id";var data = connection.Query<Post, User, Post>(sql, (post, user) => { post.Owner = user; return post;});//泛型的最后一个参数是要返回的类型var post = data.First();post.Content.IsEqualTo("Sams Post1");post.Id.IsEqualTo(1);post.Owner.Name.IsEqualTo("Sam");post.Owner.Id.IsEqualTo(99);

首要注意Dapper假使您的Id列命名称为“Id”或“Id”,倘诺你的主键不是,或你想分割宽行的“Id”,使用可选的“splitOn”参数。

Performance of SELECT mapping over 500 iterations – 典型用法

方法

持续时间(毫秒)

备注

Linq 2 SQL CompiledQuery

81

Not super typical involves complex code

NHibernate HQL

118

 

Linq 2 SQL

559

 

Entity framework

859

 

SubSonic ActiveRecord.SingleOrDefault

3619

 

Performance of SELECT mapping over 500 iterations – 典型用法

方法

持续时间

备注

Linq 2 SQL CompiledQuery

81

Not super typical involves complex code

NHibernate HQL

118

 

Linq 2 SQL

559

 

Entity framework

859

 

SubSonic ActiveRecord.SingleOrDefault

3619

 

当先500次迭代的SELECT映射质量 – POCO种类化

方法 执行时间 备注
手工编码 (使用 SqlDataReader) 47ms  
Dapper ExecuteMapperQuery 49ms  
ServiceStack.OrmLite (使用Id查询) 50ms  
PetaPoco 52ms 可以更快
BLToolkit 80ms  
SubSonic CodingHorror 107ms  
NHibernate SQL 104ms  
Linq 2 SQL ExecuteQuery 181ms  
Entity framework ExecuteStoreQuery 631ms  

多个结实


Dapper允许您处理八个结果在一个查询中.

例子:

var sql = @"select * from Customers where CustomerId = @idselect * from Orders where CustomerId = @idselect * from Returns where CustomerId = @id";using (var multi = connection.QueryMultiple(sql, new {id=selectedId})){   var customer = multi.Read<Customer>().Single();   var orders = multi.Read<Order>().ToList();   var returns = multi.Read<Return>().ToList();   ...} 

参数化的查询


参数可以视作匿名类来传递。那使你能够轻松地给命名参数,只要不难地分开和粘贴
SQL 片断,并在查询分析器中进行即可。

new {A = 1, B = "b"} // A will be mapped to the param @A, B to the param @B 

参数化的查询


参数能够当作匿名类来传递。这使您能够轻松地给命名参数,只要简单地划分和粘贴
SQL 片断,并在查询分析器中执行即可。

new {A = 1, B = "b"} // A will be mapped to the param @A, B to the param @B 

超越500次迭代的SELECT映射品质 – 动态类别化

方法 执行时间 备注
Dapper ExecuteMapperQuery (动态) 48ms  
Massive 52ms  
Simple.Data 95ms  

积存进度


Dapper完全支持存款和储蓄进度

var user = cnn.Query<User>("spGetUser", new {Id = 1},         commandType: CommandType.StoredProcedure).SingleOrDefault();

只要您想做的更了不起你能够那样:

var p = new DynamicParameters();p.Add("@a", 11);p.Add("@b", dbType: DbType.Int32, direction: ParameterDirection.Output);p.Add("@c", dbType: DbType.Int32, direction: ParameterDirection.ReturnValue);cnn.Execute("spMagicProc", p, commandType: CommandType.StoredProcedure); int b = p.Get<int>("@b");int c = p.Get<int>("@c"); 

List 支持


Dapper 运营让你传递 IEnumerable,自动地参数化的询问。

例如上面 SQL 的 in 查询:

connection.Query<int>("select * from (select 1 as Id union all select 2 union all select 3) as X where Id in @Ids", new { Ids = new int[] { 1, 2, 3 });

将被翻译为:

select * from (select 1 as Id union all select 2 union all select 3) as X where Id in (@Ids1, @Ids2, @Ids3)" // @Ids1 = 1 , @Ids2 = 2 , @Ids2 = 3

List 支持


Dapper 运维让你传递 IEnumerable,自动地参数化的查询。

譬如上面 SQL 的 in 查询:

connection.Query<int>("select * from (select 1 as Id union all select 2 union all select 3) as X where Id in @Ids", new { Ids = new int[] { 1, 2, 3 });

将被翻译为:

select * from (select 1 as Id union all select 2 union all select 3) as X where Id in (@Ids1, @Ids2, @Ids3)" // @Ids1 = 1 , @Ids2 = 2 , @Ids2 = 3

超过500次迭代的SELECT映射质量 – 典型用法

方法 执行时间 备注
Linq 2 SQL CompiledQuery 81ms 非典型的且不涉及复杂的代码
NHibernate HQL 118ms  
Linq 2 SQL 559ms  
Entity framework 859ms  
SubSonic ActiveRecord.SingleOrDefault 3619ms  

品质基准测试新闻 点击那里.

能够4意提交蕴含其余O库罗德M的补丁 –
运营条件测试时,请保管在Release中编写翻译,且不能够附加调节和测试器 (Ctrl+F5).

可能,你能够行使Frans
Bouma的RawDataAccessBencher或OrmBenchmark测试套件作为测试工具使用。

Ansi字符串和varchar


Dapper帮助varchar
params,若是您是3个varchar列上实行二个where子句使用参数一定要经过它以那种办法:

Query<Thing>("select * from Thing where Name = @Name", new {Name = new DbString { Value = "abcde", IsFixedLength = true, Length = 10, IsAnsi = true });

在Sql Server上海重机厂要,查询时选用unicode
unicode和ansi当查询非unicode的时候。

缓存和非缓存的 readers


Dapper 的暗许动作是推行 SQL 并在回到时缓冲整个
reader。在多数景观下,那是尽善尽美的,因为它能最大限度地回落数据库中的共享锁,以及收缩数据库的互连网时间。

而是,在执行庞大查询时,你大概为了削减内存的占有,只加载需求的靶子。要做到这一点,通过缓冲到查询办法中。

/// <summary>

/// NonBuffered

/// 将会抛出异常,Invalid attempt to Read when reader is closed.

/// </summary>

public static void TestBasicStringUsageAsyncNonBuffered()

{

    var query = DbHelp.QueryAsync<string>(new CommandDefinition("select 'abc' as Value union all select @txt", new { txt = "def" }, flags: CommandFlags.None));

    var arr = query.Result.ToArray();

    arr.IsSequenceEqualTo(new[] { "abc", "def" });

}

 

/// <summary>

/// Buffered

/// 不会抛出异常

/// </summary>

public static void TestBasicStringUsageAsyncBuffered()

{

    var query = DbHelp.QueryAsync<string>(new CommandDefinition("select 'abc' as Value union all select @txt", new { txt = "def" }, flags: CommandFlags.Buffered));

    var arr = query.Result.ToArray();

    arr.IsSequenceEqualTo(new[] { "abc", "def" });

}

/// <summary>

/// Pipelined

/// 将会抛出异常,Invalid attempt to Read when reader is closed.

/// </summary>

public static void TestBasicStringUsageAsyncPipelined()

{

    var query = DbHelp.QueryAsync<string>(new CommandDefinition("select 'abc' as Value union all select @txt", new { txt = "def" }, flags: CommandFlags.Pipelined));

    var arr = query.Result.ToArray();

    arr.IsSequenceEqualTo(new[] { "abc", "def" });

}

缓存和非缓存的 readers


Dapper 的私下认可动作是实行 SQL 并在回来时缓冲整个
reader。在大部分景色下,那是优质的,因为它能最大限度地缩减数据库中的共享锁,以及缩小数据库的互联网时间。

可是,在执行庞大查询时,你或然为了削减内部存款和储蓄器的挤占,只加载要求的靶子。要做到那点,通过缓冲到查询办法中。

/// <summary>

/// NonBuffered

/// 将会抛出异常,Invalid attempt to Read when reader is closed.

/// </summary>

public static void TestBasicStringUsageAsyncNonBuffered()

{

    var query = DbHelp.QueryAsync<string>(new CommandDefinition("select 'abc' as Value union all select @txt", new { txt = "def" }, flags: CommandFlags.None));

    var arr = query.Result.ToArray();

    arr.IsSequenceEqualTo(new[] { "abc", "def" });

}

 

/// <summary>

/// Buffered

/// 不会抛出异常

/// </summary>

public static void TestBasicStringUsageAsyncBuffered()

{

    var query = DbHelp.QueryAsync<string>(new CommandDefinition("select 'abc' as Value union all select @txt", new { txt = "def" }, flags: CommandFlags.Buffered));

    var arr = query.Result.ToArray();

    arr.IsSequenceEqualTo(new[] { "abc", "def" });

}

/// <summary>

/// Pipelined

/// 将会抛出异常,Invalid attempt to Read when reader is closed.

/// </summary>

public static void TestBasicStringUsageAsyncPipelined()

{

    var query = DbHelp.QueryAsync<string>(new CommandDefinition("select 'abc' as Value union all select @txt", new { txt = "def" }, flags: CommandFlags.Pipelined));

    var arr = query.Result.ToArray();

    arr.IsSequenceEqualTo(new[] { "abc", "def" });

}

参数化查询

可以匿名类型作为参数进行传递,那足以轻松地命名那些参数名称,且能够在数据库平台的查询分析器中回顾地行使剪切、粘贴SQL语句并运维。

new {A = 1, B = "b"} // A映射到参数@A,B映射到参数@B

限制和警戒


Dapper缓存新闻每种查询在它运转时,那使它很快实现目的和工艺参数。当前的落到实处在ConcurrentDictionary最终对象缓存这个新闻。它存款和储蓄的靶子不会被刷新。如若您是动态生成SQL字符串不选用参数有望你将蒙受内部存款和储蓄器难题。我们得以把词典转换为一个LRU缓存。

几个映射


Dapper
允许你把单行映射到四个指标。假如您想制止额外的查询和加载关联,那么这一个效果就很重点了。

例如:

var sql = 

@"select * from #Posts p 

left join #Users u on u.Id = p.OwnerId 

Order by p.Id";

 

var data = connection.Query<Post, User, Post>(sql, (post, user) => { post.Owner = user; return post;});

var post = data.First();

 

post.Content.IsEqualTo("Sams Post1");

post.Id.IsEqualTo(1);

post.Owner.Name.IsEqualTo("Sam");

post.Owner.Id.IsEqualTo(99);

提示:Dapper 假定你的 ID
列被命名叫“ID”或“id”,即使您的主键是差异的,或许你想在点上拆分宽行点,而不是“ID”,能够行使可选的’splitOn’参数。

多少个映射


Dapper
允许你把单行映射到几个对象。假诺你想制止额外的询问和加载关联,那么那么些功用就很主要了。

例如:

var sql = 

@"select * from #Posts p 

left join #Users u on u.Id = p.OwnerId 

Order by p.Id";

 

var data = connection.Query<Post, User, Post>(sql, (post, user) => { post.Owner = user; return post;});

var post = data.First();

 

post.Content.IsEqualTo("Sams Post1");

post.Id.IsEqualTo;

post.Owner.Name.IsEqualTo("Sam");

post.Owner.Id.IsEqualTo;

晋升:Dapper 假定你的 ID
列被取名字为“ID”或“id”,假诺你的主键是区别的,大概您想在点上拆分宽行点,而不是“ID”,能够动用可选的’splitOn’参数。

列表协助

Dapper允许将IEnumerable<int>用作传递参数,并能够活动地参数化查询

例子:

connection.Query<int>("select * from (select 1 as Id union all select 2 union all select 3) as X where Id in @Ids", new { Ids = new int[] { 1, 2, 3 } });

以少将被转换到:

select * from (select 1 as Id union all select 2 union all select 3) as X where Id in (@Ids1, @Ids2, @Ids3)" // @Ids1 = 1 , @Ids2 = 2 , @Ids2 = 3

本身能在本身的数据库中使用啊?


Dapper未有DB具体的达成细节,它在拥有工作。净ADO提供者includingSQLite、SQL
CE、火鸟、Oracle、MySQL、PostgreSQL和SQL服务器。

两个结果


Dapper 允许你在一次询问中处理多少个结果的会合。

例如:

var sql = 

@"

select * from Customers where CustomerId = @id

select * from Orders where CustomerId = @id

select * from Returns where CustomerId = @id";

 

using (var multi = connection.QueryMultiple(sql, new {id=selectedId}))

{

   var customer = multi.Read<Customer>().Single();

   var orders = multi.Read<Order>().ToList();

   var returns = multi.Read<Return>().ToList();

   ...

} 

四个结果


Dapper 允许你在1回询问中处理七个结实的聚众。

例如:

var sql = 

@"

select * from Customers where CustomerId = @id

select * from Orders where CustomerId = @id

select * from Returns where CustomerId = @id";

 

using (var multi = connection.QueryMultiple(sql, new {id=selectedId}))

{

   var customer = multi.Read<Customer>().Single();

   var orders = multi.Read<Order>().ToList();

   var returns = multi.Read<Return>().ToList();

   ...

} 

文字代替

Dapper援助布尔与数字类型的文字代替。

connection.Query("select * from User where UserId = {=Id}", new {Id = 1}));

文字替换不作为参数发送;
更好的布署和过滤索引用法将被允许,但普通应严苛在测试后接纳。
当注入的值实际上是固定值(例如,特定于查询的“体系ID”,“状态代码”或“区域”)时,此成效越发有用。
当你在考虑文字live数量时,也有不小希望想到also并测试特定于提供程序的询问提醒,如带有常规参数的OPTIMIZE FOR UNKNOWN

仓库储存进度


Dapper 完全扶助存款和储蓄进度:

var user = cnn.Query<User>("spGetUser", new {Id = 1}, 

        commandType: CommandType.StoredProcedure).First();}}}

假使你想要更灵敏的操作,能够这么做:

var p = new DynamicParameters();

p.Add("@a", 11);

p.Add("@b", dbType: DbType.Int32, direction: ParameterDirection.Output);

p.Add("@c", dbType: DbType.Int32, direction: ParameterDirection.ReturnValue);

 

cnn.Execute("spMagicProc", p, commandType: CommandType.StoredProcedure); 

 

int b = p.Get<int>("@b");

int c = p.Get<int>("@c"); 

Ansi Strings 和 varchar


Dapper 扶助 varchar 参数,假使你在一个 varchar 列上实施三个 where
语句,确定保证上边情势传递参数:

Query<Thing>("select * from Thing where Name = @Name", new {Name = new DbString { Value = "abcde", IsFixedLength = true, Length = 10, IsAnsi = true });

在 SQL Server 上,当查问非 Unicode 时,查询 Unicode 和 ANSI 时须求动用
Unicode。

仓库储存进程


Dapper 完全援助存款和储蓄进度:

var user = cnn.Query<User>("spGetUser", new {Id = 1}, 

        commandType: CommandType.StoredProcedure).First();}}}

倘使您想要更灵敏的操作,能够那样做:

var p = new DynamicParameters();

p.Add("@a", 11);

p.Add("@b", dbType: DbType.Int32, direction: ParameterDirection.Output);

p.Add("@c", dbType: DbType.Int32, direction: ParameterDirection.ReturnValue);

 

cnn.Execute("spMagicProc", p, commandType: CommandType.StoredProcedure); 

 

int b = p.Get<int>("@b");

int c = p.Get<int>("@c"); 

Ansi Strings 和 varchar


Dapper 帮忙 varchar 参数,如果您在3个 varchar 列上实施多个 where
语句,确认保障上面方式传递参数:

Query<Thing>("select * from Thing where Name = @Name", new {Name = new DbString { Value = "abcde", IsFixedLength = true, Length = 10, IsAnsi = true });

在 SQL Server 上,当查问非 Unicode 时,查询 Unicode 和 ANSI 时供给运用
Unicode。

缓冲与未缓冲阅读器

Dapper的私下认可行为是执行SQL并在回到时缓冲整个阅读器。
在多数情景下,那是能够的,因为它最小化了数据库中的共享锁并减少了数据库网络时间。

可是,在实施大气查询时,只怕须要最小化内部存款和储蓄器占用并仅根据供给加载对象。
为此,将buffered:false传递给Query方法。

范围和注意事项


对此 Dapper
执行的种种查询的缓存消息,使得它可以火速地物化对象和处理参数。当前的贯彻把音讯缓存在八个ConcurrentDictionary 对象中。它存款和储蓄的靶子永远不会被刷新。假设你转移的
SQL 字符串没有行使参数,那么大概会出现命中内部存款和储蓄器问题。大家把字典转换到LRU(Least Recently Used)缓存。

O奥迪Q叁M 的不在少数个性都被 Dapper 去掉了,未有身份地图(Identity
Map),未有更新/选拔的助理员等。

Dapper 不会管理你总是的生命周期,它壹旦它获得的连日是开辟的,并且不设有
DataReader 枚举(除非启用 MARS)。

什么是 Mars?它是在创制数据库连接时钦定的,下边是 Dapper 中总是 SQL
Server 的以身作则:

public static SqlConnection GetOpenConnection(bool mars = false)

{

    var cs = connectionString;

    if (mars)

    {

        SqlConnectionStringBuilder scsb = new SqlConnectionStringBuilder(cs);

        scsb.MultipleActiveResultSets = true;

        cs = scsb.ConnectionString;

    }

    var connection = new SqlConnection(cs);

    connection.Open();

    return connection;

}

假设钦定了 马尔斯,那么还会成立 SqlConnectionStringBuilder,并钦点其
MultipleActiveResultSets 属性为 true。不过,看 Dapper 的例子,貌似
SQL Server 是有 Mars 的,但 MySQL 没有。

限制和注意事项


对此 Dapper
执行的各样查询的缓存音信,使得它亦可高效地物化对象和处理参数。当前的完毕把音信缓存在二个ConcurrentDictionary 对象中。它存款和储蓄的靶子永远不会被刷新。倘诺你转移的
SQL 字符串没有接纳参数,那么大概会出现命中内部存款和储蓄器难点。大家把字典转换来LRU(Least Recently Used)缓存。

OLX570M 的广大天性都被 Dapper 去掉了,未有身份地图(Identity
Map),未有更新/接纳的臂膀等。

Dapper 不会管理你总是的生命周期,它如果它赢得的连天是打开的,并且不设有
DataReader 枚举(除非启用 MA大切诺基S)。

什么是 马尔斯?它是在创立数据库连接时钦命的,下边是 Dapper 中总是 SQL
Server 的言传身教:

public static SqlConnection GetOpenConnection(bool mars = false)

{

    var cs = connectionString;

    if 

    {

        SqlConnectionStringBuilder scsb = new SqlConnectionStringBuilder;

        scsb.MultipleActiveResultSets = true;

        cs = scsb.ConnectionString;

    }

    var connection = new SqlConnection;

    connection.Open();

    return connection;

}

若是内定了 马尔斯,那么还会创立 SqlConnectionStringBuilder,并钦定其
MultipleActiveResultSets 属性为 true。不过,看 Dapper 的例子,貌似
SQL Server 是有 Mars 的,但 MySQL 没有。

多重映射

Dapper允许将单个行映射到多少个对象。
借使想幸免毫不相关的询问和及时加载关联,那是叁个很要紧的特点。

例子:

沉凝那七个类: Post and User

class Post
{
    public int Id { get; set; }
    public string Title { get; set; }
    public string Content { get; set; }
    public User Owner { get; set; }
}

class User
{
    public int Id { get; set; }
    public string Name { get; set; }
}

目前大家要把posts表单与users表单进行映射查询。到近期停止,假如我们须要结合1个查询的结果,大家供给一个新的目的来抒发它,但在那种场合下将User目的放在Post目的中更有意义。

那是多重映射的用户案例。你告诉dapper查询重回3个Post和一个User目的,然后给它描述您想要对含有PostUser指标的每1行做什么样的函数。
在大家的例证中,大家想要获取用户对象并将其位于post对象中。所以编写函数如下:

(post, user) => { post.Owner = user; return post; }

Query主意的3个类型参数钦命dapper应该选用什么对象及重回的剧情开始展览反系列化行。大家将把那两行解释为PostUser的咬合,然后大家回来2个Post目的。
因而类型注解变为

<Post, User, Post>

怀有东西都位于壹起,看起来像这么:

var sql =
@"select * from #Posts p
left join #Users u on u.Id = p.OwnerId
Order by p.Id";

var data = connection.Query<Post, User, Post>(sql, (post, user) => { post.Owner = user; return post;});
var post = data.First();

Assert.Equal("Sams Post1", post.Content);
Assert.Equal(1, post.Id);
Assert.Equal("Sam", post.Owner.Name);
Assert.Equal(99, post.Owner.Id);

Dapper能够透过假使Id列被取名字为“Id”或“id”来拆分再次回到的行。
假设主键区别大概希望将行拆分为“Id”以外的其余岗位,请使用可选的splitOn参数。

Dapper 能运营在自己的 db 提供者上啊?


Dapper 能运作在拥有 .net ado 提供者上,包蕴sqlite,sqlce,firebird,oracle,MySQL,PostgreSQL 和 SQL Server。

Dapper 能运营在自己的 db 提供者上啊?


Dapper 能运维在颇具 .net ado 提供者上,包涵sqlite,sqlce,firebird,oracle,MySQL,PostgreSQL 和 SQL Server。

多重结果

Dapper允许在单个查询中拍卖四个结实。

例子:

var sql =
@"
select * from Customers where CustomerId = @id
select * from Orders where CustomerId = @id
select * from Returns where CustomerId = @id";

using (var multi = connection.QueryMultiple(sql, new {id=selectedId}))
{
   var customer = multi.Read<Customer>().Single();
   var orders = multi.Read<Order>().ToList();
   var returns = multi.Read<Return>().ToList();
   ...
}

有例子的完全例子列表吗?


Dapper
在测试项目中有完全的测试套件。

有例子的完整例子列表吗?


Dapper 在测试项目中有整体的测试套件。

仓库储存进程

Dapper完全扶助存款和储蓄进度:

var user = cnn.Query<User>("spGetUser", new {Id = 1},
        commandType: CommandType.StoredProcedure).SingleOrDefault();

要是您想要更好玩的东西,你能够这么做:

var p = new DynamicParameters();
p.Add("@a", 11);
p.Add("@b", dbType: DbType.Int32, direction: ParameterDirection.Output);
p.Add("@c", dbType: DbType.Int32, direction: ParameterDirection.ReturnValue);

cnn.Execute("spMagicProc", p, commandType: CommandType.StoredProcedure);

int b = p.Get<int>("@b");
int c = p.Get<int>("@c");

什么人在利用 Dapper?


当前选择 Dapper 的有 Stack Overflow 和
helpdesk。

(if you would like to be listed here let me know)

何人在动用 Dapper?


时下选择 Dapper 的有 Stack Overflow 和 helpdesk。

(if you would like to be listed here let me know)

Ansi字符串和varchar

Dapper扶助varchar参数,假若使用param在varchar列上执行where子句,请确认保证以那种方法传送它:

Query<Thing>("select * from Thing where Name = @Name", new {Name = new DbString { Value = "abcde", IsFixedLength = true, Length = 10, IsAnsi = true });

在SQL
Server中,使用unicode编码查询unicode与ANSI编码或询问非unicode编码时,变得至关心重视要。

参考资料


  • github Dapper
  • stackoverflow
    Dapper
  • A Look at
    Dapper.NET

 

下载 Demo

参考资料


  • github Dapper
  • stackoverflow Dapper
  • A Look at Dapper.NET

 

下载 Demo

每行类型转换

平凡,本身愿意将给定表中的全部行视为同样的数据类型。
不过,在一些景况下,可以将区别的行解析为差别的数据类型是卓有功能的。
那便是IDataReader.GetRowParser派上用场的地方。

万壹有一个名叫“Shapes”的数据库表,在这之中饱含列:IdTypeData,你想要基于Type列的值将它的行解析为CircleSquareTriangle对象。

var shapes = new List<IShape>();
using (var reader = connection.ExecuteReader("select * from Shapes"))
{
    // Generate a row parser for each type you expect.
    // The generic type <IShape> is what the parser will return.
    // The argument (typeof(*)) is the concrete type to parse.
    var circleParser = reader.GetRowParser<IShape>(typeof(Circle));
    var squareParser = reader.GetRowParser<IShape>(typeof(Square));
    var triangleParser = reader.GetRowParser<IShape>(typeof(Triangle));

    var typeColumnIndex = reader.GetOrdinal("Type");

    while (reader.Read())
    {
        IShape shape;
        var type = (ShapeType)reader.GetInt32(typeColumnIndex);
        switch (type)
        {
              case ShapeType.Circle:
                shape = circleParser(reader);
                break;
            case ShapeType.Square:
                shape = squareParser(reader);
                break;
            case ShapeType.Triangle:
                shape = triangleParser(reader);
                break;
              default:
                throw new NotImplementedException();
        }

          shapes.Add(shape);
    }
}

范围与警示

Dapper缓存有关它运转的各种查询的新闻,这使它亦可高效实现指标并快捷处理参数。
当前落到实处将此音讯缓存在ConcurrentDictionary目的中。仅使用二次的言辞经常会从此缓存中刷新。纵然如此,要是你在不接纳参数的情事下动态生成SQL字符串,则或者会遇到内存难点。

Dapper的简洁性意味着OSportageM附带的多多功力都被剥离了。Dapper担心玖五%的气象,并为您提供抢先6壹%小时所需的工具,并不打算缓解全体标题。

Dapper扶助什么数据库?

Dapper未有特定于DB的兑现细节,它适用于全体.NET
ADO提供程序,包含SQLite(https://www.sqlite.org/),SQL),SQL CE,Firebird,Oracle,MySQL,PostgreSQL和SQL
Server。

有完全的事例清单吧?

Dapper有一个一体化位于测试工程的测试套件。

何人在用那么些?

Stack Overflow正值使用Dapper。

网站地图xml地图