.NET Exception Handling

前言

最近還是常常看到同仁在處理 Exception 時，將 Exception throw 出去，但這樣前面的 StackTrace 就會斷掉了哦!

研究

許多人常常很習慣地將 ex throw 出去，如下，

try
{
    //exception code here
}
catch (Exception ex){
    // do somthing
    thorw ex;
}

比較好的應該只要寫 throw 就會有完整的 StackTrace 資料，如下，

try
{
    //exception code here
}
catch (Exception ex){
    // do somthing
    thorw;
}

throw new Exception

• 參數值無效
  一般我們在驗證參數時，如果參數值無效時，可以用 System.ArgumentException ，而參數可以使用 nameof([參數])，如下，

static void CopyObject(SampleClass original)
{
    if (original == null)
    {
        throw new System.ArgumentException("Parameter cannot be null", nameof(original));
    }
}

如果某參數發生了 IndexOutOfRangeException，則可以將它傳入 ArgumentException 作為 InnerException 參數，如下，

static int GetValueFromArray(int[] array, int index)
{
    try
    {
        return array[index];
    }
    catch (System.IndexOutOfRangeException ex)
    {
        System.ArgumentException argEx = new System.ArgumentException("Index is out of range", "index", ex);
        throw argEx;
    }
}

• 不適當的操作，則可以使用 System.InvalidOperationException

自定的 Exception Class

我們可以繼承自 Exception ，並且可序列化，至少需要 4 個建構函式:

1. 預設建構函式
2. 設定 Message 的建構函式
3. 同時設定 Message 和 InnerException 屬性的建構函式
4. 是用來序列化例外狀況。
   如下，

[Serializable()]
public class InvalidDepartmentException : System.Exception
{
    public InvalidDepartmentException() : base() { }
    public InvalidDepartmentException(string message) : base(message) { }
    public InvalidDepartmentException(string message, System.Exception inner) : base(message, inner) { }

    // A constructor is needed for serialization when an
    // exception propagates from a remoting server to the client.
    protected InvalidDepartmentException(System.Runtime.Serialization.SerializationInfo info,
        System.Runtime.Serialization.StreamingContext context) { }
}

詳細可以參考 建立和擲回例外狀況。
如果程式中有一堆的 try…catch ，則可以參考 包裝程式中共用的 try…catch 透過共用的 try…catch 去封裝。

實作練習

我們可以學習 JsonException Class的設計方式，來練習。

以下為Error Handling in C# with Exceptions的範例，大家可以參考一下哦!

[Serializable()]
class CalculationException : Exception
{
    private static readonly string DefaultMessage = "CalculationException 預設Message";
    public CalculationException() : base(DefaultMessage)
    {}

    public CalculationException(string message) : base(message)
    {}

    public CalculationException(Exception innerException)
        : base (DefaultMessage, innerException)
    {}

    public CalculationException(string message, Exception innerException)
        : base (message, innerException)
    {}
}

[Serializable()]
class CalculationOperationNotSupportedException : CalculationException
{
    public string Operation { get; }

    public CalculationOperationNotSupportedException()
        : base("Specified operation was out of the range of valid values.")
    {}

    public CalculationOperationNotSupportedException(string operation)
        : this()
    {
        Operation = operation;
    }
    public CalculationOperationNotSupportedException(string message,
        Exception innerException) : base (message, innerException)
    {}

    public CalculationOperationNotSupportedException(string operation, string message)
        : base (message)
    {
        Operation = operation;
    }

    public override string Message
    {
        get
        {
            string message = base.Message;
            if (Operation != null)
            {
                return message + Environment.NewLine +
                    $"不支援的運算: {Operation}";
            }
            return message;
        }
    }
}

CalculationException 繼承自 Exception ，而 CalculationOperationNotSupportedException 繼承自 CalculationException ，因為有運算子，所以 建構函數多了一個運算子的參數 。並且覆寫 Message 的屬性，讓 Message 可讀性更高。測試程式如下，

static void Main(string[] args)
{
	//處理非預期的錯誤
	AppDomain currentAppDomain = AppDomain.CurrentDomain;
	currentAppDomain.UnhandledException
		+= new UnhandledExceptionEventHandler(HandleException);

	WriteLine("請輸入第一個數值");
	int number1 = int.Parse(ReadLine());

	WriteLine("請輸入第二個數值");
	int number2 = int.Parse(ReadLine());

	WriteLine("請輸入運算子");
	string op = ReadLine().ToUpperInvariant();


	var calculator = new Calculator();

	try
	{
		int result = calculator.Calculate(number1, number2, op);
		WriteLine($"結果為: {result}");
	}
	catch (CalculationException ex)
	{
		// Log.Error(ex);
		WriteLine(ex);
	}
	catch (Exception ex)
	{
		WriteLine($"發生了錯誤. {ex}");
	}
	finally
	{
		WriteLine("... finally ...");
	}

	WriteLine("\n請輸入 enter 離開");
	ReadLine();
}

private static void HandleException(object sender, UnhandledExceptionEventArgs e)
{
	WriteLine($"發生非預期的錯誤: {e.ExceptionObject}");
}

當輸入了不 support 的 運算子，output 如下，

參考資料

包裝程式中共用的 try…catch
建立和擲回例外狀況
JsonException Class
Error Handling in C# with Exceptions