异常实践 | 优雅，永不过时

原创

GoBoy

发布于 2023-12-11 13:10:52

3842

发布于 2023-12-11 13:10:52

文章被收录于专栏：GoboyGoboy

异常处理在实际编程中是一个重要的方面，以下是一些异常处理的实践方法和建议。

实践方法和建议仅代表个人观点，如有相似，不胜荣幸。

明确知道何时捕获异常

理解何时明确捕获异常涉及到在代码中精确判断异常情况并进行相应的处理，不要简单地将所有异常都捕获，并且不要隐藏异常，以免给调试和维护带来困难。以下是几个方面的考虑：

了解方法可能抛出的异常

在调用一个可能抛出异常的方法时，查阅相关文档或源代码，了解可能抛出的异常类型和异常产生的原因。

识别需要处理的异常

识别哪些异常是你的代码可以处理的，即你知道如何通过某种方式进行恢复、记录或通知用户。

区分异常和错误

区分哪些异常是程序可以预期并通过代码处理的，而哪些是不可预测、严重的错误，后者可能需要终止程序或进行其他非常规处理。

捕获异常的目的

明确捕获异常的目的是为了在出现问题时进行合适的响应，而不是简单地忽略或随意捕获所有异常。

合理使用多个 catch 块

使用多个 catch 块，每个块捕获一种类型的异常，确保对不同类型的异常进行不同的处理。

try {
    // 可能抛出不同类型的异常
} catch (IOException e) {
    // 处理文件操作相关的异常
} catch (SQLException e) {
    // 处理数据库操作相关的异常
}

避免过度捕获异常

避免过度捕获所有异常，只捕获你知道如何处理的异常，以防止隐藏问题并使代码更易于调试。

try {
    // 可能抛出异常
} catch (Exception e) {
    // 避免空的 catch 块
}

抛出合适的自定义异常

在方法中抛出适当的自定义异常，以提供更有意义的错误信息，帮助调用者理解发生了什么问题。

public void validateInput(String input) throws InvalidInputException {
    if (input == null || input.isEmpty()) {
        throw new InvalidInputException("Input cannot be null or empty.");
    }
}

记录异常信息

在 catch 块中至少记录异常信息，这对于调试和问题排查非常有帮助。

try {
    // 可能抛出异常
} catch (Exception e) {
    e.printStackTrace(); // 记录异常信息
}

使用具体的异常类型

尽量使用具体的异常类型而不是通用的 Exception ，具体的异常类型是良好的编程实践，有助于更准确地处理不同类型的异常情况，提高代码的可读性和可维护性。以下是一些关于使用具体异常类型的指导原则：

更精确的错误识别

使用具体的异常类型可以更准确地识别发生的问题。这有助于理解异常的来源和原因，从而更容易修复问题。

try {
    // 可能抛出异常
} catch (FileNotFoundException e) {
    // 处理文件不存在的异常
} catch (IOException e) {
    // 处理其他文件操作相关的异常
}

提高代码可读性

使用具体的异常类型使得代码更易读懂。通过查看异常类型，可以清晰地了解可能发生的错误情况。

try {
    // 可能抛出异常
} catch (SQLException e) {
    // 处理数据库操作相关的异常
} catch (NumberFormatException e) {
    // 处理字符串转换为数字的异常
}

精确的异常处理逻辑

每种异常类型可能需要不同的处理逻辑。使用具体的异常类型可以为每个异常提供适当的处理，而不是在一个 catch 块中处理所有异常。

try {
    // 可能抛出不同类型的异常
} catch (FileNotFoundException e) {
    // 处理文件不存在的异常
} catch (IOException e) {
    // 处理其他文件操作相关的异常
} catch (SQLException e) {
    // 处理数据库操作相关的异常
}

提高可维护性

使用具体的异常类型使得代码更易维护。在代码中指定明确的异常类型可以帮助维护人员更容易理解和修改异常处理逻辑。

try {
    // 可能抛出异常
} catch (FileNotFoundException e) {
    // 处理文件不存在的异常
} catch (IOException e) {
    // 处理其他文件操作相关的异常
}

减少不必要的捕获

使用具体的异常类型可以减少不必要的捕获。捕获过于宽泛的异常可能导致隐藏问题，而使用具体的异常类型可以帮助精确定位问题。

try {
    // 可能抛出异常
} catch (Exception e) {
    // 避免空的 catch 块
}

合理使用多个 catch 块

如果你的代码可能引发多种异常，使用多个 catch 块分别处理不同类型的异常，而不是在一个 catch 块中处理所有异常。合理使用多个 catch 块是一种有效的异常处理策略，可以根据不同类型的异常提供特定的处理逻辑。

按照异常的具体性处理

将最具体的异常类型的 catch 块放在前面，逐渐向上放置更通用的异常类型。这样可以确保每个异常都有机会被正确处理，而不会被更通用的 catch 块拦截。

try {
    // 可能抛出不同类型的异常
} catch (FileNotFoundException e) {
    // 处理文件不存在的异常
} catch (IOException e) {
    // 处理其他文件操作相关的异常
} catch (SQLException e) {
    // 处理数据库操作相关的异常
}

避免捕获冗余异常

避免使用冗余的 catch 块，即捕获的异常已经在之前的 catch 块中处理过了。这样可以防止重复处理同一异常。

try {
    // 可能抛出异常
} catch (FileNotFoundException e) {
    // 处理文件不存在的异常
} catch (IOException e) {
    // 避免再次处理文件操作相关的异常
}

每个 catch 块专注于一种异常类型

每个 catch 块应该专注于处理一种特定类型的异常，避免在一个 catch 块中处理多种不同类型的异常。这有助于保持代码的清晰性和可读性。

try {
    // 可能抛出异常
} catch (FileNotFoundException | IOException e) {
    // 避免在同一个 catch 块中处理多种异常类型
}

适当记录异常信息

在每个 catch 块中适当记录异常信息，以便在调试和排查问题时有更多的上下文信息。

try {
    // 可能抛出异常
} catch (FileNotFoundException e) {
    // 处理文件不存在的异常
    e.printStackTrace();
} catch (IOException e) {
    // 处理其他文件操作相关的异常
    e.printStackTrace();
} catch (SQLException e) {
    // 处理数据库操作相关的异常
    e.printStackTrace();
}

使用多个 catch 块处理不同分支逻辑：

在每个 catch 块中可以提供针对不同异常类型的处理逻辑，以确保每个异常都能够得到适当的处理。

try {
    // 可能抛出不同类型的异常
} catch (FileNotFoundException e) {
    // 处理文件不存在的异常
} catch (IOException e) {
    // 处理其他文件操作相关的异常
} catch (SQLException e) {
    // 处理数据库操作相关的异常
}

使用多个 catch 块可以使异常处理更具体、清晰，从而提高代码的可读性和可维护性。

使用 finally 块进行资源释放

如果使用了需要手动关闭的资源（如文件、网络连接），将释放资源的代码放在 finally 块中确保资源的正确释放。使用 finally 块进行资源释放是一种良好的编程实践，确保资源在不论是否发生异常的情况下都能被正确释放。

确保资源释放

finally 块中的代码会在 try 块中的代码执行后无论是否发生异常都会被执行。这确保了资源的正确释放，无论代码是否抛出异常。

FileInputStream fileInputStream = null;
try {
    fileInputStream = new FileInputStream("example.txt");
    // 使用 fileInputStream 进行文件操作
} catch (IOException e) {
    // 处理文件操作相关的异常
} finally {
    if (fileInputStream != null) {
        try {
            fileInputStream.close();
        } catch (IOException e) {
            // 处理关闭文件流的异常
        }
    }
}

避免资源泄漏

使用 finally 块可以避免资源泄漏，即在使用资源后忘记释放。确保在 finally 块中释放所有可能泄漏的资源。

BufferedReader bufferedReader = null;
try {
    bufferedReader = new BufferedReader(new FileReader("example.txt"));
    // 使用 bufferedReader 进行文件读取
} catch (IOException e) {
    // 处理文件读取相关的异常
} finally {
    if (bufferedReader != null) {
        try {
            bufferedReader.close();
        } catch (IOException e) {
            // 处理关闭文件读取流的异常
        }
    }
}

确保清理操作执行

finally 块中的代码是在 try 块中的代码执行后执行的，这意味着不论是否发生异常，清理操作都会得到执行。

Connection connection = null;
try {
    connection = DriverManager.getConnection("jdbc:mysql://localhost:3306/example", "user", "password");
    // 进行数据库操作
} catch (SQLException e) {
    // 处理数据库操作相关的异常
} finally {
    if (connection != null) {
        try {
            connection.close();
        } catch (SQLException e) {
            // 处理关闭数据库连接的异常
        }
    }
}

使用 try-with-resources 简化代码

如果资源实现了 AutoCloseable 或 Closeable 接口，可以使用 try-with-resources 语句来自动关闭资源，无需显式使用 finally 块。

try (FileInputStream fileInputStream = new FileInputStream("example.txt")) {
    // 使用 fileInputStream 进行文件操作
} catch (IOException e) {
    // 处理文件操作相关的异常
}

不要忽略异常

不要简单地将异常抛弃或者使用空的 catch 块。这样可能导致问题的隐藏和难以调试。忽略异常是一个非常不好的实践，因为它可能导致潜在的问题被掩盖，使得调试和问题排查变得更加困难。

问题追踪困难

如果异常被忽略，当程序出现问题时，将失去异常提供的关键信息。这使得问题的定位和修复变得更加困难。

代码健壮性下降

忽略异常可能导致程序的健壮性下降，因为它无法适应潜在的错误情况。及时处理异常有助于提高代码的稳定性。

安全性问题

在一些情况下，忽略异常可能导致安全性问题。例如，如果一个文件操作失败但异常被忽略，可能导致未经授权的访问。

更好的用户体验

对异常进行适当处理可以提供更好的用户体验。通过向用户提供有意义的错误消息，用户能够更好地理解发生了什么问题。

及时发现潜在问题

处理异常可以帮助你及时发现潜在的问题并采取适当的措施，而不是等到问题变得严重才意识到。

避免忽略异常的方式包括在 catch 块中至少记录异常信息，采取适当的处理措施，或者向上层抛出异常以通知调用者。以下是一个简单的例子：

try {
    // 可能抛出异常
} catch (IOException e) {
    // 记录异常信息
    e.printStackTrace();

    // 采取适当的处理措施，如提供友好的错误提示
    showMessageDialog("发生了文件操作相关的错误，请稍后重试。");
}

要时刻注意异常的存在，确保在代码中进行适当的异常处理，以提高程序的健壮性和可维护性。

不要捕获 Throwable 类

捕获 Throwable 类是一个不好的实践，因为它包括了所有可抛出的异常和错误，包括 Error 类型的错误。Throwable 是 Exception 和 Error 的根类，如果捕获了 Throwable，它将捕获到所有可能的异常和错误，甚至包括 Java 虚拟机无法恢复的严重问题。

不可恢复的错误

Throwable 包括 Error 类型，而 Error 通常表示无法恢复的、严重的问题，例如内存溢出。捕获这些错误可能导致程序处于不稳定状态。

不精确的异常处理

捕获 Throwable 会导致异常处理变得非常宽泛，无法精确地识别和处理特定类型的异常。这可能会掩盖真正需要关注的问题。

不符合最佳实践

按照最佳实践，应该捕获具体的异常类型，而不是捕获过于通用的 Throwable。这有助于更好地理解和处理代码中可能发生的问题。

try {
    // 可能抛出异常
} catch (Throwable t) {
    // 避免捕获 Throwable 类型
    t.printStackTrace();
}

代替捕获 Throwable，应该根据实际情况捕获具体的异常类型，例如 Exception 或其子类，以及可能的自定义异常。这有助于确切地知道可能发生的问题，以便进行适当的处理。

try {
    // 可能抛出异常
} catch (IOException e) {
    // 处理文件操作相关的异常
} catch (SQLException e) {
    // 处理数据库操作相关的异常
}

记录异常信息

记录异常信息是一种良好的实践，它有助于调试和排查问题，提供有关发生异常的详细信息，在 catch 块中至少记录异常信息，这有助于调试和排查问题。

使用 `printStackTrace` 方法

printStackTrace 方法是 Throwable 类的一个方法，用于打印异常堆栈信息。这是一个简单的方式，但在生产环境中可能不够安全，因为它会将堆栈信息打印到标准错误流。

try {
    // 可能抛出异常
} catch (Exception e) {
    // 记录异常信息
    e.printStackTrace();
}

使用日志框架记录异常信息

使用日志框架（如Log4j、SLF4J、java.util.logging等）记录异常信息是更灵活和可配置的方法。这允许在不同环境中配置日志级别，并将日志信息输出到不同的目标。

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public class ExampleClass {
    private static final Logger logger = LoggerFactory.getLogger(ExampleClass.class);

    public void someMethod() {
        try {
            // 可能抛出异常
        } catch (Exception e) {
            // 使用日志框架记录异常信息
            logger.error("An error occurred: {}", e.getMessage(), e);
        }
    }
}

使用自定义日志记录方式

在一些情况下，你可能希望使用自定义的方式记录异常信息，例如将异常信息写入文件、发送邮件或将其存储到数据库。这可以根据项目的需要来实现。

try {
    // 可能抛出异常
} catch (Exception e) {
    // 使用自定义方式记录异常信息
    logToCustomStorage(e);
}

private void logToCustomStorage(Exception e) {
    // 实现自定义的异常信息记录逻辑
}

记录异常发生的上下文信息

在记录异常信息时，也可以考虑记录异常发生时的上下文信息，例如输入参数、方法调用链等，以便更好地理解问题的背景。

try {
    // 可能抛出异常
} catch (Exception e) {
    // 记录异常信息和上下文信息
    logExceptionWithContext(e, "Error in someMethod");
}

private void logExceptionWithContext(Exception e, String context) {
    // 记录异常信息和上下文信息的自定义逻辑
}

记录异常信息是一个重要的实践，它有助于在程序运行时及时发现和解决问题。选择适当的记录方式取决于项目的需求和约定。

自定义异常：

自定义异常是一种在特定情况下创建并抛出的异常，它允许开发人员定义自己的异常类型以更好地适应应用程序的需求，以便更好地传达异常的含义和上下文。

继承现有异常类

通常，自定义异常类应该继承自现有的异常类，例如 Exception 或其子类，以确保它们符合异常的一般约定。

public class CustomException extends Exception {
    // 自定义异常类的构造函数
    public CustomException(String message) {
        super(message);
    }
}

提供有意义的异常信息

在自定义异常类中，确保提供有意义的异常信息，以便在捕获到异常时能够更容易地理解发生了什么问题。

public class CustomException extends Exception {
    // 自定义异常类的构造函数
    public CustomException(String message) {
        super("Custom exception: " + message);
    }
}

添加额外的属性或方法

根据需要，可以在自定义异常类中添加额外的属性或方法，以提供更多的上下文信息或支持特定的处理逻辑。

public class CustomException extends Exception {
    private int errorCode;

    // 自定义异常类的构造函数
    public CustomException(String message, int errorCode) {
        super("Custom exception: " + message);
        this.errorCode = errorCode;
    }

    // 获取错误代码的方法
    public int getErrorCode() {
        return errorCode;
    }
}

使用自定义异常

在应用程序中，可以在适当的地方抛出自定义异常，并在调用者处捕获和处理。

public class ExampleClass {
    public void someMethod() throws CustomException {
        // 在某些条件下抛出自定义异常
        if (someCondition) {
            throw new CustomException("Something went wrong", 500);
        }
    }
}

public class AnotherClass {
    public void anotherMethod() {
        try {
            // 调用可能抛出自定义异常的方法
            new ExampleClass().someMethod();
        } catch (CustomException e) {
            // 处理自定义异常
            System.out.println("Caught custom exception: " + e.getMessage());
            System.out.println("Error code: " + e.getErrorCode());
        }
    }
}

通过自定义异常，可以更好地组织和管理应用程序中可能发生的不同类型的问题，并为不同类型的问题提供适当的处理逻辑。

以上是一些建议，实践时要根据具体情况进行调整。有效的异常处理可以提高程序的健壮性和可维护性。

我正在参与2023腾讯技术创作特训营第四期有奖征文，快来和我瓜分大奖！

原创声明：本文系作者授权腾讯云开发者社区发表，未经许可，不得转载。

如有侵权，请联系 cloudcommunity@tencent.com 删除。

2023腾讯·技术创作特训营第四期

原创声明：本文系作者授权腾讯云开发者社区发表，未经许可，不得转载。

如有侵权，请联系 cloudcommunity@tencent.com 删除。

2023腾讯·技术创作特训营第四期

登录后参与评论

0 条评论

热度