Order Module Entities

إحنا عايزين نعمل نظام يخلي الـ Customer يقدر يعمل Order ويدفع أونلاين. النهاردة هنركز على تصميم الـ Order نفسه.

Entities

• بما انك شغال Code-first، المفروض تقرأ الـ SRS الأول وبعدين ترسم الـ Class Diagram.

• قبل ما تكتب أي سطر Code، لازم تعمل Design للـ Service بتاعتك وتشوف ايه الـ Entities اللي هتبقا موجودة عن طريق Class Diagram، وهي زي الـ ERD بس بتعملها لو شغال Code-first.

• لو بتشتغل لوحدك ممكن تعمل اللي يعجبك، لكن لو حد هيشتغل معاك لازم تشتغل على الـ Standards.

• أي Module بتبدأ تشتغل فيه، بتشوف ايه هي الـ Entities, Poco Classes, Domain Models.

Order Aggregate

• هنروح على بروجكت Core ونعمل في الـ Entitles فولدر للـ Order Aggregate.
• تصميمه مش سهل (Complex)، فعشان تعمله Create لازم تمشي على Patterns زي الـ Abstract Factory Pattern and other patterns.
• لو هتعمل Complex Object لازم تمشي ببـ Pattern عشان كل حاجة تبقا تمام زي الـ Abstract Factory أو الـ Builder Design Pattern.

Address

هعمل Address اللي هشحن عليه الـ Order:

public class Address
{
	public string FirstName {get; set;}
	public string LName {get; set;}
	public string Street {get; set;}
	public string City {get; set;}
	public string Country {get; set;}
}

• هتقولي ما احنا كنا عاملين Address في الـ Identity بس دا كان بتاع الـ User ودا Table في الـ Database. انما دا بيمثل الـ Address بتاع الـ Order.
• مش هخليه يورث من الـ BaseEntity لأني مش هحوله لـ Table.
• العلاقة بين الـ Address والـ Order هي One-to-one وكمان الاتنين لازم يشاركوا فالمفروض الإتنين بيتحطوا ف Table واحد عشان كدا مش هعمل لدا Table يعني من الآخر هيتحط مع الـ Order.
• الـ Address دا هييجي من عنوان الـ User نفسه أول ما ييجي يعمل Order وأحطه مع الـ Order بس على هيئة الـ Address دا وهديله امكانية انه يقدر يغير فيه. يعني الـ Address بتاع الـ User هو الـ Default Address for Order.
• يعني أنا ممكن أبعت على نفس الـ Address بتاع الـ User أكتر من Order بس الـ Address بتاع الـ Order لازم يبقا واحد بس وممكن يبقا هو هو بتاع الـ User.

Delivery method

هيبقا عبارة عن Table فهيورث من الـ BaseEntity:

public class DeliveryMethod : BaseEntity
{
	public string ShortName {get; set;}
	public string Description {get; set;}
	public decimal Cost {get; set;}
	public string DeliveryTime {get; set;}
}

Order Status : Enum

public enum OrderStatus
{
	[EnumMember(Value = "Pending")]
	Pending, // label
	[EnumMember(Value = "Payment Buy")]
	PaymentReveived,
	[EnumMember(Value = "Payment Faild")]
	PaymentFailed
}

• انا عايزة يتخزن في الـ Database مش رقم أنا عايزة يتخزن ككلمة.
• فهستخدم Attribute اسمه EnumMember ودا هيخزنه في الـ Database كـ String. اتكلمنا قبل كدا عن الـ Cs Enums.

Items

• هيبقا عبارة عن Table فهيورث من الـ BaseEntity.
• العلاقة بينه وبين الـ Order انه One-to-Many من ناحية الـ Order:

public class OrderItem : BaseEntity
{
	public int ProductId {get; set;}
	public string ProductName {get; set;}
	public string PictureUrl {get; set;}
	public decimal Price {get; set;}
	public int Qunatity {get; set;}
}

• فيه فرق بين الـ ProductId والـ Id اللي هيورثه من الـ BaseEntity.
  • الـ ProductId دا بتاع الـ Product نفسه
  • انما التاني عبارة عن الـ Primary key بتاع الجدول.
  • انا مثلًا روحت ستار بكر وطلبت أيس موكا وفيه Id له فأنا عملت Order فالـ Order بتاعي دا فيه Item واحد بس ودا Record in table orderItems فأكيد له الـ Id بتاعه هو مش بتاع الحاجة اللي بتطلب.

---

من ضمن قواعد الـ Clean Code: لو عندك مجموعة من الـ Properties كلهم بيمثلوا نفس الحاجة وينفع تعملهم Encapsulation في Type واحد ولما تعمل كدا هيبقا ليها Meaning، اعمل كدا.

ففالمثال اللي فوق دا عندنا الـ ProductId, ProductName, PictureUrl كلهم بيعبروا عن الـ Product اللي هيتطلب. ليه مدخلناش الـ Price لأن دا مش شرط يبقا سعر الـ Product انما دا سعر الـ Item في الـ Order. بمعنى ان ممكن يحصل مثلًا Discount فينزل أو كدا.

// In another file
public class ProductItemOrdered
{
	public int ProductId {get; set;}
	public string ProductName {get; set;}
	public string PictureUrl {get; set;}
}
 
public class OrderItem : BaseEntity
{
	public ProductItemOrdered Product {get; set;}
	public decimal Price {get; set;}
	public int Qunatity {get; set;}
}

• بس دا مش هيبقا Table لأن العلاقة عبارة عن One-to-one.
• فأنا هعمل Mapping للاتنين دول في جدول واحد زي ما هنعمل في الـ Order والـ Address.
• الحياة في الـ Database مختلفة عن الـ Code لأن مثلًا في الـ Database كنا قولنا هيبقوا في جدول واحد.
• انما في الكود هروح أعمل Order وهيبقا جواه Items وجوا الـ Items فيه ProductItemOrdered وجواه المعلومات بتاع الـ Order بقا.

Order : Main

هيبقا عبارة عن Table فهيورث من الـ BaseEntity:

public class Order : BaseEntity
{
	public string BuyerEmail {get; set;}
	public DateTimeOffset OrderDate {get; set;} = DateTimeOffset.UtcNow;
	public OrderStatus Status {get; set;} = OrderStatus.Pending;
	public Address ShippingAddress {get; set;} 
	// Not navigational Property
	// public int DeliveryMethodId {get; set;} // FK
	public DeliveryMethod DeliveryMethod {get; set;}
	// Navigational Property [One]
	public ICollection<OrderItem> Items {get; set;} = new HashSet<OrderItem>();
	// Navigational Property [Many]
	public decimal Subtotal {get; set;} // Cost without delivery
	[NotMapped]
	public decimal Total {get {return Subtotal + DeliveryMethod.Cost};}
	//Or
	public decimal Total => Subtotal + DeliveryMethod.Cost;
 
	// Second Way
	public decimal GetTotal()
		=> Subtotal + DeliveryMethod.Cost;
	// Derived Attribute
 
	public string PymentIntentId {get; set;} = string.Empty;
}

• ليه DatTimeOffset؟ عشان ميظهرش Local ولو راح بلد تانية دا ميعملش مشاكل.
• الـ Address مش هيبقا Navigational Property عشان هو بيبقا في نفس الـ Table.

---

• ممكن أستخدم الـ Delivery Method عشان يوصل اكتر من Order بس الـ Order بنستخدم عشان نوصله Delivery Method واحدة.

---

• هحتاج أروح في الـ Delivery Method أعمل Navigational Property(Many) بس انا مش محتاج أعملها حاليًا عشان مش هستخدمها فهو هيفهم ان هي One-to-One فهو هيروح ياخد الـ May(Delivery Method) يحطها في الـ Must (Order). هو عرف منين؟ عرف عن طريق ان الـ Order فيه Delivery Method فدا لازم يشارك في العلاقة انما الناحية التانية مفيش فدا عادي ميشاركش او كدا. فهحتاج أعمل الـ Foreign Key.

---

• لو جيت أعمل Order وحطيت الـ DeliveyMethodId بـ 1 وجه مثلًا بوب وعمل اوردر وحط الـ DeliveyMethodId بـ 1، حد هيعترض؟ اكيد لا يبقا زي ما هي كدا تعتبر one-to-many مش one-to-one.
• كل العلاقات أصلًا بيتعملها Map لـ One-to-many ودا الطبيعي ككل إنما لو عايزها تبقا one-to-one فعلًا لازم أحط Constraint ويكون Unique بالـ Fluent API.

---

• بس أنا مش محتاج أعمل Property بتمثل الـ Foreign Key، وهو براحتك. لأني ممكن أستخدم الـ Navigational Property.
• ازاي أعمل Set للـ Foreign Key؟ عن طريق الـ Navigational Property بشرط إن الـDeleviryMethod تكون هي اللي جاية من الـ DB والـ EF Core عاملها Tracking.

---

الـ Derived attribute له طريقتين:

• اما إني أعمله Readonly بياخد get بس واعمل الـ get دي المعادلة بتاعته واعملها NotMapped.
• الطريقة التانية أعمل Function بتعمل Get بس (المفضلة).

لو حد قالك إن المفروض الـ Entity يبقا Poco class ومش بيبقا فيها أي Functionality أو أي Behaviour تقوله دي مش Functionality دي عبارة عن Derived Attribute.

---

• الـ Property الأخيرة دي بتاع الـ Intent عشان هستخدمها في السيشن الجاية.
• عشان مضطرش أعمل Migration تاني فهعملها بس كدا هضطر أخزنها برضو ودي مشكلة فهضطر أقول انها بتقبل Null بس برضو هضطر أغيرها واقول انها مبتقبلش Null بعد كدا فهعمل Migration فلازم أديلها Default value وهي عبارة عن Empty string والسيشن الجاية أشيلها.

Constructor

• محتاج أعمل Constructors لكل الـ Classes دي وتكون بتاخد قيم لكل حاجة وبحطها فيها. فأنا بقف على الـ Class واعمل Generate constructor ونحدد كله ونعمله.

• بس المشكلة إن الـ EF Core بيحتاج Ctor فاضي لكل الـ Tables او الـ Entities اللي جوا Tables عشان يقدر يستخدمه. فأنا مضطر إني اعمله انا لأني بعد ما عملت واحد مش فاضي اللي كان فاضي اتمسح.

بس خد بالك من الحاجات الثابتة متحطها في الـ Ctor. مثلًا دا للـ Order.