Depois de revisar um artigo Tratamento de exceções na API da Web do ASP.NET, estou um pouco confuso sobre quando lançar uma exceção vs retornar uma resposta de erro. Também me pergunto se é possível modificar a resposta quando seu método retorna um modelo específico de domínio em vez de HttpResponseMessage...
Então, para recapitular aqui, minhas perguntas, seguidas de algum código com case #:
Questões
Perguntas sobre o Caso 1
- Devo sempre usar em
HttpResponseMessagevez de um modelo de domínio concreto, para que a mensagem possa ser personalizada? - A mensagem pode ser personalizada se você estiver retornando um modelo de domínio concreto?
Perguntas sobre o caso # 2,3,4
- Devo lançar uma exceção ou retornar uma resposta de erro? Se a resposta for "depende", você pode dar situações / exemplos de quando usar um vs o outro.
- Qual é a diferença entre throwing
HttpResponseExceptionvsRequest.CreateErrorResponse? A saída para o cliente parece idêntica ... - Devo sempre usar
HttpErrorpara "quebrar" as mensagens de resposta em erros (se a exceção é lançada ou a resposta de erro é retornada)?
Amostras de casos
// CASE #1
public Customer Get(string id)
{
var customer = _customerService.GetById(id);
if (customer == null)
{
var notFoundResponse = new HttpResponseMessage(HttpStatusCode.NotFound);
throw new HttpResponseException(notFoundResponse);
}
//var response = Request.CreateResponse(HttpStatusCode.OK, customer);
//response.Content.Headers.Expires = new DateTimeOffset(DateTime.Now.AddSeconds(300));
return customer;
}
// CASE #2
public HttpResponseMessage Get(string id)
{
var customer = _customerService.GetById(id);
if (customer == null)
{
var notFoundResponse = new HttpResponseMessage(HttpStatusCode.NotFound);
throw new HttpResponseException(notFoundResponse);
}
var response = Request.CreateResponse(HttpStatusCode.OK, customer);
response.Content.Headers.Expires = new DateTimeOffset(DateTime.Now.AddSeconds(300));
return response;
}
// CASE #3
public HttpResponseMessage Get(string id)
{
var customer = _customerService.GetById(id);
if (customer == null)
{
var message = String.Format("customer with id: {0} was not found", id);
var errorResponse = Request.CreateErrorResponse(HttpStatusCode.NotFound, message);
throw new HttpResponseException(errorResponse);
}
var response = Request.CreateResponse(HttpStatusCode.OK, customer);
response.Content.Headers.Expires = new DateTimeOffset(DateTime.Now.AddSeconds(300));
return response;
}
// CASE #4
public HttpResponseMessage Get(string id)
{
var customer = _customerService.GetById(id);
if (customer == null)
{
var message = String.Format("customer with id: {0} was not found", id);
var httpError = new HttpError(message);
return Request.CreateErrorResponse(HttpStatusCode.NotFound, httpError);
}
var response = Request.CreateResponse(HttpStatusCode.OK, customer);
response.Content.Headers.Expires = new DateTimeOffset(DateTime.Now.AddSeconds(300));
return response;
}Atualizar
Para ajudar a demonstrar ainda mais os casos # 2,3,4, o seguinte trecho de código destaca várias opções que "podem acontecer" quando um cliente não é encontrado ...
if (customer == null)
{
// which of these 4 options is the best strategy for Web API?
// option 1 (throw)
var notFoundMessage = new HttpResponseMessage(HttpStatusCode.NotFound);
throw new HttpResponseException(notFoundMessage);
// option 2 (throw w/ HttpError)
var message = String.Format("Customer with id: {0} was not found", id);
var httpError = new HttpError(message);
var errorResponse = Request.CreateErrorResponse(HttpStatusCode.NotFound, httpError);
throw new HttpResponseException(errorResponse);
// option 3 (return)
var message = String.Format("Customer with id: {0} was not found", id);
return Request.CreateErrorResponse(HttpStatusCode.NotFound, message);
// option 4 (return w/ HttpError)
var message = String.Format("Customer with id: {0} was not found", id);
var httpError = new HttpError(message);
return Request.CreateErrorResponse(HttpStatusCode.NotFound, httpError);
}
6
@ Mike Wasson Como autor do artigo vinculado, qual abordagem você adotaria?
—
Zam6ak 20/09/12