拓冰网站优化 
1. 为什么需要状态机在开发复杂业务系统时我们经常遇到需要管理对象状态流转的场景。比如订单从待支付到已支付再到已发货或者工单从新建到处理中再到已解决。这些场景如果用传统的if-else或者switch-case来实现代码会变得难以维护。我去年接手过一个电商订单系统状态判断逻辑散落在十几个Service类中每次新增状态都要修改多处代码。更可怕的是有些边缘case的状态流转没有正确处理导致出现了已取消的订单还能发货的严重bug。这就是典型的状态管理失控。Spring Statemachine后文简称SSM就是为了解决这类问题而生的。它提供了一种声明式的方式来定义状态和流转规则让状态管理变得清晰可控。通过将状态逻辑集中管理我们可以直观看到所有状态和流转路径避免非法状态转换方便添加状态变更的监听逻辑支持分布式环境下的状态管理2. 环境准备与基础配置2.1 创建SpringBoot项目使用IDEA创建一个新的SpringBoot项目选择以下依赖Spring Web (如果要做REST接口)Lombok (简化代码)Spring Statemachine或者直接在pom.xml中添加dependency groupIdorg.springframework.statemachine/groupId artifactIdspring-statemachine-starter/artifactId version3.2.0/version /dependency注意SpringBoot 3.x用户需要使用SSM 3.x版本2.x用户使用2.x版本避免兼容性问题。2.2 定义状态和事件枚举我们先以一个简单的订单状态机为例public enum OrderStates { // 初始状态 UNPAID, // 待支付 WAITING_FOR_RECEIVE, // 待收货 DONE, // 已完成 CANCELLED // 已取消 } public enum OrderEvents { PAY, // 支付 RECEIVE, // 收货 CANCEL // 取消 }3. 配置状态机3.1 基础配置类创建一个配置类继承StateMachineConfigurerAdapterConfiguration EnableStateMachine public class StateMachineConfig extends StateMachineConfigurerAdapterOrderStates, OrderEvents { Override public void configure(StateMachineStateConfigurerOrderStates, OrderEvents states) throws Exception { states .withStates() .initial(OrderStates.UNPAID) .states(EnumSet.allOf(OrderStates.class)); } Override public void configure(StateMachineTransitionConfigurerOrderStates, OrderEvents transitions) throws Exception { transitions .withExternal() .source(OrderStates.UNPAID).target(OrderStates.WAITING_FOR_RECEIVE) .event(OrderEvents.PAY) .and() .withExternal() .source(OrderStates.WAITING_FOR_RECEIVE).target(OrderStates.DONE) .event(OrderEvents.RECEIVE) .and() .withExternal() .source(OrderStates.UNPAID).target(OrderStates.CANCELLED) .event(OrderEvents.CANCEL); } }这个配置定义了初始状态是UNPAID从UNPAID可以通过PAY事件转到WAITING_FOR_RECEIVE从WAITING_FOR_RECEIVE可以通过RECEIVE事件转到DONE从UNPAID可以通过CANCEL事件转到CANCELLED3.2 添加状态监听器很多时候我们需要在状态变化时执行一些业务逻辑比如发送通知、记录日志等Component public class OrderStateListener implements StateMachineListenerOrderStates, OrderEvents { Override public void stateChanged(StateOrderStates, OrderEvents from, StateOrderStates, OrderEvents to) { if (from ! null) { log.info(状态变更: {} - {}, from.getId(), to.getId()); } if (to.getId() OrderStates.WAITING_FOR_RECEIVE) { // 发送支付成功通知 notificationService.sendPaymentSuccess(); } } }然后在配置类中注册这个监听器Override public void configure(StateMachineConfigurationConfigurerOrderStates, OrderEvents config) throws Exception { config .withConfiguration() .listener(orderStateListener); }4. 使用状态机4.1 注入并使用状态机在Service中注入并使用状态机Service RequiredArgsConstructor public class OrderService { private final StateMachineFactoryOrderStates, OrderEvents stateMachineFactory; public void pay(String orderId) { StateMachineOrderStates, OrderEvents stateMachine stateMachineFactory.getStateMachine(orderId); stateMachine.sendEvent(OrderEvents.PAY); } public void cancel(String orderId) { StateMachineOrderStates, OrderEvents stateMachine stateMachineFactory.getStateMachine(orderId); stateMachine.sendEvent(OrderEvents.CANCEL); } }4.2 持久化状态机默认情况下状态机是内存中的。要实现持久化我们需要实现StateMachinePersister接口配置Repository支持Bean public StateMachinePersisterOrderStates, OrderEvents, String persister( StateMachineRuntimePersisterOrderStates, OrderEvents, String stateMachineRuntimePersister) { return new DefaultStateMachinePersister(stateMachineRuntimePersister); } // 使用示例 Transactional public void persistState(String orderId) throws Exception { StateMachineOrderStates, OrderEvents stateMachine stateMachineFactory.getStateMachine(orderId); stateMachinePersister.persist(stateMachine, orderId); } Transactional public void restoreState(String orderId) throws Exception { StateMachineOrderStates, OrderEvents stateMachine stateMachineFactory.getStateMachine(orderId); stateMachinePersister.restore(stateMachine, orderId); }5. 高级功能5.1 状态机区域Regions对于复杂的状态模型可以使用区域来划分Override public void configure(StateMachineStateConfigurerOrderStates, OrderEvents states) throws Exception { states .withStates() .initial(OrderStates.UNPAID) .state(OrderStates.UNPAID) .and() .withStates() .parent(OrderStates.UNPAID) .initial(OrderStates.SUBSTATE1) .state(OrderStates.SUBSTATE2); }5.2 保护条件Guards可以在状态转换时添加条件判断Override public void configure(StateMachineTransitionConfigurerOrderStates, OrderEvents transitions) throws Exception { transitions .withExternal() .source(OrderStates.UNPAID) .target(OrderStates.WAITING_FOR_RECEIVE) .event(OrderEvents.PAY) .guard(paymentGuard()); } Bean public GuardOrderStates, OrderEvents paymentGuard() { return context - { // 检查支付是否成功 return paymentService.checkPaymentSuccess(context.getMessageHeaders()); }; }5.3 动作Actions可以在状态转换前后执行动作transitions .withExternal() .source(OrderStates.UNPAID) .target(OrderStates.WAITING_FOR_RECEIVE) .event(OrderEvents.PAY) .action(paymentAction()); Bean public ActionOrderStates, OrderEvents paymentAction() { return context - { // 执行支付后操作 paymentService.processPayment(context.getMessageHeaders()); }; }6. 常见问题与解决方案6.1 状态机不响应事件可能原因当前状态不支持该事件没有正确初始化状态机事件类型不匹配解决方案// 确保状态机已启动 if (!stateMachine.isRunning()) { stateMachine.start(); } // 检查当前状态是否支持该事件 StateOrderStates, OrderEvents currentState stateMachine.getState(); if (currentState.getIds().stream().anyMatch(id - stateMachine.getTransitions().stream() .anyMatch(t - t.getSource().getId().equals(id) t.getTrigger().getEvent().equals(event)))) { stateMachine.sendEvent(event); }6.2 分布式环境下的状态同步在微服务架构中可以使用Redis或Zookeeper来实现分布式状态机Bean public StateMachineRuntimePersisterOrderStates, OrderEvents, String redisPersister( RedisConnectionFactory connectionFactory) { return new RedisStateMachineRuntimePersister(connectionFactory, stateMachine:); }6.3 性能优化对于高频状态变更的场景使用轻量级状态机避免在动作中执行耗时操作考虑异步处理状态变更Async public void asyncProcessOrder(String orderId) { StateMachineOrderStates, OrderEvents stateMachine stateMachineFactory.getStateMachine(orderId); stateMachine.sendEvent(OrderEvents.PAY); }7. 测试策略7.1 单元测试测试状态机配置是否正确SpringBootTest public class StateMachineTest { Autowired private StateMachineFactoryOrderStates, OrderEvents factory; Test public void testUnpaidToWaiting() { StateMachineOrderStates, OrderEvents stateMachine factory.getStateMachine(test1); stateMachine.start(); assertEquals(OrderStates.UNPAID, stateMachine.getState().getId()); stateMachine.sendEvent(OrderEvents.PAY); assertEquals(OrderStates.WAITING_FOR_RECEIVE, stateMachine.getState().getId()); } }7.2 集成测试测试整个业务流程Test public void testOrderFlow() { String orderId test-order-1; orderService.createOrder(orderId); assertEquals(OrderStates.UNPAID, orderService.getCurrentState(orderId)); orderService.pay(orderId); assertEquals(OrderStates.WAITING_FOR_RECEIVE, orderService.getCurrentState(orderId)); orderService.receive(orderId); assertEquals(OrderStates.DONE, orderService.getCurrentState(orderId)); }8. 实际项目中的经验分享在电商系统中使用SSM时我总结了以下几点经验状态定义要全面不要遗漏边缘状态比如退款中、部分发货等事件命名要业务化使用PAY而不是CHANGE_STATE_TO_PAID避免过度复杂如果状态超过10个考虑拆分成多个状态机记录状态变更历史这对排查问题非常有帮助考虑幂等性相同事件多次触发应该有相同结果一个实用的技巧是使用WithStateMachine注解来简化监听器代码WithStateMachine public class OrderStateListener { OnTransition(source UNPAID, target WAITING_FOR_RECEIVE) public void onPaid() { // 支付成功处理逻辑 } }对于复杂的业务规则可以将状态机配置外部化使用DSL或者数据库存储状态流转规则实现动态配置。 Spring Statemachine实现订单状态管理的最佳实践
1. 为什么需要状态机在开发复杂业务系统时我们经常遇到需要管理对象状态流转的场景。比如订单从待支付到已支付再到已发货或者工单从新建到处理中再到已解决。这些场景如果用传统的if-else或者switch-case来实现代码会变得难以维护。我去年接手过一个电商订单系统状态判断逻辑散落在十几个Service类中每次新增状态都要修改多处代码。更可怕的是有些边缘case的状态流转没有正确处理导致出现了已取消的订单还能发货的严重bug。这就是典型的状态管理失控。Spring Statemachine后文简称SSM就是为了解决这类问题而生的。它提供了一种声明式的方式来定义状态和流转规则让状态管理变得清晰可控。通过将状态逻辑集中管理我们可以直观看到所有状态和流转路径避免非法状态转换方便添加状态变更的监听逻辑支持分布式环境下的状态管理2. 环境准备与基础配置2.1 创建SpringBoot项目使用IDEA创建一个新的SpringBoot项目选择以下依赖Spring Web (如果要做REST接口)Lombok (简化代码)Spring Statemachine或者直接在pom.xml中添加dependency groupIdorg.springframework.statemachine/groupId artifactIdspring-statemachine-starter/artifactId version3.2.0/version /dependency注意SpringBoot 3.x用户需要使用SSM 3.x版本2.x用户使用2.x版本避免兼容性问题。2.2 定义状态和事件枚举我们先以一个简单的订单状态机为例public enum OrderStates { // 初始状态 UNPAID, // 待支付 WAITING_FOR_RECEIVE, // 待收货 DONE, // 已完成 CANCELLED // 已取消 } public enum OrderEvents { PAY, // 支付 RECEIVE, // 收货 CANCEL // 取消 }3. 配置状态机3.1 基础配置类创建一个配置类继承StateMachineConfigurerAdapterConfiguration EnableStateMachine public class StateMachineConfig extends StateMachineConfigurerAdapterOrderStates, OrderEvents { Override public void configure(StateMachineStateConfigurerOrderStates, OrderEvents states) throws Exception { states .withStates() .initial(OrderStates.UNPAID) .states(EnumSet.allOf(OrderStates.class)); } Override public void configure(StateMachineTransitionConfigurerOrderStates, OrderEvents transitions) throws Exception { transitions .withExternal() .source(OrderStates.UNPAID).target(OrderStates.WAITING_FOR_RECEIVE) .event(OrderEvents.PAY) .and() .withExternal() .source(OrderStates.WAITING_FOR_RECEIVE).target(OrderStates.DONE) .event(OrderEvents.RECEIVE) .and() .withExternal() .source(OrderStates.UNPAID).target(OrderStates.CANCELLED) .event(OrderEvents.CANCEL); } }这个配置定义了初始状态是UNPAID从UNPAID可以通过PAY事件转到WAITING_FOR_RECEIVE从WAITING_FOR_RECEIVE可以通过RECEIVE事件转到DONE从UNPAID可以通过CANCEL事件转到CANCELLED3.2 添加状态监听器很多时候我们需要在状态变化时执行一些业务逻辑比如发送通知、记录日志等Component public class OrderStateListener implements StateMachineListenerOrderStates, OrderEvents { Override public void stateChanged(StateOrderStates, OrderEvents from, StateOrderStates, OrderEvents to) { if (from ! null) { log.info(状态变更: {} - {}, from.getId(), to.getId()); } if (to.getId() OrderStates.WAITING_FOR_RECEIVE) { // 发送支付成功通知 notificationService.sendPaymentSuccess(); } } }然后在配置类中注册这个监听器Override public void configure(StateMachineConfigurationConfigurerOrderStates, OrderEvents config) throws Exception { config .withConfiguration() .listener(orderStateListener); }4. 使用状态机4.1 注入并使用状态机在Service中注入并使用状态机Service RequiredArgsConstructor public class OrderService { private final StateMachineFactoryOrderStates, OrderEvents stateMachineFactory; public void pay(String orderId) { StateMachineOrderStates, OrderEvents stateMachine stateMachineFactory.getStateMachine(orderId); stateMachine.sendEvent(OrderEvents.PAY); } public void cancel(String orderId) { StateMachineOrderStates, OrderEvents stateMachine stateMachineFactory.getStateMachine(orderId); stateMachine.sendEvent(OrderEvents.CANCEL); } }4.2 持久化状态机默认情况下状态机是内存中的。要实现持久化我们需要实现StateMachinePersister接口配置Repository支持Bean public StateMachinePersisterOrderStates, OrderEvents, String persister( StateMachineRuntimePersisterOrderStates, OrderEvents, String stateMachineRuntimePersister) { return new DefaultStateMachinePersister(stateMachineRuntimePersister); } // 使用示例 Transactional public void persistState(String orderId) throws Exception { StateMachineOrderStates, OrderEvents stateMachine stateMachineFactory.getStateMachine(orderId); stateMachinePersister.persist(stateMachine, orderId); } Transactional public void restoreState(String orderId) throws Exception { StateMachineOrderStates, OrderEvents stateMachine stateMachineFactory.getStateMachine(orderId); stateMachinePersister.restore(stateMachine, orderId); }5. 高级功能5.1 状态机区域Regions对于复杂的状态模型可以使用区域来划分Override public void configure(StateMachineStateConfigurerOrderStates, OrderEvents states) throws Exception { states .withStates() .initial(OrderStates.UNPAID) .state(OrderStates.UNPAID) .and() .withStates() .parent(OrderStates.UNPAID) .initial(OrderStates.SUBSTATE1) .state(OrderStates.SUBSTATE2); }5.2 保护条件Guards可以在状态转换时添加条件判断Override public void configure(StateMachineTransitionConfigurerOrderStates, OrderEvents transitions) throws Exception { transitions .withExternal() .source(OrderStates.UNPAID) .target(OrderStates.WAITING_FOR_RECEIVE) .event(OrderEvents.PAY) .guard(paymentGuard()); } Bean public GuardOrderStates, OrderEvents paymentGuard() { return context - { // 检查支付是否成功 return paymentService.checkPaymentSuccess(context.getMessageHeaders()); }; }5.3 动作Actions可以在状态转换前后执行动作transitions .withExternal() .source(OrderStates.UNPAID) .target(OrderStates.WAITING_FOR_RECEIVE) .event(OrderEvents.PAY) .action(paymentAction()); Bean public ActionOrderStates, OrderEvents paymentAction() { return context - { // 执行支付后操作 paymentService.processPayment(context.getMessageHeaders()); }; }6. 常见问题与解决方案6.1 状态机不响应事件可能原因当前状态不支持该事件没有正确初始化状态机事件类型不匹配解决方案// 确保状态机已启动 if (!stateMachine.isRunning()) { stateMachine.start(); } // 检查当前状态是否支持该事件 StateOrderStates, OrderEvents currentState stateMachine.getState(); if (currentState.getIds().stream().anyMatch(id - stateMachine.getTransitions().stream() .anyMatch(t - t.getSource().getId().equals(id) t.getTrigger().getEvent().equals(event)))) { stateMachine.sendEvent(event); }6.2 分布式环境下的状态同步在微服务架构中可以使用Redis或Zookeeper来实现分布式状态机Bean public StateMachineRuntimePersisterOrderStates, OrderEvents, String redisPersister( RedisConnectionFactory connectionFactory) { return new RedisStateMachineRuntimePersister(connectionFactory, stateMachine:); }6.3 性能优化对于高频状态变更的场景使用轻量级状态机避免在动作中执行耗时操作考虑异步处理状态变更Async public void asyncProcessOrder(String orderId) { StateMachineOrderStates, OrderEvents stateMachine stateMachineFactory.getStateMachine(orderId); stateMachine.sendEvent(OrderEvents.PAY); }7. 测试策略7.1 单元测试测试状态机配置是否正确SpringBootTest public class StateMachineTest { Autowired private StateMachineFactoryOrderStates, OrderEvents factory; Test public void testUnpaidToWaiting() { StateMachineOrderStates, OrderEvents stateMachine factory.getStateMachine(test1); stateMachine.start(); assertEquals(OrderStates.UNPAID, stateMachine.getState().getId()); stateMachine.sendEvent(OrderEvents.PAY); assertEquals(OrderStates.WAITING_FOR_RECEIVE, stateMachine.getState().getId()); } }7.2 集成测试测试整个业务流程Test public void testOrderFlow() { String orderId test-order-1; orderService.createOrder(orderId); assertEquals(OrderStates.UNPAID, orderService.getCurrentState(orderId)); orderService.pay(orderId); assertEquals(OrderStates.WAITING_FOR_RECEIVE, orderService.getCurrentState(orderId)); orderService.receive(orderId); assertEquals(OrderStates.DONE, orderService.getCurrentState(orderId)); }8. 实际项目中的经验分享在电商系统中使用SSM时我总结了以下几点经验状态定义要全面不要遗漏边缘状态比如退款中、部分发货等事件命名要业务化使用PAY而不是CHANGE_STATE_TO_PAID避免过度复杂如果状态超过10个考虑拆分成多个状态机记录状态变更历史这对排查问题非常有帮助考虑幂等性相同事件多次触发应该有相同结果一个实用的技巧是使用WithStateMachine注解来简化监听器代码WithStateMachine public class OrderStateListener { OnTransition(source UNPAID, target WAITING_FOR_RECEIVE) public void onPaid() { // 支付成功处理逻辑 } }对于复杂的业务规则可以将状态机配置外部化使用DSL或者数据库存储状态流转规则实现动态配置。