Làm cách nào để trả về NotFound () IHttpActionResult với thông báo lỗi hoặc ngoại lệ?

Tôi đang trả về NotFound IHttpActionResultkhi không tìm thấy thứ gì đó trong hành động GET trên WebApi của tôi. Cùng với phản hồi này, tôi muốn gửi một tin nhắn tùy chỉnh và / hoặc tin nhắn ngoại lệ (nếu có). Các hiện ApiControllercủa NotFound()phương pháp không cung cấp một quá tải để thông qua một tin nhắn.

Có cách nào để làm điều này? hoặc tôi sẽ phải viết tùy chỉnh của riêng tôi IHttpActionResult?

Bạn cần phải viết kết quả hành động của riêng mình nếu bạn muốn tùy chỉnh hình dạng thông báo phản hồi.

Chúng tôi muốn cung cấp các hình dạng thông báo phản hồi phổ biến nhất cho những thứ như 404 trống đơn giản, nhưng chúng tôi cũng muốn giữ các kết quả này càng đơn giản càng tốt; một trong những lợi thế chính của việc sử dụng kết quả hành động là nó làm cho phương pháp hành động của bạn dễ dàng hơn nhiều để kiểm tra đơn vị. Chúng tôi càng đưa nhiều thuộc tính vào kết quả hành động, thì bài kiểm tra đơn vị của bạn càng cần phải xem xét để đảm bảo rằng phương pháp hành động đang thực hiện những gì bạn mong đợi.

Tôi cũng thường muốn có khả năng cung cấp thông báo tùy chỉnh, vì vậy vui lòng ghi lại lỗi để chúng tôi xem xét hỗ trợ kết quả hành động đó trong bản phát hành trong tương lai: https://aspnetwebstack.codeplex.com/workitem/list/advanced

Tuy nhiên, có một điều thú vị về kết quả hành động là bạn luôn có thể viết cho riêng mình một cách khá dễ dàng nếu bạn muốn làm điều gì đó hơi khác một chút. Đây là cách bạn có thể thực hiện trong trường hợp của mình (giả sử bạn muốn thông báo lỗi ở dạng văn bản / thuần túy; nếu bạn muốn JSON, bạn sẽ làm điều gì đó hơi khác với nội dung):

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);
    }
}

Sau đó, trong phương pháp hành động của bạn, bạn chỉ có thể làm một số việc như sau:

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

Nếu bạn đã sử dụng lớp cơ sở của bộ điều khiển tùy chỉnh (thay vì kế thừa trực tiếp từ ApiController), bạn cũng có thể loại bỏ "this". phần (không may là bắt buộc khi gọi một phương thức mở rộng):

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.");
    }
}

Đây là một lớp lót để trả về IHttpActionResult NotFound với một thông báo đơn giản:

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

Bạn có thể sử dụng ResponseMessageResultnếu bạn thích:

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

vâng, nếu bạn cần các phiên bản ngắn hơn nhiều, thì tôi đoán bạn cần triển khai kết quả hành động tùy chỉnh của mình.

Bạn có thể sử dụng thuộc tính ReasonPhrase của lớp HttpResponseMessage

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

Bạn có thể tạo kết quả nội dung thương lượng tùy chỉnh như d3m3t3er đề xuất. Tuy nhiên tôi sẽ thừa kế từ. Ngoài ra, nếu bạn chỉ cần nó để trả về NotFound, bạn không cần phải khởi tạo trạng thái http từ hàm tạo.

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);
    }
}

Tôi đã giải quyết nó bằng cách đơn giản lấy từ OkNegotiatedContentResultvà ghi đè mã HTTP trong thông báo phản hồi kết quả. Lớp này cho phép bạn trả về nội dung với bất kỳ mã phản hồi HTTP nào.

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);
    }
}

Nếu bạn kế thừa từ cơ sở NegotitatedContentResult<T>, như đã đề cập và bạn không cần phải chuyển đổi content(ví dụ: bạn chỉ muốn trả về một chuỗi), thì bạn không cần ghi đè ExecuteAsyncphương thức.

Tất cả những gì bạn cần làm là cung cấp một định nghĩa kiểu thích hợp và một hàm tạo cho cơ sở biết Mã trạng thái HTTP nào sẽ trả về. Mọi thứ khác chỉ hoạt động.

Dưới đây là các ví dụ cho cả hai NotFoundvà 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) { }
}

Và sau đó, bạn có thể tạo các phương thức mở rộng tương ứng cho ApiController(hoặc làm điều đó trong một lớp cơ sở nếu bạn có):

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);
}

Và sau đó chúng hoạt động giống như các phương thức tích hợp sẵn. Bạn có thể gọi hiện tại NotFound()hoặc có thể gọi tùy chỉnh mới của bạnNotFound(myErrorMessage) .

Và tất nhiên, bạn có thể loại bỏ các loại chuỗi "mã hóa cứng" trong định nghĩa loại tùy chỉnh và để nó chung chung nếu bạn muốn, nhưng sau đó bạn có thể phải lo lắng về những ExecuteAsyncthứ này, tùy thuộc vào<T> thực tế .

Bạn có thể xem qua các mã nguồn cho NegotiatedContentResult<T>thấy tất cả nó. Không có gì nhiều cho nó.

Tôi cần tạo một IHttpActionResultthể hiện trong phần thân của một IExceptionHandlerlớp, để thiết lập thuộc ExceptionHandlerContext.Resulttính. Tuy nhiên, tôi cũng muốn đặt một tùy chỉnhReasonPhrase .

Tôi thấy rằng a ResponseMessageResultcó thể bọc mộtHttpResponseMessage (cho phép dễ dàng đặt ReasonPhrase).

Ví dụ:

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" });
        }
    }
}

Tôi biết PO đã hỏi bằng văn bản thông báo, nhưng một tùy chọn khác để chỉ trả về 404 là làm cho phương thức trả về một IHttpActionResult và sử dụng hàm StatusCode

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

Các câu trả lời ở đây đang thiếu một vấn đề nhỏ về câu chuyện của nhà phát triển. Các ApiControllerlớp vẫn còn phơi bày mộtNotFound() phương pháp mà các nhà phát triển có thể sử dụng. Điều này sẽ khiến một số phản hồi 404 chứa phần thân kết quả không được kiểm soát.

Tôi trình bày ở đây một vài phần của mã " phương pháp ApiController NotFound tốt hơn " sẽ cung cấp một phương pháp ít lỗi hơn mà không yêu cầu các nhà phát triển biết "cách tốt hơn để gửi 404".

• tạo một lớp kế thừa từApiController được gọiApiController
  • Tôi sử dụng kỹ thuật này để ngăn các nhà phát triển sử dụng lớp gốc
• ghi đè NotFoundphương pháp của nó để cho phép các nhà phát triển sử dụng api có sẵn đầu tiên
• nếu bạn muốn ngăn cản điều này, hãy đánh dấu điều này là [Obsolete("Use overload instead")]
• thêm một phần protected NotFoundResult NotFound(string message) mà bạn muốn khuyến khích
• vấn đề: kết quả không hỗ trợ phản hồi với một nội dung. giải pháp: kế thừa và sử dụng NegotiatedContentResult. xem lớp NotFoundResult đính kèm tốt hơn .