IHttpActionResultWebApi GET 작업에서 무언가를 찾을 수없는 경우 NotFound를 반환하고 있습니다. 이 응답과 함께 사용자 지정 메시지 및 / 또는 예외 메시지 (있는 경우)를 보내려고합니다. 현재 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
)
);예, 훨씬 더 짧은 버전이 필요한 경우 사용자 지정 작업 결과를 구현해야합니다.
HttpResponseMessage 클래스의 ReasonPhrase 속성을 사용할 수 있습니다.
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>언급했듯이 base에서 상속 하고 변환 할 필요가없는 경우 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본문에 인스턴스 를 만들어야했습니다 .IExceptionHandlerExceptionHandlerContext.Result속성 을 설정하기 위해 클래스 . 그러나 나는 또한 사용자 정의를 설정하고 싶었습니다 ReasonPhrase.
a ResponseMessageResult가 a 를 래핑 할 수 있다는 것을 발견 했습니다 HttpResponseMessage(ResonPhrase를 쉽게 설정할 수 있음).
예를 들면 :
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" });
}
}
}Iknow 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 응답에 제어되지 않은 결과 본문이 포함됩니다.
여기 에서는 개발자가 "404를 보내는 더 나은 방법"을 알 필요없이 오류가 발생하기 쉬운 메서드를 제공하는 " 더 나은 ApiController NotFound 메서드 " 코드의 일부를 제시합니다 .
ApiController 하는 클래스 만들기ApiController
NotFound개발자가 사용 가능한 첫 번째 API를 사용할 수 있도록 메서드 를 재정의합니다.[Obsolete("Use overload instead")]protected NotFoundResult NotFound(string message)장려하고 싶은 추가 추가NegotiatedContentResult. 첨부 된 더 나은 NotFoundResult 클래스를 참조하십시오 .