रिटर्निंग IHttpActionResult बनाम IENumerable <Item> बनाम IQueryable <Item>

Question

एएसपी.नेट वेब एपीआई 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

मैं आईन्यूमेरेबल और आईएचटीपीएक्शन रिसेट के बीच चयन करूंगा, आप इन दोनों के साथ थोड़ा अलग तरीके से एक ही चीज़ कर सकते हैं। IQueryable आमतौर पर निचले स्तर के डेटा एक्सेस कार्यों और एसक्यूएल प्रश्नों के स्थगित निष्पादन के लिए उपयोग किया जाता है, इसलिए मैं इसे आपके डेटा एक्सेस क्लास में encapsulated रखूंगा और इसे वेब एपीआई के साथ बेनकाब नहीं करूँगा। ,

IHttpActionResult

IHttpActionResult इंटरफ़ेस अनिवार्य रूप से वेब एपीआई 2 में introducted गया था यह एक HttpResponseMessage कारखाने परिभाषित करता है:

यहाँ एक http://www.asp.net/web-api/overview/web-api-routing-and-actions/action-results से सारांश है।

• सरल इकाई अपने नियंत्रकों का परीक्षण: यहाँ IHttpActionResult इंटरफ़ेस (HttpResponseMessage वर्ग से अधिक) का उपयोग करने के कुछ लाभ हैं।
• अलग-अलग वर्गों में HTTP प्रतिक्रियाएं बनाने के लिए सामान्य तर्क चलाता है।
• प्रतिक्रिया बनाने के निम्न-स्तर के विवरण छिपाकर, नियंत्रक कार्रवाई स्पष्ट करने का इरादा बनाता है।

IEnumerable < आइटम >

अन्य सभी प्रकार के लिए वापसी, जाल एपीआई वापसी मान क्रमानुसार करने एक मीडिया फ़ॉर्मेटर उपयोग करता है। वेब एपीआई प्रतिक्रिया शरीर में धारावाहिक मूल्य लिखता है। प्रतिक्रिया स्थिति कोड 200 (ठीक है) है।

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

इस दृष्टिकोण का एक नुकसान यह है कि आप सीधे एक त्रुटि कोड नहीं दे सकता है, इस तरह के रूप में हालांकि 404., आप त्रुटि कोड के लिए एक HttpResponseException फेंक कर सकते हैं। अधिक जानकारी के लिए।