java state machine_使用Spring StateMachine框架实现状态机

最新推荐文章于 2024-07-28 07:15:00 发布

有话我职说

最新推荐文章于 2024-07-28 07:15:00 发布

阅读量487

点赞数

文章标签： java state machine

本文链接：https://blog.csdn.net/weixin_42297446/article/details/114235095

版权

spring statemachine刚出来不久，但是对于一些企业的大型应用的使用还是十分有借鉴意义的。

最近使用了下这个，感觉还是挺好的。

下面举个例子来说下吧：

创建一个Spring Boot的基础工程，并在pom.xml中加入spring-statemachine-core的依赖，具体如下：

org.springframework.boot

spring-boot-starter-parent

1.3.7.RELEASE

org.springframework.boot

spring-boot-starter

org.springframework.statemachine

spring-statemachine-core

1.2.0.RELEASE

根据上面所述的订单需求场景定义状态和事件枚举，具体如下：

public enum States {

UNPAID, // 待支付

WAITING_FOR_RECEIVE, // 待收货

DONE // 结束

}

public enum Events {

PAY, // 支付

RECEIVE // 收货

}

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

创建状态机配置类：

import com.demo1.app.states.Events;

import com.demo1.app.states.States;

import org.slf4j.Logger;

import org.slf4j.LoggerFactory;

import org.springframework.context.annotation.Bean;

import org.springframework.context.annotation.Configuration;

import org.springframework.statemachine.config.EnableStateMachine;

import org.springframework.statemachine.config.EnumStateMachineConfigurerAdapter;

import org.springframework.statemachine.config.builders.StateMachineConfigurationConfigurer;

import org.springframework.statemachine.config.builders.StateMachineStateConfigurer;

import org.springframework.statemachine.config.builders.StateMachineTransitionConfigurer;

import org.springframework.statemachine.listener.StateMachineListener;

import org.springframework.statemachine.listener.StateMachineListenerAdapter;

import org.springframework.statemachine.transition.Transition;

import java.util.EnumSet;

/**

* 创建状态机配置类

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

@Configuration

@EnableStateMachine

public class StateMachineConfig extends EnumStateMachineConfigurerAdapter {

private Logger logger = LoggerFactory.getLogger(getClass());

/**

* configure(StateMachineStateConfigurer states)方法用来初始化当前状态机拥有哪些状态，

* 其中initial(States.UNPAID)定义了初始状态为待支付UNPAID，

* states(EnumSet.allOf(States.class))则指定了使用上一步中定义的所有状态作为该状态机的状态定义。

* @param states

* @throws Exception

@Override

public void configure(StateMachineStateConfigurer states)

throws Exception {

states

.withStates()

.initial(States.UNPAID) //初始状态定义了初始状态为待支付UNPAID，

.states(EnumSet.allOf(States.class)); //则指定了使用上一步中定义的所有状态作为该状态机的状态定义。

}

/**

* configure(StateMachineTransitionConfigurer transitions)方法用来初始化当前状态机有哪些状态迁移动作，

* 其中命名中我们很容易理解每一个迁移动作，都有来源状态source，目标状态target以及触发事件event。

* @param transitions StateMachineTransitionConfigurer

* @throws Exception

@Override

public void configure(StateMachineTransitionConfigurer 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 config)方法为当前的状态机指定了状态监听器，

// * 其中listener()则是调用了下一个内容创建的监听器实例，

// * 用来处理各个各个发生的状态迁移事件。

// * @param config

// * @throws Exception

@Override

public void configure(StateMachineConfigurationConfigurer config)

throws Exception {

config

.withConfiguration()

.listener(listener()); // 指定状态机的处理监听器

}

// * StateMachineListener listener()方法用来创建StateMachineListener状态监听器的实例，

// * 在该实例中会定义具体的状态迁移处理逻辑，上面的实现中只是做了一些输出，

// * 实际业务场景会有更复杂的逻辑，所以通常情况下，

// * 我们可以将该实例的定义放到独立的类定义中，并用注入的方式加载进来。

// * @return

@Bean

public StateMachineListener listener() {

return new StateMachineListenerAdapter() {

@Override

public void transition(Transition 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)方法用来初始化当前状态机拥有哪些状态，其中initial(States.UNPAID)定义了初始状态为UNPAID，states(EnumSet.allOf(States.class))则指定了使用上一步中定义的所有状态作为该状态机的状态定义。@Override

public void configure(StateMachineStateConfigurer states)

throws Exception {

// 定义状态机中的状态

states

.withStates()

.initial(States.UNPAID) // 初始状态

.states(EnumSet.allOf(States.class));

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

@Override

public void configure(StateMachineTransitionConfigurer 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 config)方法为当前的状态机指定了状态监听器，其中listener()则是调用了下一个内容创建的监听器实例，用来处理各个各个发生的状态迁移事件。

@Override

public void configure(StateMachineConfigurationConfigurer config)

throws Exception{

config

.withConfiguration()

.listener(listener()); // 指定状态机的处理监听器

}

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

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

@SpringBootApplication

public class Application implements CommandLineRunner{

public static void main(String[] args){

SpringApplication.run(Application.class, args);

}

@Autowired

private StateMachine 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)来完成收货操作。在运行了上述程序之后，我们可以在控制台中获得类似下面的输出内容：

其中包括了状态监听器中对各个状态迁移做出的处理。

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

定义状态和事件枚举

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

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

为状态机指定监听处理器

状态监听器

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

public interface StateMachineListener{

void stateChanged(State ~~from, State ~~to);~~~~

void stateEntered(State ~~state);~~

void stateExited(State ~~state);~~

void eventNotAccepted(Message event);

void transition(Transition ~~transition);~~

void transitionStarted(Transition ~~transition);~~

void transitionEnded(Transition ~~transition);~~

void stateMachineStarted(StateMachine ~~stateMachine);~~

void stateMachineStopped(StateMachine ~~stateMachine);~~

void stateMachineError(StateMachine ~~stateMachine, Exception exception);~~

void extendedStateChanged(Object key, Object value);