上一节我们介绍了Spring-StateMachine中的一些基础概念，接下来我们开始搭建实际项目中的脚手架。
引入依赖
<dependency>
<groupId>org.springframework.statemachine</groupId>
<artifactId>spring-statemachine-data-common</artifactId>
<version>2.2.0.RELEASE</version>
</dependency>
<dependency>
<groupId>org.springframework.statemachine</groupId>
<artifactId>spring-statemachine-redis</artifactId>
<version>1.2.10.RELEASE</version>
</dependency>
笔者项目是一个maven项目，如果需要其他如gradle的依赖请自行查询引入，这里的依赖使用了最新的稳定版本2.2.0.RELEASE。点击这里查看 Spring-StateMachine官网最新版本信息
构造器类
构造一个状态机有两种方式：
- 使用构造器工具类 StateMachineBuilder.builder()。
- 使用javaConfig的形式，扩展EnumStateMachineConfigurerAdapter<States, Events>类，并覆盖configure方法完成状态机配置。
这里我们采用了第一种方式来完成状态机构建，这是因为我们的业务对象为订单，一个订单的生命周期就对应的一个状态机实例，使用javaConfig的形式无法根据当前订单状态来动态生成一个状态机实例。
- 定义一个状态机构造类接口IStateMachineBuilder<S, E>：
import org.springframework.beans.factory.BeanFactory;
import org.springframework.statemachine.StateMachine;
/**
* Author: lehu
* Description:
* Date: Create in 下午3:04 20/5/21
*/
public interface IStateMachineBuilder<S, E> {
String getName();
StateMachine<S, E> build(BeanFactory beanFactory) throws Exception;
//订单状态机构造器
String ORDER_BUILDER_NAME = "orderStateMachineBuilder";
}
- 我们为每一种类型状态机生成一个实现类，现在我们为订单状态实现一个状态机构造类
@Slf4j
@Component
public class OrderStateMachineBuilder implements IStateMachineBuilder<OrderStatusEnum, OrderChangeEventEnum> {
/**
* 注入状态分支条件
*/
@Resource(name = "orderCreateGuard")
private Guard<OrderStatusEnum, OrderChangeEventEnum> orderCreateGuard;
/**
* 注入状态转移动作
*/
@Resource(name = "errorHandlerAction")
private Action<OrderStatusEnum, OrderChangeEventEnum> errorHandlerAction;
@Resource(name = "orderCreateAction")
private Action<OrderStatusEnum, OrderChangeEventEnum> orderCreateAction;
@Resource(name = "orderPayAction")
private Action<OrderStatusEnum, OrderChangeEventEnum> orderPayAction;
@Resource(name = "orderSignAction")
private Action<OrderStatusEnum, OrderChangeEventEnum> orderSignAction;
@Override
public String getName() {
return ORDER_BUILDER_NAME;
}
@Override
public StateMachine<OrderStatusEnum, OrderChangeEventEnum> build(BeanFactory beanFactory) throws Exception {
StateMachineBuilder.Builder<OrderStatusEnum, OrderChangeEventEnum> builder = StateMachineBuilder.builder();
//设置状态机Id
builder.configureConfiguration()
.withConfiguration()
.autoStartup(true)
.beanFactory(beanFactory)
.machineId(ORDER_BUILDER_NAME + "Id");
//初始化状态机，并指定状态集合
builder.configureStates()
.withStates()
//初始状态
.initial(OrderStatusEnum.CREATE)
.end(OrderStatusEnum.COMPLETED)
.states(Sets.newHashSet(
//订单创建
OrderStatusEnum.CREATE,
//待支付
OrderStatusEnum.WAIT_PAYMENT,
//待收货
OrderStatusEnum.WAIT_RECEIVE,
//已完成
OrderStatusEnum.COMPLETED
));
//定义状态机节点，即迁移动作
builder.configureTransitions()
//订单的初始状态为虚拟状态为了满足节点跳转
.withExternal()
//当前节点状态-订单创建
.source(OrderStatusEnum.CREATE)
//目标节点状态-待支付
.target(OrderStatusEnum.WAIT_PAYMENT)
//导致当前变化的事件，用户下单
.event(OrderChangeEventEnum.CREATE_ORDER)
/**
* 执行相关动作的前置条件判断
* orderCreateGuard为Guard<S, E>接口的实现类
*/
.guard(orderCreateGuard)
/**
* 执行当前状态变更导致的业务逻辑处理，以及异常处理
* orderCreateAction、errorHandlerAction为Action<S, E>接口的实现类
*/
.action(orderCreateAction, errorHandlerAction)
//支付订单
.and()
.withExternal()
.source(OrderStatusEnum.WAIT_PAYMENT)
.target(OrderStatusEnum.WAIT_RECEIVE)
.event(OrderChangeEventEnum.PAY_ORDER)
.action(orderPayAction, errorHandlerAction)
//签收订单
.and()
.withExternal()
.source(OrderStatusEnum.WAIT_RECEIVE)
.target(OrderStatusEnum.COMPLETE)
.event(OrderChangeEventEnum.SIGN_ORDER)
.action(orderSignAction, errorHandlerAction);
System.out.println("stateMachine:" + JSON.toJSONString(builder.build()));
return builder.build();
}
以上操作已经完成了对一个订单状态机的定义，如果我们需要创建一个状态机，那么只需要调用一下build方法即可返回一个对应的状态机对象。
构造器工厂
由于我们都是Spring项目，为了使用的便利性一般使用依赖注入的方式来使用我们的工具类，这里实现了一个简单的构造器工厂，简单来说就是把实现了IStateMachineBuilder<S, E>接口的构造器做统一管理，然后提供统一入口，根据需要的状态机类型调用不同的构造器类实例完成状态机初始化。
/**
* Author: lehu
* Description:
* Date: Create in 下午2:45 20/5/21
*/
@Component
public class StateMachineBuildFactory<S, E> implements ApplicationContextAware {
@Autowired
private BeanFactory beanFactory;
/**
* 用来存储builder-name及builder的map
*/
public static final Map<String, IStateMachineBuilder> builderMap = Maps.newConcurrentMap();
@Override
public void setApplicationContext(ApplicationContext applicationContext) throws BeansException {
String[] beanNamesForType = applicationContext.getBeanNamesForType(IStateMachineBuilder.class);
for (String beanName : beanNamesForType) {
IStateMachineBuilder bean = (IStateMachineBuilder) applicationContext.getBean(beanName);
builderMap.put(bean.getName(), bean);
}
}
/**
* 创建状态机
*
* @param machineType 状态机类型
*/
public StateMachine<S, E> createStateMachine(String machineType) throws Exception{
if (StringUtils.isBlank(StringUtils.trim(machineType))) {
throw new RuntimeException("无效的状态机类型");
}
IStateMachineBuilder builder = builderMap.get(machineType);
StateMachine<S, E> stateMachine;
try {
stateMachine = builder.build(beanFactory);
} catch (Exception e) {
throw new RuntimeException("创建状态机异常");
}
return stateMachine;
}
}
本小节介绍了如何定义和生成一个状态机对象，以及在项目中的具体使用方式，下一节将介绍业务代码如何调用状态机。
上一篇：Spring-StateMachine企业级项目应用(二)-动作和条件分支
下一篇：Spring-StateMachine企业级项目应用(四)-状态机管理
