如何返回NotFound() IHttpActionResult错误信息或异常？

Question

当在我的WebApi GET操作中未找到某些内容时，我正在返回NotFindIHttpActionResult。伴随此响应，我想发送自定义消息和/或异常消息（如果有）。当前的ApiController的NotFind（）方法不提供传递消息的重载。

有什么办法可以做到这一点吗？或者我将不得不编写自己的自定义IHttpActionResult？

Answer 1

如果您愿意，可以使用响应消息结果：

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

是的，如果你需要更短的版本，那么我想你需要实现你的自定义动作结果。

Answer 2

如果您想要自定义响应消息形状，您需要编写自己的操作结果。

我们希望为简单的空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.");
    }
}

Answer 3

这里有一个简单消息返回IHttpActionResult NotFound的一行程序：

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