C#中如何使用EF Core的查询全局过滤器?多租户应用?

来源:这里教程网 时间:2026-02-21 17:27:55 作者:

在C#中使用EF Core实现查询全局过滤器,特别是用于多租户应用,是一个常见且实用的需求。通过全局过滤器,可以确保每个租户只能访问自己的数据,而无需在每个查询中手动添加条件。

什么是查询全局过滤器?

EF Core支持在实体模型配置中定义全局查询过滤器(Global Query Filters),这些过滤器会自动应用于所有涉及该实体的LINQ查询。这在多租户系统中非常有用,比如自动过滤出当前租户的数据。

过滤器是在 OnModelCreating 方法中通过 HasQueryFilter 配置的。

如何配置全局过滤器实现多租户?

假设你有一个多租户系统,每个租户的数据通过 TenantId 字段隔离。你可以为所有需要租户隔离的实体添加基于 TenantId 的过滤器。

// 示例:定义一个带 TenantId 的实体

public class Product
{
    public int Id { get; set; }
    public string Name { get; set; }
    public int TenantId { get; set; }
}

// 在 DbContext 中配置全局过滤器

public class AppDbContext : DbContext
{
    private readonly int _currentTenantId;

    public AppDbContext(DbContextOptions options, int currentTenantId) : base(options)
    {
        _currentTenantId = currentTenantId;
    }

    public DbSet Products { get; set; }

    protected override void OnModelCreating(ModelBuilder modelBuilder)
    {
        modelBuilder.Entity()
            .HasQueryFilter(p => p.TenantId == _currentTenantId);

        // 可以为其他实体继续添加过滤器
    }
}

这样,每次查询 Products 时,EF Core 会自动生成 SQL 并加上 WHERE TenantId = 当前租户ID,开发者无需手动写这个条件。

如何在实际项目中注入租户信息?

在Web应用中,通常从请求上下文中获取租户标识,比如通过 JWT、Header 或子域名解析。

可以通过依赖注入将租户ID传递给 DbContext

// 示例:在 ASP.NET Core 中配置 DbContext

services.AddDbContext((serviceProvider, options) =>
{
    var httpContext = serviceProvider.GetRequiredService()?.HttpContext;
    var tenantId = GetTenantIdFromRequest(httpContext); // 自定义方法解析租户

    options.UseSqlServer(connectionString);
    options.UseInternalServiceProvider(serviceProvider);
});

// 使用工厂模式创建带租户ID的 DbContext
services.AddScoped(sp => new AppDbContext(
    sp.GetRequiredService>(),
    GetTenantId(sp) // 获取当前请求的租户ID
));

注意事项和高级用法

全局过滤器虽然方便,但也有一些需要注意的地方:

性能影响:过滤器始终生效,需确保相关字段有数据库索引(如 TenantId) 绕过过滤器:使用 IgnoreQueryFilters() 可临时跳过,适用于管理员操作

var allProducts = context.Products.IgnoreQueryFilters().ToList();

软删除结合:可同时过滤 IsDeleted = false 和 TenantId

modelBuilder.Entity().HasQueryFilter(p => p.TenantId == _currentTenantId && !p.IsDeleted);

继承场景:如果多个实体共享租户字段,可抽象基类并统一配置

基本上就这些。合理使用全局查询过滤器,能让多租户系统的数据隔离变得透明且安全,减少人为出错的可能。

相关推荐