Real-World Examples of Delegates in CSharp

Introduction

في المقال ده، هنتكلم عن أمثلة واقعية للـ Delegates في C#. الـ delegates هي واحدة من أهم المفاهيم اللي لازم تفهمها كمطور C#. في انترڤيوهات كتير، معظم الانترڤيورز بيطلبوا منك تشرح استخدام الـ delegates في المشاريع الواقعية اللي اشتغلت عليها.

يا ريت تقرا المقالين دول، اللي ناقشنا فيهم أساسيات الـ delegate والـ multicast delegates:

• Single Cast Delegates in C#
• Multicast Delegate in C#

الـ Delegates في C# بتُستخدم بشكل كبير من مطوري الـ framework. خلونا نفهم الـ delegates بمثالين من الواقع.

Delegate Real-Time Example 1: Worker Notifications

خلونا نقول إن عندنا class اسمه Worker والـ class ده فيه method اسمها DoWork. متطلبات البيزنس بتاعتنا هي إننا لما نستدعي DoWork method، محتاجين نبعت إشعار بنسبة الشغل اللي خلص للمستهلك (consumer)، وكمان لما الشغل يخلص، محتاجين برضه نبعت إشعار.

• مثلاً: قد إيه من الشغل خلص في ساعة، في ساعتين، في تلات ساعات، وهكذا لحد ما الشغل يخلص.
• والـ DoWork method معندهاش أي فكرة تبعت الإشعارات دي لمين. اللي بيستدعي DoWork method هو اللي المفروض يقرر يبعت الإشعار لمين. ده معناه إننا هنا محتاجين نستخدم call-back functions.

ده سيناريو مثالي محتاجين نستخدم فيه delegates. هنعمل class اسمه Worker.cs. هنا، عملنا اتنين delegates. الـ DoWork method بتاخد أربعة parameters، اتنين منهم من نوع delegate. بعدين جوه الـ method، بنستخدم for loop وكل مرة الـ loop بتتنفذ، بنعمل شوية شغل وبنخطر المستخدم عن طريق استدعاء الـ delegate. بمجرد ما تنفيذ الـ loop بيخلص، ده معناه إن شغلنا خلص، وبعدين بنستدعي work completed delegate عشان نخطر المستخدم إن الشغل خلص.

Worker.cs

using System.Threading;
namespace DelegatesRealTimeExample
{
    // Delegate for reporting progress
    public delegate void WorkPerformedHandler(int hours, string workType);
    
    // Delegate for reporting completion
    public delegate void WorkCompletedHandler(string workType);
 
    public class Worker
    {
        public void DoWork(int hours, string workType, WorkPerformedHandler del1, WorkCompletedHandler del2)
        {
            // Do Work here and notify the consumer that work has been performed
            for (int i = 0; i < hours; i++)
            {
                // Do Some Processing
                Thread.Sleep(1000); // Simulate work for 1 second
                // Notify how much work has been done
                del1(i + 1, workType);
            }
            // Notify the consumer that work has been completed
            del2(workType);
        }
    }
}

دلوقتي، عدّل Program class كالتالي. هنا، بنعمل اتنين call-back methods بنفس الـ signature بتاع الـ delegates بتاعتنا. بعدين بنعمل instances من delegate وكمان بنعمل instance من Worker class وبنستدعي DoWork method بإننا نمرر القيم المطلوبة مع الاتنين delegate instances.

Program.cs

using System;
namespace DelegatesRealTimeExample
{
    class Program
    {
        static void Main(string[] args)
        {
            // Create delegate instances pointing to our callback methods
            WorkPerformedHandler del1 = new WorkPerformedHandler(Worker_WorkPerformed);
            WorkCompletedHandler del2 = new WorkCompletedHandler(Worker_WorkCompleted);
 
            Worker worker = new Worker();
            // Pass the delegate instances to the DoWork method
            worker.DoWork(5, "Generating Report", del1, del2);
 
            Console.ReadKey();
        }
 
        // Callback method for progress reporting
        static void Worker_WorkPerformed(int hours, string workType)
        {
            Console.WriteLine($"{hours} Hours completed for {workType}");
        }
 
        // Callback method for completion notification
        static void Worker_WorkCompleted(string workType)
        {
            Console.WriteLine($"{workType} work completed");
        }
    }
}

دلوقتي، شغل التطبيق وهتلاقي إنه كل مرة الـ loop بتتنفذ، بيبعت إشعار، ولما الشغل يخلص، بيبعت إشعار تاني. Output:

1 Hours completed for Generating Report
2 Hours completed for Generating Report
3 Hours completed for Generating Report
4 Hours completed for Generating Report
5 Hours completed for Generating Report
Generating Report work completed

لكن فيه مشكلة. جوه Worker class، ممكن نخلي الـ delegate instance بـ null:

public void DoWork(...)
{
    del1 = null; // This is allowed
    del2 = null; // This is also allowed
    // ... code will crash here ...
}

هنا، لو Worker class مش بيعمل instance ولو Worker class معندوش فكرة عن الـ methods اللي هيبعتلها الإشعارات، فالمفروض ميسمحش بإنه يخلي delegate instance يبقى null. إزاي نقدر نمنع ده؟ باستخدام Events في C# وده اللي هنتكلم عنه في مقالنا الجاي.

Delegate Real-Time Example 2: Employee Promotion

دلوقتي، هنشوف مثال تاني واقعي للـ delegates. خلونا نقول إن عندنا class اسمه Employee.

namespace DelegateRealtimeExample
{
    public class Employee
    {
        public int ID { get; set; }
        public string Name { get; set; }
        public string Gender { get; set; }
        public int Experience { get; set; }
        public int Salary { get; set; }
    }
}

دلوقتي أنا عايز أكتب method في Employee class ممكن نستخدمها عشان نرقي الموظفين. الـ method اللي هنكتبها هتاخد قايمة من Employee objects كـ parameter وبعدين المفروض تطبع أسماء كل الموظفين اللي مؤهلين للترقية.

لكن المنطق اللي على أساسه الموظف بيترقى المفروض ميكونش hard coded. أوقات ممكن نرقي الموظفين بناءً على خبرتهم وأوقات تانية ممكن نرقيهم بناءً على مرتبهم أو يمكن بناءً على سبب تاني زي أداء الموظف.

إزاي نقدر نحقق ده؟ ده ممكن نحققه بسهولة جدًا بمساعدة delegates. عشان كده، محتاج أصمم Employee class بتاعي زي ما هو موضح تحت:

using System;
using System.Collections.Generic;
namespace DelegateRealtimeExample
{
    // Delegate to check promotion eligibility
    public delegate bool EligibleToPromotion(Employee EmployeeToPromotion);
 
    public class Employee
    {
        // ... properties
        
        // This method uses the delegate to decide who to promote
        public static void PromoteEmployee(List<Employee> lstEmployees, EligibleToPromotion IsEmployeeEligible)
        {
            foreach (Employee employee in lstEmployees)
            {
                // The promotion logic is passed in via the delegate
                if (IsEmployeeEligible(employee))
                {
                    Console.WriteLine($"Employee {employee.Name} Promoted");
                }
            }
        }
    }
}

في الكود اللي فوق، عملنا delegate اسمه EligibleToPromotion. الـ delegate ده بياخد Employee object كـ parameter وبيرجع قيمة boolean بتوضح إذا كان الموظف اترقى ولا لأ. في Employee class، عملنا كمان PromoteEmployee method والـ method دي بتاخد قايمة Employees و Delegate من نوع EligibleToPromotion كـ parameters.

بعدين، PromoteEmployee method بتلف على كل employee object وتمرره للـ delegate. لو الـ delegate رجع true، يبقى الموظف اترقى، وإلا لأ. فجوه الـ method، معملناش hardcode لأي منطق عن إزاي عايزين نرقي الموظفين.

دلوقتي العميل (client) اللي بيستخدم Employee class عنده المرونة إنه يحدد المنطق بتاع إزاي عايز يرقي الموظفين بتوعه. Program.cs

using System;
using System.Collections.Generic;
namespace DelegateRealtimeExample
{
    public class Program
    {
        static void Main()
        {
            // Create employees...
            List<Employee> lstEmployess = new List<Employee>();
            // Add employees to the list...
 
            // Create a delegate instance pointing to our promotion logic method
            EligibleToPromotion eligibleToPromote = new EligibleToPromotion(Program.PromoteBySalary);
            Employee.PromoteEmployee(lstEmployess, eligibleToPromote);
 
            Console.ReadKey();
        }
        
        // This is the specific promotion logic we want to use
        public static bool PromoteBySalary(Employee employee)
        {
            if (employee.Salary > 10000)
            {
                return true;
            }
            else
            {
                return false;
            }
        }
    }
}

لاحظ PromoteBySalary method اللي عملناها. الـ method دي فيها المنطق بتاع إزاي عايزين نرقي موظفينا. الـ method بعدين بتمرر كـ parameter للـ delegate. لاحظ كمان إن الـ method دي ليها نفس الـ signature بتاع EligibleToPromotion delegate. ده مهم جدًا لإن PromoteBySalary method مينفعش تتمرر كـ parameter للـ delegate لو الـ signature مختلف. ده هو السبب اللي بيخلي الـ delegates تتسمى type-safe function pointers.

لو مكانش عندنا مفهوم delegates، مكنش هيبقى ممكن نمرر function كـ parameter.

في C# 3.0، تم تقديم Lambda expressions. فتقدر تستخدم lambda expressions بدل ما تعمل function وبعدين instance من delegate. المثال التالي مكتوب تاني باستخدام Lambda expression. الـ PromoteBySalary method مبقاش مطلوب دلوقتي.

// Inside Main method
// The lambda expression defines the promotion logic inline
Employee.PromoteEmployee(lstEmployess, x => x.Experience > 5);

ده هيرقي أي موظف خبرته أكتر من 5 سنين.