在 C# 中使用 EF Core 的全局查询过滤器,可以通过 HasQueryFilter 方法在 OnModelCreating 方法中配置。这个功能常用于实现软删除、多租户等场景,确保每次查询都自动应用特定条件。
什么是全局查询过滤器?
全局查询过滤器是定义在实体上的 LINQ 条件,会自动应用于该实体所有数据库查询(包括 Include 和直接查询)。只要上下文实例存在,这些过滤器就会生效。
如何配置全局查询过滤器?
在继承 DbContext 的类中重写 OnModelCreating 方法,并使用 HasQueryFilter 为实体设置过滤条件。
示例:实现软删除
public class BloggingContext : DbContext
{
public DbSet<Blog> Blogs { get; set; }
public DbSet<Post> Posts { get; set; }
protected override void OnModelCreating(ModelBuilder modelBuilder)
{
modelBuilder.Entity<Blog>()
.HasQueryFilter(b => !b.IsDeleted);
modelBuilder.Entity<Post>()
.HasQueryFilter(p => !p.IsDeleted);
}
}
public class Blog
{
public int Id { get; set; }
public string Name { get; set; }
public bool IsDeleted { get; set; }
}
public class Post
{
public int Id { get; set; }
public string Title { get; set; }
public bool IsDeleted { get; set; }
public int BlogId { get; set; }
public Blog Blog { get; set; }
}配置后,所有对 Blog 和 Post 的查询都会自动加上 !IsDeleted 条件,无需手动添加。
忽略全局过滤器的方法
某些情况下需要绕过过滤器,比如查看已软删除的数据,可以使用 IgnoreQueryFilters() 方法。
// 获取包含已删除的博客 var deletedBlogs = context.Blogs.IgnoreQueryFilters().Where(b => b.IsDeleted).ToList();
支持复杂条件和关联过滤
查询过滤器支持复杂的表达式,甚至可以引用其他实体或服务(需配合依赖注入)。
示例:多租户支持
private readonly string _tenantId;
public BloggingContext(string tenantId)
{
_tenantId = tenantId;
}
protected override void OnModelCreating(ModelBuilder modelBuilder)
{
modelBuilder.Entity<Blog>()
.HasQueryFilter(b => b.TenantId == _tenantId);
}这样每个租户只能访问自己的数据,安全性更高。
注意事项
过滤器会影响性能,尤其是复杂表达式,建议合理使用索引。 Include 导航属性时也会应用过滤器,可能导致关联数据缺失。 静态上下文或单例模式下使用依赖注入需谨慎,避免状态污染。 过滤器无法在迁移中体现,数据库层面不会强制约束。基本上就这些。配置简单但非常实用,特别适合软删除和多租户场景。
