使用Spring StateMachine框架實現(xiàn)狀態(tài)機

Spring StateMachine框架可能對于大部分使用Spring的開發(fā)者來說還比較生僻,該框架目前差不多也才剛滿一歲多。它的主要功能是幫助開發(fā)者簡化狀態(tài)機的開發(fā)過程,讓狀態(tài)機結(jié)構(gòu)更加層次化。前幾天剛剛發(fā)布了它的第三個Release版本1.2.0,其中增加了對Spring Boot的自動化配置,既然一直在寫Spring Boot的教程,所以干脆就將該內(nèi)容也納入進來吧,希望對有需求的小伙伴有一定的幫助。

快速入門

依照之前的風格,我們通過一個簡單的示例來對Spring StateMachine有一個初步的認識。假設(shè)我們需要實現(xiàn)一個訂單的相關(guān)流程,其中包括訂單創(chuàng)建、訂單支付、訂單收貨三個動作。

下面我們來詳細的介紹整個實現(xiàn)過程:

  • 創(chuàng)建一個Spring Boot的基礎(chǔ)工程,并在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>
    
  • 根據(jù)上面所述的訂單需求場景定義狀態(tài)和事件枚舉,具體如下:

    public enum States {
        UNPAID,                 // 待支付
        WAITING_FOR_RECEIVE,    // 待收貨
        DONE                    // 結(jié)束
    }
    
    public enum Events {
        PAY,        // 支付
        RECEIVE     // 收貨
    }
    

    其中共有三個狀態(tài)(待支付、待收貨、結(jié)束)以及兩個引起狀態(tài)遷移的事件(支付、收貨),其中支付事件PAY會觸發(fā)狀態(tài)從待支付UNPAID狀態(tài)到待收貨WAITING_FOR_RECEIVE狀態(tài)的遷移,而收貨事件RECEIVE會觸發(fā)狀態(tài)從待收貨WAITING_FOR_RECEIVE狀態(tài)到結(jié)束DONE狀態(tài)的遷移。

  • 創(chuàng)建狀態(tài)機配置類:

    @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("訂單創(chuàng)建,待支付");
                        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;
                    }
                }
    
            };
        }
    
    }
    

    在該類中定義了較多配置內(nèi)容,下面對這些內(nèi)容一一說明:

    • @EnableStateMachine注解用來啟用Spring StateMachine狀態(tài)機功能

    • configure(StateMachineStateConfigurer<States, Events> states)方法用來初始化當前狀態(tài)機擁有哪些狀態(tài),其中initial(States.UNPAID)定義了初始狀態(tài)為UNPAID,states(EnumSet.allOf(States.class))則指定了使用上一步中定義的所有狀態(tài)作為該狀態(tài)機的狀態(tài)定義。

          @Override
          public void configure(StateMachineStateConfigurer<States, Events> states)
                  throws Exception {
              // 定義狀態(tài)機中的狀態(tài)
              states
                  .withStates()
                      .initial(States.UNPAID) // 初始狀態(tài)
                      .states(EnumSet.allOf(States.class));
          }
      
    • configure(StateMachineTransitionConfigurer<States, Events> transitions)方法用來初始化當前狀態(tài)機有哪些狀態(tài)遷移動作,其中命名中我們很容易理解每一個遷移動作,都有來源狀態(tài)source,目標狀態(tài)target以及觸發(fā)事件event。

          @Override
          public void configure(StateMachineTransitionConfigurer<States, Events> transitions)
                  throws Exception {
              transitions
                  .withExternal()
                      .source(States.UNPAID).target(States.WAITING_FOR_RECEIVE)// 指定狀態(tài)來源和目標
                      .event(Events.PAY)  // 指定觸發(fā)事件
                      .and()
                  .withExternal()
                      .source(States.WAITING_FOR_RECEIVE).target(States.DONE)
                      .event(Events.RECEIVE);
          }
      
    • configure(StateMachineConfigurationConfigurer<States, Events> config)方法為當前的狀態(tài)機指定了狀態(tài)監(jiān)聽器,其中listener()則是調(diào)用了下一個內(nèi)容創(chuàng)建的監(jiān)聽器實例,用來處理各個各個發(fā)生的狀態(tài)遷移事件。

          @Override
          public void configure(StateMachineConfigurationConfigurer<States, Events> config)
                  throws Exception {
              config
                  .withConfiguration()
                      .listener(listener());  // 指定狀態(tài)機的處理監(jiān)聽器
          }
      
    • StateMachineListener<States, Events> listener()方法用來創(chuàng)建StateMachineListener狀態(tài)監(jiān)聽器的實例,在該實例中會定義具體的狀態(tài)遷移處理邏輯,上面的實現(xiàn)中只是做了一些輸出,實際業(yè)務場景會會有更負責的邏輯,所以通常情況下,我們可以將該實例的定義放到獨立的類定義中,并用注入的方式加載進來。

  • 創(chuàng)建應用主類來完成整個流程:

    @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函數(shù)中,我們定義了整個流程的處理過程,其中start()就是創(chuàng)建這個訂單流程,根據(jù)之前的定義,該訂單會處于待支付狀態(tài),然后通過調(diào)用sendEvent(Events.PAY)執(zhí)行支付操作,最后通過掉用sendEvent(Events.RECEIVE)來完成收貨操作。在運行了上述程序之后,我們可以在控制臺中獲得類似下面的輸出內(nèi)容:

    INFO 2312 --- [           main] eConfig$$EnhancerBySpringCGLIB$$a05acb3d : 訂單創(chuàng)建,待支付
    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$$EnhancerBySpringCGLIB$$a05acb3d : 用戶完成支付,待收貨
    INFO 2312 --- [           main] eConfig$$EnhancerBySpringCGLIB$$a05acb3d : 用戶已收貨,訂單完成
    

    其中包括了狀態(tài)監(jiān)聽器中對各個狀態(tài)遷移做出的處理。

通過上面的例子,我們可以對如何使用Spring StateMachine做如下小結(jié):

  • 定義狀態(tài)和事件枚舉
  • 為狀態(tài)機定義使用的所有狀態(tài)以及初始狀態(tài)
  • 為狀態(tài)機定義狀態(tài)的遷移動作
  • 為狀態(tài)機指定監(jiān)聽處理器

狀態(tài)監(jiān)聽器

通過上面的入門示例以及最后的小結(jié),我們可以看到使用Spring StateMachine來實現(xiàn)狀態(tài)機的時候,代碼邏輯變得非常簡單并且具有層次化。整個狀態(tài)的調(diào)度邏輯主要依靠配置方式的定義,而所有的業(yè)務邏輯操作都被定義在了狀態(tài)監(jiān)聽器中,其實狀態(tài)監(jiān)聽器可以實現(xiàn)的功能遠不止上面我們所述的內(nèi)容,它還有更多的事件捕獲,我們可以通過查看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);

}

注解監(jiān)聽器

對于狀態(tài)監(jiān)聽器,Spring StateMachine還提供了優(yōu)雅的注解配置實現(xiàn)方式,所有StateMachineListener接口中定義的事件都能通過注解的方式來進行配置實現(xiàn)。比如,我們可以將之前實現(xiàn)的狀態(tài)監(jiān)聽器用注解配置來做進一步的簡化:

@WithStateMachine
public class EventConfig {

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

    @OnTransition(target = "UNPAID")
    public void create() {
        logger.info("訂單創(chuàng)建,待支付");
    }

    @OnTransition(source = "UNPAID", target = "WAITING_FOR_RECEIVE")
    public void pay() {
        logger.info("用戶完成支付,待收貨");
    }

    @OnTransition(source = "WAITING_FOR_RECEIVE", target = "DONE")
    public void receive() {
        logger.info("用戶已收貨,訂單完成");
    }

}

上述代碼實現(xiàn)了與快速入門中定義的listener()方法創(chuàng)建的監(jiān)聽器相同的功能,但是由于通過注解的方式配置,省去了原來事件監(jiān)聽器中各種if的判斷,使得代碼顯得更為簡潔,擁有了更好的可讀性。

本文完整示例:

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時請結(jié)合常識與多方信息審慎甄別。
平臺聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點,簡書系信息發(fā)布平臺,僅提供信息存儲服務。

相關(guān)閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容