7. Model State

হাসিব, তোমার দেওয়া লেকচার ট্রান্সক্রিপ্টটির বিস্তারিত বিশ্লেষণ নিচে দেওয়া হলো। এখানে ModelState এর কনসেপ্ট, Validation Error হ্যান্ডেলিং এবং LINQ-এর ব্যবহার খুব চমৎকারভাবে বোঝানো হয়েছে।

---

📝 Quick Summary for Revision

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

• ModelState: এটি Controller-এর একটি প্রোপার্টি যা Model Binding-এর পর Model Validation-এর রেজাল্ট এবং ডেটা স্টোর করে।

• Key Properties of ModelState:

• IsValid: true রিটার্ন করে যদি সব রুল ঠিক থাকে, আর কোনো Error থাকলে false রিটার্ন করে।

• Values: মডেলের প্রতিটি প্রোপার্টির ডেটা এবং তার Error লিস্ট ধারণ করে।

• ErrorCount: মোট কতগুলো Validation Error হয়েছে তার সংখ্যা জানায়।

• Extracting Errors: Action Method-এর ভেতরে ModelState.IsValid চেক করে Error থাকলে ModelState.Values থেকে লুপ চালিয়ে বা LINQ ব্যবহার করে Error মেসেজগুলো আলাদা করা যায়।

• Custom Error Messages: Model Class-এ Attribute-এর ভেতরে ErrorMessage প্যারামিটার ব্যবহার করে নিজের মতো Error Message সেট করা যায় (যেমন: [Required(ErrorMessage = "Name is strictly required!")])।

---

🧠 Comprehensive Breakdown

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

1. What is ModelState? [Priority: 10/10]

কেন দরকার? আগের লেকচারে আমরা দেখেছি যে, Data Annotation (যেমন [Required]) ব্যবহার করে Model-এ ভ্যালিডেশন রুলস দেওয়া যায়। কিন্তু ইউজারের রিকোয়েস্টটি ওই রুলগুলো পাস করেছে কি না, বা ফেইল করলে ঠিক কোন ফিল্ডে কী Error হয়েছে—সেগুলো তো আমাদের জানতে হবে, তাই না? এই জানার কাজটিই করে ModelState।

ModelState হলো ASP.NET Core-এর ControllerBase ক্লাসের একটি প্রোপার্টি। Model Binding এবং Validation শেষ হওয়ার পর, পুরো Validation-এর রিপোর্ট কার্ড হিসেবে কাজ করে এই ModelState।

এর মূলত তিনটি গুরুত্বপূর্ণ প্রোপার্টি আছে:

1. IsValid: এটি একটি Boolean ভ্যালু। যদি কোনো একটি ফিল্ডেও Validation Error থাকে, তাহলে এটি false হয়ে যায়।
2. Values: এটি মডেলের প্রতিটি ফিল্ডের (যেমন PersonName, Email, Price) ডেটা এবং তাদের নিজ নিজ Error লিস্ট ধারণ করে।
3. ErrorCount: মোট কতটি Error হয়েছে তার সংখ্যা দেখায়।

2. Manual Error Extraction using foreach loop [Priority: 4/10]

লেকচারে প্রথমে foreach লুপ ব্যবহার করে কীভাবে Error Message বের করতে হয় তা দেখানো হয়েছে।

if (!ModelState.IsValid)
{
    // List to store all error messages
    List<string> errorsList = new List<string>();
 
    // Outer loop: Iterate through each property (e.g., PersonName, Email)
    foreach (var value in ModelState.Values)
    {
        // Inner loop: Iterate through the errors of that specific property
        foreach (var error in value.Errors)
        {
            errorsList.Add(error.ErrorMessage);
        }
    }
 
    // Join all errors with a new line character
    string errorsMessage = string.Join("\n", errorsList);
 
    // Return the joined errors as a 400 Bad Request
    return BadRequest(errorsMessage);
}
 

এখানে কী হচ্ছে?

• Outer Loop: ModelState.Values দিয়ে মডেলের প্রতিটি প্রোপার্টি চেক করা হচ্ছে। প্রথমে সে Email, তারপর Phone চেক করে। যখন সে PersonName-এ আসে, সে দেখে সেখানে Errors আছে।
• Inner Loop: value.Errors এর ভেতরে ঢুকে সে নির্দিষ্ট Error মেসেজটা (যেমন: “The PersonName field is required”) বের করে errorsList-এ যোগ করে।
• Join: সবশেষে সবগুলো Error Message-কে \n (নতুন লাইন) দিয়ে যুক্ত করে একটি সিঙ্গেল স্ট্রিং বানানো হয়।

(নোট: এই পদ্ধতিটি কাজ করলেও এটি বেশ Lengthy। তাই রিয়েল-ওয়ার্ল্ড প্রজেক্টে সাধারণত পরবর্তী LINQ মেথডটি ব্যবহার করা হয়।)

3. Shortcut Way using LINQ (The C# Way) [Priority: 10/10]

Nested foreach লুপ লেখাটা বেশ ঝামেলার। তাই C#-এর LINQ (Language Integrated Query) ব্যবহার করে এই কাজটা মাত্র এক লাইনে করা সম্ভব।

if (!ModelState.IsValid)
{
    // Fetching all error messages using LINQ
    string errorsMessage = string.Join("\n", ModelState.Values
                                    .SelectMany(value => value.Errors) // Flatten the list of errors
                                    .Select(error => error.ErrorMessage)); // Select only the ErrorMessage string
 
    return BadRequest(errorsMessage);
}
 

কেন এটা বেটার? SelectMany মেথডটি সবগুলো ফিল্ডের Error লিস্টকে একত্রিত করে একটি ফ্লাট (Flat) লিস্টে পরিণত করে। এরপর Select ব্যবহার করে সেই লিস্ট থেকে শুধুমাত্র ErrorMessage প্রোপার্টিটি আলাদা করা হয়। এটি দেখতে ক্লিন এবং পারফরম্যান্সেও ভালো।

4. Custom Error Messages in the Model [Priority: 8/10]

যদি [Required] Attribute দেওয়া থাকে, তবে ফ্রেমওয়ার্ক অটোমেটিকভাবে একটি ডিফল্ট মেসেজ জেনারেট করে (যেমন: “The PersonName field is required”)। কিন্তু আমরা চাইলে ErrorMessage নামের একটি Named Parameter পাস করে নিজের মতো কাস্টম মেসেজ দিতে পারি।

using System.ComponentModel.DataAnnotations;
 
namespace ModelValidationsExample.Models
{
    public class Person
    {
        // Custom error message
        [Required(ErrorMessage = "Person Name cannot be empty or null.")]
        public string? PersonName { get; set; }
    }
}
 

এর ফলে, ইউজার নাম না দিলে আমাদের দেওয়া కাস্টম মেসেজটিই Response-এ দেখা যাবে।

---

🚀 Best Practices & .NET 10 / C# 13 Updates

1. Best Practice: Explicit Return Types & ProblemDetails ম্যানুয়ালি স্ট্রিং জয়েন করে BadRequest(string) রিটার্ন করার চেয়ে, মডার্ন ওয়েব API-তে ValidationProblem বা ProblemDetails রিটার্ন করাটা Best Practice। এটি অটোমেটিকভাবে স্ট্যান্ডার্ড JSON ফরম্যাটে (RFC 7807) Error গুলো সাজিয়ে ইউজারকে পাঠিয়ে দেয়।

// The Old Way (from Transcript)
return BadRequest(errorsMessage);
 
// The Best Practice Way (.NET Core standard)
// No need to manually extract or join strings. The framework does it properly!
return ValidationProblem(ModelState); 
 

2. .NET 10 Update: Automatic Validation in [ApiController] যেহেতু তুমি .NET ইকোসিস্টেম নিয়ে কাজ করছো, তোমার জানা উচিত যে, Controller-এ যদি [ApiController] Attribute লাগানো থাকে, তবে if (!ModelState.IsValid) লিখে ম্যানুয়ালি BadRequest রিটার্ন করার কোনো দরকারই নেই।

.NET ফ্রেমওয়ার্ক অটোমেটিকভাবে ModelState চেক করবে এবং ইনভ্যালিড হলে নিজেই 400 Bad Request (JSON ফরম্যাটে) রিটার্ন করে দেবে!

[ApiController] // <-- MAGIC HAPPENS HERE
[Route("api/[controller]")]
public class HomeController : ControllerBase
{
    [HttpPost("register")]
    public IActionResult Index([FromBody] Person person)
    {
        // YOU DO NOT NEED THIS ANYMORE!
        // if (!ModelState.IsValid) { ... } 
        
        // If the code reaches here, it means ModelState IS ALREADY VALID!
        return Ok(person);
    }
}