EF Core全局查询筛选器怎么用 EF Core Global Query Filters教程

EF Core全局查询筛选器是自动添加WHERE条件的机制,支持软删除(如!IsDeleted)、多租户隔离(如TenantId匹配)及复合条件(如!IsDeleted && IsActive),通过HasQueryFilter配置,IgnoreQueryFilters可临时绕过。

EF Core全局查询筛选器(Global Query Filters)是一次配置、处处生效的自动过滤机制,不用每次写.Where(x => x.IsDeleted == false).Where(x => x.TenantId == current),系统会在生成SQL时自动加上。

软删除场景:自动过滤已标记删除的数据

适合需要保留历史记录、支持数据恢复的业务,比如文章、订单、用户资料等。

  • 实体中加一个bool IsDeleted字段
  • OnModelCreating里配置:
    modelBuilder.Entity().HasQueryFilter(a => !a.IsDeleted);
  • 之后所有ctx.Articles.ToList()ctx.Articles.First()等查询,SQL都会自动带WHERE IsDeleted = 0
  • 如需查已被软删除的数据,用ctx.Articles.IgnoreQueryFilters().Where(a => a.IsDeleted)
  • 多租户隔离:按租户ID自动过滤

    每个租户看到的数据必须严格隔离,不能靠开发人员手动加条件,容易遗漏。

    • 实体中添加string TenantId字段(建议非空、索引)
    • DbContext中注入IHttpContextAccessor,获取当前请求的租户标识(可来自JWT、Header、子域名等)
    • 配置过滤器:
      modelBuilder.Entity().HasQueryFilter(p => p.TenantId == _tenantId);
      其中_tenantIdDbContext构造函数注入并缓存的值
    • 注意为TenantId字段建立数据库索引,否则性能会明显下降

    复合条件与导航属性联动

    一个筛选器可以包含多个逻辑,还能跨关联实体生效。

    • 例如同时满足软删除 + 状态启用:
      p => !p.IsDeleted && p.IsActive
    • 支持引用导航属性,比如只查“所属博客未被删除”的文章:
      a => !a.Blog.IsDeleted && !a.IsDeleted
    • 此时EF Core会自动把Blog上的过滤器也带上,形成递归过滤
    • 注意:同一实体只能有一个全局筛选器,多个HasQueryFilter调用会覆盖,要用&&合并条件

    绕过筛选器的正确方式

    某些管理后台或迁移脚本需要查看全部数据,包括被过滤掉的。

    • IgnoreQueryFilters()临时关闭当前查询的全局过滤:
      ctx.Users.IgnoreQueryFilters().ToList()
    • 它只影响本次LINQ链,不影响后续其他查询
    • 不要滥用——比如在普通API里用它查全部用户,可能造成越权访问
    • 若需部分跳过(如只跳过租户过滤但保留软删除),目前EF Core不原生支持,得拆成两个DbContext或用原始SQL

    基本上就这些。配置简单,效果直接,关键是能从框架层守住数据边界,避免人为疏漏。