- 根据上面所述的订单需求场景定义状态和事件枚举,具体如下:
public enum States {
UNPAID, // 待支付
WAITING_FOR_RECEIVE, // 待收货
DONE // 结束
}
public enum Events {
PAY, // 支付
RECEIVE // 收货
}
其中共有三个状态(待支付、待收货、结束)以及两个引起状态迁移的事件(支付、收货),其中支付事件PAY
会触发状态从待支付UNPAID
状态到待收货WAITING_FOR_RECEIVE
状态的迁移,而收货事件RECEIVE
会触发状态从待收货WAITING_FOR_RECEIVE
状态到结束DONE
状态的迁移。
- 创建状态机配置类:
@Configuration
@EnableStateMachine
public class StateMachineConfig extends EnumStateMachineConfigurerAdapter<States, Events> {
private Logger logger = LoggerFactory.getLogger(getClass());
@Override
public void configure(StateMachineStateConfigurer<States, Events> states)
throws Exception {
states
.withStates()
.initial(States.UNPAID)
.states(EnumSet.allOf(States.class));
}
@Override
public void configure(StateMachineTransitionConfigurer<States, Events> transitions)
throws Exception {
transitions
.withExternal()
.source(States.UNPAID).target(States.WAITING_FOR_RECEIVE)
.event(Events.PAY)
.and()
.withExternal()
.source(States.WAITING_FOR_RECEIVE).target(States.DONE)
.event(Events.RECEIVE);
}
@Override
public void configure(StateMachineConfigurationConfigurer<States, Events> config)
throws Exception {
config
.withConfiguration()
.listener(listener());
}
@Bean
public StateMachineListener<States, Events> listener() {
return new StateMachineListenerAdapter<States, Events>() {
@Override
public void transition(Transition<States, Events> transition) {
if(transition.getTarget().getId() == States.UNPAID) {
logger.info(“订单创建,待支付”);
return;
}
if(transition.getSource().getId() == States.UNPAID
&& transition.getTarget().getId() == States.WAITING_FOR_RECEIVE) {
logger.info(“用户完成支付,待收货”);
return;
}
if(transition.getSource().getId() == States.WAITING_FOR_RECEIVE
&& transition.getTarget().getId() == States.DONE) {
logger.info(“用户已收货,订单完成”);
return;
}
}
};
}
}
在该类中定义了较多配置内容,下面对这些内容一一说明:
-
@EnableStateMachine
注解用来启用Spring StateMachine状态机功能 -
configure(StateMachineStateConfigurer<States, Events> states)
方法用来初始化当前状态机拥有哪些状态,其中initial(States.UNPAID)
定义了初始状态为UNPAID
,states(EnumSet.allOf(States.class))
则指定了使用上一步中定义的所有状态作为该状态机的状态定义。
@Override
public void configure(StateMachineStateConfigurer<States, Events> states)
throws Exception {
// 定义状态机中的状态
states
.withStates()
.initial(States.UNPAID) // 初始状态
.states(EnumSet.allOf(States.class));
}
configure(StateMachineTransitionConfigurer<States, Events> transitions)
方法用来初始化当前状态机有哪些状态迁移动作,其中命名中我们很容易理解每一个迁移动作,都有来源状态source
,目标状态target
以及触发事件event
。
@Override
public void configure(StateMachineTransitionConfigurer<States, Events> transitions)
throws Exception {
transitions
.withExternal()
.source(States.UNPAID).target(States.WAITING_FOR_RECEIVE)// 指定状态来源和目标
.event(Events.PAY) // 指定触发事件
.and()
.withExternal()
.source(States.WAITING_FOR_RECEIVE).target(States.DONE)
.event(Events.RECEIVE);
}
configure(StateMachineConfigurationConfigurer<States, Events> config)
方法为当前的状态机指定了状态监听器,其中listener()
则是调用了下一个内容创建的监听器实例,用来处理各个各个发生的状态迁移事件。
@Override
public void configure(StateMachineConfigurationConfigurer<States, Events> config)
throws Exception {
config
.withConfiguration()
.listener(listener()); // 指定状态机的处理监听器
}
-
StateMachineListener<States, Events> listener()
方法用来创建StateMachineListener
状态监听器的实例,在该实例中会定义具体的状态迁移处理逻辑,上面的实现中只是做了一些输出,实际业务场景会会有更负责的逻辑,所以通常情况下,我们可以将该实例的定义放到独立的类定义中,并用注入的方式加载进来。 -
创建应用主类来完成整个流程:
@SpringBootApplication
public class Application implements CommandLineRunner {
public static void main(String[] args) {
SpringApplication.run(Application.class, args);
}
@Autowired
private StateMachine<States, Events> stateMachine;
@Override
public void run(String… args) throws Exception {
stateMachine.start();
stateMachine.sendEvent(Events.PAY);
stateMachine.sendEvent(Events.RECEIVE);
}
}
在run
函数中,我们定义了整个流程的处理过程,其中start()
就是创建这个订单流程,根据之前的定义,该订单会处于待支付状态,然后通过调用sendEvent(Events.PAY)
执行支付操作,最后通过掉用sendEvent(Events.RECEIVE)
来完成收货操作。在运行了上述程序之后,我们可以在控制台中获得类似下面的输出内容:
INFO 2312 — [ main] eConfig E n h a n c e r B y S p r i n g C G L I B EnhancerBySpringCGLIB EnhancerBySpringCGLIBa05acb3d : 订单创建,待支付
INFO 2312 — [ main] o.s.s.support.LifecycleObjectSupport : started org.springframework.statemachine.support.DefaultStateMachineExecutor@1d2290ce
INFO 2312 — [ main] o.s.s.support.LifecycleObjectSupport : started DONE UNPAID WAITING_FOR_RECEIVE / UNPAID / uuid=c65ec0aa-59f9-4ffb-a1eb-88ec902369b2 / id=null
INFO 2312 — [ main] eConfig E n h a n c e r B y S p r i n g C G L I B EnhancerBySpringCGLIB EnhancerBySpringCGLIBa05acb3d : 用户完成支付,待收货
INFO 2312 — [ main] eConfig E n h a n c e r B y S p r i n g C G L I B EnhancerBySpringCGLIB EnhancerBySpringCGLIBa05acb3d : 用户已收货,订单完成
其中包括了状态监听器中对各个状态迁移做出的处理。
通过上面的例子,我们可以对如何使用Spring StateMachine做如下小结:
-
定义状态和事件枚举
-
为状态机定义使用的所有状态以及初始状态
-
为状态机定义状态的迁移动作
-
为状态机指定监听处理器
状态监听器
通过上面的入门示例以及最后的小结,我们可以看到使用Spring StateMachine来实现状态机的时候,代码逻辑变得非常简单并且具有层次化。整个状态的调度逻辑主要依靠配置方式的定义,而所有的业务逻辑操作都被定义在了状态监听器中,其实状态监听器可以实现的功能远不止上面我们所述的内容,它还有更多的事件捕获,我们可以通过查看StateMachineListener
接口来了解它所有的事件定义:
自我介绍一下,小编13年上海交大毕业,曾经在小公司待过,也去过华为、OPPO等大厂,18年进入阿里一直到现在。
深知大多数Java工程师,想要提升技能,往往是自己摸索成长或者是报班学习,但对于培训机构动则几千的学费,着实压力不小。自己不成体系的自学效果低效又漫长,而且极易碰到天花板技术停滞不前!
因此收集整理了一份《2024年Java开发全套学习资料》,初衷也很简单,就是希望能够帮助到想自学提升又不知道该从何学起的朋友,同时减轻大家的负担。
既有适合小白学习的零基础资料,也有适合3年以上经验的小伙伴深入学习提升的进阶课程,基本涵盖了95%以上Java开发知识点,真正体系化!
由于文件比较大,这里只是将部分目录截图出来,每个节点里面都包含大厂面经、学习笔记、源码讲义、实战项目、讲解视频,并且会持续更新!
如果你觉得这些内容对你有帮助,可以扫码获取!!(备注Java获取)
![img](https://i-blog.csdnimg.cn/blog_migrate/9e207815a0b4edf21a75a03d215cc889.jpeg)
最后
手绘了下图所示的kafka知识大纲流程图(xmind文件不能上传,导出图片展现),但都可提供源文件给每位爱学习的朋友
《互联网大厂面试真题解析、进阶开发核心学习笔记、全套讲解视频、实战项目源码讲义》点击传送门即可获取!
如果你觉得这些内容对你有帮助,可以扫码获取!!(备注Java获取)**
![img](https://i-blog.csdnimg.cn/blog_migrate/9e207815a0b4edf21a75a03d215cc889.jpeg)
最后
手绘了下图所示的kafka知识大纲流程图(xmind文件不能上传,导出图片展现),但都可提供源文件给每位爱学习的朋友
[外链图片转存中…(img-plBvCsxx-1713524824138)]
《互联网大厂面试真题解析、进阶开发核心学习笔记、全套讲解视频、实战项目源码讲义》点击传送门即可获取!