杰瑞科技汇

Java自定义异常,如何正确创建与使用?

下面我将从 为什么需要自定义异常如何创建自定义异常最佳实践,为你提供一个全面且详细的指南。

Java自定义异常,如何正确创建与使用?-图1
(图片来源网络,侵删)

为什么需要自定义异常?

虽然 Java 已经提供了丰富的内置异常(如 NullPointerException, IOException),但在实际开发中,我们仍然需要自定义异常,主要原因如下:

  1. 更精确的错误描述:内置异常通常是通用型的,自定义异常可以让你用业务领域的语言来描述问题,使错误信息更具语义化。

    • 一个 InvalidAgeException 比直接抛出 IllegalArgumentException 更能清晰地表达“年龄无效”这个业务逻辑错误。
  2. 更好的代码可读性和可维护性:通过自定义异常,你可以将不同类型的错误进行分类,调用方可以根据具体的异常类型(catch 块)来执行不同的恢复逻辑,而不是用一个巨大的 catch (Exception e) 来处理所有问题。

    • catch (InvalidPasswordException e)catch (UserNotFoundException e) 可以执行完全不同的操作。
  3. 区分可恢复异常和不可恢复异常:你可以通过继承不同的父异常来区分错误类型。

    Java自定义异常,如何正确创建与使用?-图2
    (图片来源网络,侵删)
    • 继承 RuntimeException:表示程序设计缺陷或不可预见的错误(如 NullPointerException),通常不需要显式捕获。
    • 继承 Exception:表示客户端可以预见并可能从错误中恢复的情况(如网络中断、文件不存在),通常要求调用方显式处理(try-catchthrows)。
  4. 封装底层异常:当你的代码调用第三方库或底层 API 时,可能会抛出多种你不关心的底层异常,你可以将这些底层异常包装在一个自定义的高层异常中,向上层暴露一个统一的、符合你业务逻辑的错误视图。


如何创建自定义异常?

创建自定义异常非常简单,主要分为以下几步:

步骤 1:创建异常类

自定义异常类通常直接继承自 ExceptionRuntimeException

  • 继承 Exception:这是受检异常,编译器会强制要求处理它(try-catch 或在方法签名中使用 throws 声明),适用于那些调用方可以预见并应该处理的错误场景。
  • 继承 RuntimeException:这是非受检异常,编译器不强制要求处理,通常用于表示程序内部的逻辑错误或不可恢复的状态,比如非法参数。

基本语法:

Java自定义异常,如何正确创建与使用?-图3
(图片来源网络,侵删)
// 继承 Exception (受检异常)
public class MyBusinessException extends Exception {
    // 构造方法
    public MyBusinessException() {
        super();
    }
    public MyBusinessException(String message) {
        super(message); // 调用父类构造方法,设置错误信息
    }
    public MyBusinessException(String message, Throwable cause) {
        super(message, cause); // 调用父类构造方法,设置错误信息和原因
    }
}
// 继承 RuntimeException (非受检异常)
public class MyRuntimeException extends RuntimeException {
    // 构造方法
    public MyRuntimeException() {
        super();
    }
    public MyRuntimeException(String message) {
        super(message);
    }
    public MyRuntimeException(String message, Throwable cause) {
        super(message, cause);
    }
}

最佳实践: 至少提供接收 String message 参数的构造方法,这是最常用的。

步骤 2:在业务逻辑中抛出自定义异常

使用 throw 关键字在适当的条件判断下抛出你创建的异常实例。

步骤 3:调用方处理异常

调用方可以使用 try-catch 块来捕获并处理这个自定义异常,或者继续使用 throws 将其向上层传递。


完整代码示例

下面我们通过一个用户注册的场景来演示如何创建和使用自定义异常。

场景:用户注册

  • 业务规则1:用户名不能为空或 null。
  • 业务规则2:用户年龄必须大于等于 18 岁。
  • 业务规则3:用户名不能已存在。

第 1 步:创建自定义异常类

我们将创建两个自定义异常:一个用于业务逻辑错误(受检),一个用于表示资源找不到(非受检)。

// UserException.java - 受检异常,用于所有与用户相关的业务逻辑错误
public class UserException extends Exception {
    public UserException(String message) {
        super(message);
    }
    public UserException(String message, Throwable cause) {
        super(message, cause);
    }
}
// UserNotFoundException.java - 非受检异常,专门表示用户未找到
// 继承自 RuntimeException,表示这是一个程序逻辑问题,调用方通常不需要捕获
public class UserNotFoundException extends RuntimeException {
    public UserNotFoundException(String message) {
        super(message);
    }
}

第 2 步:创建服务类并实现业务逻辑

UserService 类将包含注册方法,并在违反业务规则时抛出相应的异常。

import java.util.HashSet;
import java.util.Set;
public class UserService {
    // 模拟一个已存在的用户名数据库
    private final Set<String> existingUsernames = new HashSet<>();
    public void register(String username, int age) throws UserException {
        // 规则1: 检查用户名
        if (username == null || username.trim().isEmpty()) {
            throw new UserException("用户名不能为空或 null");
        }
        // 规则2: 检查年龄
        if (age < 18) {
            throw new UserException("用户年龄必须大于等于 18 岁,当前年龄: " + age);
        }
        // 规则3: 检查用户名是否已存在
        if (existingUsernames.contains(username)) {
            // 抛出受检异常,表示这是一个可预见的业务错误
            throw new UserException("用户名 '" + username + "' 已被注册");
        }
        // 所有检查通过,注册成功
        existingUsernames.add(username);
        System.out.println("用户 '" + username + "' 注册成功!");
    }
    // 模拟根据用户名查找用户的方法
    public String findUserByUsername(String username) throws UserNotFoundException {
        if (!existingUsernames.contains(username)) {
            // 抛出非受检异常,表示这是一个程序预期的状态,但调用方可能想捕获它
            throw new UserNotFoundException("找不到用户名为 '" + username + "' 的用户");
        }
        return "User: " + username;
    }
}

第 3 步:创建客户端代码进行测试

public class Main {
    public static void main(String[] args) {
        UserService userService = new UserService();
        System.out.println("--- 测试 1: 注册成功 ---");
        try {
            userService.register("zhangsan", 20);
        } catch (UserException e) {
            System.err.println("注册失败: " + e.getMessage());
        }
        System.out.println("\n--- 测试 2: 用户名为空 ---");
        try {
            userService.register("", 25);
        } catch (UserException e) {
            System.err.println("捕获到 UserException: " + e.getMessage());
        }
        System.out.println("\n--- 测试 3: 年龄不足 ---");
        try {
            userService.register("lisi", 16);
        } catch (UserException e) {
            System.err.println("捕获到 UserException: " + e.getMessage());
        }
        System.out.println("\n--- 测试 4: 用户名重复 ---");
        try {
            userService.register("zhangsan", 30); // 尝试注册已存在的用户
        } catch (UserException e) {
            System.err.println("捕获到 UserException: " + e.getMessage());
        }
        System.out.println("\n--- 测试 5: 查找用户 ---");
        try {
            String user = userService.findUserByUsername("zhangsan");
            System.out.println("查找成功: " + user);
        } catch (UserNotFoundException e) {
            System.err.println("捕获到 UserNotFoundException: " + e.getMessage());
        }
        System.out.println("\n--- 测试 6: 查找不存在的用户 ---");
        try {
            String user = userService.findUserByUsername("nonexistent");
            System.out.println("查找成功: " + user);
        } catch (UserNotFoundException e) {
            System.err.println("捕获到 UserNotFoundException: " + e.getMessage());
        }
    }
}

运行结果

--- 测试 1: 注册成功 ---
用户 'zhangsan' 注册成功!
--- 测试 2: 用户名为空 ---
捕获到 UserException: 用户名不能为空或 null
--- 测试 3: 年龄不足 ---
捕获到 UserException: 用户年龄必须大于等于 18 岁,当前年龄: 16
--- 测试 4: 用户名重复 ---
捕获到 UserException: 用户名 'zhangsan' 已被注册
--- 测试 5: 查找用户 ---
查找成功: User: zhangsan
--- 测试 6: 查找不存在的用户 ---
捕获到 UserNotFoundException: 找不到用户名为 'nonexistent' 的用户

最佳实践

  1. 保持异常类简洁:异常类本身应该非常简单,通常只包含构造方法和一些字段(如错误码),不要在异常类中添加复杂的业务逻辑。
  2. 提供有意义的错误信息:通过构造方法的 message 参数提供清晰、对用户或开发者友好的描述,避免使用像 "Error #123" 这样模糊的信息。
  3. 考虑提供 cause(原因):当你捕获一个低层异常并重新抛出一个高层异常时,务必将原始异常作为 cause 传递进去,这有助于追踪问题的根本原因。
    try {
        // 调用一个可能抛出 IOException 的方法
        someExternalApiCall();
    } catch (IOException e) {
        // 将 IOException 包装成我们自己的业务异常
        throw new MyBusinessException("调用外部API失败", e);
    }
  4. 继承合适的父类
    • 如果错误是客户端可以预见并处理的,使用 extends Exception
    • 如果错误是由于程序 bug 或不可恢复状态导致的,使用 extends RuntimeException
  5. 为异常提供序列化支持:如果你的应用需要分布式部署(如微服务),异常可能会跨网络传输,为了让异常可以被正确序列化和反序列化,建议实现 Serializable 接口。
    public class UserException extends Exception implements Serializable {
        // ... 构造方法 ...
    }
  6. 避免过度使用受检异常:过多的受检异常会让代码变得臃肿(try-catchthrows 瀑布),只在真正需要调用方强制处理错误时使用,对于大部分逻辑错误,非受检异常(RuntimeException)是更好的选择。

通过遵循这些原则,你可以创建出既强大又易于维护的自定义异常体系,让你的 Java 应用程序更加健壮和专业。

分享:
扫描分享到社交APP
上一篇
下一篇