如何将 Spring Statemachine 作为一个轻量级工作流引擎来使用？

本文将探讨 Spring Statemachine 作为一个轻量级工作流引擎使用的可行性。文章首先介绍 State Machine 的基本概念然后讲解 Spring Statemachine 的核心特性最后通过电商订单状态流转的实战案例演示将 Spring Statemachine 作为工作流引擎的具体应用。1 State Machine 是什么State Machine状态机是一个用来描述事物在不同状态之间如何转换的数学模型。其包含三个核心要素状态State、事件Event、转换Transition。状态State状态是指事物可能处于的某种情形或阶段。比如一个订单处于已创建CREATED或已支付状态PAID。事件Event事件是指引发状态发生变化的外部动作或内部触发。比如对一个订单进行支付PAY或运输SHIP操作。转换Transition转换是指从一个状态到另一个状态的变化规则。比如一个订单从已支付PAID状态经过运输SHIP事件转移到已运输SHIPPED状态。一个完整的电商订单状态的流转过程如下[DRAFT] -- CREATE 事件 -- [CREATED] -- PAY 事件 -- [PAID] -- SHIP 事件 -- [SHIPPED] -- DELIVER 事件 -- [DELIVERED]2 Spring Statemachine 是什么Spring Statemachine 是 Spring 生态中的一个专门用来构建和管理 State Machine 的框架。它把上面提到的 State Machine 概念变成了 Java 开发者可以直接使用的工具。我们可以把它理解成一个「状态机工厂」—— 只需要告诉它业务规则有哪些状态、什么事件触发什么变化它就会帮我们自动管理整个状态的流转过程。没有 Spring Statemachine 时我们需要自己编写大量的if-else代码来判断状态并执行对应的业务逻辑如果订单状态是 CREATED并且用户进行了 PAY 操作 则调用支付接口 并把状态改成 PAID ... 否则如果订单状态是 PAID并且后台管理员进行了 SHIP 操作 则调用物流接口 并把状态改成 SHIPPED ...这种代码写多了就会变成难以维护的「面条代码」。而有了 Spring Statemachine 后我们只需要定义规则框架会负责执行规则里的逻辑规则 1CREATED → PAY 事件 → PAID 规则 2PAID → SHIP 事件 → SHIPPED 规则 3SHIPPED → DELIVER 事件 → DELIVERED定义好规则后我们只需要告诉它「触发支付事件」框架就会自动触发预先绑定的业务逻辑。带来的好处是将状态管理代码和具体业务代码进行了解耦职责明确易于维护。Spring Statemachine 的主要组成部分状态定义器列出所有可能的状态。比如订单的状态DRAFT、CREATED、PAID、SHIPPED、DELIVERED。事件定义器定义所有可能触发的动作。比如订单的事件CREATE、PAY、SHIP、DELIVER。转换配置器连接状态和事件形成规则。比如转换规则CREATED 状态遇到 PAY 事件后变成 PAID 状态。动作执行器在状态变化时执行具体的业务逻辑。比如支付成功后要更新状态、发送短信通知、记录日志等。监听器监控状态机的每一步变化。比如状态改变时、事件触发时都能触发到指定的回调方法。持久化支持把状态机的当前状态保存到数据库。这样当服务重启后工作流也能从上次中断的地方继续执行。3 将 Spring Statemachine 作为一个轻量级工作流引擎来使用下面就以电商订单的工作流为例演示如何将业务流程建模为一个状态机定义清晰的状态和事件使用 Spring Statemachine 框架来驱动整个流程的自动化。[DRAFT] -- CREATE 事件 -- [CREATED] -- PAY 事件 -- [PAID] -- SHIP 事件 -- [SHIPPED] -- DELIVER 事件 -- [DELIVERED]3.1 定义状态和事件States Events电商订单对应的状态和事件类如下public enum OrderStates { DRAFT, CREATED, PAID, SHIPPED, DELIVERED } public enum OrderEvents { CREATE, PAY, SHIP, DELIVER }3.2 配置流程规则Transitions这是构建工作流引擎最核心的一步。我们需要通过代码将这些状态States和事件Events连接起来形成明确的流转规则。在配置类上使用EnableStateMachineFactory注解可以为每个流程实例如每个订单创建独立的状态机。Configuration EnableStateMachineFactory public class OrderStateMachineConfig extends EnumStateMachineConfigurerAdapterOrderStates, OrderEvents { Override public void configure(StateMachineConfigurationConfigurerOrderStates, OrderEvents config) throws Exception { config.withConfiguration() .autoStartup(true); } Override public void configure(StateMachineStateConfigurerOrderStates, OrderEvents states) throws Exception { states.withStates() .initial(OrderStates.DRAFT) .states(EnumSet.allOf(OrderStates.class)); } Override public void configure(StateMachineTransitionConfigurerOrderStates, OrderEvents transitions) throws Exception { transitions.withExternal() .source(OrderStates.DRAFT).target(OrderStates.CREATED).event(OrderEvents.CREATE) .and() .withExternal() .source(OrderStates.CREATED).target(OrderStates.PAID).event(OrderEvents.PAY) .and() .withExternal() .source(OrderStates.PAID).target(OrderStates.SHIPPED).event(OrderEvents.SHIP) .and() .withExternal() .source(OrderStates.SHIPPED).target(OrderStates.DELIVERED).event(OrderEvents.DELIVER); } }3.3 配置多实例服务Multi-instance Service因为不同的订单实例需要对应不同的 StateMachine 实例所以配置一个OrderStateMachineServiceConfig类指定StateMachineService获取的StateMachine实例是从StateMachineFactory获取的。Configuration public class OrderStateMachineServiceConfig extends StateMachineConfigurerAdapterOrderStates, OrderEvents { Bean public StateMachineServiceOrderStates, OrderEvents stateMachineService( StateMachineFactoryOrderStates, OrderEvents stateMachineFactory) { return new DefaultStateMachineService(stateMachineFactory); } }3.4 封装事件发送方法Events Sending Method流程的流转是通过发送事件来驱动的下面我们在OrderService接口定义一个统一的事件发送方法public interface OrderService { void sendEvent(Long orderId, OrderEvents event); }并对该方法进行实现Service public class OrderServiceImpl implements OrderService { Override public void sendEvent(Long orderId, OrderEvents event) { StateMachineOrderStates, OrderEvents stateMachine stateMachineService.acquireStateMachine(String.valueOf(orderId)); MessageOrderEvents message MessageBuilder .withPayload(event) .setHeader(orderId, orderId) .build(); stateMachine.sendEvent(message); } }可以看到事件发送方法中StateMachine实例统一从StateMachineService获取。发送的消息体带上了orderId。封装好后在业务代码如 Service 层中就可以通过向状态机发送事件来驱动流程前进了。3.5 配置监听器Listener创建一个OrderStateMachineListener类使用OnTransition注解来监听状态变化并执行对应的业务逻辑。这比将业务代码写在 Service 层更符合工作流引擎的设计理念。Component WithStateMachine public class OrderStateMachineListener { OnStateChanged public void onStateChange(StateContextOrderStates, OrderEvents context) { MessageOrderEvents message context.getMessage(); if (null ! message) { Long orderId message.getHeaders().get(orderId, Long.class); OrderStates targetState context.getTarget().getId(); // update state orderService.updateState(orderId, targetState); // other logic // ... } } }一旦有任何订单状态的变更OrderStateMachineListener类的onStateChange方法都能监听到。这样一些诸如 Order 状态的更新以及状态变更后需要执行的业务逻辑都能放到这里。3.6 发送事件驱动流程流转Sending Events上面的准备工作做好后现在即可通过调用封装好的事件发送方法发送事件来推动整个流程的运转。orderService.sendEvent(orderId1, OrderEvents.CREATE);这样OrderStateMachineListener中的逻辑即会被触发。3.7 状态持久化与恢复State Persistence、Restore对于一个可靠的工作流引擎来说服务重启后流程必须能从断点处恢复这是至关重要的一步。因此我们需要优化OrderService中的事件发送方法Service public class OrderServiceImpl implements OrderService { Override public void sendEvent(Long orderId, OrderEvents event) { StateMachineOrderStates, OrderEvents stateMachine stateMachineService.acquireStateMachine(String.valueOf(orderId)); OrderStates currentState stateMachine.getState().getId(); OrderStates state orderRepository.getState(orderId); if (currentState ! state) { restoreState(stateMachine, orderId, state); } MessageOrderEvents message MessageBuilder .withPayload(event) .setHeader(orderId, orderId) .build(); stateMachine.sendEvent(message); } private void restoreState(StateMachineOrderStates, OrderEvents stateMachine, Long orderId, OrderStates state) { stateMachine.getStateMachineAccessor() .doWithAllRegions(access - { StateMachineContextOrderStates, OrderEvents context new DefaultStateMachineContext( state, null, null, null, null, String.valueOf(orderId) ); access.resetStateMachine(context); }); } }在发送事件前需要判断StateMachine的当前状态是否与数据库中订单的最新状态一致不一致要以数据库中的状态为准然后接着推送流程的运转。这样流程走到任何一步遇到服务重启时都能接着正确的运行。4 小结综上本文首先介绍了 State Machine 的概念接着介绍了 Spring Statemachine 的作用最后以电商订单的状态流转为例演示了使用 Spring Statemachine 充当轻量级工作流引擎的可行性。初步来看Spring Statemachine 还是很强大的其设计支持多流程实例、支持以配置的方式定义状态流转规则、支持以监听器的方式接收状态变更信号。是简单工作流场景的一个可选的实现引擎。