本文首發(fā)于個(gè)人網(wǎng)站：Spring Boot 2.x實(shí)戰(zhàn)之StateMachine

Spring StateMachine是一個(gè)狀態(tài)機(jī)框架，在Spring框架項(xiàng)目中，開發(fā)者可以通過簡(jiǎn)單的配置就能獲得一個(gè)業(yè)務(wù)狀態(tài)機(jī)，而不需要自己去管理狀態(tài)機(jī)的定義、初始化等過程。今天這篇文章，我們通過一個(gè)案例學(xué)習(xí)下Spring StateMachine框架的用法。

案例介紹

假設(shè)在一個(gè)業(yè)務(wù)系統(tǒng)中，有這樣一個(gè)對(duì)象，它有三個(gè)狀態(tài)：草稿、待發(fā)布、發(fā)布完成，針對(duì)這三個(gè)狀態(tài)的業(yè)務(wù)動(dòng)作也比較簡(jiǎn)單，分別是：上線、發(fā)布、回滾。該業(yè)務(wù)狀態(tài)機(jī)如下圖所示。

img

實(shí)戰(zhàn)

接下來(lái)，基于上面的業(yè)務(wù)狀態(tài)機(jī)進(jìn)行Spring StateMachine的演示。

• 創(chuàng)建一個(gè)基礎(chǔ)的Spring Boot工程，在主pom文件中加入Spring StateMachine的依賴：

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
  <modelVersion>4.0.0</modelVersion>
  <parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
    <version>2.2.1.RELEASE</version>
    <relativePath/> <!-- lookup parent from repository -->
  </parent>
  <groupId>online.javaadu</groupId>
  <artifactId>statemachinedemo</artifactId>
  <version>0.0.1-SNAPSHOT</version>
  <name>statemachinedemo</name>
  <description>Demo project for Spring Boot</description>

  <properties>
    <java.version>1.8</java.version>
  </properties>

  <dependencies>
    <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter</artifactId>
    </dependency>

    <dependency>
      <groupId>org.projectlombok</groupId>
      <artifactId>lombok</artifactId>
      <optional>true</optional>
    </dependency>
    <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-test</artifactId>
      <scope>test</scope>
      <exclusions>
        <exclusion>
          <groupId>org.junit.vintage</groupId>
          <artifactId>junit-vintage-engine</artifactId>
        </exclusion>
      </exclusions>
    </dependency>

    <!--加入spring statemachine的依賴-->
        <dependency>
        <groupId>org.springframework.statemachine</groupId>
        <artifactId>spring-statemachine-core</artifactId>
        <version>2.1.3.RELEASE</version>
      </dependency>
  </dependencies>

  <build>
    <plugins>
      <plugin>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-maven-plugin</artifactId>
      </plugin>
    </plugins>
  </build>

</project>

定義狀態(tài)枚舉和事件枚舉，代碼如下：

/**
* 狀態(tài)枚舉
**/
public enum States {
    DRAFT,
    PUBLISH_TODO,
    PUBLISH_DONE,
}

/**
* 事件枚舉
**/
public enum Events {
    ONLINE,
    PUBLISH,
    ROLLBACK
}

• 完成狀態(tài)機(jī)的配置，包括：（1）狀態(tài)機(jī)的初始狀態(tài)和所有狀態(tài)；（2）狀態(tài)之間的轉(zhuǎn)移規(guī)則

@Configuration
@EnableStateMachine
public class StateMachineConfig extends EnumStateMachineConfigurerAdapter<States, Events> {

    @Override
    public void configure(StateMachineStateConfigurer<States, Events> states) throws Exception {
        states.withStates().initial(States.DRAFT).states(EnumSet.allOf(States.class));
    }

    @Override
    public void configure(StateMachineTransitionConfigurer<States, Events> transitions) throws Exception {
        transitions.withExternal()
            .source(States.DRAFT).target(States.PUBLISH_TODO)
            .event(Events.ONLINE)
            .and()
            .withExternal()
            .source(States.PUBLISH_TODO).target(States.PUBLISH_DONE)
            .event(Events.PUBLISH)
            .and()
            .withExternal()
            .source(States.PUBLISH_DONE).target(States.DRAFT)
            .event(Events.ROLLBACK);
    }
}

• 定義一個(gè)測(cè)試業(yè)務(wù)對(duì)象，狀態(tài)機(jī)的狀態(tài)轉(zhuǎn)移都會(huì)反映到該業(yè)務(wù)對(duì)象的狀態(tài)變更上

@WithStateMachine
@Data
@Slf4j
public class BizBean {

    /**
     * @see States
     */
    private String status = States.DRAFT.name();

    @OnTransition(target = "PUBLISH_TODO")
    public void online() {
        log.info("操作上線，待發(fā)布. target status:{}", States.PUBLISH_TODO.name());
        setStatus(States.PUBLISH_TODO.name());
    }

    @OnTransition(target = "PUBLISH_DONE")
    public void publish() {
        log.info("操作發(fā)布,發(fā)布完成. target status:{}", States.PUBLISH_DONE.name());
        setStatus(States.PUBLISH_DONE.name());
    }

    @OnTransition(target = "DRAFT")
    public void rollback() {
        log.info("操作回滾,回到草稿狀態(tài). target status:{}", States.DRAFT.name());
        setStatus(States.DRAFT.name());
    }

}

• 編寫測(cè)試用例，這里我們使用CommandLineRunner接口代替，定義了一個(gè)StartupRunner，在該類的run方法中啟動(dòng)狀態(tài)機(jī)、發(fā)送不同的事件，通過日志驗(yàn)證狀態(tài)機(jī)的流轉(zhuǎn)過程。

public class StartupRunner implements CommandLineRunner {

    @Resource
    StateMachine<States, Events> stateMachine;

    @Override
    public void run(String... args) throws Exception {
        stateMachine.start();
        stateMachine.sendEvent(Events.ONLINE);
        stateMachine.sendEvent(Events.PUBLISH);
        stateMachine.sendEvent(Events.ROLLBACK);
    }
}

在運(yùn)行上述程序后，我們可以在控制臺(tái)中獲得如下輸出，我們執(zhí)行了三個(gè)操作：上線、發(fā)布、回滾，在下圖中也確實(shí)看到了對(duì)應(yīng)的日志。不過我還發(fā)現(xiàn)有一個(gè)意料之外的地方——在啟動(dòng)狀態(tài)機(jī)的時(shí)候，還打印出了一個(gè)日志——“操作回滾，回到草稿狀態(tài). target status:DRAFT”，這里應(yīng)該是狀態(tài)機(jī)設(shè)置初始狀態(tài)的時(shí)候觸發(fā)的。

image-20191110162618938

分析

如上面的實(shí)戰(zhàn)過程所示，使用Spring StateMachine的步驟如下：

1. 定義狀態(tài)枚舉和事件枚舉
2. 定義狀態(tài)機(jī)的初始狀態(tài)和所有狀態(tài)
3. 定義狀態(tài)之間的轉(zhuǎn)移規(guī)則
4. 在業(yè)務(wù)對(duì)象中使用狀態(tài)機(jī)，編寫響應(yīng)狀態(tài)變化的監(jiān)聽器方法

為了將狀態(tài)變更的操作都統(tǒng)一管理起來(lái)，我們會(huì)考慮在項(xiàng)目中引入狀態(tài)機(jī)，這樣其他的業(yè)務(wù)模塊就和狀態(tài)轉(zhuǎn)移模塊隔離開來(lái)了，其他業(yè)務(wù)模塊也不會(huì)糾結(jié)于當(dāng)前的狀態(tài)是什么，應(yīng)該做什么操作。在應(yīng)用狀態(tài)機(jī)實(shí)現(xiàn)業(yè)務(wù)需求時(shí)，關(guān)鍵是業(yè)務(wù)狀態(tài)的分析，只要狀態(tài)機(jī)設(shè)計(jì)得沒問題，具體的實(shí)現(xiàn)可以選擇用Spring StateMachine，也可以自己去實(shí)現(xiàn)一個(gè)狀態(tài)機(jī)。

使用Spring StateMachine的好處在于自己無(wú)需關(guān)心狀態(tài)機(jī)的實(shí)現(xiàn)細(xì)節(jié)，只需要關(guān)心業(yè)務(wù)有什么狀態(tài)、它們之間的轉(zhuǎn)移規(guī)則是什么、每個(gè)狀態(tài)轉(zhuǎn)移后真正要進(jìn)行的業(yè)務(wù)操作。

本文完整實(shí)例參見：https://github.com/duqicauc/Spring-Boot-2.x-In-Action/tree/master/statemachinedemo

參考資料

1. http://blog.didispace.com/spring-statemachine/
2. https://projects.spring.io/spring-statemachine/#quick-start

javaadu