Spring Boot状态机中如何捕获动作处理时的异常？

核心原因 #

状态机动作中抛出的异常如果被内部吞掉，或者未正确传播到状态机核心逻辑，监听器的stateMachineError方法就无法捕获到异常。

解决方案 #

1. 确保动作不吞掉异常 #

检查OnboardingStateMachineAction中的动作实现，绝对不要在动作内部捕获异常后不抛出。示例：

// 正确的动作实现：直接抛出异常，不吞掉
public Action<OnboardingState, OnboardingEvent> completeOnboardingAction() {
    return context -> {
        // 业务逻辑示例
        String requiredData = context.getExtendedState().get("key", String.class);
        if (requiredData == null) {
            // 直接抛出异常，让状态机核心逻辑感知到
            throw new IllegalStateException("执行动作缺少必要数据");
        }
        // 其他业务操作
    };
}

2. 配置状态机错误处理机制 #

在状态机配置中显式添加错误处理配置，确保异常能被传递到监听器：
修改OnboardingStateMachineConfiguration的configure(StateMachineConfigurationConfigurer)方法：

@Override
public void configure(StateMachineConfigurationConfigurer<OnboardingState, OnboardingEvent> config)
    throws Exception {
    config
        .withConfiguration()
        .autoStartup(false)
        .listener(new StateMachineListener())
        // 新增错误处理配置，强化异常传播路径
        .and()
        .withErrorHandling()
        .defaultErrorHandler((exception, context) -> {
            // 额外记录上下文信息，同时保证异常触发监听器的stateMachineError方法
            log.error("动作执行异常，上下文详情：{}", context, exception);
        });
}

3. 直接实现StateMachineListener接口（可选） #

如果继承StateMachineListenerAdapter仍不生效，可以直接实现完整的StateMachineListener接口，避免适配器方法覆盖遗漏：

@Slf4j
public class StateMachineListener implements StateMachineListener<OnboardingState, OnboardingEvent> {

    @Override
    public void stateChanged(State<OnboardingState, OnboardingEvent> from, State<OnboardingState, OnboardingEvent> to) {
        log.info("状态从 {} 切换到 {}", from == null ? "初始状态" : from.getId(), to.getId());
    }

    @Override
    public void stateMachineError(StateMachine<OnboardingState, OnboardingEvent> stateMachine, Exception exception) {
        // 打印完整异常栈轨迹，便于排查问题
        log.error("状态机执行错误", exception);
    }

    // 实现接口剩余方法（可留空，但必须声明）
    @Override public void stateEntered(State<OnboardingState, OnboardingEvent> state) {}
    @Override public void stateExited(State<OnboardingState, OnboardingEvent> state) {}
    @Override public void eventNotAccepted(Message<OnboardingEvent> event) {}
    @Override public void transition(Transition<OnboardingState, OnboardingEvent> transition) {}
    @Override public void transitionStarted(Transition<OnboardingState, OnboardingEvent> transition) {}
    @Override public void transitionEnded(Transition<OnboardingState, OnboardingEvent> transition) {}
    @Override public void stateMachineStarted(StateMachine<OnboardingState, OnboardingEvent> stateMachine) {}
    @Override public void stateMachineStopped(StateMachine<OnboardingState, OnboardingEvent> stateMachine) {}
    @Override public void stateMachineReset(StateMachine<OnboardingState, OnboardingEvent> stateMachine) {}
}

验证方式 #

在动作中手动抛出测试异常，启动状态机后查看日志，确认stateMachineError中的错误信息及完整栈轨迹是否正常输出。

内容的提问来源于stack exchange，提问作者Mehrdad Bozorgmehr