创建和引发异常

项目
12/22/2023

异常用于指示在运行程序时发生了错误。此时将创建一个描述错误的异常对象，然后使用 throw 语句或表达式引发。然后，运行时搜索最兼容的异常处理程序。

当存在下列一种或多种情况时，程序员应引发异常：

方法无法完成其定义的功能。例如，如果一种方法的参数具有无效的值：

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

根据对象的状态，对某个对象进行不适当的调用。一个示例可能是尝试写入只读文件。在对象状态不允许操作的情况下，引发 InvalidOperationException 的实例或基于此类的派生的对象。以下代码是引发 InvalidOperationException 对象的方法示例：

public class ProgramLog
{
    FileStream logFile = null!;
    public void OpenLog(FileInfo fileName, FileMode mode) { }

    public void WriteLog()
    {
        if (!logFile.CanWrite)
        {
            throw new InvalidOperationException("Logfile cannot be read-only");
        }
        // Else write data to the log and return.
    }
}

方法的参数引发了异常。在这种情况下，应捕获原始异常，并创建 ArgumentException 实例。应将原始异常作为 InnerException 参数传递给 ArgumentException 的构造函数：
```
static int GetValueFromArray(int[] array, int index)
{
    try
    {
        return array[index];
    }
    catch (IndexOutOfRangeException e)
    {
        throw new ArgumentOutOfRangeException(
            "Parameter index is out of range.", e);
    }
}
```
注意

前面的示例演示了如何使用 InnerException 属性。这是有意简化的。在实践中，应先检查索引是否在范围内，然后再使用它。当参数成员引发在调用成员之前无法预料到的异常时，可以使用此方法来包装异常。

异常包含一个名为 StackTrace 的属性。此字符串包含当前调用堆栈上的方法的名称，以及为每个方法引发异常的位置（文件名和行号）。 StackTrace 对象由公共语言运行时 (CLR) 从 throw 语句的位置点自动创建，因此必须从堆栈跟踪的开始点引发异常。

所有异常都包含一个名为 Message 的属性。应设置此字符串来解释发生异常的原因。不应将安全敏感的信息放在消息文本中。除 Message 以外，ArgumentException 也包含一个名为 ParamName 的属性，应将该属性设置为导致引发异常的参数的名称。在属性资源库中，ParamName 应设置为 value。

公共的受保护方法在无法完成其预期功能时将引发异常。引发的异常类是符合错误条件的最具体的可用异常。这些异常应编写为类功能的一部分，并且原始类的派生类或更新应保留相同的行为以实现后向兼容性。

引发异常时应避免的情况

以下列表标识了引发异常时要避免的做法：

不要使用异常在正常执行过程中更改程序的流。使用异常来报告和处理错误条件。
只能引发异常，而不能作为返回值或参数返回异常。
请勿有意从自己的源代码中引发 System.Exception、System.SystemException、System.NullReferenceException 或 System.IndexOutOfRangeException。
不要创建可在调试模式下引发，但不会在发布模式下引发的异常。若要在开发阶段确定运行时错误，请改用调试断言。

任务返回方法中的异常

使用 async 修饰符声明的方法在出现异常时，有一些特殊的注意事项。方法 async 中引发的异常会存储在返回的任务中，直到任务即将出现时才会出现。有关存储的异常的详细信息，请参阅异步异常。

建议在输入方法的异步部分之前验证参数并引发任何相应的异常，例如 ArgumentException 和 ArgumentNullException。也就是说，在开始工作之前，这些验证异常应同步出现。以下代码片段演示了一个示例，其中，如果引发异常，ArgumentException 个异常将同步出现，而 InvalidOperationException 个将存储在返回的任务中。

// Non-async, task-returning method.
// Within this method (but outside of the local function),
// any thrown exceptions emerge synchronously.
public static Task<Toast> ToastBreadAsync(int slices, int toastTime)
{
    if (slices is < 1 or > 4)
    {
        throw new ArgumentException(
            "You must specify between 1 and 4 slices of bread.",
            nameof(slices));
    }

    if (toastTime < 1)
    {
        throw new ArgumentException(
            "Toast time is too short.", nameof(toastTime));
    }

    return ToastBreadAsyncCore(slices, toastTime);

    // Local async function.
    // Within this function, any thrown exceptions are stored in the task.
    static async Task<Toast> ToastBreadAsyncCore(int slices, int time)
    {
        for (int slice = 0; slice < slices; slice++)
        {
            Console.WriteLine("Putting a slice of bread in the toaster");
        }
        // Start toasting.
        await Task.Delay(time);

        if (time > 2_000)
        {
            throw new InvalidOperationException("The toaster is on fire!");
        }

        Console.WriteLine("Toast is ready!");

        return new Toast();
    }
}

定义异常的类别

程序可以引发 System 命名空间中的预定义异常类（前面提到的情况除外），或通过从 Exception 派生来创建其自己的异常类。派生类应该至少定义三个构造函数：一个无参数构造函数、一个用于设置消息属性，还有一个用于设置 Message 和 InnerException 属性。例如：

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

当新属性提供的数据有助于解决异常时，将新属性添加到异常类中。如果将新属性添加到派生异常类中，则应替代 ToString() 以返回添加的信息。

C# 语言规范

有关详细信息，请参阅 C# 语言规范中的异常和 throw 语句。该语言规范是 C# 语法和用法的权威资料。

另请参阅

异常层次结构