Quartz 5

9. IActionResult vs ActionResult

4 min read

চমৎকার! আপনি এখন কোর্সের Lecture 363: IActionResult vs ActionResult-এ আছেন। Web API ডেভেলপমেন্টে সঠিক Return Type নির্বাচন করা একটি অত্যন্ত গুরুত্বপূর্ণ স্কিল। আজ আমরা শিখবো কখন IActionResult ব্যবহার করা উচিত এবং কখন ActionResult<T> ব্যবহার করা বেশি ভালো।

চলুন কনসেপ্টগুলো পরিষ্কার করে নিই!

📝 Lecture Summary

ভবিষ্যতে দ্রুত রিভিশন দেওয়ার জন্য পুরো লেকচারের মূল বিষয়গুলো নিচে তালিকাভুক্ত করা হলো:

  • The Core Interface: ASP.NET Core-এ সব ধরনের রেজাল্ট (যেমন: OkResult, NotFoundResult, BadRequestResult) মূলত IActionResult ইন্টারফেস থেকে ইমপ্লিমেন্ট করা।
  • When to use IActionResult?: যখন একটি Action Method থেকে একাধিক ধরনের রেজাল্ট (যেমন: কখনো 400 Bad Request, কখনো 404 Not Found, কখনো 204 No Content) রিটার্ন করার সম্ভাবনা থাকে।
  • When to use ActionResult<T>?: যখন আপনি নিশ্চিত যে মেথডটি মূলত একটি নির্দিষ্ট Model Data (যেমন: City অবজেক্ট) রিটার্ন করবে।
  • Benefit of ActionResult<T>: এটি ব্যবহার করলে আপনাকে ডেটা রিটার্ন করার সময় আলাদা করে Ok(data) লিখতে হয় না, সরাসরি return data; লিখলেই ফ্রেমওয়ার্ক স্বয়ংক্রিয়ভাবে সেটিকে OkObjectResult (200 OK) এ কনভার্ট করে নেয়।
  • ObjectResult Family: OkObjectResult, CreatedAtActionResult, NotFoundObjectResult— এগুলো সবই ObjectResult-এর চাইল্ড ক্লাস, যাদের কাজ হলো আপনার C# অবজেক্টকে JSON-এ কনভার্ট করে ক্লায়েন্টকে পাঠানো।

🧠 Comprehensive Breakdown

নিচে লেকচারের প্রতিটি কনসেপ্ট বিস্তারিত এবং সহজভাবে ব্যাখ্যা করা হলো।

১. The Fundamental Return Type: IActionResult (Importance: 10/10)

আপনি MVC Controller বা Web API Controller যাই ব্যবহার করুন না কেন, সবকিছুর মূলে রয়েছে IActionResult ইন্টারফেস। আপনি যখন BadRequest(), NotFound(), NoContent(), বা Ok() কল করেন, তখন এগুলো যথাক্রমে BadRequestResult, NotFoundResult, NoContentResult ইত্যাদি অবজেক্ট তৈরি করে। মজার বিষয় হলো, এই সব ক্লাসগুলোই IActionResult ইন্টারফেসকে ইমপ্লিমেন্ট করে।

Example Scenario (PUT Method): ভিডিওতে দেখানো PutCity মেথডে আমরা IActionResult ব্যবহার করেছি। কারণ সেখানে কন্ডিশনের ওপর ভিত্তি করে কখনো BadRequest(), কখনো NotFound(), আবার কখনো NoContent() রিটার্ন হতে পারে। যেহেতু একাধিক টাইপের রেজাল্ট রিটার্ন হচ্ছে, তাই এদের কমন প্যারেন্ট IActionResult ব্যবহার করাই সবচেয়ে লজিক্যাল।

২. The Smart Choice: ActionResult<T> (Importance: 10/10)

যখন আপনি জানেন যে আপনার মেথডটি সফল হলে মূলত একটি নির্দিষ্ট টাইপের ডেটা (যেমন City অবজেক্ট বা List<City>) রিটার্ন করবে, তখন IActionResult-এর বদলে ActionResult<T> ব্যবহার করা উচিত।

The Magic: ধরা যাক, আপনি IActionResult ব্যবহার করে একটি শহর রিটার্ন করতে চান। আপনাকে লিখতে হবে: return Ok(city);

কিন্তু আপনি যদি ActionResult<City> ব্যবহার করেন, তবে আপনি সরাসরি লিখতে পারবেন: return city; ASP.NET Core নিজেই বুঝে নেবে যে আপনি ডেটা পাঠাতে চাচ্ছেন এবং সে স্বয়ংক্রিয়ভাবে এটিকে OkObjectResult-এ মুড়িয়ে (wrap করে) JSON হিসেবে পাঠিয়ে দেবে। এটি কোডকে অনেক ক্লিন করে এবং Swagger/OpenAPI-কে বুঝতে সাহায্য করে যে এই API থেকে ঠিক কী ধরনের ডেটা আসবে।

৩. The Relationship: ObjectResult and Status Codes (Importance: 8/10)

যখনই আপনি ক্লায়েন্টকে কোনো ডেটা (JSON/XML) পাঠাতে চান, তখন ফ্রেমওয়ার্ক ইন্টারনালি ObjectResult ক্লাস ব্যবহার করে। মাইক্রোসফট বিভিন্ন স্ট্যাটাস কোডের জন্য এই ObjectResult থেকে ইনহেরিট করে আরও কিছু স্পেসিফিক ক্লাস বানিয়েছে:

  • OkObjectResult: যখন স্ট্যাটাস কোড 200 (ডেটা ঠিকঠাক পাওয়া গেছে)।
  • CreatedAtActionResult: যখন স্ট্যাটাস কোড 201 (নতুন ডেটা তৈরি হয়েছে এবং রেসপন্সে ডেটা পাঠানো হচ্ছে)।
  • BadRequestObjectResult: যখন স্ট্যাটাস কোড 400 (ইউজারের ভুল এবং সাথে Validation Error অবজেক্ট পাঠানো হচ্ছে)।
  • NotFoundObjectResult: যখন স্ট্যাটাস কোড 404 (ডেটা পাওয়া যায়নি এবং সাথে কোনো কাস্টম মেসেজ অবজেক্ট পাঠানো হচ্ছে)।

💻 Code Implementation: Comparison

নিচে একই কাজ দুইভাবে করে দেখানো হলো যাতে আপনি পার্থক্যটা পরিষ্কার বুঝতে পারেন:

Approach 1: Using IActionResult (Less specific)

[HttpGet("{id}")]
public async Task<IActionResult> GetCity(Guid id)
{
    var city = await _context.Cities.FindAsync(id);
 
    if (city == null)
    {
        return NotFound(); // 404
    }
 
    // IActionResult ব্যবহার করলে আপনাকে explicitly Ok() লিখতে হবে
    return Ok(city); // 200 OK with JSON
}

Approach 2: Using ActionResult<T> (Smarter & Best Practice for Data Return)

[HttpGet("{id}")]
// T এর জায়গায় Model এর নাম (City) দেওয়া হয়েছে
public async Task<ActionResult<City>> GetCity(Guid id) 
{
    var city = await _context.Cities.FindAsync(id);
 
    if (city == null)
    {
        return NotFound(); // 404 
    }
 
    // ActionResult<T> ব্যবহার করায় Ok() লেখার দরকার নেই, সরাসরি object রিটার্ন করা যায়
    return city; 
}

🏆 Best Practices for Return Types

  • Use ActionResult<T> for GET Requests: যখনই আপনি ডাটাবেজ থেকে ডেটা তুলে আনছেন (যেমন: Get() বা GetAll()), সবসময় ActionResult<T> বা ActionResult<IEnumerable<T>> ব্যবহার করুন। এটি API ডকুমেন্টেশন (Swagger) এর জন্য খুবই উপকারী।
  • Use IActionResult for Modifiers: যখন আপনি ডেটা ইনসার্ট, আপডেট বা ডিলিট করছেন (POST, PUT, DELETE) এবং শুধুমাত্র একটি স্ট্যাটাস (যেমন: 204 NoContent বা 201 CreatedAtAction) রিটার্ন করছেন, তখন IActionResult ব্যবহার করা বেস্ট।
  • Avoid wrapping explicitly: আপনি যদি ActionResult<T> ব্যবহার করেন, তবে অযথাই return Ok(data); লিখবেন না, সরাসরি return data; লিখুন। এটি কোডকে পরিষ্কার রাখে।

আশা করি IActionResult এবং ActionResult<T> এর কনসেপ্টটি এখন আপনার কাছে একদম পানির মতো পরিষ্কার! এর পরের লেকচারে আমরা ControllerBase এর ইন্টার্নাল কিছু মেকানিজম নিয়ে আলোচনা করবো। আপনি কি প্রস্তুত?

Graph View

Backlinks