.NET Core Web API可选查询参数仍不为空问题求助

你的问题出在ASP.NET Core的模型绑定机制上，和JSON序列化配置无关：

• 对于FilterQuery这类自定义复杂类型，ASP.NET Core的查询参数模型绑定器默认会自动创建实例——哪怕没有传任何查询参数，它也会初始化一个所有属性为默认值的对象，而不是设为null。
• 你修改的JsonSerializerOptions是用来处理JSON请求/响应的序列化逻辑，和URL查询参数的模型绑定完全是两个独立流程，所以不会产生任何效果。

解决办法 #

方法1：手动判断并重置为null #

在控制器方法里，检查filterQuery的所有属性是否都是默认值，若是则将其设为null：

首先给FilterQuery添加判断方法：

public class FilterQuery
{
    // 你的属性定义示例
    public string? Keyword { get; set; }
    public int? MinValue { get; set; }

    // 判断所有属性是否为默认值
    public bool IsAllDefault()
    {
        return Keyword == null && MinValue == null;
        // 按实际属性逐一补充判断逻辑
    }
}

然后在控制器方法中处理：

[HttpGet("Lists")]
public Codebook GetFilterLists([FromQuery] FilterQuery? filterQuery = null)
{
    if (filterQuery?.IsAllDefault() == true)
    {
        filterQuery = null;
    }

    // 后续业务逻辑代码
}

方法2：自定义模型绑定器（全局生效，更优雅） #

如果不想在每个方法中重复判断逻辑，可以自定义模型绑定器，让所有复杂类型查询参数在无传入值时自动返回null：

1. 创建自定义模型绑定器：

public class NullableComplexTypeModelBinder : IModelBinder
{
    private readonly ComplexTypeModelBinder _innerBinder;

    public NullableComplexTypeModelBinder(ComplexTypeModelBinder innerBinder)
    {
        _innerBinder = innerBinder;
    }

    public async Task BindModelAsync(ModelBindingContext bindingContext)
    {
        await _innerBinder.BindModelAsync(bindingContext);
        
        // 若绑定后的模型所有属性都是默认值，将结果设为null
        var model = bindingContext.Result.Model;
        if (model != null && IsAllPropertiesDefault(model))
        {
            bindingContext.Result = ModelBindingResult.Success(null);
        }
    }

    private bool IsAllPropertiesDefault(object model)
    {
        foreach (var prop in model.GetType().GetProperties())
        {
            var defaultValue = prop.PropertyType.IsValueType ? Activator.CreateInstance(prop.PropertyType) : null;
            var currentValue = prop.GetValue(model);
            if (!Equals(currentValue, defaultValue))
            {
                return false;
            }
        }
        return true;
    }
}

2. 创建模型绑定器提供器：

public class NullableComplexTypeModelBinderProvider : IModelBinderProvider
{
    public IModelBinder? GetBinder(ModelBinderProviderContext context)
    {
        if (context.Metadata.IsComplexType && !context.Metadata.IsCollectionType)
        {
            var innerBinder = context.CreateBinder(context.Metadata);
            if (innerBinder is ComplexTypeModelBinder complexBinder)
            {
                return new NullableComplexTypeModelBinder(complexBinder);
            }
        }
        return null;
    }
}

3. 在Program.cs中注册：

builder.Services.AddControllers(options =>
{
    options.ModelBinderProviders.Insert(0, new NullableComplexTypeModelBinderProvider());
});

这样所有复杂类型的查询参数，只要没有传入任何属性值，都会自动被设为null，无需在每个控制器方法中手动处理。

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