1. 简介
本文重点介绍Spring的状态机项目-该项目可用于表示工作流或任何其他类型的有限状态自动机表示问题。
2. Maven依赖
首先，我们需要添加主要的Maven依赖项：
<dependency>
<groupId>org.springframework.statemachine</groupId>
<artifactId>spring-statemachine-core</artifactId>
<version>3.2.0.RELEASE</version>
</dependency>
此依赖项的最新版本可在此处找到。
3. 状态机配置
现在，让我们开始定义一个简单的状态机：
@Configuration
@EnableStateMachine
public class SimpleStateMachineConfiguration extends StateMachineConfigurerAdapter<String, String> {
@Override
public void configure(StateMachineStateConfigurer<String, String> states) throws Exception {
states.withStates()
.initial("SI")
.end("SF")
.states(new HashSet<String>(Arrays.asList("S1", "S2", "S3")));
}
@Override
public void configure(StateMachineTransitionConfigurer<String, String> transitions) throws Exception {
transitions.withExternal()
.source("SI").target("S1").event("E1").and()
.withExternal()
.source("S1").target("S2").event("E2").and()
.withExternal()
.source("S2").target("SF").event("end");
}
}
请注意，此类被标注为传统的Spring配置以及状态机。它还需要扩展StateMachineConfigurerAdapter，以便可以调用各种初始化方法。在其中一种配置方法中，我们定义了状态机的所有可能状态，在另一种配置方法中，我们定义了事件如何改变当前状态。
上面的配置设置了一个非常简单的直线转换状态机，应该很容易理解。
现在我们需要启动一个Spring上下文并获取对我们配置定义的状态机的引用：
@Autowired
private StateMachine<String, String> stateMachine;
一旦我们有了状态机，就需要启动它：
stateMachine.start();
现在我们的状态机处于初始状态，我们可以发送事件并触发转换：
stateMachine.sendEvent("E1");
我们始终可以检查状态机的当前状态：
stateMachine.getState();
4. 动作
让我们添加一些要围绕状态转换执行的操作。首先，我们在同一个配置文件中将我们的操作定义为一个Spring bean：
@Bean
public Action<String, String> initAction() {
return ctx -> System.out.println(ctx.getTarget().getId());
}
然后我们可以在我们的配置类中注册上面创建的转换动作：
@Override
public void configure(StateMachineTransitionConfigurer<String, String> transitions) throws Exception {
transitions.withExternal()
.source("SI").target("S1")
.event("E1").action(initAction())
当通过事件E1从SI到S1的转换发生时，将执行此操作。操作可以附加到状态本身：
@Bean
public Action<String, String> executeAction() {
return ctx -> System.out.println("Do" + ctx.getTarget().getId());
}
states
.withStates()
.state("S3", executeAction(), errorAction());
此状态定义函数接收当状态机处于目标状态时要执行的操作，以及可选的错误操作处理程序。
错误操作处理程序与任何其他操作没有太大区别，但如果在评估状态操作期间的任何时间抛出异常，它将被调用：
@Bean
public Action<String, String> errorAction() {
return ctx -> System.out.println("Error " + ctx.getSource().getId() + ctx.getException());
}
也可以为entry、do和exit状态转换注册单独的动作：
@Bean
public Action<String, String> entryAction() {
return ctx -> System.out.println("Entry " + ctx.getTarget().getId());
}
@Bean
public Action<String, String> executeAction() {
return ctx -> System.out.println("Do " + ctx.getTarget().getId());
}
@Bean
public Action<String, String> exitAction() {
return ctx -> System.out.println("Exit " + ctx.getSource().getId() + " -> " + ctx.getTarget().getId());
}
states
.withStates()
.stateEntry("S3", entryAction())
.state("S3", executeAction())
.stateExit("S3", exitAction());
相应的操作将在相应的状态转换上执行。例如，我们可能希望在进入时验证一些前置条件或在退出时触发一些报告。
5. 全局监听器
可以为状态机定义全局事件监听器。这些监听器将在任何时候发生状态转换时被调用，并且可以用于日志记录或安全性等操作。
首先，我们需要添加另一种配置方法-一种不处理状态或转换，而是处理状态机本身的配置方法。
我们需要通过扩展StateMachineListenerAdapter来定义一个监听器：
public class StateMachineListener extends StateMachineListenerAdapter {
@Override
public void stateChanged(State from, State to) {
System.out.printf("Transitioned from %s to %s%n", from == null ? "none" : from.getId(), to.getId());
}
}
在这里，我们只覆盖了stateChanged，尽管还有许多其他钩子可用。
6. 扩展状态
Spring State Machine跟踪其状态，但要跟踪我们的应用程序状态，无论是一些计算值、来自管理员的条目还是来自调用外部系统的响应，我们需要使用所谓的扩展状态。
假设我们要确保一个帐户应用程序经过两个级别的批准。我们可以使用存储在扩展状态中的整数来跟踪批准计数：
@Bean
public Action<String, String> executeAction() {
return ctx -> {
int approvals = (int) ctx.getExtendedState().getVariables()
.getOrDefault("approvalCount", 0);
approvals++;
ctx.getExtendedState().getVariables()
.put("approvalCount", approvals);
};
}
7. 卫兵
守卫可用于在执行状态转换之前验证某些数据。守卫看起来与动作非常相似：
@Bean
public Guard<String, String> simpleGuard() {
return ctx -> (int) ctx.getExtendedState()
.getVariables()
.getOrDefault("approvalCount", 0) > 0;
}
这里明显的区别是守卫返回true或false，这将通知状态机是否应该允许转换发生。
还支持SPeL表达式作为守卫。上面的例子也可以写成：
.guardExpression("extendedState.variables.approvalCount > 0")
8. 来自构建器的状态机
StateMachineBuilder可用于在不使用Spring注解或创建Spring上下文的情况下创建状态机：
StateMachineBuilder.Builder<String, String> builder = StateMachineBuilder.builder();
builder.configureStates().withStates()
.initial("SI")
.state("S1")
.end("SF");
builder.configureTransitions()
.withExternal()
.source("SI").target("S1").event("E1")
.and().withExternal()
.source("S1").target("SF").event("E2");
StateMachine<String, String> machine = builder.build();
9. 层级状态
可以通过结合使用多个withStates()和parent()来配置分层状态：
states
.withStates()
.initial("SI")
.state("SI")
.end("SF")
.and()
.withStates()
.parent("SI")
.initial("SUB1")
.state("SUB2")
.end("SUBEND");
这种设置允许状态机具有多个状态，因此对getState()的调用将产生多个ID。例如，在启动后立即出现以下表达式：
stateMachine.getState().getIds()
["SI", "SUB1"]
10. 路口(选择)
到目前为止，我们已经创建了本质上是线性的状态转换。这不仅相当无趣，而且也没有反映开发人员将被要求实现的真实用例。很有可能需要实现条件路径，而Spring状态机的junctions(或choices)允许我们做到这一点。
首先，我们需要在状态定义中将状态标记为junction(choice)：
states
.withStates()
.junction("SJ")
然后在转换中，我们定义了对应于if-then-else结构的first/then/last选项：
.withJunction()
.source("SJ")
.first("high", highGuard())
.then("medium", mediumGuard())
.last("low")
first和then接收第二个参数，它是一个常规守卫，将被调用以找出采用哪条路径：
@Bean
public Guard<String, String> mediumGuard() {
return ctx -> false;
}
@Bean
public Guard<String, String> highGuard() {
return ctx -> false;
}
请注意，转换不会在连接节点处停止，而是会立即执行定义的守卫并转到指定路线之一。
在上面的示例中，指示状态机转换为SJ将导致实际状态变low，因为两个守卫都返回false。
最后要注意的是，API提供了junctions和choices。但是，从功能上讲，它们在各个方面都是相同的。
11. Fork
有时需要将执行拆分为多个独立的执行路径。这可以使用fork功能来实现。
首先，我们需要指定一个节点作为分叉节点并创建层次区域，状态机将在其中执行拆分：
states
.withStates()
.initial("SI")
.fork("SFork")
.and()
.withStates()
.parent("SFork")
.initial("Sub1-1")
.end("Sub1-2")
.and()
.withStates()
.parent("SFork")
.initial("Sub2-1")
.end("Sub2-2");
然后定义分叉转换：
.withFork()
.source("SFork")
.target("Sub1-1")
.target("Sub2-1");
12. Join
fork操作的补充是join。它允许我们设置一个状态转换，该状态依赖于完成其他一些状态：
与fork一样，我们需要在状态定义中指定一个join节点：
states
.withStates()
.join("SJoin")
然后在转换中，我们定义需要完成哪些状态才能启用我们的join状态：
transitions
.withJoin()
.source("Sub1-2")
.source("Sub2-2")
.target("SJoin");
就是这样！使用此配置，当Sub1-2和Sub2-2都实现时，状态机将转换为SJoin
13. 用枚举代替字符串
在上面的示例中，为了清晰和简单起见，我们使用字符串常量来定义状态和事件。在真实世界的生产系统上，人们可能希望使用Java的枚举来避免拼写错误并获得更多的类型安全性。
首先，我们需要定义系统中所有可能的状态和事件：
public enum ApplicationReviewStates {
PEER_REVIEW, PRINCIPAL_REVIEW, APPROVED, REJECTED
}
public enum ApplicationReviewEvents {
APPROVE, REJECT
}
当我们扩展配置时，我们还需要将我们的枚举作为泛型参数传递：
public class SimpleEnumStateMachineConfiguration extends StateMachineConfigurerAdapter<ApplicationReviewStates, ApplicationReviewEvents>
一旦定义，我们就可以使用我们的枚举常量而不是字符串。例如定义一个转换：
transitions.withExternal()
.source(ApplicationReviewStates.PEER_REVIEW)
.target(ApplicationReviewStates.PRINCIPAL_REVIEW)
.event(ApplicationReviewEvents.APPROVE)
14. 总结
本文探讨了Spring状态机的一些特性。
与往常一样，本教程的完整源代码可在GitHub上获得。
Post Directory
