使用Spring StateMachine框架实现状态机
Spring StateMachine框架可能对于大部分使用Spring的开发者来说还比较生僻,该框架目前差不多也才刚满一岁多。它的主要功能是帮助开发者简化状态机的开发过程,让状态机结构更加层次化。前几天刚刚发布了它的第三个Release版本1.2.0,其中增加了对Spring Boot的自动化配置,既然一直在写Spring Boot的教程,所以干脆就将该内容也纳入进来吧,希望对有需求的小伙伴有一定的帮助。
快速入门
依照之前的风格,我们通过一个简单的示例来对Spring StateMachine有一个初步的认识。假设我们需要实现一个订单的相关流程,其中包括订单创建、订单支付、订单收货三个动作。
下面我们来详细的介绍整个实现过程:
创建一个Spring Boot的基础工程,并在
pom.xml
中加入spring-statemachine-core
的依赖,具体如下:<parent> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-parent</artifactId> <version>1.3.7.RELEASE</version> <relativePath/> </parent> <dependencies> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter</artifactId> </dependency> <dependency> <groupId>org.springframework.statemachine</groupId> <artifactId>spring-statemachine-core</artifactId> <version>1.2.0.RELEASE</version> </dependency></dependencies>
根据上面所述的订单需求场景定义状态和事件枚举,具体如下:
public enum States { UNPAID, // 待支付 WAITING_FOR_RECEIVE, // 待收货 DONE // 结束} public enum Events { PAY, // 支付 RECEIVE // 收货}
其中共有三个状态(待支付、待收货、结束)以及两个引起状态迁移的事件(支付、收货),其中支付事件
PAY
会触发状态从待支付UNPAID
状态到待收货WAITING_FOR_RECEIVE
状态的迁移,而收货事件RECEIVE
会触发状态从待收货WAITING_FOR_RECEIVE
状态到结束DONE
状态的迁移。创建状态机配置类:
@Configuration@EnableStateMachinepublic 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))
则指定了使用上一步中定义的所有状态作为该状态机的状态定义。@Overridepublic 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
。@Overridepublic 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()
则是调用了下一个内容创建的监听器实例,用来处理各个各个发生的状态迁移事件。@Overridepublic void configure(StateMachineConfigurationConfigurer<States, Events> config) throws Exception { config .withConfiguration() .listener(listener()); // 指定状态机的处理监听器}
StateMachineListener<States, Events> listener()
方法用来创建StateMachineListener
状态监听器的实例,在该实例中会定义具体的状态迁移处理逻辑,上面的实现中只是做了一些输出,实际业务场景会会有更负责的逻辑,所以通常情况下,我们可以将该实例的定义放到独立的类定义中,并用注入的方式加载进来。
创建应用主类来完成整个流程:
@SpringBootApplicationpublic 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$$EnhancerBySpringCGLIB$$a05acb3d : 订单创建,待支付INFO 2312 --- [ main] o.s.s.support.LifecycleObjectSupport : started org.springframework.statemachine.support.DefaultStateMachineExecutor@1d2290ceINFO 2312 --- [ main] o.s.s.support.LifecycleObjectSupport : started DONE UNPAID WAITING_FOR_RECEIVE / UNPAID / uuid=c65ec0aa-59f9-4ffb-a1eb-88ec902369b2 / id=nullINFO 2312 --- [ main] eConfig$$EnhancerBySpringCGLIB$$a05acb3d : 用户完成支付,待收货INFO 2312 --- [ main] eConfig$$EnhancerBySpringCGLIB$$a05acb3d : 用户已收货,订单完成
其中包括了状态监听器中对各个状态迁移做出的处理。
通过上面的例子,我们可以对如何使用Spring StateMachine做如下小结:
- 定义状态和事件枚举
- 为状态机定义使用的所有状态以及初始状态
- 为状态机定义状态的迁移动作
- 为状态机指定监听处理器
状态监听器
通过上面的入门示例以及最后的小结,我们可以看到使用Spring StateMachine来实现状态机的时候,代码逻辑变得非常简单并且具有层次化。整个状态的调度逻辑主要依靠配置方式的定义,而所有的业务逻辑操作都被定义在了状态监听器中,其实状态监听器可以实现的功能远不止上面我们所述的内容,它还有更多的事件捕获,我们可以通过查看StateMachineListener
接口来了解它所有的事件定义:
public interface StateMachineListener<S,E> { void stateChanged(State<S,E> from, State<S,E> to); void stateEntered(State<S,E> state); void stateExited(State<S,E> state); void eventNotAccepted(Message<E> event); void transition(Transition<S, E> transition); void transitionStarted(Transition<S, E> transition); void transitionEnded(Transition<S, E> transition); void stateMachineStarted(StateMachine<S, E> stateMachine); void stateMachineStopped(StateMachine<S, E> stateMachine); void stateMachineError(StateMachine<S, E> stateMachine, Exception exception); void extendedStateChanged(Object key, Object value); void stateContext(StateContext<S, E> stateContext); } |
注解监听器
对于状态监听器,Spring StateMachine还提供了优雅的注解配置实现方式,所有StateMachineListener
接口中定义的事件都能通过注解的方式来进行配置实现。比如,我们可以将之前实现的状态监听器用注解配置来做进一步的简化:
@WithStateMachinepublic class EventConfig { private Logger logger = LoggerFactory.getLogger(getClass()); @OnTransition(target = "UNPAID") public void create() { logger.info("订单创建,待支付"); } @OnTransition(source = "UNPAID", target = "WAITING_FOR_RECEIVE") public void pay() { logger.info("用户完成支付,待收货"); } @OnTransition(source = "WAITING_FOR_RECEIVE", target = "DONE") public void receive() { logger.info("用户已收货,订单完成"); } } |
上述代码实现了与快速入门中定义的listener()
方法创建的监听器相同的功能,但是由于通过注解的方式配置,省去了原来事件监听器中各种if的判断,使得代码显得更为简洁,拥有了更好的可读性。
本文完整示例:
- 开源中国:http://git.oschina.net/didispace/SpringBoot-Learning/tree/master/Chapter6-1-1
- GitHub:https://github.com/dyc87112/SpringCloud-Learning/tree/master/1-Brixton%E7%89%88%E6%95%99%E7%A8%8B%E7%A4%BA%E4%BE%8B/Chapter6-1-1
使用Spring StateMachine框架实现状态机相关推荐
- Spring StateMachine,教你快速实现一个状态机
来源:http://t.cn/RIxCXiO Spring StateMachine框架可能对于大部分使用Spring的开发者来说还比较生僻,它的主要功能是帮助开发者简化状态机的开发过程,让状态机结构 ...
- Spring Statemachine 简介
Spring Statemachine 简介 Spring Statemachine是Spring官方提供的一个框架,供应用程序开发人员在Spring应用程序中使用状态机.支持状态的嵌套(substa ...
- Spring系列学习之Spring Statemachine状态机
英文原文:https://projects.spring.io/spring-statemachine/ 目录 快速开始 Builder JavaConfig 版本 资源 实战 Spring Stat ...
- spring statemachine的企业可用级开发指南1-说些废话
2019独角兽企业重金招聘Python工程师标准>>> 1.背景 在我打算学习spring statemachine的时候,我几乎看过了所有网上的中文教程,基本上都处于浅尝辄止的阶段 ...
- 初试SpringStateMachine框架实现状态机
官网:https://projects.spring.io/spring-statemachine/ 官网这里列出了很多特性,说的就是易于使用的状态机,帮助开发者简化状态机的开发过程,让状态机结构更加 ...
- Spring StateMachine(2) UML状态图支持
还是刚才的以二级审批请假流程为例. 绘制流程 首先创建 Papyrus 项目,选择 StateMachine 模板,绘制流程图如下: 然后创建 6 个 signal event 和与之绑定的 sign ...
- 【Spring】框架简介
[Spring]框架简介 Spring是什么 Spring是分层的Java SE/EE应用full-stack轻量级开源框架,以IOC(Inverse Of Control:反转控制)和AOP(Asp ...
- Spring MVC 框架搭建及详解
现在主流的Web MVC框架除了Struts这个主力 外,其次就是Spring MVC了,因此这也是作为一名程序员需要掌握的主流框架,框架选择多了,应对多变的需求和业务时,可实行的方案自然就多了.不过 ...
- 使用Spring JDBC框架连接并操作数据库
在前一篇博文JAVA通过JDBC连接并操作MySQL数据库中,我们知道如何通过JDBC连接并操作数据库,但是请看程序,整个程序连接数据库和关闭数据库占了很大一部分代码量,而且每次我们执行一下数据库操作 ...
最新文章
- 人工智能:从经典计算机到量子计算机,弱AI进阶到强AI时代?
- $.ajax的一些坑啊
- Sql自动配置器原理及其说明
- python二进制整数的定义_TensorFlow定义操作整数的二进制表示
- 新年首发成功!SpaceX“猎鹰9号”火箭发射升空
- git21天打卡day4-查看仓库地址
- linux openssh 升级最新版本
- 一个在线工具箱:栅栏密码加密解密工具
- 阿里云服务器搭建及宝塔面板安装(图文教程)
- 基于Barra多因子模型的组合权重优化
- 截流式合流制设计流量计算_截流式合流制管道系统的设计说明
- 第44件事 用户运营的5个关键环节
- ❤表白❤相册——动态3D图片墙
- 解决微信图片不可引用的问题
- 配置失败还原请勿关闭计算机怎么办,配置windows update失败还原更改 彻底解决方案...
- 【我的架构之路】什么是代理服务器以及什么是负载均衡?
- 计算机科学与技术论文摘要范文,计算机科学与技术论文范文两篇(2)
- 磁盘检查清理修复命令
- Dancing Link --- 模板题 HUST 1017 - Exact cover
- 强化学习:DDPG到MADDPG
热门文章
- 图的定义与术语 - 数据结构和算法54
- [原创]FineUI秘密花园(二十一) — 表格之动态创建列
- 利用寄存器进入栈值交换
- SessionState详解
- 三次握手 四次握手 与socket函数的关系
- Qt 开源作品 | 小伙子,给你的 Linux 系统写个 Launcher 吧
- 嵌入式OS入门笔记-以RTX为案例:三.初探进程
- 四、Vue组件化开发学习笔记——父子组件通信,父级向子级传值(props),子级向父级传值(自定义事件),slot插槽
- LintCode 1816. 使结果不超过阈值的最小除数(二分查找)
- LeetCode 1578. 避免重复字母的最小删除成本