ASP.NET Core自定义ModelBinder：无效值未拦截请求如何解决

你的理解偏差 #

ModelBinder仅负责完成模型绑定逻辑（将请求值转换为目标类型），并将绑定结果、错误信息写入ModelState，它本身不会自动终止请求进入Action方法。ASP.NET Core默认不会因为ModelState存在错误就阻断请求，所以即便绑定失败，Action依然会被调用，且未绑定成功的参数会被设为默认值（引用类型为null）。

正确实现方式 #

要达到“无效输入时终止请求、不进入Action”的效果，需要两步：完善ModelBinder逻辑，再启用ModelState自动验证。

1. 完善DeploymentIdModelBinder的绑定逻辑 #

确保所有无效场景（包括值为空）都能正确将错误写入ModelState，并标记绑定失败：

public sealed class DeploymentIdModelBinder : IModelBinder
{
    public Task BindModelAsync(ModelBindingContext bindingContext)
    {
        string modelName = bindingContext.ModelName;
        string? value = bindingContext.ValueProvider.GetValue(modelName).FirstValue;

        // 处理值为空的场景（路由参数必填，此处必须报错）
        if (string.IsNullOrEmpty(value))
        {
            bindingContext.ModelState.TryAddModelError(modelName, $"{nameof(DeploymentId)} 参数不能为空");
            bindingContext.Result = ModelBindingResult.Failed();
            return Task.CompletedTask;
        }

        if (DeploymentId.TryParse(value, out var id))
        {
            bindingContext.Result = ModelBindingResult.Success(id);
        }
        else
        {
            bindingContext.ModelState.TryAddModelError(modelName, $"{value} 不是有效的 {nameof(DeploymentId)} 格式");
            bindingContext.Result = ModelBindingResult.Failed();
        }
        return Task.CompletedTask;
    }
}

2. 注册ModelBinder #

需要让ASP.NET Core知道用这个Binder处理DeploymentId类型，有两种方式：

• 类型级标注：在DeploymentId类上添加[ModelBinder]属性

[ModelBinder(BinderType = typeof(DeploymentIdModelBinder))]
public sealed class DeploymentId
{
    // 你的DeploymentId实现代码（比如Parse方法、属性等）
}

• 全局注册：在Program.cs（或Startup.cs）中配置MVC选项

builder.Services.AddControllers(options =>
{
    options.ModelBinderProviders.Insert(0, new BinderTypeModelBinderProvider(typeof(DeploymentId), typeof(DeploymentIdModelBinder)));
});

3. 启用ModelState自动验证 #

要让ASP.NET Core在ModelState无效时自动返回400错误、不进入Action，最简便的方式是给控制器添加[ApiController]属性（Web API项目推荐）：

[ApiController]
public class YourController : ControllerBase
{
    [HttpGet]
    [Route("download/{deploymentId}")]
    public async Task<IActionResult> DownloadDeployment(DeploymentId deploymentId)
    {
        // 只有ModelState完全有效时，才会执行到这里
        ...
    }
}

如果不想使用[ApiController]，也可以手动在Action开头检查ModelState：

[HttpGet]
[Route("download/{deploymentId}")]
public async Task<IActionResult> DownloadDeployment(DeploymentId deploymentId)
{
    if (!ModelState.IsValid)
    {
        return BadRequest(ModelState);
    }
    // 后续业务逻辑
    ...
}

这样配置后，当传入无效的DeploymentId时，ASP.NET Core会自动返回包含错误信息的400响应，不会执行Action内的代码。

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