Asp.Net Core 5 [FromQuery]模型绑定时查询参数缺失如何设置默认值

问题原因 #

ASP.NET Core 5的默认模型绑定逻辑存在以下规则：

• 对于可空值类型的属性，如果请求中没有传递对应参数，模型绑定会直接赋值为null，覆盖属性定义时设置的初始值
• 对于非可空值类型的属性，框架会默认将其标记为必填项，请求未传参数时直接触发验证报错

可选解决方案 #

方案1：接口逻辑内手动赋值（最简便，无额外依赖） #

直接在接口入口处对缺失的参数赋值即可，无需修改模型或全局配置：

[HttpGet("list")]
public async Task<IList<Entry>> GetJsonAsync([FromQuery] Query query)
{
    query.After ??= DateTime.MinValue;
    query.Duration ??= TimeSpan.MaxValue;
    return await _store.QueryAsync(query);
}

方案2：模型属性标注[Optional]特性 #

如果希望默认值逻辑内聚在模型定义中，可以给非可空属性加[Optional]特性，覆盖框架的隐式必填校验规则，未传参时会自动使用属性初始值：

using Microsoft.AspNetCore.Mvc.ModelBinding;

public class Query
{
    [Optional]
    public DateTime After { get; set; } = DateTime.MinValue;
    [Optional]
    public TimeSpan Duration { get; set; } = TimeSpan.MaxValue;
}

方案3：模型内部实现默认值回退 #

也可以在模型的属性setter中处理默认值逻辑，适合可空类型的场景：

public class Query
{
    private DateTime? _after = DateTime.MinValue;
    public DateTime? After 
    { 
        get => _after; 
        set => _after = value ?? DateTime.MinValue; 
    }

    private TimeSpan? _duration = TimeSpan.MaxValue;
    public TimeSpan? Duration 
    { 
        get => _duration; 
        set => _duration = value ?? TimeSpan.MaxValue; 
    }
}

方案4：全局关闭隐式必填校验 #

如果项目中大量场景需要类似逻辑，可以全局关闭非可空类型的隐式必填规则，在Startup.cs的ConfigureServices方法中添加配置：

services.AddControllers(options =>
{
    options.SuppressImplicitRequiredAttributeForNonNullableReferenceTypes = true;
});

注意：该配置会对整个项目生效，可能会影响其他接口的必填校验逻辑，按需开启。

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