Trả về IHttpActionResult và IEnumerable <Item> và IQueryable <Item>

Question

Trong ASP.NET Web API 2, sự khác nhau giữa những điều sau đây là gì?

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

và

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

và

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

Tôi có nên trở IHttpActionResult hoặc IEnumerable<MyItem>/IQueryable<MyItem>?

Answer 1

Bạn nên trả lại IHttpActionResult vì bạn có thể cụ thể hơn cho khách hàng. Bạn có thể tạo nhiều ứng dụng web thân thiện với người dùng hơn. Về cơ bản bạn có thể trả về các thông báo trạng thái HTML khác nhau cho các tình huống khác nhau.

Ví dụ:

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

IEnumerable và IQueryable chỉ sẽ phân tích dữ liệu của bạn sang định dạng đầu ra và bạn sẽ không phải một cách thích hợp để xử lý các trường hợp ngoại lệ. Đó là sự khác biệt quan trọng nhất.

Answer 2

Tôi sẽ chọn giữa IEnumerable và IHttpActionResult, bạn có thể thực hiện khá nhiều điều tương tự với cả hai cách này chỉ theo những cách hơi khác nhau. IQueryable thường được sử dụng cho các nhiệm vụ truy cập dữ liệu cấp thấp hơn và thực thi truy vấn sql bị trì hoãn để tôi giữ nó được đóng gói trong các lớp truy cập dữ liệu của bạn và không hiển thị nó với api web.

Dưới đây là một bản tóm tắt từ http://www.asp.net/web-api/overview/web-api-routing-and-actions/action-results:

IHttpActionResult

Giao diện IHttpActionResult được INTRODUCTED trong Web API 2. Về cơ bản, nó định nghĩa một nhà máy HttpResponseMessage. Dưới đây là một số lợi thế của việc sử dụng giao diện IHttpActionResult (trên lớp HttpResponseMessage):

• đơn giản hoá đơn vị thử nghiệm bộ điều khiển của bạn.
• Di chuyển logic chung để tạo phản hồi HTTP thành các lớp riêng biệt.
• Làm cho mục đích của thao tác bộ điều khiển rõ ràng hơn, bằng cách ẩn chi tiết cấp thấp của việc xây dựng phản hồi.

IEnumerable < mục >

Đối với tất cả các loại lợi nhuận khác, Web API sử dụng một định dạng phương tiện truyền thông để serialize giá trị trả về. Web API ghi giá trị được tuần tự hóa vào nội dung phản hồi. Mã trạng thái phản hồi là 200 (OK).

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

Một nhược điểm của phương pháp này là bạn có thể không trực tiếp trả lại mã lỗi, chẳng hạn như 404. Tuy nhiên, bạn có thể ném một HttpResponseException cho mã lỗi. Để biết thêm thông tin.