异常处理

自 v6.2.0 起

自动捕获和处理服务方法中的异常。

UltiTools 通过 @ExceptionCatch 注解提供声明式异常处理。无需在服务方法调用处用 try-catch 块包裹，只需为方法添加注解，框架根据你的配置自动处理异常。

基本用法

在任意受容器管理的 Bean（如 @Service）的方法上添加 @ExceptionCatch：

@Service
public class FileService {

    @ExceptionCatch
    public String readFile(String path) {
        // 如果发生任何异常，框架会自动捕获并记录日志
        // 方法返回 null
        return new String(Files.readAllBytes(Paths.get(path)));
    }
}

默认行为：

• 捕获所有 Exception 类型（及其子类）
• 异常会被记录为警告日志（除非 silent = true）
• 返回默认值（对象返回 null，原始类型返回 0 等）

注解属性

属性	类型	默认值	说明
value	Class<? extends Throwable>[]	{Exception.class}	要捕获的异常类型。子类会自动被包含。
silent	boolean	false	为 true 时，异常被静默捕获，不记录日志。为 false 时，异常被记录为警告。
handler	String	""	自定义异常处理器 Bean 的名称。该 Bean 必须实现 ExceptionHandler 接口。
defaultValue	String	""	异常被捕获时返回的值的表达式。

捕获特定异常

指定应该被捕获的异常类型：

@Service
public class DataService {

    @ExceptionCatch(IOException.class)
    public String loadData() {
        // 只捕获 IOException
        // 其他异常会向上传播
        return readFromFile();
    }

    @ExceptionCatch({IOException.class, SQLException.class})
    public List<User> fetchUsers() {
        // IOException 和 SQLException 都会被捕获
        // 它们的子类也会被捕获
        return queryDatabase();
    }
}

异常继承关系

当指定异常类型时，框架也会捕获其子类。例如，@ExceptionCatch(IOException.class) 会捕获 FileNotFoundException、EOFException 等 IOException 的子类。

静默模式

对于已预期的或非关键异常，禁用日志记录：

@Service
public class ConfigService {

    @ExceptionCatch(silent = true)
    public void saveOptionalConfig() {
        // 任何异常都被捕获且不记录日志
        // 适用于非关键的后台操作
        writeConfigBackup();
    }

    @ExceptionCatch(value = FileNotFoundException.class, silent = true)
    public boolean fileExists(String path) {
        // FileNotFoundException 被静默捕获
        // 其他异常仍会被记录
        return checkFile(path);
    }
}

何时使用 silent = true：

• 非关键操作（如可选备份）
• 后备逻辑（如文件未找到时使用默认值）
• 异常是预期的操作

默认返回值

控制异常被捕获时返回的值：

@Service
public class MoneyService {

    @ExceptionCatch(defaultValue = "0")
    public int getBalance(String accountId) {
        // 异常发生时返回 0，而不是 null
        return queryBalance(accountId);
    }

    @ExceptionCatch(defaultValue = "false")
    public boolean isPlayerOnline(String playerName) {
        // 返回 false 而不是 null
        return checkDatabase(playerName);
    }

    @ExceptionCatch(defaultValue = "empty")
    public List<User> getAllUsers() {
        // 返回空列表而不是 null
        return queryAllUsers();
    }
}

支持的默认值表达式：

• "null" — 返回 null（对象的默认值）
• "true" / "false" — 返回布尔值
• 数字字面量 — "0"、"100"、"-5"、"3.14" — 返回该数字
• "empty" — 根据返回类型返回空集合/数组/字符串

如果未指定 defaultValue，会使用类型默认值：

• 对象：null
• boolean：false
• int、long 等：0
• String：null
• 集合：null

defaultValue 类型匹配

defaultValue 表达式会根据方法的返回类型进行解析。如果在返回 String 的方法上指定 defaultValue = "0"，会返回字符串 "0"，而不是数字零。

自定义异常处理器

通过创建 ExceptionHandler Bean 来实现自定义异常处理逻辑：

@Service
public class LoggingExceptionHandler implements ExceptionHandler {

    @Override
    public Object handleException(Throwable exception, Object target, Method method, Object[] args) {
        // 记录详细的异常信息
        System.out.println("异常发生于: " + method.getDeclaringClass().getSimpleName() + "." + method.getName());
        System.out.println("错误信息: " + exception.getMessage());
        exception.printStackTrace();
        return null;
    }

    @Override
    public boolean supports(Class<? extends Throwable> exceptionType) {
        // 此处理器支持任何异常
        return true;
    }
}

注册并通过名称引用处理器：

@Service
public class MyService {

    @ExceptionCatch(handler = "loggingExceptionHandler")
    public String processData() {
        // 如果发生异常，会调用 LoggingExceptionHandler.handleException()
        return getData();
    }
}

处理器接口

自定义处理器实现 ExceptionHandler 接口，包含以下方法：

• handleException(Throwable, Object, Method, Object[]) — 主处理逻辑，返回替换值或可以重新抛出异常
• supports(Class) — 可选；返回 true 表示该处理器支持此异常类型（默认：支持所有异常）
• getOrder() — 可选；值越低优先级越高（默认：0）

方法要求

@ExceptionCatch 仅对受 IoC 容器管理的 Bean 中的方法有效：

@Service
public class MyService {

    @ExceptionCatch  // 正确 - 方法在受管理的 @Service Bean 中
    public void safeOperation() {
        // ...
    }
}

public class NonManagedClass {

    @ExceptionCatch  // 错误 - 此类不是 Bean
    public void unsafeOperation() {
        // 注解无效
    }
}

支持的 Bean 类型：

• @Service — 服务
• @Component — 通用 Bean
• 任何手动注册到 IoC 容器中的类

完整示例

@Service
public class UserDatabaseService {

    @Autowired
    private UltiToolsPlugin plugin;

    // 安全读取：任何异常都会被捕获并记录日志，返回 null
    @ExceptionCatch
    public User findById(String userId) {
        DataOperator<User> op = plugin.getDataOperator(User.class);
        return op.query().where("id").eq(userId).first();
    }

    // 安全读取并带默认值：查询失败时返回空列表
    @ExceptionCatch(defaultValue = "empty")
    public List<User> findByRole(String role) {
        DataOperator<User> op = plugin.getDataOperator(User.class);
        return op.query().where("role").eq(role).list();
    }

    // 安全操作且静默模式：文件未找到异常不记录日志
    @ExceptionCatch(value = FileNotFoundException.class, silent = true)
    public String loadUserData(String filename) {
        return readFile(filename);
    }

    // 安全操作且带自定义处理器：详细的错误报告
    @ExceptionCatch(
        value = {SQLException.class, IOException.class},
        handler = "detailedErrorHandler",
        defaultValue = "null"
    )
    public String exportUsers() {
        // 如果发生 SQLException 或 IOException，会调用 detailedErrorHandler
        return performExport();
    }

    // 关键操作：不捕获异常，异常向上传播
    public void deleteUser(String userId) {
        // 没有 @ExceptionCatch - 异常必须由调用者处理
        DataOperator<User> op = plugin.getDataOperator(User.class);
        op.query().where("id").eq(userId).delete();
    }
}

最佳实践

1. 用于容错 — 在预期会出现故障或非关键的方法上捕获异常
2. 指定异常类型 — 使用 @ExceptionCatch(IOException.class) 而非捕获所有异常
3. 启用日志 — 除非有充分理由，否则保持 silent = false
4. 提供有意义的默认值 — 集合使用 defaultValue = "empty"，计数器使用 "0" 等
5. 配合服务使用 — @ExceptionCatch 最适合用在为容错而设计的 @Service Bean 上

相关文章

• IoC 容器 — Bean 的管理和代理机制
• 事务 — 使用 @Transactional 进行声明式事务管理
• 定时任务 — 使用生命周期管理的自动任务调度

贡献者

Ling Bao

Claude Opus 4.6

页面历史

最后编辑于 1 分钟前

查看完整历史

619b0c9-feat: add version switcher with @viteplus/versions for v6.1.0/v6.2.0 docs