HotChocolate中DateTime集合的AND过滤异常问题

问题场景 #

使用HotChocolate.AspNetCore 13.5.1开发C# GraphQL应用时，遇到集合字段日期区间过滤逻辑不符合预期的问题：

定义包含DateTime集合的MyData类：

public class MyData {
    // 其他字段
    public IEnumerable<DateTime> MyDates { get; set; } = new List<DateTime>();
}

需求是查询出MyDates集合中存在处于指定日期区间内元素的MyData条目，在Playground执行以下查询：

query {
    getMyData
        (first: 10, 
         where: { myDates: { some: {gt: "2016-02-23", lt: "2016-02-25"}}}) 
    { ... }
}

预期结果：

• MyDates为["2016-02-22", "2016-02-24", "2016-02-26"]的条目应被查出
• MyDates为["2016-02-22", "2016-02-26"]的条目不应被查出

但实际两个条目都被返回，原因是gt和lt逻辑被默认当作OR执行，只要集合中有元素满足其中一个条件就会被选中。

当前查询配置：

[ExtendObjectType("Query")]
public class MyDataQuery
{
    [UsePaging(IncludeTotalCount = true)]
    [UseFiltering]
    [UseSorting]
    public IQueryable<MyData> GetMyData([Service] ISomeService service)
    {
        if (service == null) throw new ArgumentNullException(nameof(service));
        return service.GetMyData();
    }
}

Program.cs配置：

builder.Services.AddGraphQLServer()
    .AddQueryType(d => d.Name("Query"))
    .AddTypeExtension<MyDataQuery>()
    .AddProjections()
    .AddFiltering()
    .AddSorting()
    .ModifyRequestOptions(opt => opt.IncludeExceptionDetails = true);

问题原因 #

HotChocolate默认对集合字段的多条件过滤采用OR逻辑组合，即some: {gt: "...", lt: "..."}会被解析为“集合存在元素大于指定日期 或 存在元素小于指定日期”，而非我们需要的“存在元素同时满足大于且小于指定日期”。

解决方案 #

提供两种可行解决方式：

方式一：显式使用AND组合条件 #

无需修改后端代码，直接在查询中用AND关键字包裹两个条件，强制逻辑为“同时满足”：

query {
    getMyData
        (first: 10, 
         where: { myDates: { some: {AND: [{gt: "2016-02-23"}, {lt: "2016-02-25"}]}}}) 
    { ... }
}

适合临时场景或简单需求。

方式二：自定义过滤器类型（推荐，适合复用） #

通过自定义过滤器输入类型，实现语义化的区间判断逻辑，后续复用更方便：

1. 创建自定义过滤器相关类

// 自定义MyData的过滤器输入类型
public class MyDataFilterInputType : FilterInputType<MyData>
{
    protected override void Configure(IFilterInputTypeDescriptor<MyData> descriptor)
    {
        descriptor.Field(f => f.MyDates)
            .AllowSome()
            .BindFilters(BindingBehavior.Explicit)
            .AddFilter<DateTimeRangeFilter>();
    }
}

// 自定义日期区间过滤器
public class DateTimeRangeFilter : FilterInputType
{
    protected override void Configure(IFilterInputTypeDescriptor descriptor)
    {
        descriptor.Name("DateTimeRangeFilter");
        descriptor.Field("between")
            .Type<NonNullType<InputObjectType<DateRangeInput>>>()
            .Handler<MyData, DateRangeInput>(
                (context, input) => context.SetQuery(
                    context.Query.Where(m => m.MyDates.Any(d => d > input.Start && d < input.End))
                )
            );
    }
}

// 日期区间输入参数类
public class DateRangeInput
{
    public DateTime Start { get; set; }
    public DateTime End { get; set; }
}

2. 修改Program.cs的GraphQL配置，注册自定义过滤器

builder.Services.AddGraphQLServer()
    .AddQueryType(d => d.Name("Query"))
    .AddTypeExtension<MyDataQuery>()
    .AddProjections()
    .AddFiltering(x => x.AddFilterType<MyDataFilterInputType>()) // 替换默认过滤器为自定义类型
    .AddSorting()
    .ModifyRequestOptions(opt => opt.IncludeExceptionDetails = true);

3. 使用新的语义化查询语法

query {
    getMyData
        (first: 10, 
         where: { myDates: { some: {between: {start: "2016-02-23", end: "2016-02-25"}}}}) 
    { ... }
}

内容的提问来源于stack exchange，提问作者Febertson