الواجهة Interface في C#: التصريح والتنفيذ والدوال الافتراضية وأمثلة

الواجهة (interface) عقد: قائمة مسمّاة من الأعضاء يعد نوع بتقديمها. تقول ما يستطيع النوع فعله ولا شيء عن الكيفية. تنفّذ الأصناف والبنى الواجهات، والشيفرة المكتوبة مقابل الواجهة تعمل مع كل تنفيذ، بما في ذلك تنفيذات تُكتب لاحقًا.

التصريح بواجهة وتنفيذها

تصرّح الواجهة بأعضاء بلا أجسام. وعُرفًا يبدأ اسمها بـ I. ينفّذها الصنف بذكرها بعد نقطتين وتقديم عضو عام لكل واحد منها:

using System;
using System.Collections.Generic;

interface IDiscount
{
    string Name { get; }
    decimal Apply(decimal price);
}

class PercentOff : IDiscount
{
    private readonly decimal percent;
    public PercentOff(decimal percent) { this.percent = percent; }

    public string Name => $"{percent}% off";
    public decimal Apply(decimal price) => price - price * percent / 100;
}

class FixedOff : IDiscount
{
    private readonly decimal amount;
    public FixedOff(decimal amount) { this.amount = amount; }

    public string Name => $"{amount} off";
    public decimal Apply(decimal price) => Math.Max(0, price - amount);
}

class Program
{
    static decimal BestPrice(decimal price, List<IDiscount> discounts)
    {
        decimal best = price;
        foreach (IDiscount d in discounts)
            best = Math.Min(best, d.Apply(price));
        return best;
    }

    static void Main()
    {
        var discounts = new List<IDiscount> { new PercentOff(15), new FixedOff(10) };
        foreach (var d in discounts)
            Console.WriteLine($"{d.Name}: {d.Apply(80m)}");

        Console.WriteLine($"Best for 80: {BestPrice(80m, discounts)}");
        Console.WriteLine($"Best for 40: {BestPrice(40m, discounts)}");
    }
}

المخرجات:

15% off: 68
10 off: 70
Best for 80: 68
Best for 40: 30

لا تعرف BestPrice شيئًا عن PercentOff أو FixedOff. لا تعتمد إلا على IDiscount، فإضافة صنف BuyOneGetOne لاحقًا لا تحتاج إلى أي تغيير فيها. هذا الفصل هو السبب الكامل لوجود الواجهات.

بضع قواعد عن التصريح:

• أعضاء الواجهة عامة افتراضيًا، ويجب أن تكون الأعضاء المنفّذة عامة أيضًا (ما لم تُنفَّذ صراحة، كما سيأتي).
• يمكن للواجهة التصريح بدوال وخصائص ومفهرسات وأحداث. ولا يمكنها التصريح بحقول مثيل أو مُنشئات.
• الصنف الذي يحذف عضوًا لا يُترجم: الخطأ CS0535، "'FixedOff' does not implement interface member 'IDiscount.Apply(decimal)'".
• لا يمكنك إنشاء واجهة بـ new. تنشئ صنفًا منفّذًا ويمكنك حمله في متغيّر من نوع الواجهة: IDiscount d = new FixedOff(5);.

الواجهة كنوع

يمكن التصريح بمتغيّر أو معامل أو حقل أو نوع إرجاع كواجهة. عندها يقبل أي كائن ينفّذها، ولا يكشف إلا أعضاء الواجهة. هكذا تكتب شيفرة لا يهمّها أي تنفيذ تتلقاه، وهكذا تستبدل الاختبارات نسخة وهمية:

public class Checkout
{
    private readonly IPaymentGateway gateway;          // not StripeGateway, not PayPalGateway
    public Checkout(IPaymentGateway gateway) { this.gateway = gateway; }

    public bool Pay(decimal amount) => gateway.Charge(amount);
}

// Production: new Checkout(new StripeGateway(apiKey))
// Unit test:  new Checkout(new FakeGateway(alwaysSucceeds: true))

حاويات حقن الاعتماديات في ASP.NET Core مبنية على هذا: تُسجَّل الخدمات وتُطلب بالواجهة.

تنفيذ عدة واجهات

للصنف صنف أساس واحد على الأكثر لكنه يستطيع تنفيذ أي عدد من الواجهات. الصنف الأساس أولًا، ثم الواجهات، مفصولة بفواصل:

using System;

interface IPrintable { string Print(); }
interface ISearchable { bool Matches(string term); }

class Document
{
    public string Title { get; }
    public Document(string title) { Title = title; }
}

class Invoice : Document, IPrintable, ISearchable
{
    public decimal Amount { get; }
    public Invoice(string title, decimal amount) : base(title) { Amount = amount; }

    public string Print() => $"INVOICE {Title}: {Amount:F2}";
    public bool Matches(string term) => Title.IndexOf(term, StringComparison.OrdinalIgnoreCase) >= 0;
}

class Program
{
    static void Main()
    {
        var inv = new Invoice("Studio rent March", 950m);

        IPrintable p = inv;
        ISearchable s = inv;
        Console.WriteLine(p.Print());
        Console.WriteLine(s.Matches("rent"));
        Console.WriteLine(inv is IPrintable);
    }
}

المخرجات:

INVOICE Studio rent March: 950.00
True
True

يمكن للواجهات أيضًا أن ترث من واجهات أخرى: تضيف interface IRepository<T> : IReadRepository<T> أعضاء إلى التي ترثها، ويجب على الصنف الذي ينفّذ IRepository<T> تقديم المجموعتين.

التنفيذ الصريح للواجهة

أحيانًا تصرّح واجهتان بعضو بالاسم نفسه ومعنيين مختلفين، أو لا يكون لعضو واجهة معنى على الواجهة العامة للصنف. نفّذه صراحة بوضع اسم الواجهة قبله وحذف معدّل الوصول:

using System;

interface ICsvRow { string Format(); }
interface IDisplayText { string Format(); }

class Product : ICsvRow, IDisplayText
{
    public string Name = "Desk lamp";
    public decimal Price = 34.90m;

    string ICsvRow.Format() => $"{Name},{Price}";
    string IDisplayText.Format() => $"{Name} for {Price:F2}";
}

class Program
{
    static void Main()
    {
        var lamp = new Product();

        Console.WriteLine(((ICsvRow)lamp).Format());
        IDisplayText shown = lamp;
        Console.WriteLine(shown.Format());
        // lamp.Format(); // error CS1061: 'Product' does not contain a definition for 'Format'
    }
}

المخرجات:

Desk lamp,34.90
Desk lamp for 34.90

العضو المنفّذ صراحة لا يمكن الوصول إليه إلا عبر الواجهة. يستخدم الإطار ذلك لإبعاد الضجيج عن الأنواع الشائعة: تنفّذ المصفوفات IList.Add صراحة (ترمي NotSupportedException، لأن المصفوفات ثابتة الحجم)، فلا تظهر الدالة حين تكتب array..

واجهات الإطار التي ستنفّذها

تنفيذ واجهة قياسية يوصل نوعك بشيفرة الإطار الموجودة. ثلاث منها تظهر باستمرار.

IComparable<T> تمنح النوع ترتيبًا طبيعيًا، تستخدمه List<T>.Sort() وArray.Sort وMax(). تعيد CompareTo رقمًا سالبًا أو صفرًا أو رقمًا موجبًا:

using System;
using System.Collections.Generic;

class Version : IComparable<Version>
{
    public int Major { get; }
    public int Minor { get; }
    public Version(int major, int minor) { Major = major; Minor = minor; }

    public int CompareTo(Version other)
    {
        if (other == null) return 1;
        int byMajor = Major.CompareTo(other.Major);
        return byMajor != 0 ? byMajor : Minor.CompareTo(other.Minor);
    }

    public override string ToString() => $"{Major}.{Minor}";
}

class Program
{
    static void Main()
    {
        var releases = new List<Version> { new Version(2, 10), new Version(2, 9), new Version(10, 0), new Version(1, 4) };
        releases.Sort();
        Console.WriteLine(string.Join(", ", releases));
    }
}

المخرجات:

1.4, 2.9, 2.10, 10.0

فرز الإصدارات نفسها كنصوص سيعطي 1.4, 10.0, 2.10, 2.9. ودون IComparable<T> ترمي Sort() استثناء InvalidOperationException لأنها لا تملك طريقة لمقارنة كائني Version.

IEnumerable<T> تجعل النوع قابلًا للاستخدام في foreach ومع LINQ. الطريقة السهلة لتنفيذ GetEnumerator هي yield return، المشروحة في صفحة IEnumerable وyield.

IDisposable تعلّم نوعًا يمسك شيئًا يجب تحريره (مقبض ملف، اتصال، مؤقّت). دالتها الوحيدة، Dispose، هي ما تستدعيه العبارة using حين تنتهي الكتلة، حتى إن رُمي استثناء:

using System;

class ReportFile : IDisposable
{
    private readonly string name;
    public ReportFile(string name) { this.name = name; Console.WriteLine($"open {name}"); }

    public void Write(string line) => Console.WriteLine($"  write to {name}: {line}");

    public void Dispose() => Console.WriteLine($"close {name}");
}

class Program
{
    static void Main()
    {
        using (var report = new ReportFile("sales.txt"))
        {
            report.Write("March total: 12400");
        }
        Console.WriteLine("after using");
    }
}

المخرجات:

open sales.txt
  write to sales.txt: March total: 12400
close sales.txt
after using

دوال الواجهة الافتراضية (C# 8)

كانت إضافة عضو إلى واجهة منشورة تكسر كل صنف ينفّذها. منذ C# 8 يمكن أن يكون لعضو الواجهة جسم، ترثه الأصناف المنفّذة ما لم تقدّم نسختها الخاصة:

public interface ILogger
{
    void Write(string message);

    // New in version 2 of the library. Existing implementers keep compiling.
    void Error(string message) => Write("ERROR: " + message);
}

public class ConsoleLogger : ILogger
{
    public void Write(string message) => Console.WriteLine(message);
}

ILogger log = new ConsoleLogger();
log.Error("disk full");            // ERROR: disk full

var direct = new ConsoleLogger();
// direct.Error("x");              // does not compile: the default method belongs to the interface

السطر الأخير هو الجزء الذي يفاجئ الناس: الدالة الافتراضية لا تُورث إلى أعضاء الصنف نفسه، فلا يمكن استدعاؤها إلا عبر نوع الواجهة. ولا تستطيع الدوال الافتراضية أيضًا استخدام حقول المثيل (لا حقول للواجهات)؛ بل تعمل عبر أعضاء الواجهة الأخرى. وتتطلب .NET Core 3.0 أو أحدث وليست متاحة في .NET Framework.

سمحت C# 8 أيضًا بالأعضاء الساكنة في الواجهات، وأضافت C# 11 الأعضاء الساكنة المجرّدة (static abstract)، التي تتيح للشيفرة العامة استدعاء دالة ساكنة أو معامل على T. وعلى هذا بُنيت الرياضيات العامة في .NET 7 (INumber<T> وwhere T : INumber<T>).

واجهة أم صنف مجرّد؟

استخدم واجهة لقدرة يمكن لأنواع غير مترابطة تشاركها، أو حين يجب أن تشارك البنى، أو حين يحتاج صنف إلى عدة أدوار من هذا النوع. واستخدم صنفًا مجرّدًا حين تكون التنفيذات تنويعات على شيء واحد وتتشارك حالة أو خوارزمية ثابتة. في صفحة الأصناف المجرّدة جدول مقارنة. وتصاميم كثيرة تستخدم الاثنين: واجهة للمستهلكين، وصنفًا أساسًا مجرّدًا ينفّذ الأجزاء المملة للمنفّذين.

أخطاء شائعة

• تنفيذ مفقود أو غير عام. كل عضو واجهة يحتاج إلى عضو عام بتوقيع مطابق، أو إلى تنفيذ صريح. وإلا CS0535 (أو CS0737 حين تكون الدالة موجودة لكنها غير عامة).
• واجهات بتنفيذ واحد "احتياطًا". تستحق الواجهة مكانها حين توجد عدة تنفيذات أو نسخة وهمية للاختبار. وإلا فهي ملف آخر للتنقل بينه.
• الواجهات المتضخمة. واجهة من عشرين عضوًا تجبر كل منفّذ على كتابة عشرين عضوًا. قسّمها إلى أدوار أصغر (IReader وIWriter) تجمعها الأصناف.
• تحويل واجهة إلى صنف. يلغي ((StripeGateway)gateway).Refund() الفصل. إن احتاج المستدعون إلى Refund فمكانها الواجهة.
• توقّع استدعاء دالة واجهة افتراضية على الصنف. يُوصل إليها عبر نوع الواجهة.