Spring Boot教程（十八）使用Spring StateMachine框架實現狀態機

時間  2019-11-20
標籤 spring boot 教程 十八 使用 statemachine 框架 實現 狀態 欄目 Spring 简体版
原文   原文鏈接

快速入門

依照以前的風格，咱們經過一個簡單的示例來對Spring StateMachine有一個初步的認識。假設咱們須要實現一個訂單的相關流程，其中包括訂單建立、訂單支付、訂單收貨三個動做。html

下面咱們來詳細的介紹整個實現過程：spring

 

  • 建立一個Spring Boot的基礎工程，並在pom.xml中加入spring-statemachine-core的依賴，具體以下：ide

    <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狀態的遷移。spring-boot

  • 建立狀態機配置類：ui

    @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("訂單建立，待支付");
                    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;
                }
            }

        };
    }

}

    在該類中定義了較多配置內容，下面對這些內容一一說明：spa

  • @EnableStateMachine註解用來啓用Spring StateMachine狀態機功能3d

  • configure(StateMachineStateConfigurer<States, Events> states)方法用來初始化當前狀態機擁有哪些狀態，其中initial(States.UNPAID)定義了初始狀態爲UNPAID，states(EnumSet.allOf(States.class))則指定了使用上一步中定義的全部狀態做爲該狀態機的狀態定義。code

    @Override
public 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。xml

    @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);
}

    configure(StateMachineConfigurationConfigurer<States, Events> config)方法爲當前的狀態機指定了狀態監聽器，其中listener()則是調用了下一個內容建立的監聽器實例，用來處理各個各個發生的狀態遷移事件。

    @Override
public void configure(StateMachineConfigurationConfigurer<States, Events> config)
        throws Exception {
    config
        .withConfiguration()
            .listener(listener());	// 指定狀態機的處理監聽器
}

     

  • StateMachineListener<States, Events> listener()方法用來建立StateMachineListener狀態監聽器的實例，在該實例中會定義具體的狀態遷移處理邏輯，上面的實現中只是作了一些輸出，實際業務場景會會有更負責的邏輯，因此一般狀況下，咱們能夠將該實例的定義放到獨立的類定義中，並用注入的方式加載進來。

  • 建立應用主類來完成整個流程：

    @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函數中，咱們定義了整個流程的處理過程，其中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@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 : 用戶已收貨，訂單完成

     

  • 其中包括了狀態監聽器中對各個狀態遷移作出的處理。

  • 經過上面的例子，咱們能夠對如何使用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接口中定義的事件都能經過註解的方式來進行配置實現。好比，咱們能夠將以前實現的狀態監聽器用註解配置來作進一步的簡化：

@WithStateMachine
public 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的判斷，使得代碼顯得更爲簡潔，擁有了更好的可讀性。

源碼來源

相關文章
相關標籤/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公眾號
   歡迎關注本站公眾號,獲取更多信息
聯繫我們 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程