专栏首页程序猿DD使用Spring StateMachine框架实现状态机

使用Spring StateMachine框架实现状态机

Spring StateMachine框架可能对于大部分使用Spring的开发者来说还比较生僻,该框架目前差不多也才刚满一岁多。它的主要功能是帮助开发者简化状态机的开发过程,让状态机结构更加层次化。前几天刚刚发布了它的第三个Release版本1.2.0,其中增加了对Spring Boot的自动化配置,既然一直在写Spring Boot的教程,所以干脆就将该内容也纳入进来吧,希望对有需求的小伙伴有一定的帮助。

快速入门

依照之前的风格,我们通过一个简单的示例来对Spring StateMachine有一个初步的认识。假设我们需要实现一个订单的相关流程,其中包括订单创建、订单支付、订单收货三个动作。

下面我们来详细的介绍整个实现过程:

创建一个Spring Boot的基础工程,并在`pom.xml`中加入`spring-statemachine-core`的依赖

根据上面所述的订单需求场景定义状态和事件枚举

共有三个状态(待支付、待收货、结束)以及两个引起状态迁移的事件(支付、收货),其中支付事件`PAY`会触发状态从待支付`UNPAID`状态到待收货`WAITING_FOR_RECEIVE`状态的迁移,而收货事件`RECEIVE`会触发状态从待收货`WAITING_FOR_RECEIVE`状态到结束`DONE`状态的迁移。

创建状态机配置类:

在该类中定义了较多配置内容,下面对这些内容一一说明

@EnableStateMachine注解用来启用Spring StateMachine状态机功能

configure(StateMachineStateConfigurer<States, Events> states)方法用来初始化当前状态机拥有哪些状态,其中`initial(States.UNPAID)`定义了初始状态为`UNPAID`,`states(EnumSet.allOf(States.class))`则指定了使用上一步中定义的所有状态作为该状态机的状态定义。

configure(StateMachineTransitionConfigurer<States, Events> transitions)方法用来初始化当前状态机有哪些状态迁移动作,其中命名中我们很容易理解每一个迁移动作,都有来源状态`source`,目标状态`target`以及触发事件`event`。

configure(StateMachineConfigurationConfigurer<States, Events> config)方法为当前的状态机指定了状态监听器,其中`listener()`则是调用了下一个内容创建的监听器实例,用来处理各个各个发生的状态迁移事件。

StateMachineListener<States, Events> listener()方法用来创建`StateMachineListener`状态监听器的实例,在该实例中会定义具体的状态迁移处理逻辑,上面的实现中只是做了一些输出,实际业务场景会会有更负责的逻辑,所以通常情况下,我们可以将该实例的定义放到独立的类定义中,并用注入的方式加载进来。

创建应用主类来完成整个流程

在`run`函数中,我们定义了整个流程的处理过程,其中`start()`就是创建这个订单流程,根据之前的定义,该订单会处于待支付状态,然后通过调用`sendEvent(Events.PAY)`执行支付操作,最后通过调用`sendEvent(Events.RECEIVE)`来完成收货操作。在运行了上述程序之后,我们可以在控制台中获得类似下面的输出内容。其中包括了状态监听器中对各个状态迁移做出的处理。

通过上面的例子,我们可以对如何使用Spring StateMachine做如下小结:

- 定义状态和事件枚举

- 为状态机定义使用的所有状态以及初始状态

- 为状态机定义状态的迁移动作

- 为状态机指定监听处理器

状态监听

通过上面的入门示例以及最后的小结,我们可以看到使用Spring StateMachine来实现状态机的时候,代码逻辑变得非常简单并且具有层次化。整个状态的调度逻辑主要依靠配置方式的定义,而所有的业务逻辑操作都被定义在了状态监听器中,其实状态监听器可以实现的功能远不止上面我们所述的内容,它还有更多的事件捕获,我们可以通过查看`StateMachineListener`接口来了解它所有的事件定义。

篇幅原因,更多关于`StateMachineListener`接口定义的内容,可以点击下方“阅读原文”查看。

注解实现

对于状态监听器,Spring StateMachine还提供了优雅的注解配置实现方式,所有`StateMachineListener`接口中定义的事件都能通过注解的方式来进行配置实现。比如,我们可以将之前实现的状态监听器用注解配置来做进一步的简化:

上述代码实现了与快速入门中定义的`listener()`方法创建的监听器相同的功能,但是由于通过注解的方式配置,省去了原来事件监听器中各种if的判断,使得代码显得更为简洁,拥有了更好的可读性。

本文分享自微信公众号 - 程序猿DD(didispace)

原文出处及转载信息见文内详细说明,如有侵权,请联系 yunjia_community@tencent.com 删除。

原始发表时间:2016-12-19

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

我来说两句

0 条评论
登录 后参与评论

相关文章

  • jenkins 入门教程(中)

    接上回继续,本文以我托管在bitbucket上的一个开源项目spring-boot-rest-framework做为演示,讲解如何创建自动化部署。 一、创建it...

    菩提树下的杨过
  • ActiveMQ笔记(7):如何清理无效的延时消息?

    ActiveMQ的延时消息是一个让人又爱又恨的功能,具体使用可参考上篇ActiveMQ笔记(6):消息延时投递,在很多需要消息延时投递的业务场景十分有用,但是也...

    菩提树下的杨过
  • spring boot + embed tomcat + standalone jar的内存泄露问题

    前一阵遇到了一个很坑的内存泄露问题,记录于此: 有个项目采用spring cloud重构后,部署到线上(其中有一个接口,大概每天调用量在1千万次左右),发现za...

    菩提树下的杨过
  • spring-boot 速成(3) actuator

    actuator 通过暴露一系列的endpoints可以让开发者快速了解spring boot的各项运行指标,比如:线程数,jvm剩余内存等一系列参数。 启用方...

    菩提树下的杨过
  • spring-boot 速成(2) devtools之热部署及LiveReload

    JRebel热部署插件相信很多人都知道,但是这是一款商业插件,spring-boot框架也提供了类似的功能,即:devtools,关键是免费的! 使用方法如下:...

    菩提树下的杨过
  • mybatis: 利用多数据源实现分库存储

    之前写过一篇mybatis 使用经验小结 提到过多数据源的处理方式,虽然简单但是姿势不太优雅,今天介绍一些更美观的办法: spring中有一个AbstractR...

    菩提树下的杨过
  • redis 学习笔记(7)-cluster 客户端(jedis)代码示例

    上节学习了cluster的搭建及redis-cli终端下如何操作,但是更常用的场景是在程序代码里对cluster读写,这需要redis-client对clust...

    菩提树下的杨过
  • spring-boot 速成(2) devtools之热部署及LiveReload

    JRebel热部署插件相信很多人都知道,但是这是一款商业插件,spring-boot框架也提供了类似的功能,即:devtools,关键是免费的! 使用方法如下:...

    菩提树下的杨过
  • dubbox升级spring到4.x及添加log4j2支持

    今天花了点时间,把dubbox依赖的spring从3.x升级成最新版的4.x了,其它一些依赖的组件也顺带升级了,同时dubbo支持的第三方日志组件居然没有log...

    菩提树下的杨过
  • spring 在Thread中注入@Resource失败,总为null的解决方案

    @Resource private MyMapper myDao; 但是运行的时候,进入到这个线程,这个myDao总为nul...

    似水的流年

扫码关注云+社区

领取腾讯云代金券