در این قسمت مدل‌های باقی مانده‌ی از بخش‌هایی را که در مقاله اول مطرح شدند، به اتمام می‌رسانیم. همچنین با بازخوردهایی که در مقالات قبل گرفتیم، در این قسمت تغییرات ایجاد شده‌ی در مدل‌های قسمت‌های قبل را نیز مطرح خواهیم کرد.
مدل‌های بالا هم برای ثبت لاگ فعالیت‌های کاربران در سیستم در نظر گرفته شده است . برای مثال اگر بخش آخرین تغییرات سایت جاری را هم مشاهده کنید، یک همچین سیستمی را هم دارد. این لاگ‌ها برای ردیابی عملکرد کاربران در سیستم مفید خواهد بود.
این مدل برای ایجاد امکانی به منظور واکشی لیست افردای که در حال مشاهده‌ی یک بخش خاص هستند، مفید است. فرض کنید در یک انجمن قصد دارید لیست افردای را که در حال مشاهده‌ی آن هستند، در پایین صفحه نمایش دهید. برای تاپیک‌ها هم همین امکان لازم است. لذا مدل بالا مختص مدل خاصی نیست و برای هر بخشی می‌توان از آن استفاده کرد.
مدل بالا مشخص کننده‌ی صفحاتی است که مدیر می‌تواند در پنل مدیریتی آنها را برای استفاده‌های خاصی تعریف کند. حالت درختی آن مشخص است. یکسری از خصوصیات مربوط به محتوای صفحه و همچنین تنظیمات سئو برای آن در نظر گرفته شده است که بیشتر آنها در مقالات قبل توضیح داده شده‌اند. خصوصیت Section از نوع ShowPageSection و برای مشخص کردن امکان نمایش صفحه‌ی مورد نظر در نظر گرفته شده‌است. همچنین این مدل بالا از کلاس پایه‌ی مطرح شده‌ی در اول مقاله، ارث بری کرده است که امکان ردیابی تغییرات آن را مهیا میکند.
مدل‌های AuditLog (اصلاحیه)و ActivityLog
باید توجه داشت که اگر سیستم AuditLog، جزئیات بیشتری را در بر بگیرد، می‌توان از آن به عنوان History هم یاد کرد. در قسمت چهارم برای پست‌های انجمن یک جدول جدا هم به منظور ذخیره سازی تاریخچه‌ی تغییرات، در نظر گرفتیم. فرض کنید که یک سری از جداول دیگر هم نیازمند این امکان باشند! راه حل چیست؟
- استفاده از جداول جدا برای هر کدام از جداول به صورتیکه یک ارتباط یک به چند مابین آنها برقرار است. از این جداول تحت عنوان HistoryTable یاد میشود.
- استفاده از یک جدول برای نگهداری تاریخچه‌ی تغییرات جداولی که نیازمند این امکان هستند.
در زیر پیاده سازی از روش دوم رو مشاهده میکنید.
/// <summary>
/// Represent The Operation's log
/// </summary>
public class AuditLog
{
#region Ctor
/// <summary>
/// Create One Instance Of <see cref="AuditLog"/>
/// </summary>
public AuditLog()
{
Id = SequentialGuidGenerator.NewSequentialGuid();
OperatedOn = DateTime.Now;
}
#endregion
#region Properties
/// <summary>
/// sets or gets identifier of AuditLog
/// </summary>
public virtual Guid Id { get; set; }
/// <summary>
/// gets or sets Type of Modification(create,softDelet,Delete,update)
/// </summary>
public virtual AuditAction Action { get; set; }
/// <summary>
/// sets or gets description of Log
/// </summary>
public virtual string Description { get; set; }
/// <summary>
/// sets or gets when log is operated
/// </summary>
public virtual DateTime OperatedOn { get; set; }
/// <summary>
/// sets or gets Type Of Entity
/// </summary>
public virtual string Entity { get; set; }
/// <summary>
/// gets or sets Old value of Properties before modification
/// </summary>
public virtual string XmlOldValue { get; set; }
/// <summary>
/// gets or sets XML Base OldValue of Properties (NotMapped)
/// </summary>
public virtual XElement XmlOldValueWrapper
{
get { return XElement.Parse(XmlOldValue); }
set { XmlOldValue = value.ToString(); }
}
/// <summary>
/// gets or sets new value of Properties after modification
/// </summary>
public virtual string XmlNewValue { get; set; }
/// <summary>
/// gets or sets XML Base NewValue of Properties (NotMapped)
/// </summary>
public virtual XElement XmlNewValueWrapper
{
get { return XElement.Parse(XmlNewValue); }
set { XmlNewValue = value.ToString(); }
}
/// <summary>
/// gets or sets Identifier Of Entity
/// </summary>
public virtual string EntityId { get; set; }
/// <summary>
/// gets or sets user agent information
/// </summary>
public virtual string Agent { get; set; }
/// <summary>
/// gets or sets user's ip address
/// </summary>
public virtual string OperantIp { get; set; }
#endregion
#region NavigationProperties
/// <summary>
/// sets or gets log's creator
/// </summary>
public virtual User Operant { get; set; }
/// <summary>
/// sets or gets identifier of log's creator
/// </summary>
public virtual long OperantId { get; set; }
#endregion
}
public enum AuditAction
{
Create,
Update,
Delete,
SoftDelete,
} خصوصیاتی که نیاز به توضیح خواهند داشت:
- Action : از نوع AdutiAction است و برای مشخص کردن نوع عملیاتی که انجام شده است، میباشد.
- Description : اگر نیاز باشد توضیحاتی اضافی ثبت شوند، از این خصوصیت استفاده میشود.
- Entity : مشخص کننده‌ی نام مدل خواهد بود. شاید بهتر بود از یک Enum استفاده می‌شد. ولی این سیستم به احتمال زیاد قرار است افزونه پذیر باشد و استفاده از Enum، یعنی محدودیت و این امکان وجود نخواهد داشت که سایر افزونه‌ها بتوانند از مدل بالا استفاده کنند. برا ی مثال BlogPost , NewsItem , ForumPost , ...
- EntitytId : آی دی رکوردی است که تاریخچه‌ی آن ثبت شده است. از آنجائیکه بعضی از موجودیت‌ها دارای آی دی از نوع long و برخی دیگر Guid ، لذا ذخیره‌ی رشته‌ای آن مفید خواهد بود.
- XmlOldValue : در برگیرنده‌ی مقدار (قبل از اعمال تغییرات) خصوصیاتی است که لازم است از یک موجودیت مشخص، در قالب XML رشته‌ای ذخیره شوند.
- XmlNewValue : در برگیرنده‌ی مقدار (بعد از تغییرات) خصوصیاتی است که لازم است از یک موجودیت مشخص، در قالب XML رشته‌ای ذخیره شوند.
- Operant, OperantId: برای برقراری ارتباط یک به چند مابین مدل کاربر و مدل بالا در نظر گرفته شده‌اند که به عنوان انجام دهنده‌ی این تغییرات بوده است.
با استفاده از مدل بالا می‌توان متوجه شد که کاربر x چه خصوصیاتی از موجودیت y را تغییر داده است و این خصوصیات قبل از تغییر چه مقدارهایی داشته‌اند.
/// <summary>
/// Represents Activity Log record
/// </summary>
public class ActivityLog
{
#region Ctor
/// <summary>
/// Create one instance of <see cref="ActivityLog"/>
/// </summary>
public ActivityLog()
{
Id = SequentialGuidGenerator.NewSequentialGuid();
OperatedOn=DateTime.Now;
}
#endregion
#region Properties
/// <summary>
/// gets or sets identifier
/// </summary>
public virtual Guid Id { get; set; }
/// <summary>
/// gets or sets the comment of this activity
/// </summary>
public virtual string Comment { get; set; }
/// <summary>
/// gets or sets the date that this activity was done
/// </summary>
public virtual DateTime OperatedOn { get; set; }
/// <summary>
/// gets or sets the page url .
/// </summary>
public virtual string Url { get; set; }
/// <summary>
/// gets or sets the title of page if Url is Not null
/// </summary>
public virtual string Title { get; set; }
/// <summary>
/// gets or sets user agent information
/// </summary>
public virtual string Agent { get; set; }
/// <summary>
/// gets or sets user's ip address
/// </summary>
public virtual string OperantIp { get; set; }
#endregion
#region NavigationProperties
/// <summary>
/// gets or sets the type of this activity
/// </summary>
public virtual ActivityLogType Type{ get; set; }
/// <summary>
/// gets or sets the type's id of this activity
/// </summary>
public virtual Guid TypeId { get; set; }
/// <summary>
/// gets or sets User that done this activity
/// </summary>
public virtual User Operant { get; set; }
/// <summary>
/// gets or sets Id of User that done this activity
/// </summary>
public virtual long OperantId { get; set; }
#endregion
}
/// <summary>
/// Represents Activity Log Type Record
/// </summary>
public class ActivityLogType
{
#region Ctor
/// <summary>
/// Create one Instance of <see cref="ActivityLogType"/>
/// </summary>
public ActivityLogType()
{
Id = SequentialGuidGenerator.NewSequentialGuid();
}
#endregion
#region Properties
/// <summary>
/// gets or sets identifier
/// </summary>
public virtual Guid Id { get; set; }
/// <summary>
/// gets or sets the system name
/// </summary>
public virtual string Name{ get; set; }
/// <summary>
/// gets or sets the display name
/// </summary>
public virtual string DisplayName { get; set; }
/// <summary>
/// gets or sets the description
/// </summary>
public virtual string Description { get; set; }
/// <summary>
/// indicate this log type is enable for logging
/// </summary>
public virtual bool IsEnabled { get; set; }
#endregion
} - Comment : توضیحات کوتاهی از اکشنی که کاربر انجام داده است.
- Url : آدرس صفحه‌ای که این عملیات در آنجا انجام شده است. این خصوصیت نال‌پذیر میباشد.
- Title : عنوان صفحه‌ای که این عملیات در آنجا انجام شده است؛ اگر Url نال نباشد.
- Operant , OperantId : برای برقراری ارتباط یک به چند بین کاربر و مدل فعالیت‌ها در نظر گرفته شده‌اند.
- Type : از نوع ActivityLogType پیاده سازی شده در بالا میباشد. با استفاده از مدل ActivityLogType می‌توان مثلا لاگ فعالیت مربوط به بخش اخبار را غیر فعال کند یا بالعکس و از این موارد.
خصوصیات مدل ActivityLogType :
- Name : نام سیستمی آن است. برای مثال : Login ، NewsComment ، NewsItem و ...
- IsEnabled : نشان دهنده‌ی این است که این نوع لاگ فعال است یا خیر.
کلاس پایه تمام مدل‌ها (اصلاحیه)
/// <summary>
/// Represents the entity
/// </summary>
/// <typeparam name="TForeignKey">type of user's Id that can be long or long? </typeparam>
public abstract class Entity<TForeignKey>
{
#region Properties
/// <summary>
/// gets or sets date that this entity was created
/// </summary>
public virtual DateTime CreatedOn { get; set; }
/// <summary>
/// gets or sets Date that this entity was updated
/// </summary>
public virtual DateTime ModifiedOn { get; set; }
/// <summary>
/// gets or sets IP Address of Creator
/// </summary>
public virtual string CreatorIp { get; set; }
/// <summary>
/// gets or set IP Address of Modifier
/// </summary>
public virtual string ModifierIp { get; set; }
/// <summary>
/// indicate this entity is Locked for Modify
/// </summary>
public virtual bool ModifyLocked { get; set; }
/// <summary>
/// indicate this entity is deleted softly
/// </summary>
public virtual bool IsDeleted { get; set; }
/// <summary>
/// gets or sets information of user agent of modifier
/// </summary>
public virtual string ModifierAgent { get; set; }
/// <summary>
/// gets or sets information of user agent of Creator
/// </summary>
public virtual string CreatorAgent { get; set; }
/// <summary>
/// gets or sets date that this entity repoted last time
/// </summary>
public virtual DateTime? ReportedOn { get; set; }
/// <summary>
/// gets or sets counter for Content's report
/// </summary>
public virtual int ReportsCount { get; set; }
/// <summary>
/// gets or sets count of Modification Default is 1
/// </summary>
public virtual int Version { get; set; }
/// <summary>
/// gets or sets action (create,update,softDelete)
/// </summary>
public virtual AuditAction Action { get; set; }
/// <summary>
/// gets or sets TimeStamp for prevent concurrency Problems
/// </summary>
public virtual byte[] RowVersion { get; set; }
#endregion
#region NavigationProperties
/// <summary>
/// gets ro sets User that Modify this entity
/// </summary>
public virtual User ModifiedBy { get; set; }
/// <summary>
/// gets ro sets Id of User that modify this entity
/// </summary>
public virtual TForeignKey ModifiedById { get; set; }
/// <summary>
/// gets ro sets User that Create this entity
/// </summary>
public virtual User CreatedBy { get; set; }
/// <summary>
/// gets ro sets User that Create this entity
/// </summary>
public virtual TForeignKey CreatedById { get; set; }
#endregion
}
/// <summary>
/// Represents the base Entity
/// </summary>
/// <typeparam name="TKey">type of Id</typeparam>
/// <typeparam name="TForeignKey">type of User's Id that can be long or long?</typeparam>
public abstract class BaseEntity<TKey,TForeignKey> : Entity<TForeignKey>
{
#region Properties
/// <summary>
/// gets or sets Identifier of this Entity
/// </summary>
public virtual TKey Id { get; set; }
#endregion
} از دو کلاس معرفی شده‌ی در بالا برای کپسوله کردن یکسری خصوصیات تکراری استفاده شده است. البته با بهبودهایی نسبت به مقاله‌ی قبل که با مشاهده‌ی خصوصیات آنها قابل فهم خواهد بود. در برخی از مدل‌ها، برای مثال نظرات وبلاگ امکان ارسال نظر برای افراد Anonymous هم وجود داشت؛ لذا CreatedById امکان نال بودن را هم داشت. به همین دلیل برای کاهش کدها، کلاس‌های بالا را به صورت جنریک تعریف کردیم. فایل EDMX نهایی که در انتهای مقاله ضمیمه شده، برای درک تغییرات اعمال شده مفید خواهد.
مدل سیستم آگاه سازی
/// <summary>
/// Represents the Notification Record
/// </summary>
public class Notification
{
#region Ctor
/// <summary>
/// create one instance of <see cref="Notification"/>
/// </summary>
public Notification()
{
Id = SequentialGuidGenerator.NewSequentialGuid();
ReceivedOn = DateTime.Now;
}
#endregion
#region Properties
/// <summary>
/// gets or sets identifier
/// </summary>
public virtual Guid Id { get; set; }
/// <summary>
/// indicate that this notification is read by owner
/// </summary>
public virtual bool IsRead { get; set; }
/// <summary>
/// gets or sets notification's text body
/// </summary>
public virtual string Message { get; set; }
/// <summary>
/// gets or sets page url that this notification is related with it
/// </summary>
public virtual string Url { get; set; }
/// <summary>
/// gets or sets date that this Notification Received
/// </summary>
public virtual DateTime ReceivedOn { get; set; }
/// <summary>
/// gets or sets the type of notification
/// </summary>
public virtual NotificationType Type { get; set; }
#endregion
#region NavigationProperties
/// <summary>
/// gets or sets the id of user that is owner of this notification
/// </summary>
public virtual long OwnerId { get; set; }
/// <summary>
/// gets or sets the user that is owner of this notification
/// </summary>
public virtual User Owner { get; set; }
#endregion
}
public enum NotificationType
{
NewConversation,
NewConversationReply,
...
} در این سیستم برای اطلاع رسانی کاربر، علاوه بر ارسال ایمیل، بحث اطلاع رسانی RealTime را هم خواهیم داشت. اطلاع رسانی‌هایی که توسط کاربر خوانده نشده باشند، در جدول حاصل از مدل Notification ذخیره خواهند شد. خصوصیاتی که نیاز به توضیح دارند:
- IsRead : مشخص کننده‌ی این است که یک اطلاع رسانی خوانده شده است یا خیر. در آخر هر روز اطلاع رسانی‌هایی که دارای خصوصیت IsRead با مقدار true هستند، حذف خواهند شد.
- Url : برای مواردی که لازم است کاربر با کلیک بر روی آن به صفحه‌ی خاصی هدایت شود.
- OwnerId, Owner : برای برقراری ارتباط یک به چند بین کاربر و مدل Notification در نظر گرفته شده‌اند.
- Type : از نوع NotificationType و مشخص کننده‌ی نوع اطلاع رسانی میباشد .
مدل Observation
public class Observation
{
#region Ctor
/// <summary>
/// create one instance of <see cref="Observation"/>
/// </summary>
public Observation()
{
LastObservedOn = DateTime.Now;
Id = SequentialGuidGenerator.NewSequentialGuid();
}
#endregion
#region Properties
public virtual Guid Id { get; set; }
/// <summary>
/// gets or sets datetime of last visit
/// </summary>
public virtual DateTime LastObservedOn { get; set; }
/// <summary>
/// gets or sets Id Of section That user is observing the entity
/// </summary>
public virtual string SectionId { get; set; }
/// <summary>
/// gets or sets section That user is observing in it
/// </summary>
public virtual string Section { get; set; }
#endregion
#region NavigationProperites
/// <summary>
/// gets or sets user that observed the entity
/// </summary>
public virtual User Observer { get; set; }
/// <summary>
/// gets or sets identifier of user that observed the entity
/// </summary>
public virtual long ObserverId { get; set; }
#endregion
} فرض کنیم کاربری قصد هدایت به یک تاپیک را دارد. لذا هنگام هدایت شدن لازم است رکوردی در جدول حاصل از مدل بالا ثبت شود که کاربر x در بخش Topic، در تاریخ d، تاپیک به شماره‌ی y را مشاهده کرد. در صفحه‌ی مشاهده‌ی تاپیک می‌توان لیست افرادی را که قبل از مدت زمان مشخصی تاپیک را مشاهده کرده اند، نمایش داد. این رکورد‌ها را هم با تعریف یک Task می‌توان در بازه‌های زمانی مشخصی حذف کرد.
مدل صفحات داینامیک
/// <summary>
/// represents one custom page
/// </summary>
public class Page : BaseEntity<long, long>
{
#region Properties
/// <summary>
/// gets or sets the blog pot body
/// </summary>
public virtual string Body { get; set; }
/// <summary>
/// gets or sets the content title
/// </summary>
public virtual string Title { get; set; }
/// <summary>
/// gets or sets value indicating Custom Slug
/// </summary>
public virtual string SlugUrl { get; set; }
/// <summary>
/// gets or sets meta title for seo
/// </summary>
public virtual string MetaTitle { get; set; }
/// <summary>
/// gets or sets meta keywords for seo
/// </summary>
public virtual string MetaKeywords { get; set; }
/// <summary>
/// gets or sets meta description of the content
/// </summary>
public virtual string MetaDescription { get; set; }
/// <summary>
/// gets or sets
/// </summary>
public virtual string FocusKeyword { get; set; }
/// <summary>
/// gets or sets value indicating whether the content use CanonicalUrl
/// </summary>
public virtual bool UseCanonicalUrl { get; set; }
/// <summary>
/// gets or sets CanonicalUrl That the Post Point to it
/// </summary>
public virtual string CanonicalUrl { get; set; }
/// <summary>
/// gets or sets value indicating whether the content user no Follow for Seo
/// </summary>
public virtual bool UseNoFollow { get; set; }
/// <summary>
/// gets or sets value indicating whether the content user no Index for Seo
/// </summary>
public virtual bool UseNoIndex { get; set; }
/// <summary>
/// gets or sets value indicating whether the content in sitemap
/// </summary>
public virtual bool IsInSitemap { get; set; }
/// <summary>
/// gets or sets title for snippet
/// </summary>
public string SocialSnippetTitle { get; set; }
/// <summary>
/// gets or sets description for snippet
/// </summary>
public string SocialSnippetDescription { get; set; }
/// <summary>
/// gets or sets section's type that this page show on
/// </summary>
public virtual ShowPageSection Section { get; set; }
/// <summary>
/// indicate this page has not any body
/// </summary>
public virtual bool IsCategory { get; set; }
/// <summary>
/// gets or sets order for display forum
/// </summary>
public virtual int DisplayOrder { get; set; }
#endregion
#region NavigationProeprties
/// <summary>
/// gets or sets Parent of this page
/// </summary>
public virtual Page Parent { get; set; }
/// <summary>
/// gets or sets parent'id of this page
/// </summary>
public virtual long? ParentId { get; set; }
/// <summary>
/// get or set collection of page that they are children of this page
/// </summary>
public virtual ICollection<Page> Children { get; set; }
#endregion
}
public enum ShowPageSection
{
Menu,
Footer,
SideBar
} خوب! حجم مقاله زیاد شده است و تا اینجا کافی خواهد بود ؛ بر خلاف تصور بنده، یک مقاله‌ی دیگر نیز برای اتمام بحث لازم میباشد.
نتیجه‌ی تا این قسمت
