用于输入验证的自定义中间件

Question

我的 API 只有 POST 操作方法。我想创建一个库来验证我的 API 的输入。现在我想在点击控制器操作方法之前进行此验证。

我已经决定使用中间件方式 -

public class ValidateInputMiddleware
{
    private readonly RequestDelegate _next;

    public ValidateInputMiddleware(RequestDelegate next)
    {
        _next = next;
    }

    public async Task Invoke(HttpContext httpContext)
    {
        //read the request body

        //serialize the json body to input model

        //validations
        if(reqJsonObj.Id == null)
            //return response - id is null

        //other validations

        await _next(httpContext);
    }
}

如果满足我的验证条件，那么我不希望管道中的其他项目执行。

我需要帮助 -

1. 如何限制管道中的其他项目执行。

2. 如何以 JSON 的形式返回自定义错误响应。

Answer 1

您不应为此使用自定义中间件。中间件是非常低级的，正如您所注意到的，您必须自己阅读和解析请求正文。这不仅复杂，而且还会导致这种情况发生两次（再次在 MVC 中间件内部）。

相反，您应该使用MVC filter，尤其是action filter。过滤器作为 MVC 管道的一部分运行，因此您可以依赖 MVC 管道已经为您做的各种事情，例如模型绑定或授权。

它还可以更轻松地中止响应并改为返回自定义 JSON 响应，因为您不必再​​次手动序列化您的内容，而是可以使用高级 MVC 结果。

适合您情况的操作过滤器可能如下所示：

public class InputValidationActionFilter : IActionFilter
{
    public void OnActionExecuting(ActionExecutingContext context)
    {
        // we can even *still* use model state properly…
        if (!context.ModelState.IsValid)
        {
            var responseObj = new {
                successful = false,
                error = "The input is not valid",
            };

            // setting the result shortcuts the pipeline, so the action is never executed
            context.Result = new JsonResult(responseObj)
            {
                StatusCode = 400
            };
        }
    }

    public void OnActionExecuted(ActionExecutedContext context)
    { }
}