Есть ли какой-нибудь способ в промежуточном программном обеспечении, работающем на ASP.NET Core 2.2, определить, является ли запрос для ApiController? - PullRequest
Новая
       26

Есть ли какой-нибудь способ в промежуточном программном обеспечении, работающем на ASP.NET Core 2.2, определить, является ли запрос для ApiController?

1 голос
/ 21 марта 2019

У меня есть приложение с обоими сосуществующими конечными точками MVC и «новым» ApiController в ASP.NET Core 2.2.

До добавления конечных точек API я использовал глобальный обработчик исключений, зарегистрированный в качестве промежуточного программного обеспечения с использованием app.UseExceptionHandler((x) => { ... }, который перенаправлял бы на страницу с ошибкой.

Конечно, это не работает для ответа API, и я хотел бы вернуть ObjectResult (согласованный) 500 результат с ProblemDetails отформатированным результатом.

Проблема в том, что я не уверен, как надежно определить в моей лямбде UseExceptionHandler, имею ли я дело с MVC или запросом API. Я мог бы использовать какое-то соответствие URL запроса (например, /api/... prefix), но я хотел бы более надежное решение, которое не вернется, чтобы укусить меня в будущем.

Грубая версия псевдо-кода, которую я пытаюсь реализовать: 

app.UseExceptionHandler(x =>
{
    x.Run(async context =>
    {
        // extract the exception that was thrown
        var ex = context.Features.Get<IExceptionHandlerFeature>()?.Error;

        try
        {
            // generically handle the exception regardless of what our response needs to look like by logging it
            // NOTE: ExceptionHandlerMiddleware itself will log the exception

            // TODO: need to find a way to see if we have run with negotiation turned on (in which case we are API not MVC!! see below extensions for clues?)
            // TODO: ... could just use "/api/" prefix but that seems rubbish
            if (true)
            {
                // return a 500 with object (in RFC 7807 form) negotiated to the right content type (eg. json)
            }
            else
            {
                // otherwise, we handle the response as a 500 error page redirect
            }
        }
        catch (Exception exofex)
        {
            // NOTE: absolutely terrible if we get into here
            log.Fatal($"Unhandled exception in global error handler!", exofex);
            log.Fatal($"Handling exception: ", ex);
        }
    });
});
}

Есть идеи?

Ура!

Ответы [ 3 ]

0 голосов
/ 22 марта 2019

Если вы хотите проверить, направлен ли запрос на ApiController, вы можете попробовать IExceptionFilter, чтобы обработать исключения.

public class CustomExceptionFilter : IExceptionFilter
{
    public void OnException(ExceptionContext context)
    {
        if (IsApi(context))
        {
            HttpStatusCode status = HttpStatusCode.InternalServerError;
            var message = context.Result;

            //You can enable logging error

            context.ExceptionHandled = true;
            HttpResponse response = context.HttpContext.Response;
            response.StatusCode = (int)status;
            response.ContentType = "application/json";
            context.Result = new ObjectResult(new { ErrorMsg = message });
        }
        else
        {

        }
    }
    private bool IsApi(ExceptionContext context)
    {
        var controllerActionDesc = context.ActionDescriptor as ControllerActionDescriptor;
        var attribute = controllerActionDesc
                        .ControllerTypeInfo
                        .CustomAttributes
                        .FirstOrDefault(c => c.AttributeType == typeof(ApiControllerAttribute));
        return attribute == null ? false : true;
    }
}
0 голосов
/ 26 марта 2019

Спасибо всем советам от других, но после некоторого размышления и идей отсюда я понял, что мой подход был неправильным с самого начала - и что я должен обрабатывать большинство исключений локально в контроллере и отвечать оттуда.

Я в основном сохранил свое промежуточное программное обеспечение для обработки ошибок так же, как если бы оно обрабатывало необработанные исключения MVC. Клиент получит 500 с ответом HTML, но в этот момент клиент ничего не может сделать, так что никакого вреда.

Спасибо за вашу помощь!

0 голосов
/ 21 марта 2019

Это может немного отличаться от того, что вы ожидаете, но вы можете просто проверить, является ли запрос запросом AJAX.

Вы можете использовать это расширение: 

public static class HttpRequestExtensions
{
    public static bool IsAjaxRequest(this HttpRequest request)
    {
        if (request == null)
            throw new ArgumentNullException(nameof(request));

        if (request.Headers == null)
            return false;

        return request.Headers["X-Requested-With"] == "XMLHttpRequest";
    }
}

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

public async Task Invoke(HttpContext context)
{
    if (context.Request.IsAjaxRequest())
    {
        try
        {
            await _next(context);
        }
        catch (Exception ex)
        {
             //Handle the exception
             await HandleExceptionAsync(context, ex);
        }
    }
    else
    {
        await _next(context);
    }
}

private static Task HandleExceptionAsync(HttpContext context, Exception exception)
{
    //you can do more complex logic here, but a basic example would be:
    var result = JsonConvert.SerializeObject(new { error = "An unexpected error occurred." });
    context.Response.ContentType = "application/json";
    context.Response.StatusCode = 500;
    return context.Response.WriteAsync(result);
}

см. этот ответ SO для более подробной версии.

...