Spring Event 玩轉(zhuǎn) DDD 領域事件
1、領域事件
領域事件是 DDD 中重要的模式之一,主要用于模型或系統(tǒng)間的解耦,提高系統(tǒng)的可擴展性和可維護性。
(1)什么是領域事件
領域事件是領域驅(qū)動設計(Domain-Driven Design,簡稱DDD)中的一個重要概念,特指在領域模型中發(fā)生的有意義的事件,是對領域模型中的重要業(yè)務動作執(zhí)行結(jié)果的抽象,如訂單創(chuàng)建、支付完成等。
在DDD中,領域事件是一種用于傳遞信息的機制,它使得不同領域模型之間的通信變得更加簡單和靈活。通過將事件分發(fā)給相關的訂閱者,可以讓不同的領域模型之間實現(xiàn)松耦合,從而更容易擴展和維護應用程序。
領域事件通常由領域?qū)ο笾鲃佑|發(fā)并發(fā)布,而事件處理器則負責訂閱事件并對事件進行處理。通過事件發(fā)布和訂閱機制,可以在應用程序中實現(xiàn)高效的事件驅(qū)動架構(gòu),從而更好地支持復雜的業(yè)務邏輯和業(yè)務流程。
說起來有點抽象,簡單舉個例子:
假設有一個電子商務系統(tǒng),用戶下單后需要生成訂單并發(fā)送通知給相關人員。在領域模型中,可以定義一個 Order 領域?qū)ο?,該對象可以包含多個屬性,如訂單號、下單時間、購買的商品信息、收貨地址等等。當用戶下單時,可以通過調(diào)用 Order 對象的方法來生成訂單,同時也可以通過領域事件來發(fā)送通知。
具體來說,可以定義一個 OrderCreated 領域事件,用于表示訂單創(chuàng)建完成的事件,該事件包含一些必要的屬性,如訂單號、下單時間、購買的商品信息、收貨地址等等。當 Order 對象創(chuàng)建完成后,可以通過領域事件來觸發(fā)發(fā)送通知的操作,比如發(fā)送郵件或短信通知相關人員。
(2)領域事件的應用場景
領域事件的應用創(chuàng)建眾多,從圖中可以看出:
領域事件可以:
- 保證聚合間的數(shù)據(jù)一致性。當一個聚合根上的操作引發(fā)了其他聚合根的變更時,將這些變更作為領域事件發(fā)布出去,其他聚合根可以訂閱這些事件并更新自己的狀態(tài),從而實現(xiàn)最終一致性。
- 替換批量處理??梢宰鳛槿蝿盏挠|發(fā)器,例如定時任務、異步任務,避免定時+掃描這類批量處理。
- 實現(xiàn)事件源模式。將所有的領域事件全部存儲下來,可以用于恢復聚合的狀態(tài),實現(xiàn)事件源模式;也可以用于后續(xù)的審計和調(diào)試。
- 進行限界上下文集成。將事件從一個子域發(fā)布到另一個子域,使得這兩個子域可以解耦,不用相互知道彼此的存在。
領域事件雖好,但仍需技術(shù)框架進行支持,其實 Spring 的 Event 機制就足以滿足各類需求。
2、Spring 對 Event 的支持
在 Spring 中,事件的處理可以通過三種方式來實現(xiàn):
- 基于接口的事件處理:通過實現(xiàn) ApplicationListener 接口并重寫 onApplicationEvent 方法來處理事件。
- 基于注解的事件處理:通過在方法上添加 @EventListener 或 @TransactionEventListener 注解來處理事件,可以指定事件的類型以及監(jiān)聽的條件等。
- 基于異步事件處理:通過使用 @Async 注解來異步處理事件,可以提高應用程序的響應速度。
(1)基于接口的事件處理
由于與 Spring 存在強耦合,現(xiàn)在已經(jīng)很少使用,可以直接跳過。
下面是一個基于接口的事件處理的示例代碼:
在這個示例中,MyEvent 是一個自定義的事件類,MyEventListener 是一個實現(xiàn)了 ApplicationListener 接口的監(jiān)聽器,用于處理 MyEvent 事件,MyEventPublisher 是用于發(fā)布事件的類。
當應用程序調(diào)用 MyEventPublisher 的 publishEvent 方法時,會觸發(fā)一個 MyEvent 事件,MyEventListener 中的 onApplicationEvent 方法將被自動調(diào)用,從而處理這個事件。
(2)基于注解的事件處理
Spring 提供 @EventListener 和 @TransactionListener 兩個注解以簡化對事件的處理。
@EventListener
Spring 的 EventListener 監(jiān)聽器是一種相對于傳統(tǒng)的事件監(jiān)聽方式更為簡潔和靈活的事件機制。與傳統(tǒng)的事件機制不同,EventListener 不需要顯示地繼承特定的事件接口,而是使用注解標識需要監(jiān)聽的事件類型,然后通過一個單獨的監(jiān)聽器類處理所有類型的事件。
相比之下 EventListener 的優(yōu)勢主要有以下幾點:
- 更加靈活:EventListener 不依賴于任何特定的事件接口,從而使得事件處理更加靈活,可以監(jiān)聽和處理任意類型的事件。
- 更加簡潔:相比傳統(tǒng)的事件監(jiān)聽方式,使用 EventListener 可以避免一系列繁瑣的接口定義和實現(xiàn),簡化了代碼結(jié)構(gòu),使得開發(fā)效率更高。
- 更加松耦合:EventListener 將事件發(fā)布方和事件處理方分離,遵循松耦合的設計原則,提高了代碼的可維護性和擴展性。
- 更加可測試:由于 EventListener 可以監(jiān)聽和處理任意類型的事件,可以通過單元測試驗證其功能是否正確,從而提高了測試的可靠性。
以下是一個簡單的例子:
相比基于接口的事件處理,EventListener 是一種更加簡潔、靈活、松耦合、可測試的事件機制,能夠有效地降低開發(fā)的復雜度,提高開發(fā)效率。
@TransactionEventListener
在 Spring 中,TransactionEventListner 和 EventListner 都是用于處理事件的接口。不同之處在于
- TransactionEventListner 是在事務提交后才會觸發(fā)
- 而 EventListner 則是在事件發(fā)布后就會觸發(fā)。
具體來說,在使用 Spring 的聲明式事務時,可以在事務提交后觸發(fā)某些事件。這就是 TransactionEventListner 的應用場景。而 EventListner 則不涉及事務,可以用于在事件發(fā)布后觸發(fā)一些操作。
下面是一個簡單的示例,演示了如何使用 TransactionEventListner 和 EventListner:
在這個例子中,MyEventListener 類定義了兩個方法,handleMyEvent 和
handleMyTransactionalEvent,分別處理 MyEvent 和 MyTransactionalEvent 事件。其中,handleMyTransactionalEvent 方法用 @TransactionalEventListener 注解標記,表示它只會在事務提交后觸發(fā)。
MyService 類中的 doSomething 方法使用 ApplicationEventPublisher 來發(fā)布事件。注意,它發(fā)布了兩種不同類型的事件:MyEvent 和 MyTransactionalEvent。這兩個事件會分別觸發(fā) MyEventListener 中的對應方法。
總的來說,Spring 的事件機制非常靈活,可以方便地擴展應用程序的功能。TransactionEventListner 和 EventListner 這兩個接口的應用場景有所不同,可以根據(jù)實際需求選擇使用。
(3)基于異步事件處理
@Async是Spring框架中的一個注解,用于將一個方法標記為異步執(zhí)行。使用該注解,Spring將自動為該方法創(chuàng)建一個新線程,使其在后臺異步執(zhí)行,不會阻塞主線程的執(zhí)行。
在具體應用中,使用@Async可以大大提升應用的并發(fā)處理能力,使得系統(tǒng)能夠更快地響應用戶請求,提高系統(tǒng)的吞吐量。
@Async 和 @EventListener 或 @TransactionEventListener 注解在一起使用時,會產(chǎn)生異步的事件處理器。使用這種組合的方式,事件處理器會在單獨的線程池中執(zhí)行,以避免阻塞主線程。這種方式在需要處理大量事件或者事件處理器耗時較長的情況下非常有用,可以有效提高應用的性能和可伸縮性。同時,Spring 框架對這種方式也提供了完善的支持,可以方便地使用這種方式來實現(xiàn)異步事件處理。
下面是一個簡單的示例代碼,演示了如何在 Spring 中使用 @Async 和 @EventListener 一起實現(xiàn)異步事件處理:
在這個示例中,ExampleEventListener 類中的 handleExampleEvent 方法使用了 @Async 和 @EventListener 注解,表示這個方法是一個異步事件監(jiān)聽器。當一個 ExampleEvent 事件被觸發(fā)時,這個方法會被異步地執(zhí)行。在這個方法中,可以執(zhí)行任何異步的邏輯處理,比如向隊列發(fā)送消息、調(diào)用其他服務等。
備注:在使用 @Async 時,需要根據(jù)業(yè)務場景對線程池進行自定義,以免出現(xiàn)資源不夠的情況(Spring 默認使用單線程處理@Async異步任務)
4、場景分析
綜上所述,當領域事件發(fā)出來之后,不同的注解會產(chǎn)生不同的行為,簡單匯總?cè)缦拢?/p>
@EventListener | @TransactionEventListener | |
無 @Async | 順序、同步執(zhí)行 | 事務提交后、同步執(zhí)行 |
有 @Async | 順序、異步執(zhí)行 | 事務提交后、異步執(zhí)行 |
(1)@EventListener
特點:
- 順序執(zhí)行。調(diào)用 publish(Event) 后,自動觸發(fā)對 @EventListner 注釋方法的調(diào)用
- 同步執(zhí)行。使用主線程執(zhí)行,方法拋出異常會中斷調(diào)用鏈路,會觸發(fā)事務的回歸
應用場景:
- 事務消息表。在同一事務中完成對業(yè)務數(shù)據(jù)和消息表的修改
- 業(yè)務驗證。對業(yè)務對象進行最后一次驗證,如果驗證不通過直接拋出異常中斷數(shù)據(jù)庫事務
- 業(yè)務插件。在當前線程和事務中執(zhí)行插件完成業(yè)務擴展
(2)@TransactionEventListener
特點:
- 事務提交后執(zhí)行。調(diào)用 publish(Event) 時,只是向上下文中注冊了一個回調(diào)器,并不會立即執(zhí)行;只有在事務提交后,才會觸發(fā)對 @TransactionEventListner 注釋方法的調(diào)用
- 同步執(zhí)行。使用主線程執(zhí)行,方法拋出異常會中斷調(diào)用鏈路,當不會回歸事務(事務已提交,沒有辦法進行回歸)
應用場景:
- 數(shù)據(jù)同步。事務提交后,將變更同步到 ES 或 Cache
- 記錄審計日志。只有在業(yè)務變更成功更新到數(shù)據(jù)庫時才進行記錄
備注:
@TransactionEventLisnter 必須在事務上下文中,脫離上下文,調(diào)用不會生效
(3)@EventListener + @Async
特點:
- 順序執(zhí)行。調(diào)用 publish(Event) 后,自動觸發(fā)對 @EventListner 注釋方法的調(diào)用
- 異步執(zhí)行。使用獨立的線程池執(zhí)行任務,方法拋出異常對主流程沒有任何影響
應用場景:
- 記日志明細日志,輔助排查問題
(4)@TransactionEventListener + @Async
特點:
- 事務提交后執(zhí)行。調(diào)用 publish(Event) 時,只是向上下文中注冊了一個回調(diào)器,并不會立即執(zhí)行;只有在事務提交后,才會觸發(fā)對 @TransactionEventListner 注釋方法的調(diào)用
- 異步執(zhí)行。使用獨立的線程池執(zhí)行任務,方法拋出異常對主流程沒有任何影響
應用場景:
異步處理。記錄操作日志,異步保存數(shù)據(jù)等
備注:
@TransactionEventLisnter 必須在事務上下文中,脫離上下文,調(diào)用不會生效
5、小結(jié)
領域事件的落地,不僅需要強大的設計能力,還需要與之匹配的基礎設施。Spring 作為最常用的框架,基于發(fā)布訂閱實現(xiàn)了完整的一套 Event 管理機制。工具在手是否能根據(jù)業(yè)務場景選擇合適的解決方案就成了研發(fā)的職責,簡單思考以下組合適用場景是什么:
- @EventListener
- @TransactionEventListener
- @EventListener + @Async
- @TransactionEventListener + @Async