آموزش پیشرفته Data Annotations در EF Core

آموزش پیشرفته Data Annotations در Entity Framework Core، یکی از راه‌های تعریف ویژگی‌ها و تنظیمات مربوط به مدل‌ها (کلاس‌هایی که نماینده‌ی جدول‌ها در دیتابیس هستند)، استفاده از Data Annotationها یا همان حاشیه‌نویسی‌های داده‌ای است. این Data Annotationها در واقع Attributeهایی هستند که مستقیماً بالای کلاس‌ها یا پراپرتی‌ها نوشته می‌شوند و به EF Core کمک می‌کنند تا بداند:این Data Annotationها در واقع Attributeهایی هستند که مستقیماً بالای کلاس‌ها یا پراپرتی‌ها نوشته می‌شوند و به EF Core کمک می‌کنند تا بداند:

• کدام پراپرتی کلید اصلی در نظر گرفته شود.
• کدام فیلدها اجباری (Required) هستند و نمی‌توانند خالی بمانند.
• طول مجاز فیلدهای متنی چقدر است.
• نام ستون یا جدول در دیتابیس چه باشد.
• ارتباط بین جداول (مانند رابطه‌ی کلید خارجی) چگونه برقرار شود.
• و حتی کدام پراپرتی اصلاً نباید به دیتابیس تبدیل شود.

این روش یک راه ساده، سریع و مستقیم برای تنظیم رفتار مدل‌هاست، بدون این‌که نیازی به استفاده از روش پیچیده‌تر Fluent API داشته باشیم.

پرکاربردترین Data Annotation ها

Data Annotation های پیشرفته در ASP.NET Core و فرم‌ها

مزایای استفاده از Data Annotation

• کدنویسی ساده و سریع مناسب برای پروژه‌های سبک یا متوسط.
• قابل درک برای افراد تازه‌کار.
• قابل استفاده در کنار Fluent API برای تنظیمات جزئی‌تر.

اگر بخواهیم یک مثال بزنیم، Data Annotation مثل علامت‌هایی است که مستقیم روی دیوار می‌چسبانی تا به بقیه بگویی هر چیزی کجا باید قرار بگیرد — سریع، ساده، و واضح!

RegularExpression های پرکاربرد ایرانی

مثال عملی Data Annotations

[Table("tbl_user_profiles")] // تغییر نام جدول در دیتابیس
public class UserProfile
{
// کلید اصلی که توسط دیتابیس به‌صورت افزایشی تولید می‌شود
[Key]
[DatabaseGenerated(DatabaseGeneratedOption.Identity)]
[HiddenInput(DisplayValue = false)] // در فرم HTML به صورت hidden
public int Id { get; set; }
// فیلد ضروری با حداقل و حداکثر طول مشخص
[Required]
[StringLength(100, MinimumLength = 3)]
[Display(Name = "Full Name")]
public string FullName { get; set; }
// اعتبارسنجی ایمیل
[Required]
[EmailAddress]
[Column(TypeName = "varchar(100)")]
public string Email { get; set; }
// اعتبارسنجی شماره تلفن با regex مخصوص شماره‌های ایرانی
[Required]
[RegularExpression(@"^09\d{9}$", ErrorMessage = "شماره موبایل باید با ۰۹ شروع شود و ۱۱ رقم باشد")]
[StringLength(11, MinimumLength = 11)]
[Display(Name = "Mobile Number")]
public string PhoneNumber { get; set; }
// فیلد آدرس سایت – URL معتبر
[Url]
public string Website { get; set; }
// شماره کارت اعتباری (برای تمرین)
[CreditCard]
[Display(Name = "Credit Card Number")]
public string CreditCard { get; set; }
// سن بین ۱۸ تا ۹۹ سال
[Range(18, 99)]
public int Age { get; set; }
// تاریخ تولد با فرمت خاص نمایش
[DataType(DataType.Date)]
[DisplayFormat(DataFormatString = "{0:yyyy-MM-dd}", ApplyFormatInEditMode = true)]
public DateTime BirthDate { get; set; }
// فیلدی که فقط در کد مقدار می‌گیرد، نه از فرم (BindNever)
[BindNever]
public bool IsAdmin { get; set; }
// فیلدی که باید در فرم ارسال شود، وگرنه خطا می‌دهد
[BindRequired]
public string Username { get; set; }
// فیلد فقط‌خواندنی در فرم
[Editable(false)]
public string CreatedBy { get; set; }
// فیلد محاسباتی که در دیتابیس ذخیره نمی‌شود
[NotMapped]
public string FullNameUpper => FullName?.ToUpper();
// توضیحات بلند با قالب نمایشی چند خطی در فرم
[UIHint("MultilineText")]
public string Bio { get; set; }
// رمز عبور: مقدار اصلی
[Required]
[DataType(DataType.Password)]
[StringLength(100, MinimumLength = 6, ErrorMessage = "رمز عبور باید حداقل ۶ کاراکتر باشد.")]
public string Password { get; set; }
// تکرار رمز عبور: برای مقایسه با رمز اصلی
[Compare("Password", ErrorMessage = "رمز عبور و تکرار آن یکسان نیست.")]
[DataType(DataType.Password)]
[Display(Name = "Confirm Password")]
public string ConfirmPassword { get; set; }
// کنترل همزمانی برای مدیریت تغییرات هم‌زمان رکورد
[Timestamp]
public byte[] RowVersion { get; set; }
// فیلدی که در Scaffold نمایش داده نشود (مثلاً برای سیستم)
[ScaffoldColumn(false)]
public DateTime CreatedAt { get; set; } = DateTime.Now;
}

نکته مهم: در پروژه‌های بزرگ‌تر و پیچیده‌تر Asp.Net Core، معمولاً از Fluent API برای تنظیم دقیق‌تر و منعطف‌تر استفاده می‌شود، ولی Data Annotation همچنان یک ابزار بسیار قدرتمند و کارآمد است برای تنظیمات ابتدایی و متداول.

تفاوت Data Annotation در Model و ViewModel

از Data Annotationها برای اعتبارسنجی، نمایش بهتر فرم‌ها و تنظیم رفتار فیلدها استفاده می‌شود؛ اما جایگاه استفاده آن‌ها بسته به نوع کلاس (Model یا ViewModel) متفاوت است.

در Entity Modelها (مدل‌های EF Core)، Data Annotationهایی مانند [Key], [ForeignKey], [DatabaseGenerated], [Timestamp] و [NotMapped] برای مدیریت ساختار دیتابیس به کار می‌روند.

در مقابل، ViewModelها برای نمایش و دریافت اطلاعات از کاربر طراحی شده‌اند، بنابراین در آن‌ها از Annotationهایی مثل [Required], [StringLength], [Display], [UIHint], [Compare] و [RegularExpression] برای اعتبارسنجی فرم و کنترل ظاهر استفاده می‌شود.

نتیجه: هر جا با دیتابیس سروکار داری، از Data Annotationهای EF استفاده کن؛ و هر جا با فرم کاربر طرف هستی، از Annotationهای مرتبط با UI و Validation در ViewModel استفاده کن.

اگر در پروژه از ViewModel استفاده می‌کنی، همه‌ی Annotationهای مرتبط با فرم، اعتبارسنجی و نمایش UI باید در ViewModel باشن، و همه‌ی Annotationهای مربوط به EF Core و دیتابیس باید فقط در Entity Model باقی بمونن.