ASP.NET обработка исключений Core Web API

лучше всего использовать промежуточное ПО для ведения журнала, который вы ищете. Вы хотите поместить журнал исключений в одно промежуточное ПО, а затем обработать страницы ошибок, отображаемые пользователю в другом промежуточном по. Это позволяет разделить логику и следует дизайн Microsoft выложил с 2 промежуточного программного обеспечения componenets. Вот хорошая ссылка на документацию Microsoft:обработка ошибок в ASP.Net ядро

для вашего конкретного примера вы можете использовать одно из расширений в промежуточное ПО StatusCodePage или свернуть свой собственный, как этой.

вы можете найти пример здесь для регистрации исключений:ExceptionHandlerMiddleware.cs

public void Configure(IApplicationBuilder app)
{
    // app.UseErrorPage(ErrorPageOptions.ShowAll);
    // app.UseStatusCodePages();
    // app.UseStatusCodePages(context => context.HttpContext.Response.SendAsync("Handler, status code: " + context.HttpContext.Response.StatusCode, "text/plain"));
    // app.UseStatusCodePages("text/plain", "Response, status code: {0}");
    // app.UseStatusCodePagesWithRedirects("~/errors/{0}");
    // app.UseStatusCodePagesWithRedirects("/base/errors/{0}");
    // app.UseStatusCodePages(builder => builder.UseWelcomePage());
    app.UseStatusCodePagesWithReExecute("/Errors/{0}");  // I use this version

    // Exception handling logging below
    app.UseExceptionHandler();
}

Если вам не нравится эта конкретная реализация, то вы также можете использовать промежуточное ПО ELM и вот несколько примеров: Elm Исключение Промежуточного Программного Обеспечения

public void Configure(IApplicationBuilder app)
{
    app.UseStatusCodePagesWithReExecute("/Errors/{0}");
    // Exception handling logging below
    app.UseElmCapture();
    app.UseElmPage();
}

Если это не работает для ваших нужд, вы всегда можете свернуть свой собственный компонент промежуточного ПО, посмотрев на их реализации ExceptionHandlerMiddleware и ElmMiddleware, чтобы понять концепции для создания собственного.

важно добавить промежуточное ПО обработки исключений ниже промежуточного ПО StatusCodePages, но выше всех других компонентов промежуточного ПО. Таким образом, промежуточное ПО исключения захватит исключение, зарегистрирует его, а затем разрешит запрос перейти к промежуточному по StatusCodePage, которое будет отображение страницы дружественных ошибок для пользователя.

для настройки поведения обработки исключений для каждого типа исключений можно использовать промежуточное ПО из пакетов NuGet:

• сообщество.AspNetCore.Обработка исключений.NewtonsoftJson на ASP.NET Core 2.0
• сообщество.AspNetCore.Обработка исключений.В MVC на ASP.NET Core 2.1+.

код:

public void ConfigureServices(IServiceCollection services)
{
    services.AddMvc();

    services.AddExceptionHandlingPolicies(options =>
    {
        options.For<InitializationException>().Rethrow();

        options.For<SomeTransientException>().Retry(ro => ro.MaxRetryCount = 2).NextPolicy();

        options.For<SomeBadRequestException>()
        .Response(e => 400)
            .Headers((h, e) => h["X-MyCustomHeader"] = e.Message)
            .WithBody((req,sw, exception) =>
                {
                    byte[] array = Encoding.UTF8.GetBytes(exception.ToString());
                    return sw.WriteAsync(array, 0, array.Length);
                })
        .NextPolicy();

        // Ensure that all exception types are handled by adding handler for generic exception at the end.
        options.For<Exception>()
        .Log(lo =>
            {
                lo.EventIdFactory = (c, e) => new EventId(123, "UnhandlerException");
                lo.Category = (context, exception) => "MyCategory";
            })
        .Response(null, ResponseAlreadyStartedBehaviour.GoToNextHandler)
            .ClearCacheHeaders()
            .WithObjectResult((r, e) => new { msg = e.Message, path = r.Path })
        .Handled();
    });
}

public void Configure(IApplicationBuilder app, IHostingEnvironment env)
{
    app.UseExceptionHandlingPolicies();
    app.UseMvc();
}

во-первых, настроить ASP.NET ядро 2 Startup для повторного выполнения на странице ошибок для любых ошибок с веб-сервера и любых необработанных исключений.

public void Configure(IApplicationBuilder app, IHostingEnvironment env)
{
    if (env.IsDevelopment()) {
        // Debug config here...
    } else {
        app.UseStatusCodePagesWithReExecute("/Error");
        app.UseExceptionHandler("/Error");
    }
    // More config...
}

затем определите тип исключения, который позволит вам создавать ошибки с кодами состояния HTTP.

public class HttpException : Exception
{
    public HttpException(HttpStatusCode statusCode) { StatusCode = statusCode; }
    public HttpStatusCode StatusCode { get; private set; }
}

наконец, в контроллере для страницы ошибки настройте ответ на основе причины ошибки и того, будет ли ответ виден непосредственно конечным пользователем. Этот код предполагает, что все URL-адреса API начинаются с /api/.

[AllowAnonymous]
public IActionResult Error()
{
    // Gets the status code from the exception or web server.
    var statusCode = HttpContext.Features.Get<IExceptionHandlerFeature>()?.Error is HttpException httpEx ?
        httpEx.StatusCode : (HttpStatusCode)Response.StatusCode;

    // For API errors, responds with just the status code (no page).
    if (HttpContext.Features.Get<IHttpRequestFeature>().RawTarget.StartsWith("/api/", StringComparison.Ordinal))
        return StatusCode((int)statusCode);

    // Creates a view model for a user-friendly error page.
    string text = null;
    switch (statusCode) {
        case HttpStatusCode.NotFound: text = "Page not found."; break;
        // Add more as desired.
    }
    return View("Error", new ErrorViewModel { RequestId = Activity.Current?.Id ?? HttpContext.TraceIdentifier, ErrorText = text });
}

ASP.NET Core будет регистрировать сведения об ошибке для отладки, поэтому код состояния может быть всем, что вы хотите предоставить (потенциально ненадежному) запросчику. Если вы хотите показать больше информации, вы можете улучшить HttpException обеспечить его. Для ошибок API вы можете поместить информацию об ошибке в кодировке JSON в тело сообщения, заменив return StatusCode... С return Json....

во-первых, спасибо Андрею, поскольку я основал свое решение на его примере.

Я включаю свой, поскольку это более полный образец и может сэкономить читателям некоторое время.

ограничение подхода Андрея заключается в том, что он не обрабатывает ведение журнала, захват потенциально полезных переменных запроса и согласование контента (он всегда будет возвращать JSON независимо от того, что запросил клиент - XML / обычный текст и т. д.).

мой подход заключается в использовании ObjectResult, который позволяет мы используем функциональность, запеченную в MVC.

этот код также предотвращает кэширование ответа.

ответ на ошибку был оформлен таким образом, что он может быть сериализован XML-сериализатором.

public class ExceptionHandlerMiddleware
{
    private readonly RequestDelegate next;
    private readonly IActionResultExecutor<ObjectResult> executor;
    private readonly ILogger logger;
    private static readonly ActionDescriptor EmptyActionDescriptor = new ActionDescriptor();

    public ExceptionHandlerMiddleware(RequestDelegate next, IActionResultExecutor<ObjectResult> executor, ILoggerFactory loggerFactory)
    {
        this.next = next;
        this.executor = executor;
        logger = loggerFactory.CreateLogger<ExceptionHandlerMiddleware>();
    }

    public async Task Invoke(HttpContext context)
    {
        try
        {
            await next(context);
        }
        catch (Exception ex)
        {
            logger.LogError(ex, $"An unhandled exception has occurred while executing the request. Url: {context.Request.GetDisplayUrl()}. Request Data: " + GetRequestData(context));

            if (context.Response.HasStarted)
            {
                throw;
            }

            var routeData = context.GetRouteData() ?? new RouteData();

            ClearCacheHeaders(context.Response);

            var actionContext = new ActionContext(context, routeData, EmptyActionDescriptor);

            var result = new ObjectResult(new ErrorResponse("Error processing request. Server error."))
            {
                StatusCode = (int) HttpStatusCode.InternalServerError,
            };

            await executor.ExecuteAsync(actionContext, result);
        }
    }

    private static string GetRequestData(HttpContext context)
    {
        var sb = new StringBuilder();

        if (context.Request.HasFormContentType && context.Request.Form.Any())
        {
            sb.Append("Form variables:");
            foreach (var x in context.Request.Form)
            {
                sb.AppendFormat("Key={0}, Value={1}<br/>", x.Key, x.Value);
            }
        }

        sb.AppendLine("Method: " + context.Request.Method);

        return sb.ToString();
    }

    private static void ClearCacheHeaders(HttpResponse response)
    {
        response.Headers[HeaderNames.CacheControl] = "no-cache";
        response.Headers[HeaderNames.Pragma] = "no-cache";
        response.Headers[HeaderNames.Expires] = "-1";
        response.Headers.Remove(HeaderNames.ETag);
    }

    [DataContract(Name= "ErrorResponse")]
    public class ErrorResponse
    {
        [DataMember(Name = "Message")]
        public string Message { get; set; }

        public ErrorResponse(string message)
        {
            Message = message;
        }
    }
}