[Spring]Spring-Statemachine 状态机

本文介绍了Spring状态机的主要特性,包括易于使用、层次化的状态机结构、类型安全的配置适配器等,并详细解释了状态机中的核心概念如状态、事件、转移等。此外还提供了状态机的配置实例和业务层的集成示例。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

输入图片说明

介绍

Spring状态机为程序开发员提供了传统状态机和Spring应用程序使用,有以下特性:

  1. 易于使用的状态机的用例
  2. 层次的状态机结构缓解复杂状态机的配置
  3. 状态机提供更复杂的配置状态
  4. 使用触发器、转移、警卫以及动作
  5. 类型安全的配置适配器
  6. 状态机的事件监听器
  7. IOC将状态机和bean整合

名词解释

  • State Machine
    • 将状态结合、转移、事件整合到一起
  • State
    • 一个不变的状态模型
    • 主要由一个事件修改实体的状态
  • Extended State
    • 扩展状态是一组特殊的变量保存在一个状态机来减少所需的数据量。
  • Transition
    • 源状态和目标状态之间的关系,它可能是复合过度的一部分,将状态机配置从一个状态到另一个地方,响应状态机的一个特定类型的事件的发生。
  • Event
    • 一个实体发送一个状态驱动各个状态的变化
  • Initial State
    • 状态机特殊的开始状态. 初始状态标记在一个状态或者一个区域上. 一个状态的多个区域都可能回到初始状态
  • End State
    • 一种最终状态,一种特殊的状态表示完成封闭区域,如果封闭区域直接包含在一个状态机状态机和其他地区也完成了,然后它意味着整个状态机完成。
  • History State
    • 伪状态可以记住它的最后活动的状态, 存在两种类型历史状态.
  • Choice State
    • 允许选择基础即过度, 事件标题或扩展状态变量.
  • Fork State
    • 状态赋予一个控制进入一个地区.
  • Join State
    • 状态赋予一个退出控制区域.
  • Region
    • 组合状态或者状态机。它包含状态和转换.
  • Guard
    • 用一个布尔表达式来表示扩展状态变量的价值动态评估和事件参数. 守卫条件影响的行为状态机通过启用操作或转换,只有当他们评估为TRUE并评估为FALSE时禁用它们.
  • Action
    • 行动是一种行为的触发过渡期间执行.

使用场景

  • 如果你的项目很好的使用状态机:
    • 应用程序的结构可以表示成状态的一部分。
    • 你希望复杂的逻辑分割成更小的可管理的任务。
    • 应用程序已经遭受异步的并发性问题。
  • 如果你准备实现一个状态机:
    • 使用布尔标记和枚举模型的情况
    • 对于某些应用程序生命周期的一部分的有效变量
    • 遍历if/else结构设置特定标示和枚举

例子

定义枚举和实现

/**
* 状态
*/
public enum Status{

    START,
    CANCEL,
    ENE;

}
/**
* 事件
*/
public enum Events {
    SAVE;
}

状态机配置

@Configuration
@EnableStateMachine(name = "orderStateMachine")
public class TestStateMachineConfig extends EnumStateMachineConfigurerAdapter<Status, Events> {

    @Resource
    private SaveAction saveAction;

    @Override
    public void configure(StateMachineStateConfigurer<Status, Events> states)
            throws Exception {
        states
                .withStates()
                .initial(Status.START)
                .states(EnumSet.allOf(Status.class));
    }

    @Override
    public void configure(StateMachineTransitionConfigurer<Status, Events> transitions)
            throws Exception {
        transitions
                .withExternal()
                .source(Status.START).target(Status.END)
                .event(Events.SAVE).action(saveAction)
                ;
    }

    @Override
    public void configure(StateMachineConfigurationConfigurer<Status, Events> config)
            throws Exception {
        config
                .withConfiguration().autoStartup(true)
                .listener(listener());
    }

    @Bean
    public StateMachineListener<Status, Events> listener() {
        return new StateMachineListenerAdapter<Status, Events>() {
            @Override
            public void transition(Transition<Status, Events> transition) {
                if (transition.getTarget().getId() == Status.START) {
                    System.out.println("创建");
                    return;
                }

            }
        };
    }


}

定义Action

@Component
public class SaveAction implements Action<Status, Events>{

    @Resource
    private OrderInfoService orderInfoService;

    @Override
    public void execute(StateContext<Status, Events> context) {
        Order order  = (Order) context.getMessageHeader(OrderStatusContextKey.ORDER_ENTITY_KEY);

        orderInfoService.save(order);

    }
}

状态机管理类

@Component
public class DefaultStateMachineManager implements InitializingBean, ApplicationContextAware {

    private static final String ORDER_STATE_MACHINE_CONFIG = "orderStateMachine";

    private ApplicationContext applicationContext;
    private StateMachine<Status, Events> orderStateMachine;
  

    @Override
    public void afterPropertiesSet() throws Exception {
        orderStateMachine = applicationContext.getBean(ORDER_STATE_MACHINE_CONFIG, StateMachine.class);
     
    }

    @Override
    public StateMachine<OrderStatus, Events> getOrderStateMachine() {
        return orderStateMachine;
    }

  

    @Override
    public void setApplicationContext(ApplicationContext applicationContext) throws BeansException {
        this.applicationContext = applicationContext;
    }
}

业务层

@Service
public class OrderBizImpl {

    @Resource
    private StateMachineManager stateMachineManager;

    @Override
    public void save(Order order) {

        if (order == null) {
            return;
        }

        StateMachine<Status, Events> orderStateMachine = stateMachineManager.getOrderStateMachine();

        Message<Events> message = MessageBuilder
                .withPayload(Events.SAVE)
                .setHeader(ORDER_ENTITY_KEY, order)
                .build();

        orderStateMachine.sendEvent(message);
    }


}

转载于:https://my.oschina.net/lowkeysoft/blog/1557698

<think>嗯,用户要求查找关于SpringStateMachine的使用指南或示例,包括配置步骤和代码示例。我已经得到了一些引用内容,虽然它们只是参考,但提供了一些有用的线索。在引用中看到,SpringStateMachine是一个用于管理状态流转的框架,特别适合订单系统、工作流引擎等场景。现在用户询问具体如何使用它创建状态机,我需要展示配置流程并提供实际代码示例。从引用中找到的关键信息包括:状态机需要分层构建、可以通过注解启用、需要定义状态和事件等元素。关于配置部分,引用提到需要定义状态、事件、状态转换规则和状态监听器。状态监听器可以在状态转换时执行特定操作,这点很重要,因为在实际使用中会需要处理业务逻辑。引用中还提到SpringBoot通过StateMachine框架提供支持,说明可以使用SpringBoot项目来整合这个框架。对于代码示例,引用中有个简单的订单流程示例,包括Order实体类和状态枚举类。状态枚举类列出可能的订单状态如待支付、已支付等;事件枚举列出触发状态变化的事件如支付、发货等。此外还需要配置状态转换规则,定义起始状态和目标状态。用户需要了解如何运行状态机,这涉及到通过Spring上下文获取状态机实例并触发事件。引用展示了一个SpringBoot应用启动类的例子,里面有创建订单并发送支付事件的代码。注意到官方文档链接在引用中,我应该推荐用户查看完整文档,因为框架的细节可能经常更新。同时提醒用户注意状态机设计的关键点:明确定义状态和事件、配置状态转换规则,以及利用状态监听器处理业务逻辑。准备在回答中包括配置依赖的示例代码、状态机和事件枚举类示例、状态机配置类示例、状态监听器实现和运行状态机的入口代码。最后总结创建状态机的主要步骤,帮用户理清思路。</think> 以下是使用 Spring StateMachine 创建状态机的完整指南和代码示例,结合官方文档和最佳实践整理: --- ### 一、核心步骤与配置 #### 1. 添加 Maven 依赖 ```xml <dependency> <groupId>org.springframework.statemachine</groupId> <artifactId>spring-statemachine-core</artifactId> <version>3.2.0</version> <!-- 使用最新版本 --> </dependency> ``` #### 2. 定义状态和事件枚举 ```java // 订单状态 public enum OrderStates { UNPAID, // 待支付 PAID, // 已支付 SHIPPED, // 已发货 RECEIVED, // 已签收 CANCELLED // 已取消 } // 订单事件 public enum OrderEvents { PAY, // 支付事件 SHIP, // 发货事件 CONFIRM_RECEIVE, // 确认收货 CANCEL // 取消订单 } ``` #### 3. 配置状态机(关键步骤) ```java @Configuration @EnableStateMachine public class StateMachineConfig extends EnumStateMachineConfigurerAdapter<OrderStates, OrderEvents> { @Override public void configure(StateMachineStateConfigurer<OrderStates, OrderEvents> states) throws Exception { states.withStates() .initial(OrderStates.UNPAID) // 初始状态 .states(EnumSet.allOf(OrderStates.class)); } @Override public void configure(StateMachineTransitionConfigurer<OrderStates, OrderEvents> transitions) throws Exception { transitions .withExternal() .source(OrderStates.UNPAID).target(OrderStates.PAID) .event(OrderEvents.PAY) .and() .withExternal() .source(OrderStates.PAID).target(OrderStates.SHIPPED) .event(OrderEvents.SHIP) .and() .withExternal() .source(OrderStates.SHIPPED).target(OrderStates.RECEIVED) .event(OrderEvents.CONFIRM_RECEIVE) .and() .withExternal() .source(OrderStates.UNPAID).target(OrderStates.CANCELLED) .event(OrderEvents.CANCEL); } @Bean public StateMachineListener<OrderStates, OrderEvents> listener() { return new StateMachineListenerAdapter<>() { @Override public void transition(Transition<OrderStates, OrderEvents> transition) { if (transition.getTarget() != null) { System.out.println("状态变更: " + transition.getSource().getId() + " -> " + transition.getTarget().getId()); } } }; } } ``` #### 4. 业务实体类 ```java @Data public class Order { private Long id; private OrderState state; // 使用定义的枚举类型 // 其他业务字段... } ``` #### 5. 使用状态机(在Service中) ```java @Service public class OrderService { @Autowired private StateMachineFactory<OrderStates, OrderEvents> factory; public void processOrderEvent(Long orderId, OrderEvents event) { StateMachine<OrderStates, OrderEvents> stateMachine = factory.getStateMachine(); stateMachine.start(); // 发送事件触发状态迁移 stateMachine.sendEvent(MessageBuilder .withPayload(event) .setHeader("orderId", orderId) .build()); } } ``` --- ### 二、关键特性说明 1. **层次化状态** ```java states.withStates() .parent(OrderStates.PROCESSING) // 父状态 .initial(OrderStates.PACKAGING) // 子状态 ``` 2. **动作执行** ```java transitions.withExternal() .source(OrderStates.UNPAID).target(OrderStates.PAID) .event(OrderEvents.PAY) .action(context -> { Long orderId = context.getMessage().getHeaders().get("orderId", Long.class); orderService.updatePaymentStatus(orderId); // 执行业务逻辑 }) ``` 3. **状态守卫(Guard)** ```java .guard(ctx -> { Order order = ctx.getExtendedState().get("order", Order.class); return order.getAmount() > 0; // 仅当金额>0才允许状态迁移 }) ``` --- ### 三、调试与监控 ```java // 打印状态机当前状态 System.out.println("Current state: " + stateMachine.getState().getId()); // 导出UML状态图(需添加spring-statemachine-uml) StateMachineModelVerifier<OrderStates, OrderEvents> verifier = new StateMachineModelVerifier<>(); verifier.verify(stateMachine); ``` > 官方文档推荐:[Spring StateMachine Docs](https://docs.spring.io/spring-statemachine/docs/current/reference/) > 调试工具:[State Machine Designer](https://rclayton.github.io/smithy/) --- ### 常见问题解决方案 1. **事件被拒绝?** - 检查当前状态是否支持该事件 - 验证守卫条件是否满足 - 确保状态机已启动 `.start()` 2. **并发处理** 对每笔订单创建独立状态机实例: ```java StateMachine<OrderStates, OrderEvents> stateMachine = factory.getStateMachine(orderId); ``` 3. **持久化状态** 使用`Repository`保存状态机: ```java @Bean public StateMachineRuntimePersister<...> persister() { return new JpaStateMachineRepository<>(/* JPA配置 */); } ``` --- ### 完整示例项目: GitHub 参考实现:[spring-statemachine-demo](https://github.com/spring-projects/spring-statemachine/tree/master/spring-statemachine-samples) > 最佳实践提示: > 1. 使用`@WithStateMachine`注解分离状态逻辑 > 2. 通过`StateMachineSystemConstants.TASK_EXECUTOR_BEAN_NAME`配置线程池 > 3. 使用`@EnableStateMachineFactory`创建多实例状态机工厂[^4]
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值