سناریویی را در نظر بگیرید که برای هر کدام از مدلهای Article, Video, Event میخواهیم قابلیت کامنت‌گذاری جداگانه‌ای را داشته باشیم. چندین روش برای پیاده‌سازی این سناریو وجود دارد که در ادامه به آنها خواهیم پرداخت.
Polymorphic association
در این روش بجای تعریف چند کلید خارجی، تنها یک فیلد جنریک را تعریف خواهیم کرد که میتواند همزمان یک ارجاع را به مدلهای مطرح شده داشته باشد. برای تعیین نوع کلید هم نیاز به یک فیلد دیگر جهت تعیین نوع ارجاع خواهیم داشت. در واقع با کمک آن میتوانیم تشخیص دهیم که ارجاع موردنظر به کدام موجودیت اشاره دارد:
public enum CommentType
{
Article,
Video,
Event
}
public class Comment
{
public int Id { get; set; }
public string CommentText { get; set; }
public string User { get; set; }
public int? TypeId { get; set; }
public CommentType CommentType { get; set; }
}
public class Article
{
public int Id { get; set; }
public string Title { get; set; }
public string Slug { get; set; }
public string Description { get; set; }
}
public class Video
{
public int Id { get; set; }
public string Url { get; set; }
public string Description { get; set; }
}
public class Event
{
public int Id { get; set; }
public string Name { get; set; }
public DateTimeOffset? Start { get; set; }
public DateTimeOffset? End { get; set; }
}
public class MyDbContext : DbContext
{
public DbSet<Article> Articles { get; set; }
public DbSet<Video> Videos { get; set; }
public DbSet<Event> Events { get; set; }
public DbSet<Comment> Comments { get; set; }
protected override void OnConfiguring(DbContextOptionsBuilder options)
=> options.UseSqlite("Data Source=polymorphic.db");
} این روش در واقع به عنوان یک Anti Pattern و SQL Smell شناخته میشود؛ زیرا امکان کوئری گرفتن از دیتابیس را دشوار خواهد کرد. اکثر فریم‌ورک‌های غیر دات‌نتی به صورت توکار قابلیت پیاده‌سازی این نوع ارتباط را ارائه می‌دهند. اما در Entity Framework باید به صورت دستی تنظیمات انجام شوند و همچنین به دلیل نداشتن ارجاع مستقیم (کلید خارجی) درون جدول Comments با مشکل data integrity مواجه خواهیم شد. یکی دیگر از مشکلات آن امکان درج orphaned record است؛ زیرا هیچ Constraintی بر روی Polymorphic Key تعریف نشده‌است. در این روش مدیریت واکشی اطلاعات سخت خواهد بود و در حین کوئری گرفتن دیتا باید CommentType را نیز به همراه TypeId به صورت صریحی قید کنیم:
var articleComments = dbContext.Comments
.Where(x => x.CommentType == CommentType.Article && x.TypeId.Value == 1);
foreach (var articleComment in articleComments)
{
Console.WriteLine(articleComment.CommentText);
} Join Table Per Relationship Type
یک روش دیگر ایجاد Join Table به ازای هر ارتباط است:
public class Comment
{
public int Id { get; set; }
public string CommentText { get; set; }
public string User { get; set; }
public virtual ICollection<ArticleComment> ArticleComments { get; set; }
public virtual ICollection<VideoComment> VideoComments { get; set; }
public virtual ICollection<EventComment> EventComments { get; set; }
}
public class Article
{
public Article()
{
ArticleComments = new HashSet<ArticleComment>();
}
public int Id { get; set; }
public string Title { get; set; }
public string Slug { get; set; }
public string Description { get; set; }
public virtual ICollection<ArticleComment> ArticleComments { get; set; }
}
public class Video
{
public Video()
{
VideoComments = new HashSet<VideoComment>();
}
public int Id { get; set; }
public string Url { get; set; }
public string Description { get; set; }
public virtual ICollection<VideoComment> VideoComments { get; set; }
}
public class Event
{
public Event()
{
EventComments = new HashSet<EventComment>();
}
public int Id { get; set; }
public string Name { get; set; }
public DateTimeOffset? Start { get; set; }
public DateTimeOffset? End { get; set; }
public virtual ICollection<EventComment> EventComments { get; set; }
}
public class MyDbContext : DbContext
{
public DbSet<Article> Articles { get; set; }
public DbSet<ArticleComment> ArticleComments { get; set; }
public DbSet<Video> Videos { get; set; }
public DbSet<VideoComment> VideoComments { get; set; }
public DbSet<Event> Events { get; set; }
public DbSet<EventComment> EventComments { get; set; }
public DbSet<Comment> Comments { get; set; }
protected override void OnConfiguring(DbContextOptionsBuilder options)
=> options.UseSqlite("Data Source=polymorphic.db");
protected override void OnModelCreating(ModelBuilder modelBuilder)
{
modelBuilder.Entity<ArticleComment>(entity =>
{
entity.HasKey(e => new { e.CommentId, e.ArticleId })
.HasName("PK_dbo.ArticleComments");
entity.HasIndex(e => e.ArticleId)
.HasName("IX_ArticleId");
entity.HasIndex(e => e.CommentId)
.HasName("IX_ArticleCommentId");
entity.HasOne(d => d.Article)
.WithMany(p => p.ArticleComments)
.HasForeignKey(d => d.ArticleId)
.HasConstraintName("FK_dbo.ArticleComments_dbo.Articles_ArticleId");
entity.HasOne(d => d.Comment)
.WithMany(p => p.ArticleComments)
.HasForeignKey(d => d.CommentId)
.HasConstraintName("FK_dbo.ArticleComments_dbo.Comments_CommentId");
});
modelBuilder.Entity<VideoComment>(entity =>
{
entity.HasKey(e => new { e.CommentId, e.VideoId })
.HasName("PK_dbo.VideoComments");
entity.HasIndex(e => e.VideoId)
.HasName("IX_VideoId");
entity.HasIndex(e => e.CommentId)
.HasName("IX_VideoCommentId");
entity.HasOne(d => d.Video)
.WithMany(p => p.VideoComments)
.HasForeignKey(d => d.VideoId)
.HasConstraintName("FK_dbo.VideoComments_dbo.Videos_VideoId");
entity.HasOne(d => d.Comment)
.WithMany(p => p.VideoComments)
.HasForeignKey(d => d.CommentId)
.HasConstraintName("FK_dbo.VideoComments_dbo.Comments_CommentId");
});
modelBuilder.Entity<EventComment>(entity =>
{
entity.HasKey(e => new { e.CommentId, e.EventId })
.HasName("PK_dbo.EventComments");
entity.HasIndex(e => e.EventId)
.HasName("IX_EventId");
entity.HasIndex(e => e.CommentId)
.HasName("IX_EventCommentId");
entity.HasOne(d => d.Event)
.WithMany(p => p.EventComments)
.HasForeignKey(d => d.EventId)
.HasConstraintName("FK_dbo.EventComments_dbo.Events_EventId");
entity.HasOne(d => d.Comment)
.WithMany(p => p.EventComments)
.HasForeignKey(d => d.CommentId)
.HasConstraintName("FK_dbo.EventComments_dbo.Comments_CommentId");
});
}
} همانطور که مشاهده میکنید روش فوق نیاز به اضافه کردن مدلهای بیشتری دارد و همچنین تمام روابط چند به چند نیز نیاز است به صورت کامل تنظیم شوند. مزیت این روش داشتن Constraint برای تمامی کلیدهای خارجی است؛ بنابراین میتوانیم از صحت دیتا مطمئن شویم:
var article = new Article
{
Title = "Article A",
Slug = "article_a",
Description = "No Description"
};
var comment = new Comment
{
CommentText = "It's great",
User = "Sirwan"
};
dbContext.ArticleComments.Add(new ArticleComment
{
Article = article,
Comment = comment
});
dbContext.SaveChanges();
var articleOne = dbContext.Articles
.Include(article => article.ArticleComments)
.ThenInclude(comment => comment.Comment)
.First(article => article.Id == 1);
var article1Comments = articleOne.ArticleComments.Select(x => x.Comment);
Console.WriteLine(article1Comments.Count()); Exclusive Belongs To
یک روش دیگر، اضافه کردن ارجاعی به ازای هر کدام از مدلهای عنوان شده، درون موجودیت Comment میباشد که به صورت nullable خواهند بود. بنابراین اگر به عنوان مثال بخواهیم برای یک Article یک کامنت داشته باشیم، کلید رکورد ذخیره شده را به عنوان کلید خارجی در جدول Comments اضافه خواهیم کرد:
public class Comment
{
public int Id { get; set; }
public string CommentText { get; set; }
public string User { get; set; }
// Article
public virtual Article Article { get; set; }
public int? ArticleId { get; set; }
// Video
public virtual Video Video { get; set; }
public int? VideoId { get; set; }
// Event
public virtual Event Event { get; set; }
public int? EventId { get; set; }
}
public class Article
{
public int Id { get; set; }
public string Title { get; set; }
public string Slug { get; set; }
public string Description { get; set; }
public virtual ICollection<Comment> Comments { get; set; }
}
public class Video
{
public int Id { get; set; }
public string Url { get; set; }
public string Description { get; set; }
public virtual ICollection<Comment> Comments { get; set; }
}
public class Event
{
public int Id { get; set; }
public string Name { get; set; }
public DateTimeOffset? Start { get; set; }
public DateTimeOffset? End { get; set; }
public virtual ICollection<Comment> Comments { get; set; }
}
public class MyDbContext : DbContext
{
public DbSet<Article> Articles { get; set; }
public DbSet<Video> Videos { get; set; }
public DbSet<Event> Events { get; set; }
public DbSet<Comment> Comments { get; set; }
protected override void OnConfiguring(DbContextOptionsBuilder options)
=> options.UseSqlite("Data Source=polymorphic.db");
} این روش از لحاظ منطقی و طراحی دیتابیس بدون اشکال است؛ زیرا مقدار نامعتبری را نمی‌توانیم برای کلیدهای خارجی درج کنیم. چون برای کلیدهای تعریف شده درون جدول Comment یکسری Constraint تعریف شده‌اند که صحت دیتای ورودی را بررسی خواهند کرد. حتی در صورت نیاز نیز میتوانیم یک Constraint ترکیبی را جهت مطمئن شدن از خالی نبودن همزمان ستون‌های FK اضافه کنیم. البته SQLite Provider از HasCheckConstraint پشتیبانی نمی‌کند، ولی اگر به عنوان مثال از MySQL استفاده میکنید میتوانید Constraint موردنظر را اینگونه اضافه کنید:
protected override void OnModelCreating(ModelBuilder modelBuilder)
{
modelBuilder.Entity<Comment>(entity =>
entity.HasCheckConstraint("CHECK_FKs",
"(`ArticleId` IS NOT NULL) AND (`VideoId` IS NOT NULL) AND (`EventId` IS NOT NULL)"));
} با طراحی فوق میتوانیم مطمئن شویم که orphaned record نخواهیم داشت. اما اگر تعداد مدل‌ها بیشتر شوند، باید به ازای هر مدل جدید، یک ارجاع به آن را به جدول Comment اضافه کنیم که در نهایت با تعداد زیادی کلیدهای خارجی مواجه خواهیم شد که در آن واحد فقط یکی از آنها مقدار دارند و بقیه NULL خواهند شد. در مقابل، مزیت این روش، امکان کوئری نویسی ساده‌ی آن است:
var articles = dbContext.Articles
.Include(x => x.Comments).Where(x => x.Id == 1);
foreach (var article in articles)
{
Console.WriteLine($"{article.Title} - Comments: {article.Comments.Count}");
}
var comment = dbContext.Comments.Include(x => x.Article)
.FirstOrDefault(x => x.Id == 1);
Console.WriteLine(comment?.Article.Title); کدهای مطلب جاری را میتوانید از اینجا دریافت کنید (هر مثال بر روی برنچی جدا قرار دارد)
