spring statemachine是spring的一個框架,即將狀態機概念和spring相結合的一個框架。更詳細的可以參考官網。
1.什么時候可以用spring statemachine
當你的項目有一個明顯的狀態流轉的總流程時,你就可以使用這個框架。直白點,你在系統里下單,整個訂單流程如下:待支付---支付--》待發貨--發貨-》待收貨--收貨--》訂單完成,這個框架當你操作某個事件后,它會自動跳到下個狀態。
2.如何使用statemachine
引入jar包
<dependency>
<groupId>org.springframework.statemachine</groupId>
<artifactId>spring-statemachine-starter</artifactId>
<version>${spring.statemachine.version}</version>
</dependency>
定義事件和狀態
//定義事件
public enum Events {
E1, E2
}
//定義狀態
public enum States {
SI, S1, S2
}
@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));
}
/**
* 配置狀態流轉
* @param transitions
* @throws Exception
*/
@Override
public void configure(StateMachineTransitionConfigurer<States, Events> transitions)
throws Exception {
transitions
.withExternal()
.source(States.SI).target(States.S1).event(Events.E1)
//SI->S1 經過事件E1
.and()
.withExternal()
.source(States.S1).target(States.S2).event(Events.E2)
//S1->S2 經過事件E2
;
}
//配置監聽器
@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());
}
};
}
}
配置測試狀態機功能
@SpringBootApplication
public class StatemachineDemoApplication implements CommandLineRunner {
public static void main(String[] args) {
SpringApplication.run(StatemachineDemoApplication.class, args);
}
@Autowired
private StateMachine<States, Events> stateMachine;
@Override
public void run(String... args) throws Exception {
System.out.println("開始狀態改變:當前狀態"+stateMachine.getState().getId());
stateMachine.sendEvent(Events.E1);
System.out.println("當前狀態:"+stateMachine.getState().getId());
stateMachine.sendEvent(Events.E2);
System.out.println("第二次狀態改變:"+stateMachine.getState().getId());
}
}
觀察打印結果。
