MK
摩柯社区 - 一个极简的技术知识社区
AI 面试

C#中的异常处理与调试技巧

2023-09-216.0k 阅读

异常处理基础

异常是什么

在C# 编程中，异常是在程序执行期间发生的错误或意外情况。当程序遇到无法正常处理的状况时，就会抛出异常。例如，试图访问数组越界的元素、除以零、文件不存在时尝试读取文件等操作都会引发异常。异常打破了程序正常的执行流程，迫使程序寻找相应的处理机制来应对这些错误，以免程序崩溃。

异常类层次结构

C# 中的所有异常类都继承自 System.Exception 类。这个类是整个异常类层次结构的根。其中，System.SystemException 类用于表示系统定义的异常，而 System.ApplicationException 类则可用于应用程序自定义异常，但通常建议直接从 System.Exception 派生自定义异常类。一些常见的预定义异常类如 System.ArgumentException（当向方法传递无效参数时抛出）、System.IO.FileNotFoundException（当试图访问不存在的文件时抛出）等。

try - catch - finally 块

try - catch - finally 块是C# 中处理异常的核心机制。

  • try 块：包含可能会抛出异常的代码。如果 try 块中的任何代码抛出异常，程序流程将立即跳转到相应的 catch 块。
try
{
    int[] numbers = { 1, 2, 3 };
    Console.WriteLine(numbers[3]); // 这里会抛出 IndexOutOfRangeException
}
  • catch 块：用于捕获并处理 try 块中抛出的异常。可以有多个 catch 块，每个 catch 块捕获特定类型的异常。
catch (IndexOutOfRangeException ex)
{
    Console.WriteLine($"捕获到异常: {ex.Message}");
}

在上述代码中，当 try 块中的代码访问数组越界元素时，会抛出 IndexOutOfRangeException 异常，catch 块捕获到该异常并输出异常信息。

  • finally 块：无论 try 块中是否抛出异常，也无论 catch 块是否捕获到异常，finally 块中的代码都会执行。它通常用于清理资源，如关闭文件、释放数据库连接等。
finally
{
    Console.WriteLine("这是 finally 块，总是会执行。");
}

完整示例如下：

try
{
    int[] numbers = { 1, 2, 3 };
    Console.WriteLine(numbers[3]);
}
catch (IndexOutOfRangeException ex)
{
    Console.WriteLine($"捕获到异常: {ex.Message}");
}
finally
{
    Console.WriteLine("这是 finally 块，总是会执行。");
}

异常处理的深入应用

捕获多个异常类型

在实际编程中，一段代码可能会抛出多种类型的异常。可以通过多个 catch 块来捕获不同类型的异常，并进行针对性处理。

try
{
    int num1 = 10;
    int num2 = 0;
    int result = num1 / num2; // 这里会抛出 DivideByZeroException
    string s = null;
    Console.WriteLine(s.Length); // 这里会抛出 NullReferenceException
}
catch (DivideByZeroException ex)
{
    Console.WriteLine($"捕获到除零异常: {ex.Message}");
}
catch (NullReferenceException ex)
{
    Console.WriteLine($"捕获到空引用异常: {ex.Message}");
}

在这个例子中，try 块中的代码可能会抛出 DivideByZeroException 和 NullReferenceException 两种异常，通过不同的 catch 块分别捕获并处理。

捕获通用异常

有时候，可能希望捕获任何类型的异常，可以使用 catch 块不指定异常类型，即通用的 catch 块。但这种方式应谨慎使用，因为它会捕获所有异常，可能掩盖真正的问题。

try
{
    // 可能抛出异常的代码
}
catch
{
    Console.WriteLine("捕获到一个异常。");
}

更推荐的做法是在捕获通用异常之前，先捕获特定类型的异常，以便进行更精确的处理。

try
{
    int[] numbers = { 1, 2, 3 };
    Console.WriteLine(numbers[3]);
}
catch (IndexOutOfRangeException ex)
{
    Console.WriteLine($"捕获到索引越界异常: {ex.Message}");
}
catch
{
    Console.WriteLine("捕获到其他类型的异常。");
}

异常过滤

从 C# 6.0 开始，可以使用异常过滤器来更精细地控制异常捕获。异常过滤器允许在 catch 块中添加额外的条件，只有当条件满足时，才会捕获异常。

try
{
    int num = -5;
    if (num < 0)
    {
        throw new ArgumentException("数字不能为负数", nameof(num));
    }
}
catch (ArgumentException ex) when (ex.ParamName == nameof(num))
{
    Console.WriteLine($"捕获到特定参数的异常: {ex.Message}");
}

在上述代码中，when 关键字后面的条件就是异常过滤器。只有当 ArgumentException 的 ParamName 属性等于 num 时，才会捕获该异常。

重新抛出异常

在某些情况下，捕获异常后可能需要进一步处理，然后将异常重新抛出，以便调用栈中的上层代码也能知晓这个异常。可以使用 throw; 语句重新抛出捕获的异常，这样可以保留原始异常的堆栈跟踪信息。

try
{
    int[] numbers = { 1, 2, 3 };
    Console.WriteLine(numbers[3]);
}
catch (IndexOutOfRangeException ex)
{
    Console.WriteLine($"在当前方法中进行了部分处理，重新抛出异常: {ex.Message}");
    throw;
}

也可以抛出一个新的异常，同时将原始异常作为新异常的内部异常，这样既可以提供更高层次的异常信息，又能保留底层异常的详细信息。

try
{
    int num1 = 10;
    int num2 = 0;
    int result = num1 / num2;
}
catch (DivideByZeroException ex)
{
    Exception newEx = new ApplicationException("业务层出现问题，与除零相关", ex);
    throw newEx;
}

自定义异常

为什么需要自定义异常

在实际应用开发中，预定义的异常类型可能无法满足特定业务逻辑的需求。例如，在一个用户注册系统中，当用户名已存在时，预定义的异常类型可能无法准确描述这种情况。这时就需要自定义异常来清晰地表达业务逻辑中的错误状况，使代码更具可读性和可维护性。

如何定义自定义异常

自定义异常类通常继承自 System.Exception 类。可以添加自定义的属性和方法，以提供更多关于异常的信息。

public class UsernameExistsException : Exception
{
    public string ExistingUsername { get; set; }

    public UsernameExistsException() : base() { }

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

    public UsernameExistsException(string message, string existingUsername) : base(message)
    {
        ExistingUsername = existingUsername;
    }
}

在上述代码中，定义了一个 UsernameExistsException 自定义异常类，它有一个 ExistingUsername 属性，用于存储已存在的用户名。构造函数有多种重载形式，方便在不同场景下创建异常实例。

使用自定义异常

在业务逻辑代码中，可以抛出并捕获自定义异常。

class UserRegistration
{
    private List<string> existingUsernames = new List<string>() { "John", "Jane" };

    public void RegisterUser(string username)
    {
        if (existingUsernames.Contains(username))
        {
            throw new UsernameExistsException($"用户名 {username} 已存在", username);
        }
        else
        {
            existingUsernames.Add(username);
            Console.WriteLine($"用户 {username} 注册成功。");
        }
    }
}

class Program
{
    static void Main()
    {
        UserRegistration registration = new UserRegistration();
        try
        {
            registration.RegisterUser("John");
        }
        catch (UsernameExistsException ex)
        {
            Console.WriteLine($"捕获到自定义异常: {ex.Message}，已存在的用户名: {ex.ExistingUsername}");
        }
    }
}

在这个例子中，UserRegistration 类的 RegisterUser 方法在检测到用户名已存在时，抛出 UsernameExistsException 异常。在 Main 方法中，通过 try - catch 块捕获并处理该自定义异常。

调试技巧

使用 Visual Studio 进行调试

Visual Studio 是C# 开发中常用的集成开发环境（IDE），它提供了强大的调试功能。

  • 设置断点：在代码编辑器中，点击代码行左侧的空白区域可以设置断点。当程序执行到断点处时，会暂停执行，此时可以查看变量的值、调用堆栈等信息。
int num1 = 10;
int num2 = 5;
int result = num1 + num2; // 在这行设置断点
Console.WriteLine($"结果是: {result}");
  • 调试工具栏：调试时，Visual Studio 会显示调试工具栏，通过它可以执行各种调试操作，如继续执行（F5）、逐语句执行（F11）、逐过程执行（F10）、跳出（Shift + F11）等。逐语句执行会进入方法内部，逐过程执行则会将方法调用作为一个整体执行，不会进入方法内部。
  • 查看变量：当程序暂停在断点处时，可以将鼠标悬停在变量上查看其当前值。也可以在“监视”窗口中添加要监视的变量，实时观察变量值的变化。
  • 调用堆栈：“调用堆栈”窗口显示了当前执行点的方法调用层次结构。可以通过它了解程序的执行路径，找到异常发生的源头。

日志记录

日志记录是一种重要的调试手段，它可以在程序运行过程中记录关键信息，如变量值、方法调用、异常发生等。在C# 中，可以使用第三方日志框架，如 NLog 或 Serilog。

  • NLog 示例：首先安装 NLog 包，可以通过 NuGet 包管理器进行安装。
<package id="NLog" version="4.7.11" targetFramework="netcoreapp3.1" />

然后在代码中配置并使用 NLog。

using NLog;
using System;

class Program
{
    private static readonly Logger logger = LogManager.GetCurrentClassLogger();

    static void Main()
    {
        try
        {
            int num1 = 10;
            int num2 = 0;
            int result = num1 / num2;
        }
        catch (DivideByZeroException ex)
        {
            logger.Error(ex, "发生除零异常");
        }
    }
}

在上述代码中，当发生除零异常时，NLog 会将异常信息记录到配置的日志文件或其他目标中，方便后续分析。

断言

断言是一种在开发阶段用于验证假设的机制。如果断言条件为 false，程序会抛出 System.Diagnostics.AssertFailedException 异常并终止执行（在调试版本中）。在C# 中，可以使用 System.Diagnostics.Debug.Assert 方法或 System.Diagnostics.Trace.Assert 方法。

using System.Diagnostics;

class Program
{
    static void Main()
    {
        int num = -5;
        Debug.Assert(num >= 0, "数字必须为非负数");
        // 如果 num 小于 0，在调试版本中会抛出 AssertFailedException
    }
}

Debug.Assert 主要用于调试版本，而 Trace.Assert 可以在调试和发布版本中使用，但通常在发布版本中会被优化掉，不会影响性能。通过断言，可以在开发过程中尽早发现不符合预期的情况，有助于提高代码的可靠性。

代码分析工具

Visual Studio 自带了代码分析工具，如 FxCop（现在集成在 Visual Studio 分析工具中）。它可以对代码进行静态分析，检查代码是否符合最佳实践、是否存在潜在的错误等。在项目属性中，可以启用代码分析，分析结果会在“错误列表”窗口中显示。例如，代码分析可能会提示未使用的变量、空的 catch 块等问题，帮助开发者及时发现并修正代码中的潜在风险。

通过合理运用异常处理机制和各种调试技巧，可以使C# 程序更加健壮、可靠，提高开发效率和代码质量。无论是处理运行时错误，还是在开发过程中排查问题，这些技术都是开发者不可或缺的工具。