Stackoverflow/dapper的Dapper-Extensions用法(二)
2015-07-03 18:44 Fururur 阅读(18830) 评论(13) 编辑 收藏 举报之前翻译了Dapper-Extensions项目首页的readme.md,大家应该对这个类库的使用有一些了解了吧,接下来是wiki的文档翻译,主要提到了AutoClassMapper、KeyTypes、Predicates System的高级用法用法。
若不熟悉Dapper及Dapper-Extensions的,请移步:
- 《Dapper的基本使用》:http://www.cnblogs.com/Sinte-Beuve/p/4231053.html
- 《Stackoverflow/dapper的Dapper-Extensions用法(一)》:http://www.cnblogs.com/Sinte-Beuve/p/4612971.html
- (扩展)《利用Dapper ORM搭建三层架构》:http://www.cnblogs.com/Sinte-Beuve/p/4230943.html
AutoClassMapper
在不确定的情况下Dapper Extensions使用一个默认的ClassMapper(AutoClassMapper)来处理POCO和数据表之间的映射。ClassMapper非常重要,它可以保证POCOs的纯净,不需要增加额外的attribute。你可以通过继承ClassMapper来自定义自己的映射规则去改变Dapper Extensions的行为。(这边我觉得文档有些问题,应该是继承AutoClassMapper,因为DefaultMapper是用来设置全局的映射器的而不是单表的自定义。)
DapperExtensions.DapperExtensions.DefaultMapper = typeof(MyCustomClassMapper<>);
AutoClassMapper Assumptions
默认的AutoClassMapper是建立在数据库与POCOs之间有一定约束的条件下才可以工作的。
约定条件如下:
- AutoClassMapper假定数据表名与POCOs名一致(Ex: Car table name and Car POCO name).。
- 每个POCOs必须包含一个属性名为Id或以Id结尾的。
- 如果有多个属性以Id结尾,Dapper Extensions会使用第一个"Id"属性作为主键。
- 如果Id属性的类型为整形,则它的 KeyType属性会被设成Identity。
- 如果Id属性的类型为GUID,则它的 KeyType属性会被设成GUID。
- 如果Id属性的类型为其他类型,则它的 KeyType属性会被设成Assigned。(此类型为用户自定义主键)。
Customized PluralizedAutoClassMapper
英语有很多多元化(pluralization)的规则,PluralizedAutoClassMapper会提供给我们一些正确的多元化命名为任何可能的场景。但是仍然有很多情况,当你的数据库表名和默认的Dapper Extensions的多元化规则不相匹配时,你可以自定义该类,注入自己的规则。
通俗的话来讲,就是说数据库表名和POCOs的命名可能会因为英文语义或者说文化等的影响而不同,这时候Dapper Extensions提供给我们PluralizedAutoClassMapper,提供一些转换的规则。例如Person和Person。
下面的例子,使用CustomPluralizedMapper对来Person到Persons数据表进行映射。如果不重写,PluralizedAutoClassMapper默认会把Person映射到People表。
public class CustomPluralizedMapper<T> : PluralizedAutoClassMapper<T> where T : class
{
protected override void Table(string tableName)
{
if(tableName.Equals("Person", StringComparison.CurrentCultureIgnoreCase))
{
TableName = "Persons";
}
base.Table(tableName);
}
}
全局配置:
DapperExtensions.DapperExtensions.DefaultMapper = typeof(CustomPluralizedMapper<>);
KeyTypes
KeyType这个enum允许Dapper Extensions知道如何去映射POCOs的主键。当你的POCOs被Dapper Extensions检查后,映射关系将被建立和缓存下下来。这个类型映射用于生产合适的SQL语句来进行子查询的调用。举个例子,在不确定的情况下,Dapper-Extensions必须知道哪一个属性是POCOs的标识。
下列KeyTypes是可用的:
public enum KeyType
{
NotAKey,
Identity,
Guid,
Assigned
}
NotAKey
非主键属性映射到该枚举值。
Identity
任何整形的主键将被映射成这个枚举值。
Guid
Guid类型的主键属性被映射成这个枚举值。这个标识会使得Dapper Extensions在数据库执行插入命令前先生成一个新的Guid值。Dapper-Extensions生成COMB(see: GetNextGuid)
Assigned
任意非Guid和整形的主键将会映射到该枚举值。这个标识会使得Dapper Extensions在数据库执行插入命令前不会生成一个key。再者,Dapper-Extensions在插入后不会获得任意一个键的值,总而言之,这个是由开发者决定的。即自定义主键值或者是联合主键时的标识。
Predicates
谓词系统在Dapper-Extensions中是非常容易去使用的。现在我们使用下面这个Model来展开它的用法。
public class Person
{
public int Id { get; set; }
public string FirstName { get; set; }
public string LastName { get; set; }
public bool Active { get; set; }
public DateTime DateCreated { get; set; }
}
Simple FieldPredicate Operation
为了创建一个简单的谓词,我们仅仅创建一个字段谓词并且把它传给查询操作。FieldPredicate需要一个一般的类型,允许使用强类型。
下面的已给例子,我们返回Active值为true的所有Persons。
Code
using (SqlConnection cn = new SqlConnection(_connectionString))
{
cn.Open();
var predicate = Predicates.Field<Person>(f => f.Active, Operator.Eq, true);
IEnumerable<Person> list = cn.GetList<Person>(predicate);
cn.Close();
}
Generated SQL
SELECT
[Person].[Id]
, [Person].[FirstName]
, [Person].[LastName]
, [Person].[Active]
, [Person].[DateCreated]
FROM [Person]
WHERE ([Person].[Active] = @Active_0)
IN Clause TODO: Demonstrate that you can pass an IEnumerable as the value to acheive WHERE x IN ('a','b') functionality
Compound Predicate (Predicate Group)复合谓词
复合谓词谓词可以通过谓词组来实现。对于每个谓词组,你必须选择一个操作符(AND/OR),每个被添加到组中的谓词将会被加入具体的操作。
如果每个谓词组都实现了IPredicate,那么多谓词可以被同时添加到一起。
下面的例子,我们建立一个通过AND操作符连接的谓词组。
Code
using (SqlConnection cn = new SqlConnection(_connectionString))
{
cn.Open();
var pg = new PredicateGroup { Operator = GroupOperator.And, Predicates = new List<IPredicate>() };
pg.Predicates.Add(Predicates.Field<Person>(f => f.Active, Operator.Eq, true));
pg.Predicates.Add(Predicates.Field<Person>(f => f.LastName, Operator.Like, "Br%"));
IEnumerable<Person> list = cn.GetList<Person>(pg);
cn.Close();
}
Generated SQL
SELECT
[Person].[Id]
, [Person].[FirstName]
, [Person].[LastName]
, [Person].[Active]
, [Person].[DateCreated]
FROM [Person]
WHERE (([Person].[Active] = @Active_0)
AND ([Person].[LastName] LIKE @LastName_1))
Multiple Compound Predicates (Predicate Group)
只要每个谓词组都实现了IPredicate,你可以创建复杂的复合谓词,并把它们联合起来。
在下面的例子中,我们创建两个谓词组,并且把它们组合在第三个谓词组中。
Code
using (SqlConnection cn = new SqlConnection(_connectionString))
{
cn.Open();
var pgMain = new PredicateGroup { Operator = GroupOperator.Or, Predicates = new List<IPredicate>() };
var pga = new PredicateGroup { Operator = GroupOperator.And, Predicates = new List<IPredicate>() };
pga.Predicates.Add(Predicates.Field<Person>(f => f.Active, Operator.Eq, true));
pga.Predicates.Add(Predicates.Field<Person>(f => f.LastName, Operator.Like, "Br%"));
pgMain.Predicates.Add(pga);
var pgb = new PredicateGroup { Operator = GroupOperator.And, Predicates = new List<IPredicate>() };
pgb.Predicates.Add(Predicates.Field<Person>(f => f.Active, Operator.Eq, false));
pgb.Predicates.Add(Predicates.Field<Person>(f => f.FirstName, Operator.Like, "Pa%", true /* NOT */ ));
pgMain.Predicates.Add(pgb);
IEnumerable<Person> list = cn.GetList<Person>(pgMain);
cn.Close();
}
Generated SQL
SELECT
[Person].[Id]
, [Person].[FirstName]
, [Person].[LastName]
, [Person].[Active]
, [Person].[DateCreated]
FROM [Person]
WHERE
((([Person].[Active] = @Active_0) AND ([Person].[LastName] LIKE @LastName_1))
OR (([Person].[Active] = @Active_2) AND ([Person].[FirstName] NOT LIKE @FirstName_3)))
PropertyPredicate
TODO
Exists Predicate
var subPred = Predicates.Field<User>(u => u.Email, Operator.Eq, "someone@somewhere.com");
var existsPred = Predicates.Exists<User>(subPred);
var existingUser = cn.GetList<User>(existsPred , null, tran).FirstOrDefault();
以上就是Dapper-Extensions所有的文档了。
![知识共享许可协议](https://i.creativecommons.org/l/by-nc-sa/4.0/88x31.png)
本作品采用知识共享署名-非商业性使用-相同方式共享 4.0 国际许可协议进行许可。欢迎转载,演绎或用于商业目的,但是必须保留本文的署名Fururur(包含链接),如您有任何疑问或者授权方面的协商,请给我留言。