如何监听发送至Spring State Machine的每一个事件？

要监听并记录Spring State Machine接收的每一个事件，你可以通过以下几种可行方式实现：

1. 自定义EventInterceptor拦截事件 #

Spring State Machine提供的EventInterceptor接口，其中preEvent方法会在事件被状态机处理前触发——无论该事件是否会引发状态转换，都能被捕获到，还能结合状态机上下文做记录。

实现步骤： #

• 编写自定义拦截器类，实现EventInterceptor并重写preEvent方法：

@Component
public class EventLoggingInterceptor implements EventInterceptor<States, Events> {

    private static final Logger logger = LoggerFactory.getLogger(EventLoggingInterceptor.class);

    @Override
    public Message<Events> preEvent(Message<Events> message, StateMachine<States, Events> stateMachine) {
        // 记录事件详情：事件类型、消息头、状态机当前状态
        logger.info("状态机接收到事件: {}, 消息头: {}, 当前状态: {}",
                message.getPayload(),
                message.getHeaders(),
                stateMachine.getState().getId());
        return message; // 返回原消息，不干扰后续处理流程
    }
}

• 在状态机配置类中注册该拦截器：

@Configuration
@EnableStateMachine
public class StateMachineConfig extends StateMachineConfigurerAdapter<States, Events> {

    @Autowired
    private EventLoggingInterceptor eventLoggingInterceptor;

    @Override
    public void configure(StateMachineConfigurationConfigurer<States, Events> config) throws Exception {
        config
            .withConfiguration()
            .and()
            .withInterceptors(eventLoggingInterceptor);
    }

    // 状态、转换等其他配置省略
}

2. 自定义ChannelInterceptor拦截消息通道 #

Spring State Machine的事件通过消息通道传递，在通道层面拦截可以捕获到所有发送给状态机的事件——哪怕事件被过滤未进入状态机处理流程，也能被记录。

实现步骤： #

• 编写通道拦截器类：

@Component
public class MessageChannelLoggingInterceptor implements ChannelInterceptor {

    private static final Logger logger = LoggerFactory.getLogger(MessageChannelLoggingInterceptor.class);

    @Override
    public Message<?> preSend(Message<?> message, MessageChannel channel) {
        // 仅处理状态机事件类型的消息
        if (message.getPayload() instanceof Events) {
            logger.info("消息通道接收到状态机事件: {}, 消息头: {}",
                    message.getPayload(),
                    message.getHeaders());
        }
        return message;
    }
}

• 注册拦截器到状态机的输入消息通道：

@Configuration
public class ChannelConfig {

    @Autowired
    private MessageChannelLoggingInterceptor loggingInterceptor;

    @Autowired
    private StateMachine<States, Events> stateMachine;

    @PostConstruct
    public void registerChannelInterceptor() {
        // 获取状态机的输入通道
        MessageChannel inputChannel = stateMachine.getStateMachineAccessor()
                .doWithAllRegions(sma -> sma.getStateMachineExecutor().getEventExecutor().getInputChannel());
        if (inputChannel instanceof AbstractMessageChannel) {
            ((AbstractMessageChannel) inputChannel).addInterceptor(loggingInterceptor);
        }
    }
}

3. 代理状态机的sendEvent方法 #

直接包装状态机的事件发送方法，在调用原方法前记录事件，适合简单的日志记录场景，逻辑直观。

实现步骤： #

• 编写状态机代理类，委托所有方法并在sendEvent时记录：

@Component
public class LoggingStateMachineProxy implements StateMachine<States, Events> {

    private final StateMachine<States, Events> delegate;
    private static final Logger logger = LoggerFactory.getLogger(LoggingStateMachineProxy.class);

    @Autowired
    public LoggingStateMachineProxy(StateMachine<States, Events> delegate) {
        this.delegate = delegate;
    }

    @Override
    public boolean sendEvent(Message<Events> event) {
        logger.info("状态机即将处理事件: {}, 消息头: {}", event.getPayload(), event.getHeaders());
        return delegate.sendEvent(event);
    }

    @Override
    public boolean sendEvent(Events event) {
        logger.info("状态机即将处理事件: {}", event);
        return delegate.sendEvent(event);
    }

    // 其他所有方法直接委托给delegate，此处省略实现
}

• 确保业务代码中注入的是该代理类而非原生状态机Bean（可通过调整Bean优先级实现）。

内容的提问来源于stack exchange，提问作者Aman Kumar Sinha