Возврат IHttpActionResult против IEnumerable <Item> vs IQueryable <Item>

Question

В ASP.NET Web API 2 в чем разница между следующими?

public async Task<IEnumerable<MyItem>> GetMyItems() 
{ 
    //... code ..., var myItems = await ... 
    return myItems; 
} 

и

public async Task<IQueryable<MyItem>> GetMyItems() 
{ 
    //... code ..., var myItems = await ... 
    return myItems; 
} 

и

public async Task<IHttpActionResult> GetMyItems() 
{ 
    //... code ..., var myItems = await ... 
    return Ok(myItems); 
} 

Должен ли я вернуть IHttpActionResult или IEnumerable<MyItem>/IQueryable<MyItem>?

Answer 1

Вы должны вернуть IHttpActionResult, потому что вы можете быть более конкретным для клиента. Вы можете создавать более удобные веб-приложения. В основном вы можете возвращать разные сообщения статуса HTML для разных ситуаций.

Например:

public async Task<IHttpActionResult> GetMyItems() 
{ 
    if(!authorized) 
     return Unauthorized(); 
    if(myItems.Count == 0) 
     return NotFound(); 
    //... code ..., var myItems = await ... 
    return Ok(myItems); 
} 

IEnumerable и IQueryable просто разобрать ваши данные в формат вывода и вы не будете иметь надлежащий способ обработки исключений. Это самое важное различие.

Answer 2

Я бы выбрал между IEnumerable и IHttpActionResult, вы можете сделать почти то же самое с обоими из них только несколько разными способами. IQueryable обычно используется для задач доступа к данным более низкого уровня и отложенного выполнения sql-запросов, поэтому я бы сохранил его инкапсулированным в ваших классах доступа к данным и не подвергал его веб-ави.

Вот резюме от http://www.asp.net/web-api/overview/web-api-routing-and-actions/action-results:

IHttpActionResult

Интерфейс IHttpActionResult был Введены в Web API 2. По существу, он определяет HttpResponseMessage завод. Вот некоторые преимущества использования интерфейса IHttpActionResult (по классу HttpResponseMessage):

• Упрощает модульное тестирование контроллеров.
• Перемещает общую логику для создания ответов HTTP на отдельные классы.
• Делает намерение действия контроллера более ясным, скрывая детали низкого уровня построения ответа.

IEnumerable <Item>

Для всех других типов возврата, Web API использует медиа форматировщик для сериализации возвращаемого значения. Web API записывает сериализованное значение в тело ответа. Код состояния ответа - 200 (OK).

public class ProductsController : ApiController 
{ 
    public IEnumerable<Product> Get() 
    { 
     return GetAllProductsFromDB(); 
    } 
} 

Недостатком этого подхода является то, что вы не можете напрямую возвращать код ошибки, например, 404. Тем не менее, вы можете бросить HttpResponseException коды ошибок. Чтобы получить больше информации.