Spring狀態(tài)機 Statemachine使用小結(jié)
更新時間：2025年09月03日 10:05:55 作者：桂老七
狀態(tài)機通過狀態(tài)、事件、配置管理流程,分離業(yè)務邏輯與狀態(tài)控制,實現(xiàn)結(jié)構(gòu)化流轉(zhuǎn),本文主要介紹了Spring狀態(tài)機Statemachine使用小結(jié),感興趣的可以了解一下
1. 狀態(tài)機簡介
狀態(tài)機（State Machine）是一種描述系統(tǒng)行為的數(shù)學模型，核心思想是將系統(tǒng)抽象為有限個狀態(tài)，并通過狀態(tài)轉(zhuǎn)移規(guī)則定義系統(tǒng)如何響應外部事件。它由一系列狀態(tài)（States）、轉(zhuǎn)換（Transitions）、事件（Events）、衛(wèi)兵（Guards）和動作（Actions）組成。在軟件開發(fā)中，狀態(tài)機常用于控制程序的流程和狀態(tài)變化。
其核心優(yōu)勢在于: 通過清晰明確的狀態(tài)定義、自動狀態(tài)更新，將復雜的狀態(tài)流轉(zhuǎn)邏輯結(jié)構(gòu)化。從而使得業(yè)務邏輯與狀態(tài)解耦，減少了自己維護狀態(tài)產(chǎn)生的大量if-else，顯著提升代碼可維護性和擴展性??。
2. 核心組件介紹
2.1 流轉(zhuǎn)邏輯相關:
組件? | 處理邏輯類型? |
State枚舉 | 枚舉對象所有的狀態(tài)（流程圖的節(jié)點） |
Events枚舉 | 枚舉所有引起兩個狀態(tài)之間切換的事件（流程圖的箭頭） |
Configurer配置類 | 組裝State和Event的轉(zhuǎn)換關系 (相當于流程圖) |
| StateMachine狀態(tài)機 | 一個狀態(tài)機表征一個對象實體，它擁有狀態(tài)，并通過event的驅(qū)動來按照Configurer的配置進行狀態(tài)變化，同時執(zhí)行配置中指定的guard、action和listener |
2.2 業(yè)務邏輯組件:
（具體業(yè)務開發(fā)在這里寫，由框架負責調(diào)度）
組件? | 處理邏輯類型? | 是否阻塞遷移? |
Guard? | 純校驗邏輯 (金額校驗/渠道檢查) | 是，失敗則中斷遷移 |
Action? | 核心業(yè)務操作 (支付執(zhí)行/庫存扣減) | 是，異常導致遷移失敗 |
Listener? | 后續(xù)操作響應 (通知/日志/監(jiān)控) | 否，異步執(zhí)行（也可同步） |
2.3 流程示例圖
3. 示例代碼
3.1 依賴引入
<!--狀態(tài)機--> <dependency> <groupId>org.springframework.statemachine</groupId> <artifactId>spring-statemachine-starter</artifactId> <version>3.2.0</version> </dependency> <!-- redis持久化狀態(tài)機--非必需組件,也可以用文件或數(shù)據(jù)庫做持久化 --> <dependency> <groupId>org.springframework.statemachine</groupId> <artifactId>spring-statemachine-redis</artifactId> <version>1.2.9.RELEASE</version> </dependency>
3.2 狀態(tài)枚舉定義
public enum OrderStatus {
// 待支付，待發(fā)貨，待收貨，已完成
WAIT_PAYMENT(1, "待支付"),
WAIT_DELIVER(2, "待發(fā)貨"),
WAIT_RECEIVE(3, "待收貨"),
FINISH(4, "已完成");
private Integer key;
private String desc;
OrderStatus(Integer key, String desc) {
this.key = key;
this.desc = desc;
}
public Integer getKey() {
return key;
}
public String getDesc() {
return desc;
}
}3.3 事件枚舉定義
public enum OrderStatusChangeEvent {
// 支付，發(fā)貨，確認收貨
PAYED, DELIVERY, RECEIVED,UNPAY;
/**
* 獲取下一個事件枚舉
*
* @return 下一個事件枚舉
*/
public OrderStatusChangeEvent getNextEvent() {
switch (this) {
case UNPAY:
return PAYED;
case PAYED:
return DELIVERY;
case DELIVERY:
return RECEIVED;
case RECEIVED:
// 如果是最后一個事件，則返回null
return null;
default:
// 如果枚舉值不在預期范圍內(nèi)，則拋出異常
throw new IllegalArgumentException("不支持的事件枚舉值");
}
}
}3.4 配置類
@Configuration
@EnableStateMachineFactory
public class OrderStateMachineConfig extends StateMachineConfigurerAdapter<OrderStatus, OrderStatusChangeEvent> {
@Autowired
private OrderGuard orderGuard;
@Autowired
private OrderAction orderAction;
/**
* 配置狀態(tài)
*
* @param states
* @throws Exception
*/
public void configure(StateMachineStateConfigurer<OrderStatus, OrderStatusChangeEvent> states) throws Exception {
states
.withStates()
.initial(OrderStatus.WAIT_PAYMENT)
.states(EnumSet.allOf(OrderStatus.class));
}
/**
* 配置狀態(tài)轉(zhuǎn)換事件關系
*
* @param transitions
* @throws Exception
*/
public void configure(StateMachineTransitionConfigurer<OrderStatus, OrderStatusChangeEvent> transitions) throws Exception {
transitions
//支付事件:待支付-》待發(fā)貨
.withExternal()
.source(OrderStatus.WAIT_PAYMENT).target(OrderStatus.WAIT_DELIVER)
.event(OrderStatusChangeEvent.PAYED)
.guard(orderGuard)
.action(orderAction)
.and()
//發(fā)貨事件:待發(fā)貨-》待收貨
.withExternal()
.source(OrderStatus.WAIT_DELIVER).target(OrderStatus.WAIT_RECEIVE)
.event(OrderStatusChangeEvent.DELIVERY)
.guard(orderGuard)
.action(orderAction)
.and()
//收貨事件:待收貨-》已完成
.withExternal()
.source(OrderStatus.WAIT_RECEIVE).target(OrderStatus.FINISH)
.event(OrderStatusChangeEvent.RECEIVED)
.guard(orderGuard)
.action(orderAction)
.and()
.withExternal()
.source(OrderStatus.WAIT_DELIVER).target(OrderStatus.WAIT_PAYMENT)
.event(OrderStatusChangeEvent.UNPAY)
.guard(orderGuard)
.action(orderAction);
}
}3.5 Guard--存放業(yè)務檢查邏輯
業(yè)務開發(fā)只用關心實現(xiàn)這個Guard接口不用關心執(zhí)行調(diào)度和狀態(tài)維護。
@Component
public class OrderGuard implements Guard<OrderStatus, OrderStatusChangeEvent> {
@Override
public boolean evaluate(StateContext<OrderStatus, OrderStatusChangeEvent> context) {
Order order = context.getMessage().getHeaders().get("order", Order.class);
// ...自定義業(yè)務檢查邏輯
return true;
}
}3.6 Action---存放業(yè)務執(zhí)行邏輯
業(yè)務開發(fā)只用關心實現(xiàn)這個Action接口不用關心執(zhí)行調(diào)度和狀態(tài)維護
@Slf4j
@Component
public class OrderAction implements Action<OrderStatus,OrderStatusChangeEvent> {
@Resource
private OrderMapper orderMapper;
@Override
public void execute(StateContext<OrderStatus, OrderStatusChangeEvent> stateContext) {
try {
Order order = stateContext.getMessage().getHeaders().get("order", Order.class);
State<OrderStatus, OrderStatusChangeEvent> target = stateContext.getTarget();
order.setStatus(target.getId().getKey());
log.info("orderAction:{}", order);
// 自定義業(yè)務執(zhí)行邏輯
} catch (Exception e) {
log.error("訂單狀態(tài)機執(zhí)行異常", e);
stateContext.getStateMachine().setStateMachineError(new RuntimeException("自定義錯誤"));
throw e;
}
}
}3.7 核心控制類
對并發(fā)有要求的使用工廠方法，每個訂單都單獨使用一個狀態(tài)機表達
@Service("orderService")
@Slf4j
public class OrderServiceImpl extends ServiceImpl<OrderMapper, Order> implements OrderService {
@Autowired
private StateMachineFactory<OrderStatus, OrderStatusChangeEvent> stateMachineFactory;
@Resource
private StateMachinePersister<OrderStatus, OrderStatusChangeEvent, String> stateMachineRedisPersister;
@Resource
private OrderMapper orderMapper;
@Autowired
private RedisUtil redisUtil;
@Autowired
OrderStateListener orderStateListener;
/**
* 創(chuàng)建訂單
*
* @param order
* @return
*/
@DS("oracle-xxx")
@Transactional(propagation = Propagation.REQUIRES_NEW)
public Order create(Order order) {
order.setStatus(OrderStatus.WAIT_PAYMENT.getKey());
orderMapper.insert(order);
return order;
}
/**
* 對訂單進行支付
*
* @param id
* @return
*/
@DS("oracle-xxx")
@Transactional(propagation = Propagation.REQUIRES_NEW)
public boolean pay(Long id) {
Order order = orderMapper.selectById(id);
log.info("線程名稱：{},嘗試支付，訂單號：{}" ,Thread.currentThread().getName() , id);
return autoSendEvent(OrderStatusChangeEvent.PAYED, order);
}
/**
* 發(fā)送訂單狀態(tài)轉(zhuǎn)換事件
* synchronized修飾保證這個方法是線程安全的
*
* @param changeEvent
* @param order
* @return
*/
private boolean sendEvent(OrderStatusChangeEvent changeEvent, Order order) {
boolean result = false;
StateMachine<OrderStatus, OrderStatusChangeEvent> orderStateMachine = null;
try {
// 工廠方法生成狀態(tài)機
orderStateMachine = stateMachineFactory.getStateMachine(order.getId());
orderStateMachine.addStateListener(orderStateListener);
//啟動狀態(tài)機
orderStateMachine.start();
//嘗試恢復狀態(tài)機狀態(tài)
stateMachineRedisPersister.restore(orderStateMachine, String.valueOf(order.getId()));
Message message = MessageBuilder.withPayload(changeEvent).setHeader("order", order).build();
result = orderStateMachine.sendEvent(message);
boolean hasError = orderStateMachine.hasStateMachineError();
//持久化狀態(tài)機狀態(tài)
if(hasError){
return !hasError;
}
stateMachineRedisPersister.persist(orderStateMachine, String.valueOf(order.getId()));
// 已結(jié)束的流程 給key加上過期時間
if (order.getStatus() == OrderStatus.FINISH.getKey()) {
redisUtil.set(order.getId(), order.getStatus(), 60 * 60 * 24, TimeUnit.SECONDS);
}
} catch (Exception e) {
log.error("訂單操作失敗:{}", e);
} finally{
if (orderStateMachine != null) {
// 釋放狀態(tài)機
orderStateMachine.stop();
}
}
return result;
}
private boolean autoSendEvent(OrderStatusChangeEvent changeEvent, Order order) {
boolean b = true;
while (b && changeEvent != null) {
b = sendEvent(changeEvent, order);
changeEvent = changeEvent.getNextEvent();
}
return b;
}
3.8 監(jiān)聽器
用來執(zhí)行一些不影響流程主流程的 日志、通知之類的任務，可異步
@Component
@Slf4j
public class OrderStateListener extends StateMachineListenerAdapter<OrderStatus, OrderStatusChangeEvent> {
private StateMachine<OrderStatus, OrderStatusChangeEvent> stateMachine;
private Message<OrderStatusChangeEvent> message;
@Override
public void stateContext(StateContext<OrderStatus, OrderStatusChangeEvent> context) {
StateMachine<OrderStatus, OrderStatusChangeEvent> stateMachine = context.getStateMachine();
this.stateMachine = stateMachine;
// 獲取當前事件
Message<OrderStatusChangeEvent> message = context.getMessage();
this.message = message;
// 獲取狀態(tài)機 ID
String machineId = stateMachine.getId();
// 應用場景：訂單狀態(tài)變更記錄
if (context.getStage() == StateContext.Stage.STATE_CHANGED) {
OrderStatus oldStatus = context.getSource().getId();
OrderStatus newStatus = context.getTarget().getId();
log.info("訂單 {} 狀態(tài)變更: {} → {}", machineId, oldStatus, newStatus);
}
if(context.getException()!=null){
log.error("狀態(tài)機異常: {}",context.getException().getMessage());
}
}
@DS("oracle-xxx")
@Override
public void stateChanged(State<OrderStatus, OrderStatusChangeEvent> from, State<OrderStatus, OrderStatusChangeEvent> to) {
// 狀態(tài)變更時觸發(fā)（如 UNPAID → PAID）
System.out.println("狀態(tài)變更: " + from.getId() + " → " + to.getId());
Order order = message.getHeaders().get("order", Order.class);
order.setStatus(to.getId().getKey());
}
@Override
public void stateEntered(State<OrderStatus, OrderStatusChangeEvent> state) {
// 進入新狀態(tài)時觸發(fā)
System.out.println("進入狀態(tài): " + state.getId());
}
@Override
@Async
public void eventNotAccepted(Message<OrderStatusChangeEvent> message) {
// 事件被拒絕時觸發(fā)（如非法狀態(tài)轉(zhuǎn)換）
System.err.println("事件拒絕開始: " + message.getPayload());
Order order = message.getHeaders().get("order", Order.class);
try {
Thread.sleep(60000);
} catch (InterruptedException e) {
throw new RuntimeException(e);
}
System.err.println("事件拒絕結(jié)束: " + message.getPayload());
}
@Override
@Async
public void stateMachineError(StateMachine<OrderStatus, OrderStatusChangeEvent> stateMachine, Exception exception) {
// 只能建ring狀態(tài)機本身在運行中發(fā)生的異常，不能處理action拋出的異常
// 可以在此進行重試、告警等操作
log.error("錯誤處理: {}", exception.getMessage());
}
@Override
public void stateExited(State<OrderStatus, OrderStatusChangeEvent> state) {
// 狀態(tài)機退出時觸發(fā)
log.info("狀態(tài)退出: {}", state.getId());
}
}3.9 持久化
這里直接用的redis持久化，可自己定義成其他持久化方式
@Configuration
@Slf4j
public class Persist<E, S> {
@Resource
private RedisConnectionFactory redisConnectionFactory;
/**
* 持久化到redis中，在分布式系統(tǒng)中使用
*
* @return
*/
@Bean(name = "stateMachineRedisPersister")
public RedisStateMachinePersister<E, S> getRedisPersister() {
RedisStateMachineContextRepository<E, S> repository = new RedisStateMachineContextRepository<>(redisConnectionFactory);
RepositoryStateMachinePersist p = new RepositoryStateMachinePersist<>(repository);
return new RedisStateMachinePersister<>(p);
}
}
4. 總結(jié)
1. 狀態(tài)轉(zhuǎn)移通過配置類維護，可讀性高，新增狀態(tài)時維護方便。
2. 狀態(tài)之間轉(zhuǎn)移通過由配置強制指定，不容易出現(xiàn)邏輯錯亂。
3. 加鎖方便，可以在統(tǒng)一的事件觸發(fā)入口加redis分布式鎖。
4. 業(yè)務邏輯處理存放在Guard?、Action?、監(jiān)聽器中，各司其職結(jié)構(gòu)清晰，代碼邏輯解耦。
到此這篇關于Spring狀態(tài)機 Statemachine使用小結(jié)的文章就介紹到這了,更多相關Spring狀態(tài)機 Statemachine內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持腳本之家！
相關文章
在實際場景中，會有需要配置多個數(shù)據(jù)源的場景，本文就介紹一下如何配置Spring多數(shù)據(jù)源，具有一定的參考價值，感興趣的可以了解一下2021-08-08
Drools是一個易于訪問企業(yè)策略、易于調(diào)整以及易于管理的開源業(yè)務規(guī)則引擎，符合業(yè)內(nèi)標準，速度快、效率高。業(yè)務分析師或?qū)徍巳藛T可以利用它輕松查看業(yè)務規(guī)則，從而檢驗是否已編碼的規(guī)則執(zhí)行所需的業(yè)務規(guī)則。本文將講述SpringBoot整合Drools的步驟2021-05-05
這篇文章主要給大家介紹了關于gradle安裝配置以及使用的相關資料,Gradle是一個基于ApacheAnt和ApacheMaven概念的項目自動化構(gòu)建開源工具,文中通過圖文介紹的非常詳細,需要的朋友可以參考下2023-11-11
SpringCloud OpenFeign與Ribbon客戶端配置詳解
在springcloud中，openfeign是取代了feign作為負載均衡組件的，feign最早是netflix提供的，他是一個輕量級的支持RESTful的http服務調(diào)用框架，內(nèi)置了ribbon，而ribbon可以提供負載均衡機制，因此feign可以作為一個負載均衡的遠程服務調(diào)用框架使用2022-11-11
spring-ai-alibaba文本轉(zhuǎn)語音的實例
在使用Spring-ai-alibaba進行文本轉(zhuǎn)語音項目時,遇到DashScopeException錯誤,原因是響應中的字段未被識別,通過在項目中創(chuàng)建目錄類,復制DashScopeAudioTranscriptionApi類并在指定位置增加字段,解決了該問題2025-11-11
mybatis實現(xiàn)表與對象的關聯(lián)關系_動力節(jié)點Java學院整理
這篇文章主要介紹了mybatis實現(xiàn)表與對象的關聯(lián)關系_動力節(jié)點Java學院整理,需要的朋友可以參考下2017-09-09
SpringBoot+SpringCache實現(xiàn)兩級緩存(Redis+Caffeine)
這篇文章主要介紹了SpringBoot+SpringCache實現(xiàn)兩級緩存(Redis+Caffeine)，文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值，需要的朋友們下面隨著小編來一起學習學習吧2021-04-04
這篇文章主要介紹了最大子數(shù)組和Java實現(xiàn)的相關資料,文中介紹了兩種方法來解決尋找具有最大和的連續(xù)子數(shù)組的問題,第一種方法是動態(tài)規(guī)劃,第二種方法是分治法,需要的朋友可以參考下2024-11-11
深入學習Spring Boot排查 @Transactional 引起的 NullPointerException問題
這篇文章主要介紹了深入學習Spring Boot排查 @Transactional 引起的 NullPointerException問題,需要的朋友可以參考下2018-01-01
詳解Spring中InitializingBean接口的功能
這篇文章主要介紹了Spring中InitializingBean接口的功能,講述了spring中InitializingBean接口的功能簡介說明，本文給大家介紹的非常詳細，對大家的學習或工作具有一定的參考借鑒價值，需要的朋友可以參考下2022-05-05