基于Entity Framework自定义分页效果
简介
之前写个一个基于dapper的分页实现,现在再来写一个基于entity framework的分页实现,以及增删改的通用实现。
代码
还是先上代码:https://github.com/jinweijie/ef.genericrepository
如何运行示例
还是像先前一样:
1. 先clone下代码,在database里面解压缩database.7z
2. attach到sql server localdb上。如果你用的不是sql server的localdb,你需要更改app.config里的连接字符串。
3. ctrl + f5,运行示例程序。
repository 基类 - 查询
common\abstractrepository.cs 是repository的基类,实现了增删改查的一些方法,例如:
public virtual tuple<ienumerable<t>, int> find(expression<func<t, bool>> criteria , int pageindex , int pagesize , string[] asc , string[] desc , params expression<func<t, object>>[] includeproperties)
这个方法是abstractrepository查询方法中的一个,用于自定义分页查询,其中criteria 为一个表达式,作为查询的条件,参数pageindex, pagesize, asc, desc为分页相关参数;
关于多表(关联表):
includeproperties为在多表时候,join相关联的表。因为ef默认是lazy loading,相关联的表默认不是立即加载的,所以有时候如果写代码不小心,在for循环里就有可能会循环查询n个字表。用来includeproperties参数,就可以在查询时候join关联表。
repository 基类 - 增删改
abstractrepository已经用泛型实现了增删改方法:
public virtual t create(t entity)
public virtual t update(t entity)
public virtual t createorupdate(t entity)
public virtual void delete(tid id)
另外,关于transaction的实现,我使用了unit of work模式,多个repository共享一个dbcontext,关于uow,请在common\unitofwork.cs里找到。
调用uow的时候,基本类似于这样:
var uow = new efunitofwork(); var repo = uow.getlogrepository(); repo.create(new log { levelid = 1, thread = "", location = "manual creation", message = "this is manually created log.", createtime = datetimeoffset.now, date = datetime.now }); uow.commit();
从unitofwork里得到一个或多个repository,共享dbcontext,做增删改操作,最后uow统一savechanges。
repository的派生类
由于已经有了abstractrepository,实现了增删改查的很多方法,所以派生类,例如示例项目里的logrepository基本就可以变得很简单,主要实现一些特定的业务逻辑,在示例项目里,因为没有特殊的业务逻辑,所以会很简单:
public class logrepository : abstractrepository<log, int> { public logrepository(efcontext context) : base(context) { } }
关于entity的生成
本人比较喜欢database first 实现,先设计数据库,然后用edmx reverse engineering,生成poco。可以参考entity目录下的相关文件。
当然,如果你喜欢code first,同样没有问题,仍然适用本文的实现。
使用logging日志追踪ef sql
在使用entity framework的时候,最好关心一下ef所生成的sql,这样可以在开发阶段发现一些潜在的性能问题,避免在生产环境焦头烂额:)
在common\efcontext.cs 里,有一个配置项enabletracesql,如果为true,那么所以ef生成的sql将会被nlog记录下来。我将nlog的日志配置到了数据库。也就是说,在你运行示例项目时,每次查询,都会增加新的日志记录,内容为查询时生成的sql:
specification pattern
在查询方法里,有个重载是接受一个ispecification示例,这样的实现可以有效的控制业务逻辑,对于写给被其他人调用的接口来说,可以明确的确定查询参数,例如:
public class logsearchspecification : ispecification<log> { public string levelname { get; set; } public string message { get; set; } public expression<func<log, bool>> toexpression() { return log => (log.level.name == levelname || levelname == "") && (log.message.contains(message) || message == ""); } public bool issatisfiedby(log entity) { return (entity.level.name == levelname || levelname == "") && (entity.message.contains(message) || message == ""); } }
那么,调用这个查询方法的代码就可以明确知道,我的查询条件为levelname和message,至于levelname是等于以及message为like则是在logsearchspeficiation里实现,做到很好的封装。
最后
这套实现是几年来平时慢慢积累的,是经过实践的,所以应该可以作为一定的参考,当然,在具体的项目里,可以用一些di去拿到repository等等,不在本文讨论范围,大家可以*发挥,希望对大家可以有所帮助,谢谢。