一行代码搞定EF Core全局查询筛选

我们在使用EF查询数据的时候如果是物理删除,是查询不到删除的数据,但是实际使用情况不是这样。通常为了保证数据的完整性和安全性,在数据库层面一般将删除的数据标记为逻辑删除,而不是真正意义上的删除。这问题来了,如果查询的话每次都需要过滤掉删除的数据岂不是违反了代码重用的规则,有没有办法弄个全局的过滤器呢?EF Core有这个功能,那就是全局筛选器HasQueryFilter。本文将介绍如何使用它来全局配置。.

使用方法

新建一个.NET7项目,添加上EF Core的基础包和SQL server包;新建一个Customer实体,代码如下:

    public class Customer//客户实体    {        public int id { get; set; }        public string Name { get; set; }        public int Age { get; set; }        public bool IsDelete { get; set; }//物理删除标识    }

并新建一个Dbcontext上下文类,并添加Customer实体,实现OnModelCreating方法。代码如下:

  public class ApplicationDbContext: DbContext    {        public ApplicationDbContext(DbContextOptions<ApplicationDbContext> options):base(options)        { }        public DbSet<Customer> Customers { get; set; }//添加Customer        protected override void OnModelCreating(ModelBuilder modelBuilder)        {            //在这里就是使用HasQueryFilter            modelBuilder.Entity<Customer>().HasQueryFilter(q=>!q.IsDelete)            base.OnModelCreating(modelBuilder);        }    }

其中在实现Dbcontext上下文方法OnModelCreating中使用全局查询筛选器。关键代码如下:

modelBuilder.Entity<Customer>().HasQueryFilter(q=>!q.IsDelete);

就这样一个过滤逻辑删除的全局筛选器配置好了,只有一行代码。

那么如果这个实体某个方法的查询不用全局筛选器呢?有办法,可以使用IgnoreQueryFilters来取消当前查询的逻辑删除。

var DelEntities = _context.Customers.IgnoreQueryFilters();

这时就可以查询出全部的数据,包括逻辑删除的数据。

上面写法是不是有点麻烦呢?每增加一个有逻辑删除标识的表就要添加一次全局筛选。有办法,小编的办法是通过反射循环所有的实体,筛选出有逻辑删除标识的实体再用动态linq语句实现全局筛选,这里就不列出代码了。

注意事项:

1、全局筛选器不仅仅用于逻辑删除,你也可以用于其它的操作

2、如果涉及有一对多、多对多、一对一的关系时注意会出现未知问题,需要特殊处理。

结语

本文讲述了EF Core全局查询筛选器的使用过程,主要使用HasQueryFilter关键字;另外代码实体需要通过上下文在.NET组件中注册和添加连接,并通过Migration动态迁移到数据库才能执行。希望本文对你带来收获,同时欢迎留言和吐槽。