【微软技术栈】C#.NET 异常的最佳做法

本文内容

1、使用 try/catch/finally 块从错误中恢复或释放资源

2、在不引发异常的前提下，处理常见情况

3、设计类，以避免异常

4、引发异常而不是返回错误代码

5、使用预定义的 .NET 异常类型

6、异常类名称的结尾为 Exception

7、在自定义异常类中包括三种构造函数

8、确保代码远程执行时异常数据可用

9、使用语法正确的错误消息

10、在每个异常中都包含一个本地化字符串消息

11、在自定义异常中，按需提供其他属性

12、放置引发语句，使得堆栈跟踪有所帮助

13、使用异常生成器方法

14、因发生异常而未完成方法时还原状态

15、捕获异常以在之后再次引发异常

 

---

设计良好的应用处理异常和错误以防止应用崩溃。 本文描述处理和创建异常的最佳做法。

1、使用 try/catch/finally 块从错误中恢复或释放资源

对可能生成异常的代码使用 try/catch 块，代码就可以从该异常中恢复。 在 catch 块中，始终按从派生程度最高到派生程度最低的顺序对异常排序。 所有异常都派生自 Exception 类。 位于处理基本异常类的 catch 子句之后的 catch 子句不处理派生程度较高的异常。 当代码无法从异常中恢复时，请勿捕获该异常。 如有可能，请启用调用堆栈中更上层的方法来进行恢复。

使用 using 语句或 finally 块清除分配的资源。 当引发了异常时，优先使用 using 语句自动清除资源。 使用 finally 块清除未实现 IDisposable 的资源。 即使引发了异常，通常也会执行 finally 子句中的代码。

2、在不引发异常的前提下，处理常见情况

对于易于发生但可能会触发异常的情况，请考虑使用能避免引发异常的方法进行处理。 例如，如果尝试关闭已关闭的连接，则会收到 InvalidOperationException。 尝试关闭前，可通过使用 if 语句检查连接状态，避免该情况。

if (conn.State != ConnectionState.Closed)
{
    conn.Close();
}

如果关闭前未检查连接状态，则可能捕获 InvalidOperationException 异常。

try
{
    conn.Close();
}
catch (InvalidOperationException ex)
{
    Console.WriteLine(ex.GetType().FullName);
    Console.WriteLine(ex.Message);
}

选择的方法取决于希望时间发生的频率。

• 如果此事件未经常发生（也就是说，如果此事件确实为异常事件并指示错误[如意外的文件尾]），则使用异常处理。 如果使用异常处理，将在正常条件下执行较少代码。

• 如果事件例行发生，且被视为正常性执行的一部分，请检查代码中是否存在错误情况。 检查常见错误情况时，为了避免异常，执行较少的代码。

3、设计类，以避免异常

类可提供一些方法或属性来确保避免生成会引发异常的调用。 例如，FileStream 类提供可帮助确实是否已到达文件末尾的方法。 这些方法可用于避免在读取超过文件末尾时引发的异常。 以下示例显示如何读取文件末尾而不会引发异常：

class FileRead
{
    public void ReadAll(FileStream fileToRead)
    {
        // This if statement is optional
        // as it is very unlikely that
        // the stream would ever be null.
        if (fileToRead == null)
        {
            throw new ArgumentNullException();
        }

        int b;

        // Set the stream position to the beginning of the file.
        fileToRead.Seek(0, SeekOrigin.Begin);

        // Read each byte to the end of the file.
        for (int i = 0; i < fileToRead.Length; i++)
        {
            b = fileToRead.ReadByte();
            Console.Write(b.ToString());
            // Or do something else with the byte.
        }
    }
}

避免异常的另一方法是，对最常见的错误案例返回 null（或默认值），而不是引发异常。 常见的错误案例可被视为常规控制流。 通过在这些情况下返回 NULL（或默认值），可最大程度地减小对应用的性能产生的影响。

对于值类型，是否使用 Nullable 或默认值作为错误指示符是应用需要考虑的内容。 通过使用 Nullable，default 变为 null 而非 Guid.Empty。 有时，添加 Nullable 可更加明确值何时存在或不存在。 在其他时候，添加 Nullable 可以创建额外的案例以查看不必要的内容，并且仅用于创建潜在的错误源。

4、引发异常而不是返回错误代码

异常可确保故障不被忽略，因为调用代码不会检查返回代码。

5、使用预定义的 .NET 异常类型

仅当预定义的异常类不适用时，引入新异常类。 例如：

• 如果根据对象的当前状态，属性集或方法调用不适当，则会引发 InvalidOperationException 异常。
• 如果传送了无效的参数，则引发 ArgumentException 异常或从 ArgumentException 派生的一个预定义类。

6、异常类名称的结尾为 Exception

需要自定义异常时，对其正确命名并从 Exception 类进行派生。 例如：

public class MyFileNotFoundException : Exception
{
}

7、在自定义异常类中包括三种构造函数

创建自己的异常类时，请至少使用三种公共构造函数：无参数构造函数、采用字符串消息的构造函数以及采用字符串消息和内部异常的构造函数。

• Exception()（使用默认值）。
• Exception(String)，它接受字符串消息。
• Exception(String, Exception)，它接受字符串消息和内部异常。

8、确保代码远程执行时异常数据可用

创建用户定义的异常时，请确保异常的元数据对远程执行的代码可用。

例如，在支持应用域的 .NET 实现中，应用域中可能会出现异常。 假设应用域 A 创建应用域 B，后者执行引发异常的代码。 应用域 A 若想正确捕获和处理异常，它必须能够找到包含应用域 B 所引发的异常的程序集。如果应用域 B 在其应用程序基下（但未在应用域 A 的应用程序基下）引发了一个包含在程序集内的异常，那么应用域 A 将无法找到异常，且公共语言运行时将引发 FileNotFoundException 异常。 为避免此情况，可采用两种方式之一部署包含异常信息的程序集：

• 将程序集放在两个应用域共享的公共应用程序基中。
• 如果两个应用域不共享一个公共应用程序基，则用强名称为包含异常信息的程序集签名并将其部署到全局程序集缓存中。

9、使用语法正确的错误消息

编写清晰的句子，包括结束标点。 分配给 Exception.Message 属性的字符串中的每个句子应以句点结尾。 例如，“记录表已溢出。”将是正确的消息字符串。

10、在每个异常中都包含一个本地化字符串消息

用户看到的错误消息派生自引发的异常的 Exception.Message 属性，而不是派生自异常类的名称。 通常将值赋给 Exception.Message 属性，方法是将消息字符串传递到异常构造函数的 message 参数。

对于本地化应用程序，应为应用程序可能引发的每个异常提供本地化消息字符串。 资源文件用于提供本地化错误消息。

11、在自定义异常中，按需提供其他属性

仅当存在附加信息有用的编程方案时，才在异常中提供附加属性（不包括自定义消息字符串）。 例如，FileNotFoundException 提供 FileName 属性。

12、放置引发语句，使得堆栈跟踪有所帮助

堆栈跟踪从引发异常的语句开始，到捕获异常的 catch 语句结束。

13、使用异常生成器方法

类从其实现中的不同位置引发同一异常是常见的情况。 为避免过多的代码，应使用帮助器方法创建异常并将其返回。 例如：

class FileReader
{
    private string fileName;

    public FileReader(string path)
    {
        fileName = path;
    }

    public byte[] Read(int bytes)
    {
        byte[] results = FileUtils.ReadFromFile(fileName, bytes);
        if (results == null)
        {
            throw NewFileIOException();
        }
        return results;
    }

    FileReaderException NewFileIOException()
    {
        string description = "My NewFileIOException Description";

        return new FileReaderException(description);
    }
}

在某些情况下，更适合使用异常的构造函数生成异常。 例如，ArgumentException 等全局异常类。

14、因发生异常而未完成方法时还原状态

当异常从方法引发时，调用方应能够假定没有副作用。 例如，如果你的代码可以通过从一个帐户取钱并存入另一个帐户来转移资金，而在存款时引发了异常，你不希望取款仍然有效。

public void TransferFunds(Account from, Account to, decimal amount)
{
    from.Withdrawal(amount);
    // If the deposit fails, the withdrawal shouldn't remain in effect.
    to.Deposit(amount);
}

上述方法不会直接引发任何异常。 但是，你必须编写该方法，以便在存款操作失败时撤消取款。

解决这一情况的一种方法是，捕获由存款交易引发的异常，然后回滚取款。

private static void TransferFunds(Account from, Account to, decimal amount)
{
    string withdrawalTrxID = from.Withdrawal(amount);
    try
    {
        to.Deposit(amount);
    }
    catch
    {
        from.RollbackTransaction(withdrawalTrxID);
        throw;
    }
}

此示例介绍如何使用 throw 再次引发原始异常，让调用方更轻松地找到问题的真正原因，而无需检查 InnerException 属性。 另一种方法是，引发一个新的异常并将原始异常包括在其中作为内部异常。

catch (Exception ex)
{
    from.RollbackTransaction(withdrawalTrxID);
    throw new TransferFundsException("Withdrawal failed.", innerException: ex)
    {
        From = from,
        To = to,
        Amount = amount
    };
}

15、捕获异常以在之后再次引发异常

若要捕获异常并保留其调用堆栈，以便能在之后再次引发该异常，请使用 System.Runtime.ExceptionServices.ExceptionDispatchInfo 类。 此类另外提供下列方法和属性：

• 使用 ExceptionDispatchInfo.Capture(Exception) 捕获异常和调用堆栈。
• 使用 ExceptionDispatchInfo.Throw() 还原捕获异常时保存的状态，并再次引发捕获的异常。
• 使用 ExceptionDispatchInfo.SourceException 属性检查捕获的异常。

以下示例演示 ExceptionDispatchInfo 的使用方法，以及可能产生的输出示例。

ExceptionDispatchInfo? edi = null;
try
{
    var txt = File.ReadAllText(@"C:\temp\file.txt");
}
catch (FileNotFoundException e)
{
    edi = ExceptionDispatchInfo.Capture(e);
}

// ...

Console.WriteLine("I was here.");

if (edi is not null)
    edi.Throw();

如果示例代码中的文件不存在，则会生成以下输出：

I was here.
Unhandled exception. System.IO.FileNotFoundException: Could not find file 'C:\temp\file.txt'.
File name: 'C:\temp\file.txt'
   at Microsoft.Win32.SafeHandles.SafeFileHandle.CreateFile(String fullPath, FileMode mode, FileAccess access, FileShare share, FileOptions options)
   at Microsoft.Win32.SafeHandles.SafeFileHandle.Open(String fullPath, FileMode mode, FileAccess access, FileShare share, FileOptions options, Int64 preallocationSize, Nullable`1 unixCreateMode)
   at System.IO.Strategies.OSFileStreamStrategy..ctor(String path, FileMode mode, FileAccess access, FileShare share, FileOptions options, Int64 preallocationSize, Nullable`1 unixCreateMode)
   at System.IO.Strategies.FileStreamHelpers.ChooseStrategyCore(String path, FileMode mode, FileAccess access, FileShare share, FileOptions options, Int64 preallocationSize, Nullable`1 unixCreateMode)
   at System.IO.StreamReader.ValidateArgsAndOpenPath(String path, Encoding encoding, Int32 bufferSize)
   at System.IO.File.ReadAllText(String path, Encoding encoding)
   at Example.ProcessFile.Main() in C:\repos\ConsoleApp1\Program.cs:line 12
--- End of stack trace from previous location ---
   at Example.ProcessFile.Main() in C:\repos\ConsoleApp1\Program.cs:line 24