当前位置:首页>文章>.NET

基于Entity Framework自定义分页效果

简介

之前写个一个基于Dapper的分页实现,现在再来写一个基于Entity Framework的分页实现,以及增删改的通用实现。


如何运行示例

还是像先前一样:

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等等,不在本文讨论范围,大家可以自由发挥,希望对大家可以有所帮助,谢谢。

相关阅读: