try catch في C#: معالجة الاستثناءات بـ catch وwhen وfinally

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

try catch أساسية

غلّف الشيفرة التي قد تفشل في try، وعالج الفشل في catch:

using System;

class Program
{
    static void Main()
    {
        string[] inputs = { "42", "forty-two", "7" };

        foreach (string input in inputs)
        {
            try
            {
                int n = int.Parse(input);
                Console.WriteLine(input + " doubled is " + (n * 2));
            }
            catch (FormatException)
            {
                Console.WriteLine("'" + input + "' is not a number");
            }
        }
        Console.WriteLine("Still running");
    }
}

المخرجات:

42 doubled is 84
'forty-two' is not a number
7 doubled is 14
Still running

حين ترمي int.Parse("forty-two") تُتخطّى Console.WriteLine التي بعدها في كتلة try، وتُنفَّذ كتلة catch (FormatException)، وتستمر الحلقة. يمكنك حذف المتغيّر (catch (FormatException)) حين لا تحتاج إلى كائن الاستثناء.

لهذه الحالة بالذات أداة أفضل: تعيد int.TryParse(input, out int n) القيمة false بدل رمي استثناء. الاستثناءات للحالات التي لا تتوقعها الشيفرة؛ أما المدخلات التي تكون غالبًا غير صالحة فمتوقعة، فافحصها بدل التقاطها.

كيف ينتقل الاستثناء

الاستثناء المرمي في عمق سلسلة استدعاءات يفكّ كل دالة حتى يجد معالجًا مطابقًا. الشيفرة التي بعد الرمي في كل من تلك الدوال لا تُنفَّذ.

using System;
using System.Collections.Generic;

class Program
{
    static Dictionary<string, decimal> prices = new Dictionary<string, decimal>
    {
        ["tea"] = 2.50m,
    };

    static decimal PriceOf(string item)
    {
        return prices[item];                         // throws for a missing item
    }

    static decimal OrderTotal(string item, int qty)
    {
        decimal total = PriceOf(item) * qty;
        Console.WriteLine("OrderTotal finished");    // skipped when PriceOf throws
        return total;
    }

    static void Main()
    {
        try
        {
            Console.WriteLine(OrderTotal("tea", 2));
            Console.WriteLine(OrderTotal("cake", 1));
            Console.WriteLine("not reached");
        }
        catch (KeyNotFoundException e)
        {
            Console.WriteLine("Caught " + e.GetType().Name + " in Main");
        }
    }
}

المخرجات:

OrderTotal finished
5.00
Caught KeyNotFoundException in Main

لا catch في PriceOf وOrderTotal، فيمرّ الاستثناء عبرهما مباشرة إلى Main. ضع معالجًا في المستوى الذي يعرف ما يفعله إزاء الفشل، وهو غالبًا ليس حيث حدث.

التقاط استثناءات محددة، بالترتيب الصحيح

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

using System;

class Program
{
    static void Divide(string a, string b)
    {
        try
        {
            int x = int.Parse(a);
            int y = int.Parse(b);
            Console.WriteLine(a + " / " + b + " = " + (x / y));
        }
        catch (DivideByZeroException)
        {
            Console.WriteLine("Cannot divide by zero");
        }
        catch (FormatException)
        {
            Console.WriteLine("Both values must be whole numbers");
        }
        catch (Exception e)
        {
            Console.WriteLine("Unexpected: " + e.GetType().Name);
        }
    }

    static void Main()
    {
        Divide("10", "2");
        Divide("10", "0");
        Divide("ten", "2");
        Divide("99999999999", "1"); // too large for int
    }
}

المخرجات:

10 / 2 = 5
Cannot divide by zero
Both values must be whole numbers
Unexpected: OverflowException

يرمي الاستدعاء الأخير OverflowException، التي لا يعالجها أي من البندين المحددين، فيعالجها البند العام catch (Exception e). ووضع catch (Exception) أولًا يجعل البنود التي بعده غير قابلة للوصول، ويرفض المترجم ذلك بالخطأ CS0160.

مرشّحات الاستثناء بـ when

أضافت C# 6 البند when: شرط يقرّر هل ينطبق بند catch. إن كان false يواصل وقت التشغيل البحث عن معالج آخر كأن البند غير موجود.

using System;

class ApiException : Exception
{
    public int StatusCode { get; }
    public ApiException(int statusCode) : base("HTTP " + statusCode)
    {
        StatusCode = statusCode;
    }
}

class Program
{
    static void Call(int status)
    {
        try
        {
            throw new ApiException(status);
        }
        catch (ApiException e) when (e.StatusCode == 404)
        {
            Console.WriteLine("Not found: show an empty page");
        }
        catch (ApiException e) when (e.StatusCode >= 500)
        {
            Console.WriteLine("Server error " + e.StatusCode + ": retry later");
        }
        catch (Exception e) when (e is ArgumentException || e is FormatException)
        {
            Console.WriteLine("Bad input");
        }
    }

    static void Main()
    {
        Call(404);
        Call(503);
        try
        {
            Call(401); // no clause matches: it propagates
        }
        catch (ApiException e)
        {
            Console.WriteLine("Unhandled by Call: " + e.Message);
        }
    }
}

المخرجات:

Not found: show an empty page
Server error 503: retry later
Unhandled by Call: HTTP 401

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

finally: شيفرة تُنفَّذ دائمًا

تُنفَّذ كتلة finally حين يغادر التحكم try، سواء انتهت، أو عادت مبكرًا، أو رمت استثناءً. هناك مكان التنظيف. (تحفّظ واحد: إن لم يلتقط شيء في أي مكان الاستثناء، فقد تنتهي العملية دون تنفيذها.)

using System;

class Program
{
    static string Process(int step)
    {
        Console.WriteLine("Open connection");
        try
        {
            if (step == 1) return "returned early";
            if (step == 2) throw new InvalidOperationException();
            return "finished";
        }
        catch (InvalidOperationException)
        {
            return "handled error";
        }
        finally
        {
            Console.WriteLine("Close connection");
        }
    }

    static void Main()
    {
        Console.WriteLine(Process(0));
        Console.WriteLine(Process(1));
        Console.WriteLine(Process(2));
    }
}

المخرجات:

Open connection
Close connection
finished
Open connection
Close connection
returned early
Open connection
Close connection
handled error

في كل حالة تُطبع "Close connection" قبل أن تصل نتيجة الدالة إلى Main: تُنفَّذ finally بعد حساب قيمة return لكن قبل أن تعود الدالة فعلًا. ويمكن أن تملك try كتلة finally دون أي catch، فتنظّف مع ترك الاستثناء يستمر إلى المستدعي.

للكائنات التي تنفّذ IDisposable (الملفات والتدفقات والاتصالات) تكتب العبارة using هذه try/finally عنك.

إعادة الرمي: throw; مقابل throw e;

أحيانًا تسجّل كتلة catch شيئًا أو تحفظه ثم تترك الاستثناء يستمر. طريقة إعادة الرمي تقرّر هل ينجو أثر المكدّس:

using System;
using System.Runtime.CompilerServices;

class Program
{
    // NoInlining keeps this small method as its own frame in the stack trace.
    [MethodImpl(MethodImplOptions.NoInlining)]
    static void LoadConfig()
    {
        throw new InvalidOperationException("config file missing");
    }

    static void RethrowKeep()
    {
        try { LoadConfig(); }
        catch (InvalidOperationException) { throw; }      // original trace
    }

    static void RethrowReset()
    {
        try { LoadConfig(); }
        catch (InvalidOperationException e) { throw e; }  // trace restarts here
    }

    static void Main()
    {
        try { RethrowKeep(); }
        catch (Exception e)
        {
            Console.WriteLine("throw;   trace mentions LoadConfig: " + e.StackTrace.Contains("LoadConfig"));
        }

        try { RethrowReset(); }
        catch (Exception e)
        {
            Console.WriteLine("throw e; trace mentions LoadConfig: " + e.StackTrace.Contains("LoadConfig"));
        }
    }
}

المخرجات:

throw;   trace mentions LoadConfig: True
throw e; trace mentions LoadConfig: False

تعامل throw e; الاستثناء كأنه رُمي حديثًا من كتلة catch، فتختفي من الأثر الإطارات التي تحتها، بما في ذلك الدالة التي حدث فيها الخطأ. أعد الرمي دائمًا بـ throw; مجردة. (السمة NoInlining موجودة فقط لأن JIT قد يدمج دالة بهذا الصغر في مستدعيها، فيخفيها من الأثرين.)

لإضافة سياق بدلًا من ذلك غلّف الاستثناء في واحد جديد ومرّر الأصلي كاستثناء داخلي: throw new ConfigException("Could not start the app", e);. يحتفظ الاستثناء الداخلي بأثر مكدّسه الخاص، وتطبع أدوات التسجيل السلسلة. وكتابة أنواع استثناءاتك الخاصة مشروحة في رمي الاستثناءات.

كائن Exception

كل استثناء مشتق من System.Exception. الأعضاء التي تستخدمها أكثر:

سجّل e.ToString() بدل e.Message حين تريد تشخيص فشل لاحقًا: الرسالة وحدها نادرًا ما تقول أين كانت المشكلة. ولا تعرض e.ToString() على المستخدمين النهائيين.

أنواع الاستثناءات الشائعة

تعني NullReferenceException وIndexOutOfRangeException وInvalidCastException دائمًا تقريبًا خطأً برمجيًا. أصلح الشيفرة بدل التقاطها.

عدم ابتلاع الاستثناءات

كتلة catch الفارغة تخفي كل خطأ، بما في ذلك التي لم تتوقعها:

try
{
    SaveOrder(order);
}
catch (Exception)
{
    // nothing: the order silently was not saved
}

يستمر البرنامج في العمل كأن الحفظ نجح، ويضيع السبب الحقيقي. إرشادات تبقي معالجة الاستثناءات صادقة:

• لا تلتقط إلا ما تستطيع معالجته، في المستوى الذي يستطيع معالجته.
• إن التقطت للتسجيل فأعد الرمي بـ throw; ما لم يكن البرنامج قادرًا فعلًا على المتابعة.
• لا تلتقط Exception إلا عند الحافة الخارجية: Main، أو معالج طلب، أو حلقة عامل.
• فضّل TryParse وTryGetValue وفحوص null على الاستثناءات للحالات المتوقعة. الرمي بطيء مقارنة بالفحص، بينما كتلة try التي لا ترمي شيئًا لا تكلّف شيئًا تقريبًا.

أخطاء شائعة

• catch (Exception) أولًا. تصبح البنود اللاحقة غير قابلة للوصول (CS0160).
• throw e; لإعادة الرمي. تمحو أثر المكدّس الأصلي؛ استخدم throw;.
• كتل catch فارغة. تختفي الأخطاء؛ على الأقل سجّل وأعد الرمي.
• استخدام الاستثناءات للتحكم في التدفق. تحقّق من المدخلات بـ TryParse بدل التقاط FormatException.
• عرض e.Message لاستثناء من الإطار على المستخدمين. تختلف الصياغة بين إصدارات .NET وهي مكتوبة للمطوّرين.