Specification Design Pattern

What is Design Pattern

Specification Design Pattern

Specification Pattern and Dynamic Query Building

تعريف المشكلة:

1. مشاكل Include:
   • الخرق لـ Open/Closed Principle:
     عند إضافة موديل جديد (مثل Brand أو Category)، تحتاج تعديل الكود وإضافة Includes جديدة، ما يخالف مبدأ Closed for Modifications. كنا اتكلمنا عنها (Open-Closed Principle) شوفنا المشكلة دي في الـ Include
   • أداء غير فعال:
     استخدام Where بدلاً من Find يؤدي إلى استعلامات غير محسنة، لأن Where تعمل على البيانات مباشرة من قاعدة البيانات، بينما Find تبدأ بالبحث محليًا (Local) ثم تنتقل إلى Remote لتحسين الأداء. شوفنا المشكلة دي في التعامل مع Null في Brand و Category
2. الحل:
   • استخدام Specification Pattern لبناء الاستعلامات بشكل ديناميكي دون الحاجة لتعديل الكود عند إضافة مكونات جديدة.

---

Specification Pattern

• مش من ضمن الـ 23 اللي قولنا عليهم في الـ What is Design Pattern

الفكرة الرئيسية:

• الـSpecification يعامل كل جزء من الاستعلام كـ خاصية (Specification).
• بناء Method تأخذ المعايير المطلوبة وتُنشئ الاستعلام بشكل ديناميكي.
• بيساعدني اني أبني الـ Query بشكل Dynamic، فأنا بقسم الـ Query بتاعي لأجزاء وبغيرها كل مرة على حسب الـ Business

---

خطوات بناء Specification Pattern

1. إنشاء Interface للـ Specification:

• هنروح لبروجكت الـ Core
• هنعمل فولدر نسميه Specifications
• ونعمل جواه Interface اسمه ISpecification
• يكون Public ويكون Generic
• وتحط Constrain انها لازم تكون BaseEntity
• يحتوي على (Signatures) لكل Property تمثل جزء من الاستعلام.
• نروح نشوف الـ Query اللي كنت عملتها Static هنا التعامل مع Null في Brand و Category
• هنلاقي بيتكرر where و Includes
• الجزء اللي فالآخر بتاع FirstOrDefaultAsync و ToListAsync دا بيتغير فمش هنكتبه ونكتبه بعدها
• ممكن تقول مفيش where في الـ GetAll لأني ممكن أستخدمها بعد كدا لو عايز أظهر في البراند أو الكاتيجوري (في الـ Filters عمومًا)
• الـ FirstOrDefault بيخلوا الـ Query يتعملها Immediate Execution
  • Three Categories for Immediate (Element Operators - Casting Operator - Aggregation Operator)

public interface ISpecification<T> where T : BaseEntity
{
	// دي اللي هبعتها للوير
    Expression<Func<T, bool>> Criteria { get; set;}
    List<Expression<Func<T, object>>> Includes { get; set; }
}

• بياخدوا Cs Delegates
• الاتنين بيعملوا Return فهنبعد عن الـ Action ونستخدم الـ Func
• الأول where بيعمل Return لـ True أو False وبياخد الـ Product بتاعي مثلًا
• انما التاني بيرجع من الـ DB فممكن حرفيًا يرجع أي حاجة فبنقول انه بيرجع object

2. إنشاء Class لتنفيذ الـ Interface:

• الكلاس يحمل تفاصيل الاستعلام.
• هنعمله في الـ Core في فولدر الـ Specifications برضو
• ممكن أعملها Full property عادي لو هعمل Validation أو كدا واتكلمنا عن الموضوع دا في الـ Cs Properties

public static class BaseSpecifications<T> : ISpecification<T> where T : BaseEntity
{
    public Expression<Func<T, bool>> Criteria { get; private set; }
    public List<Expression<Func<T, object>>> Includes { get;} = new List<Expression<Func<T, object>>>();
 
	public BaseSpecification()
	{
	}
 
    public BaseSpecification(Expression<Func<T, bool>> criteria)
    {
        Criteria = criteria;
    }
 
/*
    public void AddInclude(Expression<Func<T, object>> includeExpression)
    {
        Includes.Add(includeExpression);
    }
*/
}

• لما نعمل الـ Method وبتاخد الإتنين برامتر
• لو الـ Method هتعمل Query تجيبلي كل الـ Products يبقا الـ Criteria بـNull انما لو هيجيب حاجات محددة فالمفروض تبقا بـ Expression
• فاللي هيحدد الـ Method
• فأنا هعمل اتنين Ctor واحد بيحط الـ criteria بـ Null والتاني بيحطه بالـ Expression
• في العادي لو عملت Empty ctor اللي بيحصل ان هو بيحط كل الـ Properties بـ Null أو بالقيمة الـ Default بتاعنا، فاحنا هنعمل واحد ونعمل Initialization للـ Includes ونسيب الـ Criteria عشان تفضل بـ Null
• ممكن نحطها بقيمة على طول بدل ما أستنى الـ Ctor يتنفذ

3. إنشاء Method لتطبيق الـ Specification:

• هنعملها في الـ Repository
• هحتاج أعمل Class اسمه SpecificationEvaluator وحطيته في الـ Repository عشان أنا هستخدمه مع كلاس الـ Generic Repository
• تأخذ:
  1. الـDbSet: الجدول الذي تعمل عليه.
  2. الـSpecification Object: تفاصيل الاستعلام (Criteria، Includes).

internal static class SpecificationsEvaluator<T> where T : BaseEntity
 
public static IQueryable<T> GetQuery(IQueryable<T> inputQuery, ISpecification<T> spec)
{
	var query = inputQuery;
    // Apply Criteria
    if (spec.Criteria != null)
    {
        query = query.Where(spec.Criteria);
    }
 
    // Apply Includes
    query = spec.Includes.Aggregate(query, (currentQuery, includeExpression) 
	    => currentQuery.Include(includeExpression));
 
	// query = _dbContext.Set<Product>().Where(P => P.Id==1)
	// Includes
		// 1. P => P.Brand
		// 2. P => P.Category
// _dbContext.Set<Product>().Where(P => P.Id==1).Include(P => P.Brand)
// _dbContext.Set<Product>().Where(P => P.Id==1).Include(P => P.Brand).Include(P => P.Category)
    return query;
}

Aggregate

موجودة في الـ LINQ وشرحها هنا Cs Aggregate بنعمل Accumulate لكل الـ Includes مع بعض فهنستخدم الـ Aggregate

string[] Names = {"Corn", "Pop"};
string Message = "Hello,";
Message = Names.Aggregate(Message, (x, y) => $"{x} {y}");
 
Console.WriteLine(Message);

هو كل اللي هيعمله بتديله أول قيمة اللي هيبني عليها اللي هي هنا Message وبعدها بتديله الـ Parameters وبيبقا أول Parameter في الأول اللي هي أول قيمة عندي والتاني بياخد أول قيمة في الـ Collection اللي ناديت بيها اللي هي هنا الـ Names وهكذا لحد ما تخلص

---

4. استخدام الـ Method

• كنا بنحط مسكن في الـ Generic Repository لو تفتكر في الـ Include
• هنعمل اتنين Method تانيين واحد اسمه GetAllWithSpecAsync والتاني GetWithSpecAsync ونحطه في الـ Interface متنساش

Task<IEnumerable<T>> GetAllWithSpecAsync(ISpecifications<T> spec);
Task<T?> GetWithSpecAsync(ISpecifications<T> spec);

وبعدين نروح على Class الـ GenericRepository ونعملهم Implement

public Task<IEnumerable<T>> GetAllWithSpecAsync(ISpecifications<T> spec)
{
	return await SpecificationsEvaluator<T>.GetQuery(_dbContext.Set<T>(), spec).ToListAsync();
}
 
public Task<IEnumerable<T>> GetWithSpecAsync(ISpecifications<T> spec)
{
	return await SpecificationsEvaluator<T>.GetQuery(_dbContext.Set<T>(), spec).FirstOrDefaultAsync();
}

بس انا عندي كدا جزء متكرر في الـ GetAll والـ Get فهعمل Method Private

private IQueryable<T> ApplySpecifications(ISpecifications<T> spec)
{
	return SpecificationsEvaluator<T>.GetQuery(_dbContext.Set<T>(), spec);
}

ونغير بقا الـ Methods وتبقا كدا

public Task<IEnumerable<T>> GetAllWithSpecAsync(ISpecifications<T> spec)
{
	return await ApplySpecifications(spec).ToListAsync();
}