Переглянувши статтю Обробка винятків у веб-API ASP.NET, я трохи заплутався, коли кинути виняток проти повернути відповідь на помилку. Мені також залишається цікаво, чи можна змінити відповідь, коли ваш метод повертає модель, доменну замість HttpResponseMessage...
Отже, для резюме моїх запитань, а також код з регістром №s:
Запитання
Питання щодо справи №1
- Чи слід завжди використовувати
HttpResponseMessageзамість конкретної доменної моделі, щоб повідомлення можна було налаштувати? - Чи можна налаштувати повідомлення, якщо ви повертаєте конкретну модель домену?
Питання щодо справи № 2,3,4
- Чи потрібно кидати виняток або повертати відповідь про помилку? Якщо відповідь "це залежить", чи можете ви навести ситуації / приклади, коли використовувати один проти іншого.
- Яка різниця між метанням
HttpResponseExceptionvsRequest.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
@Mike Wasson Як автор зв'язаної статті, який би ви підходили?
—
zam6ak