spring狀態(tài)機模式使用小結(jié)
1. 狀態(tài)模式
狀態(tài)模式的定義如下:
狀態(tài)模式(State Pattern)是一種行為型設(shè)計模式,它允許對象在內(nèi)部狀態(tài)發(fā)生變化時改變其行為。在狀態(tài)模式中,一個對象的行為取決于其當前狀態(tài),而且可以隨時改變這個狀態(tài)。狀態(tài)模式將對象的狀態(tài)封裝在不同的狀態(tài)類中,從而使代碼更加清晰和易于維護。當一個對象的狀態(tài)改變時,狀態(tài)模式會自動更新該對象的行為,而不需要在代碼中手動進行判斷和處理。
通常業(yè)務(wù)系統(tǒng)中會存在一些擁有狀態(tài)的對象,而且這些狀態(tài)之間可以進行轉(zhuǎn)換,并且在不同的狀態(tài)下會表現(xiàn)出不同的行為或者不同的功能,比如交通燈控制系統(tǒng)中會存在紅燈、綠燈和黃燈,再比如訂單系統(tǒng)中的訂單會存在已下單、待支付、待發(fā)貨、待收貨等狀態(tài),這些狀態(tài)會通過不同的行為進行相互轉(zhuǎn)換,這時候在系統(tǒng)設(shè)計時就可以使用狀態(tài)模式。
下面是狀態(tài)模式的類圖:
可以看到狀態(tài)模式主要包含三種類型的角色:
1、上下文( Context
)角色:封裝了狀態(tài)的實例,負責維護狀態(tài)實例,并將請求委托給當前的狀態(tài)對象。
2、抽象狀態(tài)( State
)角色:定義了表示不同狀態(tài)的接口,并封裝了該狀態(tài)下的行為。所有具體狀態(tài)都實現(xiàn)這個接口。
3、具體狀態(tài)( Concrete State
)角色:具體實現(xiàn)了抽象狀態(tài)角色的接口,并封裝了該狀態(tài)下的行為。
下面是使用狀態(tài)模式實現(xiàn)紅綠燈狀態(tài)變更的一個簡單案例:
抽象狀態(tài)類:
/** * @description: 抽象狀態(tài)類 */ public abstract class MyState { abstract void handler(); }
具體狀態(tài)類A
/** * @description: 具體狀態(tài)A */ public class RedLightState extends MyState{ @Override void handler() { System.out.println("紅燈停"); } }
具體狀態(tài)類B
/** * @description: 具體狀態(tài)B */ public class GreenLightState extends MyState{ @Override void handler() { System.out.println("綠燈行"); } }
環(huán)境類:維護當前狀態(tài)對象,并提供了切換狀態(tài)的方法。
/** * @description: 環(huán)境類 */ public class MyContext { private MyState state; public void setState(MyState state) { this.state = state; } public void handler() { state.handler(); } }
測試類
/** * @description: 測試狀態(tài)模式 */ public class TestStateModel { public static void main(String[] args) { MyContext myContext = new MyContext(); RedLightState redLightState = new RedLightState(); GreenLightState greenLightState = new GreenLightState(); myContext.setState(redLightState); myContext.handler(); //紅燈停 myContext.setState(greenLightState); myContext.handler(); //綠燈行 } }
下面是對應(yīng)的執(zhí)行結(jié)果
可以發(fā)現(xiàn),使用狀態(tài)模式中的狀態(tài)類在一定程度上也消除了if-else邏輯校驗,看到這里, 有些人可能會有疑問:狀態(tài)模式和策略模式的區(qū)別是什么呢?
狀態(tài)模式更關(guān)注對象在不同狀態(tài)的行為和狀態(tài)之間的流轉(zhuǎn),而策略模式更關(guān)注對象不同策略的選擇。
上面我們介紹了設(shè)計模式中的狀態(tài)模式,接下來我們來看看Spring狀態(tài)機。
2. Spring狀態(tài)機
狀態(tài)機,也就是 State Machine ,不是指一臺實際機器,而是指一個數(shù)學模型。說白了,就是指一張狀態(tài)轉(zhuǎn)換圖。狀態(tài)機是狀態(tài)模式的一種應(yīng)用,相當于上下文角色的一個升級版。在工作流或游戲等各種系統(tǒng)中有大量使用,如各種工作流引擎,它幾乎是狀態(tài)機的子集和實現(xiàn),封裝狀態(tài)的變化規(guī)則。Spring也提供了一個很好的解決方案。Spring中的組件名稱就叫作狀態(tài)機(StateMachine)。狀態(tài)機幫助開發(fā)者簡化狀態(tài)控制的開發(fā)過程,讓狀態(tài)機結(jié)構(gòu)更加層次化。
通過定義,我們很容易分析得到狀態(tài)機應(yīng)當具備一下幾個要素:
1.當前狀態(tài):也就是狀態(tài)流轉(zhuǎn)的起始狀態(tài)。
2.觸發(fā)事件: 引起狀態(tài)之間流轉(zhuǎn)的一些列動作。
3.響應(yīng)函數(shù): 觸發(fā)事件到下一個狀態(tài)之間的規(guī)則。
4.目標狀態(tài):狀態(tài)流轉(zhuǎn)的目標狀態(tài)。
對于組件化的狀態(tài)機,當前使用較多的主要是兩種:一種是Spring 狀態(tài)機,一種是COLA狀態(tài)機,這兩種狀態(tài)機的對比如下表所示:
Spring 狀態(tài)機 | COLA 狀態(tài)機 | |
---|---|---|
API 調(diào)用 | 使用 Reactive 的 Mono、Flux 方式進行 API 調(diào)用 | 同步的 API 調(diào)用,如果有需要也可以將方法通過 消息隊列、定時任務(wù)、多線程等方式進行異步調(diào)用 |
代碼量 | core 包 284 個接口和類 | 36 個接口和類 |
生態(tài) | 非常豐富 | 較為貧瘠 |
定制化難度 | 困難 | 簡單 |
可以看到,Spring狀態(tài)機鎖提供的內(nèi)容較為豐富,當然對于自定義的支持就不如COLA狀態(tài)機好,如果對自定義的需求比較高,那建議使用COLA狀態(tài)機。
本文以Spring狀態(tài)機為例,展示如何在業(yè)務(wù)系統(tǒng)中使用狀態(tài)機。
為了便于大家了解Spring狀態(tài)機的實現(xiàn)原理和使用方式以及其提供的功能,下面列出了官方文檔和源碼,感興趣的同學可以閱讀閱讀。
源代碼: https://github.com/spring-projects/spring-statemachine
3. Spring狀態(tài)機實現(xiàn)訂單狀態(tài)流轉(zhuǎn)
對于狀態(tài)模式,Spring封裝好了一個組件,就叫狀態(tài)機(StateMachine)。Spring狀態(tài)機可以幫助我們開發(fā)者簡化狀態(tài)控制的開發(fā)過程,讓狀態(tài)機結(jié)構(gòu)更加層次化。下面用Spring狀態(tài)機模擬一個訂單狀態(tài)流轉(zhuǎn)的過程。
3.1 環(huán)境準備
首先,如果要使用spring狀態(tài)機,需要引入對應(yīng)的jar包,這里我的springboot版本是:2.2.1.RELEASE
<dependency> <groupId>org.springframework.statemachine</groupId> <artifactId>spring-statemachine-core</artifactId> <version>${springboot.version}</version> </dependency>
下面是簡化的訂單的定義,以及訂單狀態(tài)和訂單轉(zhuǎn)換行為的枚舉
/** * @description: 模擬訂單類 */ @Data public class Order { private Long orderId; private OrderStatusEnum orderStatus; } /** * @description: 訂單狀態(tài) */ public enum OrderStatusEnum { // 待支付 WAIT_PAYMENT, // 待發(fā)貨 WAIT_DELIVER, // 待收貨 WAIT_RECEIVE, // 完成 FINISH; } /** * @description:訂單狀態(tài)轉(zhuǎn)換行為 */ public enum OrderStatusChangeEventEnum { //支付 PAYED, //發(fā)貨 DELIVERY, //收貨 RECEIVED; }
3.2 構(gòu)造訂單狀態(tài)機
在引入jar包之后,需要構(gòu)建一個針對訂單狀態(tài)流轉(zhuǎn)的狀態(tài)機
訂單狀態(tài)機配置類如下:
/** * @description: 訂單狀態(tài)機 */ @Configuration @EnableStateMachine public class OrderStatusMachineConfig extends StateMachineConfigurerAdapter<OrderStatusEnum, OrderStatusChangeEventEnum> { /** * 配置狀態(tài) */ @Override public void configure(StateMachineStateConfigurer<OrderStatusEnum, OrderStatusChangeEventEnum> states) throws Exception { states.withStates() .initial(OrderStatusEnum.WAIT_PAYMENT) .end(OrderStatusEnum.FINISH) .states(EnumSet.allOf(OrderStatusEnum.class)); } /** * 配置狀態(tài)轉(zhuǎn)換事件關(guān)系 */ @Override public void configure(StateMachineTransitionConfigurer<OrderStatusEnum, OrderStatusChangeEventEnum> transitions) throws Exception { transitions.withExternal().source(OrderStatusEnum.WAIT_PAYMENT).target(OrderStatusEnum.WAIT_DELIVER) .event(OrderStatusChangeEventEnum.PAYED) .and() .withExternal().source(OrderStatusEnum.WAIT_DELIVER).target(OrderStatusEnum.WAIT_RECEIVE) .event(OrderStatusChangeEventEnum.DELIVERY) .and() .withExternal().source(OrderStatusEnum.WAIT_RECEIVE).target(OrderStatusEnum.FINISH) .event(OrderStatusChangeEventEnum.RECEIVED); } }
3.3 編寫狀態(tài)機監(jiān)聽器
監(jiān)聽狀態(tài)變更事件,完成狀態(tài)轉(zhuǎn)換。
/** * @description: 狀態(tài)監(jiān)聽 */ @Component @WithStateMachine @Transactional public class OrderStatusListener { @OnTransition(source = "WAIT_PAYMENT", target = "WAIT_DELIVER") public boolean payTransition(Message message) { Order order = (Order) message.getHeaders().get("order"); order.setOrderStatus(OrderStatusEnum.WAIT_DELIVER); System.out.println("支付,狀態(tài)機反饋信息:" + message.getHeaders().toString()); return true; } @OnTransition(source = "WAIT_DELIVER", target = "WAIT_RECEIVE") public boolean deliverTransition(Message message) { Order order = (Order) message.getHeaders().get("order"); order.setOrderStatus(OrderStatusEnum.WAIT_RECEIVE); System.out.println("發(fā)貨,狀態(tài)機反饋信息:" + message.getHeaders().toString()); return true; } @OnTransition(source = "WAIT_RECEIVE", target = "FINISH") public boolean receiveTransition(Message message) { Order order = (Order) message.getHeaders().get("order"); order.setOrderStatus(OrderStatusEnum.FINISH); System.out.println("收貨,狀態(tài)機反饋信息:" + message.getHeaders().toString()); return true; } }
3.4 編寫訂單服務(wù)類
模擬對訂單的一些業(yè)務(wù)操作
/** * @description: 訂單服務(wù) */ @Service public class OrderServiceImpl implements OrderService { @Resource private StateMachine<OrderStatusEnum, OrderStatusChangeEventEnum> orderStateMachine; private long id = 1L; private Map<Long, Order> orders = Maps.newConcurrentMap(); @Override public Order create() { Order order = new Order(); order.setOrderStatus(OrderStatusEnum.WAIT_PAYMENT); order.setOrderId(id++); orders.put(order.getOrderId(), order); System.out.println("訂單創(chuàng)建成功:" + order.toString()); return order; } @Override public Order pay(long id) { Order order = orders.get(id); System.out.println("嘗試支付,訂單號:" + id); Message message = MessageBuilder.withPayload(OrderStatusChangeEventEnum.PAYED). setHeader("order", order).build(); if (!sendEvent(message)) { System.out.println(" 支付失敗, 狀態(tài)異常,訂單號:" + id); } return orders.get(id); } @Override public Order deliver(long id) { Order order = orders.get(id); System.out.println(" 嘗試發(fā)貨,訂單號:" + id); if (!sendEvent(MessageBuilder.withPayload(OrderStatusChangeEventEnum.DELIVERY) .setHeader("order", order).build())) { System.out.println(" 發(fā)貨失敗,狀態(tài)異常,訂單號:" + id); } return orders.get(id); } @Override public Order receive(long id) { Order order = orders.get(id); System.out.println(" 嘗試收貨,訂單號:" + id); if (!sendEvent(MessageBuilder.withPayload(OrderStatusChangeEventEnum.RECEIVED) .setHeader("order", order).build())) { System.out.println(" 收貨失敗,狀態(tài)異常,訂單號:" + id); } return orders.get(id); } @Override public Map<Long, Order> getOrders() { return orders; } /** * 發(fā)送狀態(tài)轉(zhuǎn)換事件 * @param message * @return */ private synchronized boolean sendEvent(Message<OrderStatusChangeEventEnum> message) { boolean result = false; try { orderStateMachine.start(); result = orderStateMachine.sendEvent(message); } catch (Exception e) { e.printStackTrace(); } finally { if (Objects.nonNull(message)) { Order order = (Order) message.getHeaders().get("order"); if (Objects.nonNull(order) && Objects.equals(order.getOrderStatus(), OrderStatusEnum.FINISH)) { orderStateMachine.stop(); } } } return result; } }
3.5 測試入口
這里編寫一個controller模擬c端用戶請求,為了便于展示,這里使用一個測試方法完成所有的操作
@RestController public class OrderController { @Resource private OrderService orderService; @RequestMapping("/testOrderStatusChange") public String testOrderStatusChange(){ orderService.create(); orderService.create(); orderService.pay(1L); orderService.deliver(1L); orderService.receive(1L); orderService.pay(2L); orderService.deliver(2L); orderService.receive(2L); System.out.println("全部訂單狀態(tài):" + orderService.getOrders()); return "success"; } }
下面是對應(yīng)的執(zhí)行結(jié)果
可以看到spring狀態(tài)機很好的控制了訂單在各個狀態(tài)之間的流轉(zhuǎn)。
4. 思考與總結(jié)
思考:針對狀態(tài)機的特點,還有其他思路實現(xiàn)一個狀態(tài)機嗎?下面是一些常規(guī)思路,如果還有其他方法歡迎在評論區(qū)留言。
1. 消息隊列方式
訂單狀態(tài)的流轉(zhuǎn)可以通過MQ發(fā)布一個事件,消費者根據(jù)業(yè)務(wù)條件把訂單狀態(tài)進行流轉(zhuǎn),可以根據(jù)不同的事件發(fā)送到不同的Topic。
2. 定時任務(wù)驅(qū)動
每隔一段時間啟動一下job,根據(jù)特定的狀態(tài)從數(shù)據(jù)庫中拿對應(yīng)的訂單記錄,然后判斷訂單是否有條件到達下一個狀態(tài)。
3. 規(guī)則引擎方式
業(yè)務(wù)團隊可以在規(guī)則引擎里編寫一系列的狀態(tài)及其對應(yīng)的轉(zhuǎn)換規(guī)則,由規(guī)則引擎根據(jù)已經(jīng)加載的規(guī)則對輸入數(shù)據(jù)進行解析,根據(jù)解析的結(jié)果執(zhí)行相應(yīng)的動作,完成狀態(tài)流轉(zhuǎn)。
總結(jié):
本文主要介紹了設(shè)計模式中的狀態(tài)模式,并在此基礎(chǔ)上介紹了Spring狀態(tài)機相關(guān)的概念,并根據(jù)常見的訂單流轉(zhuǎn)場景,介紹了Spring狀態(tài)機的使用方式。文中如有不當之處,歡迎在評論區(qū)批評指正。
相關(guān)文章
JAVA演示阿里云圖像識別API,印刷文字識別-營業(yè)執(zhí)照識別
最近有由于工作需要,開始接觸阿里云的云市場的印刷文字識別API-營業(yè)執(zhí)照識別這里我加上了官網(wǎng)的申請說明,只要你有阿里云賬號就可以用,前500次是免費的,API說明很簡陋,只能做個簡單參考2019-05-05MybatisPlus?BaseMapper?實現(xiàn)對數(shù)據(jù)庫增刪改查源碼
MybatisPlus?是一款在?Mybatis?基礎(chǔ)上進行的增強?orm?框架,可以實現(xiàn)不寫?sql?就完成數(shù)據(jù)庫相關(guān)的操作,這篇文章主要介紹了MybatisPlus?BaseMapper?實現(xiàn)對數(shù)據(jù)庫增刪改查源碼解析,需要的朋友可以參考下2023-01-01SpringCloud用Zookeeper搭建配置中心的方法
本篇文章主要介紹了SpringCloud用Zookeeper搭建配置中心的方法,小編覺得挺不錯的,現(xiàn)在分享給大家,也給大家做個參考。一起跟隨小編過來看看吧2018-04-04MyBatis中傳入?yún)?shù)parameterType類型詳解
這篇文章主要給大家介紹了關(guān)于MyBatis中傳入?yún)?shù)parameterType類型的相關(guān)資料,文中通過示例代碼介紹的非常詳細,對大家的學習或者工作具有一定的參考學習價值,需要的朋友可以參考下2018-04-04SpringBoot中@EnableAsync和@Async注解的使用小結(jié)
在SpringBoot中,可以通過@EnableAsync注解來啟動異步方法調(diào)用的支持,通過@Async注解來標識異步方法,讓方法能夠在異步線程中執(zhí)行,本文就來介紹一下,感興趣的可以了解一下2023-11-11