Spring StateMachine狀態(tài)機引擎在項目中的應用(八)-靈活指定引擎實例狀態(tài)

一直以來，總覺得ssm不夠靈活，主要原因是沒找到為狀態(tài)機指定狀態(tài)的方式，也就意味著狀態(tài)機引擎實例必須要跟對應的業(yè)務數(shù)據(jù)一起持久化，雖然ssm提供了多重持久化的方式，依然覺得有點不爽。
最近又回過頭去啃了下文檔和源碼，無意中在AbstractStateMachine類中看到了setCurrentState方法，如下：

void setCurrentState(State<S, E> state, Message<E> message, Transition<S, E> transition, boolean exit, StateMachine<S, E> stateMachine) {
    this.setCurrentState(state, message, transition, exit, stateMachine, (Collection)null, (Collection)null);
}

void setCurrentState(State<S, E> state, Message<E> message, Transition<S, E> transition, boolean exit, StateMachine<S, E> stateMachine, Collection<State<S, E>> sources, Collection<State<S, E>> targets) {
    this.setCurrentStateInternal(state, message, transition, exit, stateMachine, sources, targets);
}

private void setCurrentStateInternal(State<S, E> state, Message<E> message, Transition<S, E> transition, boolean exit, StateMachine<S, E> stateMachine, Collection<State<S, E>> sources, Collection<State<S, E>> targets) {
  ...
}

emmm，貌似有門兒，于是做了以下嘗試。

搭個項目框架

為了簡單，用springboot基于maven搭了個簡單的項目(http://start.spring.io)

pom.xml
<?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.1.8.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.example</groupId>
    <artifactId>demo</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>demo</name>
    <description>Demo project for Spring Boot</description>

    <properties>
        <java.version>1.8</java.version>
        <spring-statemachine.version>2.1.3.RELEASE</spring-statemachine.version>
    </properties>

    <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>${spring-statemachine.version}</version>
        </dependency>

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

        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <version>1.18.8</version>
        </dependency>

    </dependencies>

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

</project>

可以看到，只需要引入spring-statemachine-core就可以了，當然夾帶點私貨，順手扔上去了lombok。

States & Events
package com.example.demo;

public enum States {
    SI, S1, S2, S3;
}

package com.example.demo;

public enum Events {
    E1, E2, E3;
}
spring statemachine config

定義了一些configure & listener

package com.example.demo;

import org.springframework.context.annotation.Configuration;
import org.springframework.messaging.Message;
import org.springframework.statemachine.config.EnableStateMachine;
import org.springframework.statemachine.config.EnumStateMachineConfigurerAdapter;
import org.springframework.statemachine.config.builders.StateMachineConfigurationConfigurer;
import org.springframework.statemachine.config.builders.StateMachineStateConfigurer;
import org.springframework.statemachine.config.builders.StateMachineTransitionConfigurer;
import org.springframework.statemachine.listener.StateMachineListener;
import org.springframework.statemachine.listener.StateMachineListenerAdapter;
import org.springframework.statemachine.state.State;
import org.springframework.statemachine.transition.Transition;

import java.util.EnumSet;
import java.util.Optional;

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

    @Override
    public void configure(StateMachineConfigurationConfigurer<States, Events> config)
            throws Exception {
        config
                .withConfiguration()
                .autoStartup(true)
                .listener(listener());
    }

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

    @Override
    public void configure(StateMachineTransitionConfigurer<States, Events> transitions)
            throws Exception {
        transitions
                .withExternal()
                .source(States.SI).target(States.S1).event(Events.E1)
                .and()
                .withExternal()
                .source(States.S1).target(States.S2).event(Events.E2)
                .and()
                .withExternal()
                .source(States.S2).target(States.S3).event(Events.E3);
    }


    private StateMachineListener<States, Events> listener() {
        return new StateMachineListenerAdapter<States, Events>() {
            @Override
            public void transition(Transition<States, Events> transition) {
                System.out.println("move from:{" + ofNullableState(transition.getSource()) + "} " +
                        "to:{" + ofNullableState(transition.getTarget()) + "}");
            }

            @Override
            public void stateChanged(State<States, Events> from, State<States, Events> to) {

                if (null != from) {
                    System.out.println("State change from " + from.getId() + " to " + to.getId());
                } else {
                    System.out.println("State change to " + to.getId());
                }

            }

            @Override
            public void eventNotAccepted(Message<Events> event) {
                System.err.println("event not accepted: {" + event + "}");
            }

            private Object ofNullableState(State s) {
                return Optional.ofNullable(s)
                        .map(State::getId)
                        .orElse(null);
            }
        };
    }

/*    @Bean
    public StateMachineListener<States, Events> listener() {
        return new StateMachineListenerAdapter<States, Events>() {
            @Override
            public void stateChanged(State<States, Events> from, State<States, Events> to) {
                System.out.println("State change to " + to.getId());
            }
        };
    }*/

}
Stringboot Application
package com.example.demo;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.CommandLineRunner;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.statemachine.StateMachine;

@SpringBootApplication
public class DemoApplication implements CommandLineRunner {

    public static void main(String[] args) {
        SpringApplication.run(DemoApplication.class, args);
    }

    @Autowired
    private StateMachine<States, Events> stateMachine;

    @Override
    public void run(String... args) throws Exception {

        stateMachine.sendEvent(Events.E1);
        stateMachine.sendEvent(Events.E2);
    }


}
執(zhí)行結(jié)果

mvn clean install

Java -jar *.jar

move from:{null} to:{SI}
State change to SI
2019-09-17 23:10:14.374  INFO 71833 --- [           main] o.s.s.support.LifecycleObjectSupport     : started S3 SI S2 S1  / SI / uuid=eb612bb8-d97f-4505-b8af-4106320b3073 / id=null
move from:{SI} to:{S1}
State change from SI to S1
move from:{S1} to:{S2}
State change from S1 to S2

可以看到，可以通過sendEvent來觸發(fā)狀態(tài)機引擎的狀態(tài)流轉(zhuǎn)

setCurrentState

上面只是一個常規(guī)的demo，那么怎么直接設置當前狀態(tài)呢？

還是回到上面的AbstractStateMachine類中setCurrentState方法定義：

void setCurrentState(State<S, E> state, Message<E> message, Transition<S, E> transition, boolean exit, StateMachine<S, E> stateMachine) 

State<S, E> state：需要設置的狀態(tài)

Message<E> message：需要攜帶的message，這里先不用

Transition<S, E> transition：對應節(jié)點，可以先不用，畢竟還需要構(gòu)造

boolean exit：？是否可以exit，默認走false

StateMachine<S, E> stateMachine：具體的狀態(tài)機引擎實例

應該是需要提供寫一個工具類，屏蔽掉上游調(diào)用的復雜度。而SpringStateMachine中本身就提供了一個工具類StateMachineUtils，直接基于它擴展吧，畢竟很多上下文的東西構(gòu)造起來還是挺麻煩。

StateMachineUtils工具類
package org.springframework.statemachine.support;

import org.springframework.statemachine.StateMachine;
import org.springframework.statemachine.state.State;

public abstract class MyStateMachineUtils extends StateMachineUtils {

    public static <S, E> void setCurrentState(StateMachine<S, E> stateMachine, S state) {
        if (stateMachine instanceof AbstractStateMachine) {
            setCurrentState((AbstractStateMachine<S, E>) stateMachine, state);

            System.out.println("StateMachine Current:" + stateMachine);
        } else {
            throw new IllegalArgumentException("Provided StateMachine is not a valid type");
        }
    }

    public static <S, E> void setCurrentState(AbstractStateMachine<S, E> stateMachine, S state) {
        stateMachine.setCurrentState(findState(stateMachine, state), null, null, false, stateMachine);
    }

    private static <S, E> State<S, E> findState(AbstractStateMachine<S, E> stateMachine, S stateId) {
        for (State<S, E> state : stateMachine.getStates()) {
            if (state.getId() == stateId) {
                return state;
            }
        }

        throw new IllegalArgumentException("Specified State ID is not valid");
    }
}

注意：

1、這里的包名是org.springframework.statemachine.support，因為setCurrentState是default的scope，不放在同一個包里無法直接操作

2、這里findState是從stateMachine實例中獲取目標state

修改DemoApplication
        @Override
    public void run(String... args) throws Exception {

        //        stateMachine.sendEvent(Events.E1);

        MyStateMachineUtils.setCurrentState(stateMachine,States.S1);

        stateMachine.sendEvent(Events.E2);

    }

執(zhí)行下看結(jié)果：

move from:{null} to:{SI}
State change to SI
2019-09-17 23:21:14.788  INFO 72337 --- [           main] o.s.s.support.LifecycleObjectSupport     : started S1 S3 SI S2  / SI / uuid=801118a8-0115-48e1-95e7-a8ba67e5d30f / id=null
State change from SI to S1
StateMachine Current:S1 S3 SI S2  / S1 / uuid=801118a8-0115-48e1-95e7-a8ba67e5d30f / id=null
move from:{S1} to:{S2}
State change from S1 to S2

可以看到，直接把stateMachine的狀態(tài)從SI遷移到了S1，done！

注意：這里如果spring-statemachine.version=2.1.3.RELEASE是正常的，但是如果是使用3.0.0.M1版本，則狀態(tài)一直未生效，應該是新版本還有缺陷。

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

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

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