使用Spring StateMachine架構實作狀态機

Spring StateMachine架構可能對于大部分使用Spring的開發者來說還比較生僻，該架構目前差不多也才剛滿一歲多。它的主要功能是幫助開發者簡化狀态機的開發過程，讓狀态機結構更加階層化。前幾天剛剛釋出了它的第三個Release版本1.2.0，其中增加了對Spring Boot的自動化配置，既然一直在寫Spring Boot的教程，是以幹脆就将該内容也納入進來吧，希望對有需求的小夥伴有一定的幫助。

https://blog.didispace.com/spring-statemachine/#%E5%BF%AB%E9%80%9F%E5%85%A5%E9%97%A8 快速入門

依照之前的風格，我們通過一個簡單的示例來對Spring StateMachine有一個初步的認識。假設我們需要實作一個訂單的相關流程，其中包括訂單建立、訂單支付、訂單收貨三個動作。

下面我們來詳細的介紹整個實作過程：

建立一個Spring Boot的基礎工程，并在 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>

根據上面所述的訂單需求場景定義狀态和事件枚舉，具體如下：

public enum States {
    UNPAID,                 // 待支付
    WAITING_FOR_RECEIVE,    // 待收貨
    DONE                    // 結束
}

public enum Events {
    PAY,        // 支付
    RECEIVE     // 收貨
}

其中共有三個狀态（待支付、待收貨、結束）以及兩個引起狀态遷移的事件（支付、收貨），其中支付事件 PAY 會觸發狀态從待支付 UNPAID 狀态到待收貨 WAITING_FOR_RECEIVE 狀态的遷移，而收貨事件 RECEIVE 會觸發狀态從待收貨 WAITING_FOR_RECEIVE 狀态到結束 DONE 狀态的遷移。
建立狀态機配置類：

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

        };
    }

}

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

@EnableStateMachine 注解用來啟用Spring StateMachine狀态機功能
configure(StateMachineStateConfigurer<States, Events> states) 方法用來初始化目前狀态機擁有哪些狀态，其中 initial(States.UNPAID) 定義了初始狀态為 UNPAID ， states(EnumSet.allOf(States.class)) 則指定了使用上一步中定義的所有狀态作為該狀态機的狀态定義。

@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

。

@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做如下小結：

定義狀态和事件枚舉
為狀态機定義使用的所有狀态以及初始狀态
為狀态機定義狀态的遷移動作
為狀态機指定監聽處理器

https://blog.didispace.com/spring-statemachine/#%E7%8A%B6%E6%80%81%E7%9B%91%E5%90%AC%E5%99%A8 狀态監聽器

通過上面的入門示例以及最後的小結，我們可以看到使用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的判斷，使得代碼顯得更為簡潔，擁有了更好的可讀性。

本文完整示例：

使用Spring StateMachine架構實作狀态機

https://blog.didispace.com/spring-statemachine/#%E5%BF%AB%E9%80%9F%E5%85%A5%E9%97%A8 快速入門

https://blog.didispace.com/spring-statemachine/#%E7%8A%B6%E6%80%81%E7%9B%91%E5%90%AC%E5%99%A8 狀态監聽器

注解監聽器

繼續閱讀

關于Gradle配置的小結

Java小案例——随機數猜測随機數猜測

nginx location中斜線的位置的重要性

27 Best Free Eclipse Plug-ins for Java Developer to be ProductiveCode Quality PluginsText Editor PluginsDependency ManagementVersion Control Integration PluginsFramework Development Continuous Integration Related PluginsOther Utility Plugins

Java String.format方法的簡單使用

neo4j之cypher使用文檔

GitHub連夜封殺！這份阿裡 10W 字内部 Java 字面試手冊到底有多強？

spark/scala關于【資源檔案】加載方法概述外部檔案加載方案測試資源檔案打包入jar包中小結

mybatis_入門程式Mybatis入門

AOP程式設計_Android優雅權限架構(1)概念基礎，2021金三銀四前言正文大綱正文

Effective Java 8:通用程式設計

OOM三種類型

工廠模式-三種類型

【遞歸】高效率求2的n次幂

win10本地scala和spark安裝安裝scala安裝spark

scala (3) Function 和 Method