EF 10 Named Query Filter

郑子铭

发布于 2025-09-02 17:31:23

14300

代码可运行

文章被收录于专栏：DotNet NB && CloudNativeDotNet NB && CloudNative

运行总次数：0

代码可运行

EF 10 Named Query Filter

Intro

EF Core 开始支持 global query filter，原本一个表 collection 只支持一个 global query filter，最近的 .NET 10 Preview 6 版本中的 EF 10 引入了 named query filter，支持指定同时指定多个 query filter，并且忽略 global query filter 的时候也可以忽略指定的 query filter，使得 query filter 的实用性更好了

Sample

来看一个简单的示例：


file sealed class QueryFilterContext(DbContextOptions<QueryFilterContext> options) : DbContext(options)
{
    public DbSet<BlogPost> Posts { get; set; } = null!;

    protected override void OnModelCreating(ModelBuilder modelBuilder)
    {
        // 可以配置多个 query filter 并指定名称
        modelBuilder.Entity<BlogPost>()
            .HasQueryFilter("non-deleted", p => !p.Title.StartsWith("[Deleted]")) 
            .HasQueryFilter("non-disabled", p => !p.Title.StartsWith("[Disabled]"))
            ;
        base.OnModelCreating(modelBuilder);
    }
}

publicclassBlogPost
{
    publicint Id { get; set; }

    [StringLength(64)]
    publicrequiredstring Title { get; set; }

    public DateTimeOffset UpdatedAt { get; set; }

    [StringLength(64)]
    publicrequiredstring UpdatedBy { get; set; }
}

在使用的时候也可以忽略指定的 filter，使用示例如下：

const string connString = "DataSource=QueryFilterSample.db";
awaitusingvar services = new ServiceCollection()
        .AddLogging(lb => lb.AddDefaultDelegateLogger())
        .AddDbContext<QueryFilterContext>((provider, options) =>
        {
            options.UseSqlite(connString);
        })
        .BuildServiceProvider()
    ;

usingvar scope = services.CreateScope();
var context = scope.ServiceProvider.GetRequiredService<QueryFilterContext>();
await context.Database.EnsureDeletedAsync();
await context.Database.EnsureCreatedAsync();
{
    context.Posts.Add(new BlogPost
    {
        Title = "test",
        UpdatedAt = DateTimeOffset.Now,
        UpdatedBy = "test"
    });
    context.Posts.Add(new BlogPost 
    { 
        Title = "[Disabled]test",
        UpdatedAt = DateTimeOffset.Now,
        UpdatedBy = "test"
    });
    context.Posts.Add(new BlogPost
    {
        Title = "[Deleted]test",
        UpdatedAt = DateTimeOffset.Now,
        UpdatedBy = "test"
    });
    await context.SaveChangesAsync();
}

{
    var posts = await context.Posts.AsNoTracking().ToArrayAsync();
    Console.WriteLine(posts.Length);
    Console.WriteLine();
}

{
    var posts = await context.Posts.AsNoTracking()
        .IgnoreQueryFilters().ToArrayAsync();
    Console.WriteLine(posts.Length);
    Console.WriteLine();
}

{
    var posts = await context.Posts.AsNoTracking()
        .IgnoreQueryFilters(["non-deleted"]).ToArrayAsync();
    Console.WriteLine(posts.Length);
    Console.WriteLine();
}

输出结果如下：

`samples output`

我们配置了两个 query filter，从输出的结果可以看出来第一次查询会把两个 filter 都带上，第二次我们使用了 IgnoreQueryFilters() 默认会忽略所有的 query filter，所以第二次是没有 query filter 应用的，而第三次是忽略了指定的 filter，没有被忽略的还是会被应用的

References

• https://github.com/WeihanLi/SamplesInPractice/blob/main/EFSamples/EFSamples/NamedQueryFilterSample.cs
• https://learn.microsoft.com/en-us/ef/core/querying/filters?tabs=ef10&WT.mc_id=DT-MVP-5004222
• https://github.com/dotnet/core/blob/main/release-notes/10.0/preview/preview6/efcore.md#named-query-filters
• https://github.com/WeihanLi/WeihanLi.EntityFramework/issues/79

本文参与腾讯云自媒体同步曝光计划，分享自微信公众号。

原始发表：2025-08-25，如有侵权请联系 cloudcommunity@tencent.com 删除

配置