Spring StateMachine框架可能对于大部分使用Spring的开发者来说还比较生僻,它的主要功能是帮助开发者简化状态机的开发过程,让状态机结构更加层次化。
快速入门
依照之前的风格,我们通过一个简单的示例来对Spring StateMachine有一个初步的认识。假设我们需要实现一个订单的相关流程,其中包括订单创建、订单支付、订单收货三个动作。
下面我们来详细的介绍整个实现过程:
- 创建一个Spring Boot的基础工程,并在 pom.xml中加入 spring-statemachine-core的依赖,具体如下:
根据上面所述的订单需求场景定义状态和事件枚举,具体如下:
其中共有三个状态(待支付、待收货、结束)以及两个引起状态迁移的事件(支付、收货),其中支付事件 PAY会触发状态从待支付 UNPAID状态到待收货 WAITING_FOR_RECEIVE状态的迁移,而收货事件 RECEIVE会触发状态从待收货 WAITING_FOR_RECEIVE状态到结束 DONE状态的迁移。
- 创建状态机配置类:
在该类中定义了较多配置内容,下面对这些内容一一说明:
- @EnableStateMachine注解用来启用Spring StateMachine状态机功能
- configure(StateMachineStateConfigurerstates)方法用来初始化当前状态机拥有哪些状态,其中 initial(States.UNPAID)定义了初始状态为 UNPAID, states(EnumSet.allOf(States.class))则指定了使用上一步中定义的所有状态作为该状态机的状态定义。
- configure(StateMachineTransitionConfigurertransitions)方法用来初始化当前状态机有哪些状态迁移动作,其中命名中我们很容易理解每一个迁移动作,都有来源状态 source,目标状态 target以及触发事件 event。
- configure(StateMachineConfigurationConfigurerconfig)方法为当前的状态机指定了状态监听器,其中 listener()则是调用了下一个内容创建的监听器实例,用来处理各个各个发生的状态迁移事件。
StateMachineListenerlistener()方法用来创建 StateMachineListener状态监听器的实例,在该实例中会定义具体的状态迁移处理逻辑,上面的实现中只是做了一些输出,实际业务场景会会有更负责的逻辑,所以通常情况下,我们可以将该实例的定义放到独立的类定义中,并用注入的方式加载进来。创建应用主类来完成整个流程:
在 run函数中,我们定义了整个流程的处理过程,其中 start()就是创建这个订单流程,根据之前的定义,该订单会处于待支付状态,然后通过调用 sendEvent(Events.PAY)执行支付操作,最后通过掉用 sendEvent(Events.RECEIVE)来完成收货操作。在运行了上述程序之后,我们可以在控制台中获得类似下面的输出内容:
其中包括了状态监听器中对各个状态迁移做出的处理。
通过上面的例子,我们可以对如何使用Spring StateMachine做如下小结:
- 定义状态和事件枚举
- 为状态机定义使用的所有状态以及初始状态
- 为状态机定义状态的迁移动作
- 为状态机指定监听处理器
状态监听器
通过上面的入门示例以及最后的小结,我们可以看到使用Spring StateMachine来实现状态机的时候,代码逻辑变得非常简单并且具有层次化。整个状态的调度逻辑主要依靠配置方式的定义,而所有的业务逻辑操作都被定义在了状态监听器中,其实状态监听器可以实现的功能远不止上面我们所述的内容,它还有更多的事件捕获,我们可以通过查看 StateMachineListener接口来了解它所有的事件定义:
注解监听器
对于状态监听器,Spring StateMachine还提供了优雅的注解配置实现方式,所有 StateMachineListener接口中定义的事件都能通过注解的方式来进行配置实现。比如,我们可以将之前实现的状态监听器用注解配置来做进一步的简化:
上述代码实现了与快速入门中定义的 listener()方法创建的监听器相同的功能,但是由于通过注解的方式配置,省去了原来事件监听器中各种if的判断,使得代码显得更为简洁,拥有了更好的可读性。