Powracanie IHttpActionResult vs IEnumerable <Item> vs IQueryable <Item>

Question

W ASP.NET Web API 2, jaka jest różnica między następującymi?

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

i

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

i

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

powinienem wrócić IHttpActionResult lub IEnumerable<MyItem>/IQueryable<MyItem>?

Answer 1

Powinieneś zwrócić IHttpActionResult, ponieważ możesz być bardziej konkretny dla klienta. Możesz tworzyć bardziej przyjazne dla użytkownika aplikacje internetowe. Zasadniczo możesz zwrócić różne komunikaty o stanie HTML dla różnych sytuacji.

Na przykład:

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

IEnumerable i IQueryable po prostu analizować dane do formatu wyjściowego i nie będzie mieć odpowiednią drogę do obsługi wyjątków. To jest najważniejsza różnica.

Answer 2

Wybieram między IEnumerable i IHttpActionResult, możesz zrobić prawie to samo z obiema z nich w nieco inny sposób. IQueryable jest zwykle używany do zadań dostępu do niższego poziomu i odroczonego wykonywania kwerend sql, więc powinienem przechowywać go w swoich klasach dostępu do danych i nie ujawniać go za pomocą interfejsu API.

Oto podsumowanie z http://www.asp.net/web-api/overview/web-api-routing-and-actions/action-results:

IHttpActionResult

Interfejs IHttpActionResult został introducted w Web API 2. Zasadniczo definiuje fabrykę HttpResponseMessage. Oto niektóre zalety korzystania z interfejsu IHttpActionResult (nad klasą HttpResponseMessage):

• Upraszcza jednostka testowania kontrolerów.
• Przenosi wspólną logikę do tworzenia odpowiedzi HTTP na oddzielne klasy.
• Uczyni działanie kontrolera bardziej przejrzystym, ukrywając szczegóły niskiego poziomu dotyczące konstruowania odpowiedzi.

IEnumerable <Przedmiot>

Dla wszystkich innych rodzajów powrotów, Web API używa formatowania mediów do serializacji zwracanej wartości. Web API zapisuje serializowaną wartość w treści odpowiedzi. Kod statusu odpowiedzi to 200 (OK).

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

Wadą tego podejścia jest to, że nie można bezpośrednio zwracają kod błędu, takich jak 404. Można jednak rzucić HttpResponseException dla kodów błędów. Po więcej informacji.