java获取exception终的code

转载

mob64ca14031c97 2024-10-18 12:15:09

文章标签 职场和发展 java 自定义异常 Java 业务逻辑 文章分类 Java 后端开发

1、为什么要使用自定义异常？

使用自定义异常（Custom Exceptions）在程序设计中是一个良好的实践，它有几个重要的好处：

提高代码可读性：
自定义异常的名称如果能清晰表达出异常的情况，那么阅读代码的人就可以更快地理解代码可能抛出的错误以及错误的上下文。
精确的错误处理：
通过区分不同的异常类型，程序可以捕获并作出不同的处理，而不是对所有类型的异常使用单一的、笼统的处理方式。
保持代码的干净整洁：
把错误处理的逻辑集中在一处，使得业务逻辑代码与错误处理代码分离，使得业务代码更加干净、整洁。
便于调试和维护：
当异常被抛出时，如果是自定义的异常，很容易定位问题的原因和位置，因为自定义异常可以携带额外的信息和上下文。
强制错误处理：
引入新的异常类型可以强制调用者处理这些异常，避免了关键错误被忽略或者误处理。
API设计的一部分：
对于库或框架的开发者来说，自定义异常是API设计的一部分，它们可以成为库或框架公共API的一部分，供其他开发者使用。
统一异常策略：
自定义异常可以帮助实现一个统一的异常处理策略，使得异常逻辑一致，方便管理和变更。

例如，如果您正在开发一个文件处理库，使用标准的 IOException 来报告所有I/O错误可能足够了。但是，创建更具体的异常，如 FileTooLargeException 和 PermissionDeniedException，会使错误处理更加具体且用户友好。

然而，使用自定义异常也应该节制。如果过多地创建细微差别的异常，可能会使得异常体系过于复杂，增加学习和使用的难度。因此，自定义异常应该在增加显著的价值和意义时使用。

2、如何创建一个自定义异常？

在Java中创建自定义异常是一个相对简单的过程。自定义异常通常是通过继承Exception类或其子类来实现的。以下是创建自定义异常的步骤及示例：

步骤1：定义自定义异常类

你需要定义一个类来扩展Exception类（或其任何子类，如RuntimeException）。

public class MyCustomException extends Exception {
    // 构造函数1：无参构造函数
    public MyCustomException() {
        super();
    }

    // 构造函数2：接受错误信息的构造函数
    public MyCustomException(String message) {
        super(message);
    }

    // 构造函数3：接受错误信息和导致异常的另一个异常的构造函数
    public MyCustomException(String message, Throwable cause) {
        super(message, cause);
    }

    // 构造函数4：接受导致异常的另一个异常的构造函数
    public MyCustomException(Throwable cause) {
        super(cause);
    }
}

步骤2：抛出自定义异常

在你的业务逻辑中，当遇到特定的错误条件时，你可以抛出自定义异常。

public void doSomething(int value) throws MyCustomException {
    if (value < 0) {
        throw new MyCustomException("Value cannot be negative");
    }
    // 更多逻辑代码...
}

步骤3：捕获自定义异常

在调用可能抛出自定义异常的方法时，你可以捕获并处理这个异常。

public void someMethod() {
    try {
        doSomething(-1);
    } catch (MyCustomException e) {
        // 异常处理代码
        e.printStackTrace();
    }
}

注意事项：

如果你的自定义异常继承自RuntimeException，那么它是一个未检查（unchecked）异常；如果它继承自Exception，那么它是一个已检查（checked）异常。未检查异常不强制调用方法捕获它，而已检查异常则要求调用方法捕获或声明它。
自定义异常可以根据需要添加更多的构造函数和方法。例如，你可以添加一个接受错误码或其他自定义信息的构造函数。
在自定义异常类中，你也可以根据业务需求实现其他方法，例如返回错误代码或者特定的错误描述信息。
请记得在文档中清晰地描述每个自定义异常的用途，这样其他开发者在使用你的代码时，能够轻松理解和正确处理这些异常。

3、自定义异常和Java内置异常有什么区别？

自定义异常和Java内置异常的主要区别在于它们的来源和用途：

来源：

内置异常：Java内置异常是Java标准库提供的，它们定义在java.lang包和其他标准库包中。例如，NullPointerException, ArrayIndexOutOfBoundsException, IOException等。
自定义异常：自定义异常是由应用程序开发者根据需要定义的。它们通常继承自Exception, RuntimeException或者其他标准异常类。

用途：

内置异常：用于覆盖广泛的通用错误情况，例如数组越界、空指针引用、类转换错误等。
自定义异常：用于特定的应用程序逻辑和业务规则。它们为应用程序提供了一种表达和处理特定错误条件的方式，这些错误条件可能没有现成的内置异常类型能够准确描述。

明确性：

内置异常：可能具有一般性，不足以提供错误条件的详细信息。例如，IllegalArgumentException 可能用于各种不合法的参数错误。
自定义异常：可以提供更具体的错误信息，使错误更加明确。例如，InvalidUserInputException 可能表示用户输入了无效的数据。

明确的API设计：

内置异常：使用内置异常可以让你的代码更容易被其他Java开发者理解，因为它们熟悉这些异常和它们的用途。
自定义异常：使得API用户能够更清晰地了解你的API是如何设计和应该如何使用的。这可以帮助用户编写更好的错误处理代码。

强制错误处理：

内置异常：可能会被开发者忽略，特别是未检查（unchecked）异常，如RuntimeException及其子类。
自定义异常：可以设计为已检查（checked）异常，这迫使调用者处理这些异常，从而减少错误的遗漏。

在选择使用内置异常还是自定义异常时，需要权衡考虑。如果内置异常能够充分且准确地描述问题，就没有必要创建自定义异常。但是，如果你需要提供更多的错误信息，或者想要强制调用者以特定方式处理错误，自定义异常可能会是更好的选择。

4、什么时候应该使用自定义异常？

使用自定义异常通常在以下情况下是合适的：

特定的错误条件：当你的应用程序或库需要表示一个特定的错误条件时，它在Java标准异常中没有精确匹配的异常类。
增强异常信息：当你想要提供比Java标准异常类更多的信息，比如错误码、复杂的错误消息、或者额外的上下文信息时。
清晰的API设计：当你设计一个公共API，并且想要你的API用户更清晰地了解可能发生的具体错误类型时。
强制错误处理：当你想要强制调用你的方法的代码处理某些特定的异常时。在Java中，已检查的异常必须被捕获或者在方法签名中声明，这可以保证调用者不会忽略这些异常。
分层的错误处理：当你的应用程序有多个层次，并且你想要在不同层次之间传递具体的错误信息而不是通用的异常时。
统一错误格式：当你的应用程序或系统需要统一的错误处理格式时，自定义异常可以使得错误处理更加标准化。
日志和监控需求：当你需要根据异常类型做特定的日志记录或者监控时，自定义异常可以使得这些操作更加直接和简单。

自定义异常应该谨慎使用，以避免不必要的复杂性。如果标准异常已足够表达错误情况，通常最好使用标准异常。自定义异常更适合表达特定的业务逻辑错误，而非通用的编程错误。

5、自定义异常类能否被序列化？

是的，自定义异常类可以被序列化。在Java中，任何对象要想被序列化，其类必须实现java.io.Serializable接口。由于java.lang.Exception类已经实现了Serializable接口，因此任何自定义异常类只要继承自Exception（或其任何子类），它就是可序列化的。

下面是一个简单的自定义异常类，展示了如何实现序列化：

public class MyCustomException extends Exception implements Serializable {

    private static final long serialVersionUID = 1L; // 建议添加

    public MyCustomException() {
        super();
    }

    public MyCustomException(String message) {
        super(message);
    }

    // ... 其他构造方法和成员变量
}

在上面的例子中，serialVersionUID是用来保证在序列化和反序列化过程中，对象版本的兼容性。如果你没有显式声明serialVersionUID，那么Java运行时环境将会基于类的细节（成员、方法等）自动生成一个。但是，如果类的细节发生变化（如成员的添加或删除），那么自动生成的serialVersionUID也会改变，这可能会导致反序列化过程中抛出InvalidClassException。因此，为了提高类版本的兼容性，建议显式声明serialVersionUID。

要注意，如果在自定义异常类中添加了非临时的非可序列化成员变量，这些成员在默认情况下也需要实现Serializable接口，否则在序列化过程中会抛出NotSerializableException。若要避免这个问题，可以将这些成员声明为transient，这表示它们将在序列化过程中被忽略。

6、如何决定自定义异常应该是检查型（checked）还是非检查型（unchecked）？

在Java中，决定自定义异常是应该是检查型（checked）还是非检查型（unchecked）主要取决于以下因素：

异常恢复：

如果认为调用者能够以某种合理的方式恢复或处理异常，则应该使用检查型异常。这类异常通常表明客户端代码遇到了一个可预见并且可以优雅恢复的问题。

错误预防：

如果异常是由于程序员的错误导致的，如编码不当或使用方法不当，此时应该使用非检查型异常。非检查型异常通常指示编程错误，调用者无法对此做出有意义的响应。

API设计和用户体验：

应考虑异常对API用户的影响。检查型异常强制调用者处理异常，这可能导致API使用起来比较繁琐。如果异常处理是API使用的一个重要方面，那么应该使用检查型异常。

事务性操作：

如果操作是事务性的，意味着失败时需要进行一些回滚操作，那么最好使用检查型异常，以确保调用者可以识别错误并采取适当的回滚措施。

异常发生的频率：

如果异常是偶然发生的，即在正常情况下不太可能出现，则可能更适合使用检查型异常。如果异常是频繁发生的，可能会影响到正常的程序流程，那么使用非检查型异常可能更合适。

运行时环境：

如果异常与底层资源或运行时环境有关，如数据库连接失败、文件未找到等，通常使用检查型异常。

遵循现有的Java约定：

在Java中，IO错误、反射错误和其他库定义的一些异常都是检查型异常。遵循这些约定可以使你的异常逻辑与Java生态系统保持一致。

示例：

对于自定义的DataFormatException（数据格式异常），如果数据格式错误是预期内的情况并且调用者需要对此进行处理，则应该是检查型异常。
对于自定义的InvalidUserInputException（无效用户输入异常），如果认为这是由于用户错误输入导致的，并且应由调用者处理，这通常也是检查型异常。
对于自定义的DatabaseConnectionException（数据库连接异常），如果要求调用者必须处理连接失败的情况，这应该是检查型异常。
对于自定义的MyRuntimeException（我的运行时异常），如果它表示一个编程错误，比如非法的方法参数或者错误的状态，那么它应该是非检查型异常。

最终决定应该基于实际场景和设计目标。需要注意的是，在Java实践中，过度使用检查型异常可能会导致冗长的代码和过多的try-catch块，而这可能会降低代码的可读性和维护性。因此，在实际应用中，许多开发者和一些现代框架倾向于使用更多的非检查型异常。

7、在自定义异常中添加哪些信息？

在自定义异常中添加信息时，你应该考虑能够帮助异常的接收者理解和处理异常的相关信息。这里是一些你可能会想要包含的信息：

详细的错误信息：

提供一个清晰，简洁的描述错误的消息。这是帮助理解发生了什么的最基本的信息。

异常原因：

如果你的自定义异常是由另一个异常引起的，你应该保存一个对原始异常的引用。在Java中，可以通过调用父类Exception的initCause()方法或通过提供一个带有Throwable参数的构造函数来实现。

错误代码或状态码：

添加一个特定的错误代码或状态码，这样用户可以更容易地参考文档或使用代码来处理特定情况。

上下文信息：

提供足够的上下文信息，例如操作的名称、失败时的数据点、用户的输入值等，这有助于调试和日志记录。

处理指南：

如果可能的话，提供一些建议或指南，告诉接收者怎样处理这个异常。

国际化支持：

如果你的应用程序需要支持多种语言环境，考虑为错误消息提供国际化支持。

序列号：

如果自定义异常将被序列化，确保包含serialVersionUID字段。

这里是一个简单的自定义异常类的例子，展示了如何包含这些信息：

public class MyCustomException extends Exception {

    private static final long serialVersionUID = 1L; // 序列号
    private final String errorCode; // 错误代码

    // 构造函数包含错误消息和错误代码
    public MyCustomException(String message, String errorCode) {
        super(message);
        this.errorCode = errorCode;
    }

    // 构造函数包含错误消息、错误代码和原始异常
    public MyCustomException(String message, String errorCode, Throwable cause) {
        super(message, cause);
        this.errorCode = errorCode;
    }

    // Getter方法让调用者能够获取错误代码
    public String getErrorCode() {
        return errorCode;
    }

    // 重写toString方法，添加额外的错误代码信息
    @Override
    public String toString() {
        return super.toString() + " [errorCode=" + errorCode + "]";
    }

    // ... 其他自定义的方法和属性
}

在设计自定义异常时，应该保持它们的简洁性和目的性，避免过度复杂化。确保只包含对处理异常有用的信息，并考虑到异常的序列化和日志记录需求。

8、如何合理地使用自定义异常？

合理地使用自定义异常可以使代码更加清晰，易于维护，下面是一些关于如何合理使用自定义异常的指导原则：

明确异常用途：

只有在标准Java异常类不能充分表达发生的错误时，才创建自定义异常。比如，如果你需要提供更多的错误信息，或者需要区分应用程序的不同错误类型。

遵循异常命名约定：

异常类应该以Exception后缀结尾，且名称应该能够清楚地描述异常的类型，例如InvalidUserInputException 或 DatabaseConnectionException。

提供有意义的错误信息：

自定义异常应该能够提供足够的信息来帮助调试问题。这通常意味着在异常消息中包含足够的上下文，如错误发生时的操作名称和失败的原因。

不要过度细化：

不必为每一个可能出现的错误都创建一个新的异常类。过多的异常类会使代码变得复杂且难以维护。相反，可以使用错误编码或者枚举来区分不同的错误情况。

继承正确的异常类型：

根据你的自定义异常是检查型还是非检查型，选择继承自Exception或RuntimeException。

适当使用异常链：

如果你的异常是由另一个异常引起的，使用异常链来保留原始异常的栈跟踪信息，这对于调试是非常有用的。

避免在异常处理中使用控制流：

不要使用异常来控制应用程序的正常流程。异常应该用于异常情况，而不是用来代替if-else语句或循环。

提供易于使用的API：

如果你的异常类是给其他开发者使用的，确保它们很容易使用并且文档齐全。这意味着要有清晰的javadoc，且异常类的方法应该直观。

保持异常类的不变性：

异常对象一旦被创建就不应该改变其状态，这有助于避免在多线程环境下的问题，因此异常类的字段应该是最终的（final）。

合理利用日志记录：

在捕获和处理自定义异常的地方，适当地记录日志信息，这将帮助追踪和分析问题。

通过遵循这些原则，你可以确保自定义异常给你的应用程序带来的好处最大化，同时避免常见的滥用情况。记住异常处理不仅仅是解决问题，更是关于清晰地表达问题的性质和恢复策略，使得维护者和最终用户能够理解和处理这些问题。

9、自定义异常是否可以包含业务逻辑？

自定义异常应该主要用于表示错误情况或异常事件，并不推荐在异常类中直接包含业务逻辑。异常的设计目标是传递错误信息，并允许调用代码对异常作出反应。而业务逻辑应该由应用程序的其他部分来处理，这样可以保持代码的清晰和分离关注点。

下面是为什么不应该在自定义异常类中包含业务逻辑的几个原因：

职责分离：

遵循单一职责原则（SRP），应该将业务逻辑与异常处理逻辑分开。异常类的职责是提供错误信息，而业务逻辑应该由应用程序的其他部分管理。

可读性和可维护性：

将业务逻辑放在异常类中会降低代码的可读性和可维护性。其他开发者可能不会期望在异常类中找到业务逻辑，这可能导致在错误的地方寻找代码逻辑。

异常处理复杂性：

在异常类中加入业务逻辑可能会导致异常处理过于复杂，并且难以跟踪程序的流程。异常处理应该简单明了，以便于开发者理解和处理。

性能考虑：

异常构造和堆栈追踪是昂贵的操作。如果在异常流程中包含了业务逻辑，它将会影响程序的性能，特别是当异常频繁抛出时。

测试困难：

测试通常需要模拟异常情况，如果在异常类中包含业务逻辑，它可能会增加编写和维护测试用例的复杂性。

错误处理策略：

异常应该提供足够的信息以供调用者决定如何处理它们。在异常中包含业务逻辑会使调用者难以实现自己的错误处理策略。

如果你需要在异常发生时执行某些业务逻辑，最好的做法是在捕获异常的代码段中处理，而不是在异常类本身中。这样做可以保持异常类的简洁性，并允许调用代码灵活地决定如何响应不同类型的异常。

总之，设计自定义异常时，应该让它们保持简单，只包含表达错误情况所需的信息和功能。业务逻辑应该与异常处理逻辑分离，由应用程序的其他部分负责。

10、如何测试自定义异常？

要测试自定义异常，你需要确保它们在正确的条件下被抛出，并且包含了正确的信息。这通常涉及到两个步骤：首先是触发异常，然后是验证异常的属性。

下面是一些测试自定义异常的步骤：

触发异常：

设计测试用例以模拟触发异常的条件。这可能涉及到提供错误的输入数据，模拟外部系统错误，或者设置特定的环境条件，如文件不存在、网络问题等。

异常捕获：

在测试代码中捕获异常。在Java中，这通常意味着将测试的代码放在try/catch块中，并捕获你的自定义异常。

验证异常消息：

检查异常对象的消息是否符合预期。异常消息应该清晰地说明错误的情况。

检查异常属性：

如果自定义异常包含额外的属性（如错误代码），则需要验证这些属性是否设置正确。

检查异常类型：

确认抛出的异常类型正确。自定义异常应该是预期类型的实例。

验证堆栈跟踪：

在某些情况下，可能需要验证异常的堆栈跟踪，以确保异常是在正确的代码位置抛出的。

检查异常链：

如果你的自定义异常包装了另一个异常，检查getCause()方法返回的原始异常是否正确。

以下是一个简单的JUnit测试示例，演示如何测试一个自定义异常是否在预期条件下抛出，并且是否包含正确的错误信息：

import static org.junit.Assert.*;
import org.junit.Test;

public class MyCustomExceptionTest {

    @Test
    public void testExceptionMessage() {
        try {
            // 模拟触发异常的条件
            throw new MyCustomException("Custom error message", "ERROR_CODE_123");
        } catch (MyCustomException e) {
            // 检查异常消息
            assertEquals("Custom error message", e.getMessage());
            // 检查异常类型
            assertTrue(e instanceof MyCustomException);
            // 检查异常属性，例如错误代码
            assertEquals("ERROR_CODE_123", e.getErrorCode());
            // 可选的，检查堆栈跟踪或异常链
            // ...
        }
    }

    @Test(expected = MyCustomException.class)
    public void testExceptionIsThrown() throws MyCustomException {
        // 模拟触发异常的条件
        // 这里假设'methodThatThrows'在某些条件下会抛出MyCustomException
        methodThatThrows();
    }

    // 一个示例方法，可能会在某些条件下抛出你的自定义异常
    public void methodThatThrows() throws MyCustomException {
        // 你的代码逻辑...
        throw new MyCustomException("Expected to throw", "ERROR_CODE_123");
    }
}

在这个示例中，testExceptionMessage 测试方法确保自定义异常具有正确的消息和错误代码。而testExceptionIsThrown方法测试预期的异常是否被抛出。通过这些断言，可以保证自定义异常按预期工作。记住，在实际的测试用例中，你需要模拟或构造条件来触发异常。

11、在使用自定义异常时要注意什么？

在使用自定义异常时，应当注意以下几个关键点，以确保异常的正确使用和良好的代码实践：

有明确的使用场景：
自定义异常应该在标准异常无法满足需求的情况下使用，例如，当你需要提供更详细的错误信息或者区分你的应用程序的特定错误类型时。
避免不必要的自定义异常：
在没有必要区分应用程序的错误情况时，应避免自定义异常。过多的自定义异常会使代码复杂，可能导致异常处理过于繁琐。
遵守命名约定：
自定义异常的名称应以Exception结尾，并且能够直观地描述异常的类型。
提供有用的错误消息：
异常的错误消息应提供足够的信息来说明抛出异常的原因，这有助于调试问题。
继承适当的异常类：
根据自定义异常的性质，决定是继承Exception类（创建一个受检异常），还是继承RuntimeException类（创建一个非受检异常）。
保持异常不变性：
异常对象一旦创建，其状态不应该被改变，以避免在多线程环境下的潜在问题。
不要在异常类中嵌入业务逻辑：
异常应当只携带错误信息，不应该包含处理错误的业务逻辑。
合理使用异常链：
若自定义异常是由另一异常引起的，应保持原始异常的信息，可以通过设置原始异常为cause来实现。
在文档中清晰记录：
如果自定义异常是给其他开发者使用的，确保其用途和使用方法在文档中有清晰的说明。
合理利用构造函数：
为自定义异常提供多个构造函数，以便在抛出异常时有灵活性，例如仅提供错误消息，提供错误消息和原因，或者提供错误消息、原因和错误代码等。
谨慎序列化：
如果自定义异常类将会通过网络传输或者持久化到磁盘，确保其正确地实现了序列化，包括声明serialVersionUID字段。
测试自定义异常：
对自定义异常进行单元测试，以确保在适当的条件下被抛出，并且包含正确的信息。