带有消息的自定义错误代码页

Question

我正在尝试创建一个自定义错误代码页面，该页面显示我在 .NET Core MVC 1.1 应用程序中传递给它的消息。 我在Startup.cs类文件中设置了自定义错误代码页支持，然后在执行public IActionResult Example1 => NotFound("Some custom error message")的控制器中创建了一个简单视图。 我希望将此消息推送到控制器，但事实并非如此。 在没有任何参数的情况下调用NotFound()会命中错误控制器，但是一旦我通过消息，控制器就永远不会使用，并且会显示一条简单的文本消息。

我本可以发誓过去我曾经使用经典的 .NET MVC 来执行此操作，但已经有一段时间了。

如何拥有显示正确错误的自定义错误代码页。 对于我期望 JSON 响应（API 操作等）的情况，我还需要控制器在错误期间返回标准文本或 JSON 响应的能力。 我假设有一种方法可以使用属性来做到这一点，但我还没有找到一种方法来完成这些任务中的任何一个。

Answer 1

您可以做的事情类似于StatusCodePages 中间件的工作方式。 该中间件允许管道重新执行模型，以允许通过正常的 MVC 管道处理状态代码错误。 因此，当您从 MVC 返回不成功的状态代码时，中间件会检测到该状态，然后重新执行整个管道以获取状态代码错误路由。 这样，您就可以完全设计状态代码错误。 但正如 Chris Pratt 已经提到的，这些状态代码通常仅限于它们的代码。 没有真正的方法可以向其中添加其他详细信息。

但是我们可以做的是在该重新执行模型之上创建我们自己的错误处理实现。 为此，我们创建了一个CustomErrorResponseMiddleware ，它基本上检查CustomErrorResponseException异常，然后为我们的错误处理程序重新执行中间件管道。

// Custom exceptions that can be thrown within the middleware
public class CustomErrorResponseException : Exception
{
    public int StatusCode { get; set; }
    public CustomErrorResponseException(string message, int statusCode)
        : base(message)
    {
        StatusCode = statusCode;
    }
}

public class NotFoundResponseException : CustomErrorResponseException
{
    public NotFoundResponseException(string message)
        : base(message, 404)
    { }
}

// Custom context feature, to store information from the exception
public interface ICustomErrorResponseFeature
{
    int StatusCode { get; set; }
    string StatusMessage { get; set; }
}
public class CustomErrorResponseFeature : ICustomErrorResponseFeature
{
    public int StatusCode { get; set; }
    public string StatusMessage { get; set; }
}

// Middleware implementation
public class CustomErrorResponseMiddleware
{
    private readonly RequestDelegate _next;
    private readonly string _requestPath;

    public CustomErrorResponseMiddleware(RequestDelegate next, string requestPath)
    {
        _next = next;
        _requestPath = requestPath;
    }

    public async Task Invoke(HttpContext context)
    {
        try
        {
            // run the pipeline normally
            await _next(context);
        }
        catch (CustomErrorResponseException ex)
        {
            // store error information to be retrieved in the custom handler
            context.Features.Set<ICustomErrorResponseFeature>(new CustomErrorResponseFeature
            {
                StatusCode = ex.StatusCode,
                StatusMessage = ex.Message,
            });

            // backup original request data
            var originalPath = context.Request.Path;
            var originalQueryString = context.Request.QueryString;

            // set new request data for re-execution
            context.Request.Path = _requestPath;
            context.Request.QueryString = QueryString.Empty;

            try
            {
                // re-execute middleware pipeline
                await _next(context);
            }
            finally
            {
                // restore original request data
                context.Request.Path = originalPath;
                context.Request.QueryString = originalQueryString;
            }
        }
    }
}

现在，我们需要做的就是把它连接起来。 所以我们在Startup.Configure中添加中间件，靠近开头：

app.UseMiddleware<CustomErrorResponseMiddleware>("/custom-error-response");

/custom-error-response是我们在请求自定义响应时重新执行的路由。 这可以是一个正常的 MVC 控制器操作：

[Route("/custom-error-response")]
public IActionResult CustomErrorResponse()
{
    var customErrorResponseFeature = HttpContext.Features.Get<ICustomErrorResponseFeature>();

    var view = View(customErrorResponseFeature);
    view.StatusCode = customErrorResponseFeature.StatusCode;
    return view;
}

由于这使用了 MVC，所以这也需要一个视图：

@model ICustomErrorResponseFeature
@{
    ViewData["Title"] = "Error";
}

<p>There was an error with your request:</p>
<p>@Model.StatusMessage</p>

基本上就是这样。 现在，我们可以从 MVC 操作中抛出自定义错误响应异常来触发它：

// generate a 404
throw new NotFoundResponseException("This item could not be found");

// or completely custom
throw new CustomErrorResponseException("This did not work", 400);

当然，我们也可以进一步扩展，但这应该是基本思想。

---

如果您已经在使用 StatusCodePages 中间件，您可能会认为所有这些自定义重新执行是否真的有必要，而您已经在 StatusCodePages 中间件中完全拥有了。 好吧，事实并非如此。 我们也可以直接扩展它。

为此，我们将只添加上下文特征，我们可以在正常执行期间的任何时间进行设置。 然后，我们只返回一个状态码，让 StatusCodePages 中间件运行。 在其处理程序中，我们可以查找我们的功能并使用那里的信息来展开状态码错误页面：

// Custom context feature
public interface IStatusCodePagesInfoFeature
{
    string StatusMessage { get; set; }
}
public class StatusCodePagesInfoFeature : IStatusCodePagesInfoFeature
{
    public string StatusMessage { get; set; }
}

// registration of the StatusCodePages middleware inside Startup.Configure
app.UseStatusCodePagesWithReExecute("/error/{0}");

// and the MVC action for that URL
[Route("/error/{code}")]
public IActionResult StatusCode(int code)
{
    var statusCodePagesInfoFeature = HttpContext.Features.Get<IStatusCodePagesInfoFeature>();

    return View(model: statusCodePagesInfoFeature?.StatusMessage);
}

在正常的控制器操作中，我们可以在返回状态码之前设置该功能：

HttpContext.Features.Set<IStatusCodePagesInfoFeature>(new StatusCodePagesInfoFeature
{
    StatusMessage = "This item could not be found"
});
return NotFound();

---

太糟糕了，您不能在中间件类中拦截 NotFound、Unauthorized 等响应。

好，选择三！ 您可以完全拦截这些响应，而不是在中间件内部，因为这些是 MVC 结果并且不会离开 MVC 管道。 所以你必须在 MVC 过滤器管道中拦截它们。 但是我们绝对可以运行一个过滤器，例如一个结果过滤器，它会修改结果。

问题是我们仍然需要一种方法来传递信息。 我们可以再次使用上下文特征，但我们也可以使用 MVC 对象结果。 所以我们的想法是我们可以在 MVC 操作中执行以下操作：

return NotFound("The item was not found");

所以通常，该字符串将是纯文本响应。 但是在执行结果和生成响应之前，我们可以运行一个结果过滤器来修改它并返回一个视图结果。

public class StatusCodeResultFilter : IAsyncResultFilter
{
    public async Task OnResultExecutionAsync(ResultExecutingContext context, ResultExecutionDelegate next)
    {
        // retrieve a typed controller, so we can reuse its data
        if (context.Controller is Controller controller)
        {
            // intercept the NotFoundObjectResult
            if (context.Result is NotFoundObjectResult notFoundResult)
            {
                // set the model, or other view data
                controller.ViewData.Model = notFoundResult.Value;

                // replace the result by a view result
                context.Result = new ViewResult()
                {
                    StatusCode = 404,
                    ViewName = "Views/Errors/NotFound.cshtml",
                    ViewData = controller.ViewData,
                    TempData = controller.TempData,
                };
            }
            // intercept other results here…
        }

        await next();
    }
}

您现在只需要一个Views/Errors/NotFound.cshtml视图，一旦您注册了过滤器，一切都会神奇地工作。

您可以通过将[TypeFilter(typeof(StatusCodeResultFilter))]属性添加到控制器或单个操作来注册过滤器，也可以全局注册它。

Answer 2

你想要的是不可能的。 当您执行诸如 return NotFound与消息之类的操作时，该消息仅在不受干扰的情况下才会包含在响应正文中。 当您执行诸如启用状态代码页之类的操作时，中间件会简单地捕获NotFound ，并且请求将简单地交给您的错误处理操作以最终获得响应。 重要的是，这意味着您的原始NotFoundResult以及任何自定义消息已被舍入。