Как мне вернуть NotFound () IHttpActionResult с сообщением об ошибке или исключении?

Я возвращаю NotFound IHttpActionResult, если что-то не найдено в моем действии GET WebApi. Вместе с этим ответом я хочу отправить собственное сообщение и / или сообщение об исключении (если есть). Тока ApiController«ы NotFound()способ не обеспечивает перегрузку , чтобы передать сообщение.

Есть ли способ сделать это? или мне придется писать свой кастом IHttpActionResult?

Вам нужно будет написать собственный результат действия, если вы хотите настроить форму ответного сообщения.

Мы хотели предоставить наиболее распространенные формы ответных сообщений из коробки для таких вещей, как простые пустые сообщения 404, но мы также хотели, чтобы эти результаты были как можно более простыми; Одно из основных преимуществ использования результатов действий состоит в том, что они значительно упрощают модульное тестирование вашего метода действия. Чем больше свойств мы добавляем к результатам действия, тем больше вещей необходимо учитывать вашему модульному тесту, чтобы убедиться, что метод действия выполняет то, что вы ожидаете.

Мне часто нужна возможность предоставить собственное сообщение, поэтому не стесняйтесь регистрировать ошибку, чтобы мы рассмотрели возможность поддержки этого результата действия в будущей версии: https://aspnetwebstack.codeplex.com/workitem/list/advanced

Однако в результатах действий есть одна приятная вещь: вы всегда можете довольно легко написать свои собственные, если хотите сделать что-то немного другое. Вот как вы могли бы это сделать в своем случае (если вы хотите, чтобы сообщение об ошибке было в текстовом / обычном формате; если вам нужен JSON, вы бы сделали что-то немного другое с содержимым):

public class NotFoundTextPlainActionResult : IHttpActionResult
{
    public NotFoundTextPlainActionResult(string message, HttpRequestMessage request)
    {
        if (message == null)
        {
            throw new ArgumentNullException("message");
        }

        if (request == null)
        {
            throw new ArgumentNullException("request");
        }

        Message = message;
        Request = request;
    }

    public string Message { get; private set; }

    public HttpRequestMessage Request { get; private set; }

    public Task<HttpResponseMessage> ExecuteAsync(CancellationToken cancellationToken)
    {
        return Task.FromResult(Execute());
    }

    public HttpResponseMessage Execute()
    {
        HttpResponseMessage response = new HttpResponseMessage(HttpStatusCode.NotFound);
        response.Content = new StringContent(Message); // Put the message in the response body (text/plain content).
        response.RequestMessage = Request;
        return response;
    }
}

public static class ApiControllerExtensions
{
    public static NotFoundTextPlainActionResult NotFound(this ApiController controller, string message)
    {
        return new NotFoundTextPlainActionResult(message, controller.Request);
    }
}

Затем в своем методе действия вы можете просто сделать что-то вроде этого:

public class TestController : ApiController
{
    public IHttpActionResult Get()
    {
        return this.NotFound("These are not the droids you're looking for.");
    }
}

Если вы использовали базовый класс настраиваемого контроллера (вместо прямого наследования от ApiController), вы также могли бы исключить «this». часть (которая, к сожалению, требуется при вызове метода расширения):

public class CustomApiController : ApiController
{
    protected NotFoundTextPlainActionResult NotFound(string message)
    {
        return new NotFoundTextPlainActionResult(message, Request);
    }
}

public class TestController : CustomApiController
{
    public IHttpActionResult Get()
    {
        return NotFound("These are not the droids you're looking for.");
    }
}

Вот однострочный вариант для возврата IHttpActionResult NotFound с простым сообщением:

return Content(HttpStatusCode.NotFound, "Foo does not exist.");

Вы можете использовать, ResponseMessageResultесли хотите:

var myCustomMessage = "your custom message which would be sent as a content-negotiated response"; 
return ResponseMessage(
    Request.CreateResponse(
        HttpStatusCode.NotFound, 
        myCustomMessage
    )
);

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

Вы можете использовать свойство ReasonPhrase класса HttpResponseMessage

catch (Exception exception)
{
  throw new HttpResponseException(new HttpResponseMessage(HttpStatusCode.NotFound)
  {
    ReasonPhrase = exception.Message
  });
}

Вы можете создать собственный согласованный результат контента, как предложено d3m3t3er. Однако я бы унаследовал от. Кроме того, если он нужен только для возврата NotFound, вам не нужно инициализировать статус http из конструктора.

public class NotFoundNegotiatedContentResult<T> : NegotiatedContentResult<T>
{
    public NotFoundNegotiatedContentResult(T content, ApiController controller)
        : base(HttpStatusCode.NotFound, content, controller)
    {
    }

    public override Task<HttpResponseMessage> ExecuteAsync(
        CancellationToken cancellationToken)
    {
        return base.ExecuteAsync(cancellationToken).ContinueWith(
            task => task.Result, cancellationToken);
    }
}

Я решил это, просто взяв OkNegotiatedContentResultи переопределив код HTTP в полученном ответном сообщении. Этот класс позволяет вам возвращать тело содержимого с любым кодом ответа HTTP.

public class CustomNegotiatedContentResult<T> : OkNegotiatedContentResult<T>
{
    public HttpStatusCode HttpStatusCode;

    public CustomNegotiatedContentResult(
        HttpStatusCode httpStatusCode, T content, ApiController controller)
        : base(content, controller)
    {
        HttpStatusCode = httpStatusCode;
    }

    public override Task<HttpResponseMessage> ExecuteAsync(
        CancellationToken cancellationToken)
    {
        return base.ExecuteAsync(cancellationToken).ContinueWith(
            task => { 
                // override OK HTTP status code with our own
                task.Result.StatusCode = HttpStatusCode;
                return task.Result;
            },
            cancellationToken);
    }
}

Если вы наследуете от базы NegotitatedContentResult<T>, как уже упоминалось, и вам не нужно преобразовывать свой content(например, вы просто хотите вернуть строку), вам не нужно переопределять ExecuteAsyncметод.

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

Вот примеры для NotFoundи InternalServerError:

public class NotFoundNegotiatedContentResult : NegotiatedContentResult<string>
{
    public NotFoundNegotiatedContentResult(string content, ApiController controller)
        : base(HttpStatusCode.NotFound, content, controller) { }
}

public class InternalServerErrorNegotiatedContentResult : NegotiatedContentResult<string>
{
    public InternalServerErrorNegotiatedContentResult(string content, ApiController controller)
        : base(HttpStatusCode.InternalServerError, content, controller) { }
}

А затем вы можете создать соответствующие методы расширения ApiController(или сделать это в базовом классе, если он у вас есть):

public static NotFoundNegotiatedContentResult NotFound(this ApiController controller, string message)
{
    return new NotFoundNegotiatedContentResult(message, controller);
}

public static InternalServerErrorNegotiatedContentResult InternalServerError(this ApiController controller, string message)
{
    return new InternalServerErrorNegotiatedContentResult(message, controller);
}

И тогда они работают так же, как встроенные методы. Вы можете вызвать существующий NotFound()или новый пользовательский NotFound(myErrorMessage).

И, конечно же, вы можете избавиться от «жестко запрограммированных» строковых типов в определениях настраиваемых типов и оставить их универсальными, если хотите, но тогда вам, возможно, придется побеспокоиться о ExecuteAsyncвещах, в зависимости от того, что у вас на <T>самом деле.

Вы можете просмотреть в исходный код для , NegotiatedContentResult<T>чтобы увидеть все это делает. В этом нет ничего особенного.

Мне нужно было создать IHttpActionResultэкземпляр в теле IExceptionHandlerкласса, чтобы установить ExceptionHandlerContext.Resultсвойство. Однако я также хотел установить custom ReasonPhrase.

Я обнаружил, что ResponseMessageResultможно обернуть a HttpResponseMessage(что позволяет легко установить ReasonPhrase).

Например:

public class MyExceptionHandler : ExceptionHandler
{
    public override void Handle(ExceptionHandlerContext context)
    {
        var ex = context.Exception as IRecordNotFoundException;
        if (ex != null)
        {
            context.Result = new ResponseMessageResult(new HttpResponseMessage(HttpStatusCode.NotFound) { ReasonPhrase = $"{ex.EntityName} not found" });
        }
    }
}

Я знаю, что PO запрашивает текст сообщения, но другой вариант просто вернуть 404 - заставить метод возвращать IHttpActionResult и использовать функцию StatusCode

    public async Task<IHttpActionResult> Get([FromUri]string id)
    {
       var item = await _service.GetItem(id);
       if(item == null)
       {
           StatusCode(HttpStatusCode.NotFound);
       }
       return Ok(item);
    }

В ответах здесь отсутствует небольшая проблема с историей разработчика. ApiControllerКласс еще обнажая NotFound()метод , который разработчики могут использовать. Это приведет к тому, что ответ 404 будет содержать неконтролируемое тело результата.

Я представляю здесь несколько частей кода « лучшего метода ApiController NotFound », который обеспечит метод , менее подверженный ошибкам, который не требует от разработчиков знания «лучшего способа отправки 404».

• создать класс, наследующий отApiController вызываемогоApiController
  • Я использую эту технику, чтобы запретить разработчикам использовать исходный класс
• переопределить его NotFoundметод, чтобы разработчики могли использовать первый доступный API
• если вы хотите препятствовать этому, отметьте это как [Obsolete("Use overload instead")]
• добавьте еще, protected NotFoundResult NotFound(string message)что вы хотите поощрить
• проблема: результат не поддерживает ответ телом. решение: наследовать и использовать NegotiatedContentResult. см. прилагаемый лучше класс NotFoundResult .