背景介绍
最近在公司做一个Spring Boot表单项目,表单涉及的状态如图所示:
在设计表单状态转换模块时,想到状态机这个概念。在网上检索相关的实现框架,发现Spring StateMachine框架。网上大多数的教程都是非常简单的Demo,只有一个状态机连续切换的示例,很难作为一个实战入门的Demo。幸运的是在网上找到了一个Spring系列的视频,其中涉及到了状态机的实战项目。这篇文章也是基于该视频教程,结合自己的项目实践做一个完整的状态机实战笔记。
StateMachine实战
Spring StatsMachine主要涉及到两个重要的概念,一个是State(状态)、一个是Event(事件)。
State
在我的表单项目中,我的状态有:草稿、收集、统计、领取、关闭。
状态一般通过枚举类型进行定义,代码如下:
public enum PaperStates {
DRAFT(0,"草稿"),
OPENING(1,"收集"),
ACCOUNT(2,"统计"),
CLAIMING(3,"领取"),
CLOSED(-1,"关闭");
private int code;
private String desc;
PaperStates(int code, String desc){
this.code = code;
this.desc = desc;
}
}
Event
状态之间通过事件完成切换。
事件的定义一般也是通过枚举类型,代码如下:
public enum PaperEvents {
PUBLISH,//从草稿变成发布状态
EXPIRE,//从发布变成统计状态
CLAIM,//从统计状态变成可领取状态
CLOSE,//从发布状态变成下架状态,从可领取状态变成下架状态,从下架状态变成草稿状态
REOPEN;//重新发布
}
StateMachineConfig
定义好State和Event以后,还需要配置状态机,设置状态之间的流转关系。代码如下:
public class StateMachineConfig extends EnumStateMachineConfigurerAdapter<PaperStates, PaperEvents> {
@Override
public void configure(StateMachineStateConfigurer<PaperStates, PaperEvents> states) throws Exception {
states.withStates().initial(PaperStates.DRAFT).states(EnumSet.allOf(PaperStates.class));
}