После просмотра статьи Обработка исключений в ASP.NET Web API я немного озадачен тем, когда выдавать исключение и возвращать ответ об ошибке. Меня также интересует, возможно ли изменить ответ, когда ваш метод возвращает специфичную для домена модель вместо HttpResponseMessage...
Итак, подведем итоги. Мои вопросы сопровождаются кодом с делом №:
Вопросы
Вопросы по делу № 1
- Должен ли я всегда использовать
HttpResponseMessageвместо конкретной модели предметной области, чтобы сообщение можно было настроить? - Можно ли настроить сообщение, если вы возвращаете конкретную модель домена?
Вопросы по делу № 2,3,4
- Должен ли я генерировать исключение или возвращать ответ об ошибке? Если ответ «это зависит», можете ли вы привести ситуации / примеры того, когда использовать один против другого.
- Какая разница между броском
HttpResponseExceptionпротивRequest.CreateErrorResponse? Вывод клиенту кажется идентичным ... - Должен ли я всегда использовать,
HttpErrorчтобы «обернуть» ответные сообщения ошибками (было ли выброшено исключение или возвращен ответ об ошибке)?
Образцы дела
// 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;
}Обновить
Для дальнейшей демонстрации случаев № 2,3,4 в следующем фрагменте кода выделены несколько вариантов, которые «могут произойти», когда клиент не найден ...
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
@ Майк Уоссон Как автор связанной статьи, какой подход вы бы выбрали?
—
zam6ak