昆明网站建设,淮安网站定制,推进网站集约化建设的作用,营业执照怎么申报年报Spring StateMachine框架可能对于大部分使用Spring的开发者来说还比较生僻#xff0c;该框架目前差不多也才刚满一岁多。它的主要功能是帮助开发者简化状态机的开发过程#xff0c;让状态机结构更加层次化。前几天刚刚发布了它的第三个Release版本1.2.0#xff0c;其中增加了…Spring StateMachine框架可能对于大部分使用Spring的开发者来说还比较生僻该框架目前差不多也才刚满一岁多。它的主要功能是帮助开发者简化状态机的开发过程让状态机结构更加层次化。前几天刚刚发布了它的第三个Release版本1.2.0其中增加了对Spring Boot的自动化配置既然一直在写Spring Boot的教程所以干脆就将该内容也纳入进来吧希望对有需求的小伙伴有一定的帮助。
快速入门
依照之前的风格我们通过一个简单的示例来对Spring StateMachine有一个初步的认识。假设我们需要实现一个订单的相关流程其中包括订单创建、订单支付、订单收货三个动作。
下面我们来详细的介绍整个实现过程
创建一个Spring Boot的基础工程并在pom.xml中加入spring-statemachine-core的依赖具体如下 parent groupIdorg.springframework.boot/groupId artifactIdspring-boot-starter-parent/artifactId version1.3.7.RELEASE/version relativePath/ /parentdependencies dependency groupIdorg.springframework.boot/groupId artifactIdspring-boot-starter/artifactId /dependency dependency groupIdorg.springframework.statemachine/groupId artifactIdspring-statemachine-core/artifactId version1.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状态的迁移。 创建状态机配置类 ConfigurationEnableStateMachinepublic class StateMachineConfig extends EnumStateMachineConfigurerAdapterStates, Events { private Logger logger LoggerFactory.getLogger(getClass()); Override public void configure(StateMachineStateConfigurerStates, Events states) throws Exception { states .withStates() .initial(States.UNPAID) .states(EnumSet.allOf(States.class)); } Override public void configure(StateMachineTransitionConfigurerStates, 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(StateMachineConfigurationConfigurerStates, Events config) throws Exception { config .withConfiguration() .listener(listener()); } Bean public StateMachineListenerStates, Events listener() { return new StateMachineListenerAdapterStates, Events() { Override public void transition(TransitionStates, 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(StateMachineStateConfigurerStates, Events states)方法用来初始化当前状态机拥有哪些状态其中initial(States.UNPAID)定义了初始状态为UNPAIDstates(EnumSet.allOf(States.class))则指定了使用上一步中定义的所有状态作为该状态机的状态定义。 Overridepublic void configure(StateMachineStateConfigurerStates, Events states) throws Exception { // 定义状态机中的状态 states .withStates() .initial(States.UNPAID) // 初始状态 .states(EnumSet.allOf(States.class));}configure(StateMachineTransitionConfigurerStates, Events transitions)方法用来初始化当前状态机有哪些状态迁移动作其中命名中我们很容易理解每一个迁移动作都有来源状态source目标状态target以及触发事件event。 Overridepublic void configure(StateMachineTransitionConfigurerStates, 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(StateMachineConfigurationConfigurerStates, Events config)方法为当前的状态机指定了状态监听器其中listener()则是调用了下一个内容创建的监听器实例用来处理各个各个发生的状态迁移事件。 Overridepublic void configure(StateMachineConfigurationConfigurerStates, Events config) throws Exception { config .withConfiguration() .listener(listener()); // 指定状态机的处理监听器}StateMachineListenerStates, Events listener()方法用来创建StateMachineListener状态监听器的实例在该实例中会定义具体的状态迁移处理逻辑上面的实现中只是做了一些输出实际业务场景会会有更负责的逻辑所以通常情况下我们可以将该实例的定义放到独立的类定义中并用注入的方式加载进来。 创建应用主类来完成整个流程 SpringBootApplicationpublic class Application implements CommandLineRunner { public static void main(String[] args) { SpringApplication.run(Application.class, args); } Autowired private StateMachineStates, 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.DefaultStateMachineExecutor1d2290ceINFO 2312 --- [ main] o.s.s.support.LifecycleObjectSupport : started DONE UNPAID WAITING_FOR_RECEIVE / UNPAID / uuidc65ec0aa-59f9-4ffb-a1eb-88ec902369b2 / idnullINFO 2312 --- [ main] eConfig$$EnhancerBySpringCGLIB$$a05acb3d : 用户完成支付待收货INFO 2312 --- [ main] eConfig$$EnhancerBySpringCGLIB$$a05acb3d : 用户已收货订单完成其中包括了状态监听器中对各个状态迁移做出的处理。
通过上面的例子我们可以对如何使用Spring StateMachine做如下小结
定义状态和事件枚举为状态机定义使用的所有状态以及初始状态为状态机定义状态的迁移动作为状态机指定监听处理器
状态监听器
通过上面的入门示例以及最后的小结我们可以看到使用Spring StateMachine来实现状态机的时候代码逻辑变得非常简单并且具有层次化。整个状态的调度逻辑主要依靠配置方式的定义而所有的业务逻辑操作都被定义在了状态监听器中其实状态监听器可以实现的功能远不止上面我们所述的内容它还有更多的事件捕获我们可以通过查看StateMachineListener接口来了解它所有的事件定义
public interface StateMachineListenerS,E { void stateChanged(StateS,E from, StateS,E to); void stateEntered(StateS,E state); void stateExited(StateS,E state); void eventNotAccepted(MessageE event); void transition(TransitionS, E transition); void transitionStarted(TransitionS, E transition); void transitionEnded(TransitionS, E transition); void stateMachineStarted(StateMachineS, E stateMachine); void stateMachineStopped(StateMachineS, E stateMachine); void stateMachineError(StateMachineS, E stateMachine, Exception exception); void extendedStateChanged(Object key, Object value); void stateContext(StateContextS, 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-1GitHubhttps://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
