ABP(現代ASP.NET樣板開發框架)系列之14、ABP領域層——領域事件(Domain events)
基於DDD的現代ASP.NET開發框架--ABP系列之14、ABP領域層——領域事件(Domain events)
ABP是“ASP.NET Boilerplate Project (ASP.NET樣板專案)”的簡稱。
在C#中,一個類可以定義其專屬的事件並且其它類可以註冊該事件並監聽,當事件被觸發時可以獲得事件通知。這對於對於桌面應用程式或獨立的Windows Service來說非常有用。但是, 對於Web應用程式來說會有點問題,因為物件是根據請求(request)被建立並且它們的生命週期都很短暫。我們很難註冊其它類別的事件。同樣地,直接註冊其它類別的事件也造成了類之間的耦合性。
在應用系統中,領域事件被用於解耦並且重用(re-use)商業邏輯。
事件匯流排
事件匯流排為一個單體(singleton)的物件,它由所有其它類所共享,可通過它觸發和處理事件。要使用這個事件匯流排,你需要引用它。你可以用兩種方式來實現:
獲取預設例項( Getting the default instance)
你可以直接使用EventBus.Default。它是全域性事件匯流排並且可以如下方式使用:
EventBus.Default.Trigger(...); //觸發事件
注入IEventBus事件介面(Injecting IEventBus)
除了直接使用EventBus.Default外,你還可以使用依賴注入(DI)的方式來取得IEventBus的參考。這利於進行單元測試。在這裡,我們使用屬性注入的正規化:
public class TaskAppService : ApplicaService { public IEventBus EventBus { get; set; } public TaskAppService() { EventBus = NullEventBus.Instance; } }
注入事件匯流排,採用屬性注入比建構子注入更適合。事件是由類所描述並且該事件物件繼承自EventData。假設我們想要觸發某個事件於某個任務完成後:
public class TaskCompletedEventData : EventData {public int TaskId { get; set; } }
這個類所包含的屬性都是類在處理事件時所需要的。EventData類定義了EventSource(那個物件觸發了這個事件)和EventTime(何時觸發)屬性。
定義事件
ABP定義AbpHandledExceptionData事件並且在異常發生的時候自動地觸發這個事件。這在你想要取得更多關於異常的資訊時特別有用(即便ABP已自動地紀錄所有的異常)。你可以註冊這個事件並且設定它的觸發時機是在異常發生的時候。
ABP也提供在實體變更方面許多的通用事件資料類: EntityCreatedEventData, EntityUpdatedEventData和EntityDeletedEventData。它們被定義在Abp.Events.Bus.Entitis名稱空間中。當某個實體新增/更新/刪除後,這些事件會由ABP自動地觸發。如果你有一個Person實體,可以註冊到EntityCreatedEventData,事件會在新的Person實體建立且插入到資料庫後被觸發。這些事件也支援繼承。如果Student類繼承自Person類,並且你註冊到EntityCreatedEventData中,接著你將會在Person或Student新增後收到觸發。
觸發事件
觸發事件的範例如下:
public class TaskAppService : ApplicationService { public IEventBus EventBus { get; set; } public TaskAppService() { EventBus = NullEventBus.Instance; } public void CompleteTask(CompleteTaskInput input) { //TODO: 已完成資料庫上的任務 EventBus.Trigger(new TaskCompletedEventData { TaskId = 42 } ); } }
這裡有一些觸發方法的過載:
EventBus.Trigger<TaskcompletedEventData>(new TaskCompletedEventData { TaskId = 42}); EventBus.Trigger(this, new TaskCompletedEventData { TaskId = 42 }); EventBus.Trigger(typeof(TaskCompletedEventData), this, new TaskCompletedEventData { TaskId = 42});
事件處理
要進行事件的處理,你應該要實現IEventHandler介面如下所示:
public class ActivityWriter : IEventHandler<TaskCompletedEventData>, ITransientDependency { public void HandleEvent(TaskCompletedEventData eventData) { WriteActivity("A task is completed by id = " + eventData.TaskId); } }
EventBus已整合到依賴注入系統中。就如同我們在上例中實現ITransientDependency那樣,當TaskCompleted事件觸發,它會建立一個新的ActivityWriter類的實體並且呼叫它的HandleEvent方法,並接著釋放它。詳情請見依賴注入(DI)一文。
基礎事件的處理(Handling base events)
EventBus支援事件的繼承。舉例來說,你可以建立TaskEventData以及兩個繼承類:TaskCompletedEventData和TaskCreatedEventData:
public class TaskEventData : EventData { public Task Task { get; set; } } public class TaskCreatedEventData : TaskEventData { public User CreatorUser { get; set; } } public class TaskCompletedEventData : TaskEventData { public User CompletorUser { get; set; } }
然而,你可以實現IEventHandler來處理這兩個事件:
public class ActivityWriter : IEventHandler<TaskEventData>, ITransientDependency { public void HandleEvent(TaskEventData eventData) { if(eventData is TaskCreatedEventData) { ... }else{ ... } } }
當然,你也可以實現IEventHandler來處理所有的事件,如果你真的想要這樣做的話(譯者注:作者不太建議這種方式)。
處理多個事件(Handling multiple events)
在單個處理器(handler)中我們可以可以處理多個事件。此時,你應該針對不同事件實現IEventHandler。範例如下:
public class ActivityWriter : IEventHandler<TaskCompletedEventData>, IEventHandler<TaskCreatedEventData>, ITransientDependency { public void HandleEvent(TaskCompletedEventData eventData) { //TODO: 處理事件 } public void HandleEvent(TaskCreatedEventData eventData) { //TODO: 處理事件 } }
註冊處理器
我們必需註冊處理器(handler)到事件匯流排中來處理事件。
自動型Automatically
ABP掃描所有實現IEventHandler介面的類,並且自動註冊它們到事件匯流排中。當事件發生, 它通過依賴注入(DI)來取得處理器(handler)的引用物件並且在事件處理完畢之後將其釋放。這是比較建議的事件匯流排使用方式於ABP中。
手動型(Manually)
也可以通過手動註冊事件的方式,但是會有些問題。在Web應用程式中,事件的註冊應該要在應用程式啟動的時候。當一個Web請求(request)抵達時進行事件的註冊,並且反覆這個行為。這可能會導致你的應用程式發生一些問題,因為註冊的類可以被呼叫多次。同樣需要注意的是,手動註冊無法與依賴注入系統一起使用。
ABP提供了多個事件匯流排註冊方法的過載(overload)。最簡單的一個過載方法是等待委派(delegate)或Lambda。
EventBus.Register<TaskCompletedEventData>(eventData => { WriteActivity("A task is completed by id = " + eventData.TaskId); });
因此,事件:task completed會發生,而這個Lambda方法會被呼叫。第二個過載方法等待的是一個物件,該物件實現了IEventHandler:
Eventbus.Register<TaskCompletedEventData>(new ActivityWriter());
相同的例子,如果ActivityWriter因事件而被呼叫。這個方法也有一個非泛型的過載。另一個過載接受兩個泛化的引數:
EventBus.Register<TaskCompletedEventData, ActivityWriter>();
此時,事件匯流排建立一個新的ActivityWriter於每個事件。當它釋放的時候,它會呼叫ActivityWriter.Dispose方法。
最後,你可以註冊一個事件處理器工廠(event handler factory)來負責建立處理器。處理器工廠有兩個方法: GetHandler和ReleaseHandler,範例如下:
public class ActivityWriterFactory : IEventHandlerFactory { public IEventHandler GetHandler() { return new ActivityWriter(); } public void ReleaseHandler(IEventHandler handler) { //TODO: 釋放ActivityWriter實體(處理器) } }
ABP也提供了特殊的工廠類,IocHandlerFactory,通過依賴注入系統,IocHandlerFactory可以用來建立或者釋放(dispose)處理器。ABP可以自動化註冊IocHandlerFactory。因此,如果你想要使用依賴注入系統,請直接使用自動化註冊的方式。
取消註冊事件
當你手動註冊事件匯流排,你或許想要在之後取消註冊。最簡單的取消事件註冊的方式即為registration.Dispose()。舉例如下:
//註冊一個事件 Var registration = EventBus.Register<TaskCompletedEventData>(eventData => WriteActivity("A task is completed by id = " + eventData.TaskId)); //取消註冊一個事件 registration.Dispose();
當然,取消註冊可以在任何地方任何時候進行。儲存(keep)好註冊的物件並且在你想要取消註冊的時候釋放(dispose)掉它。所有註冊方法的過載(overload)都會返回一個可釋放(disposable)的物件來取消事件的註冊。
事件匯流排也提供取消註冊方法。使用範例:
//建立一個處理器 var handler = new ActivityWriter(); //註冊一個事件 EventBus.Register<TaskCompletedEventData>(handler); //取消這個事件的註冊 EventBus.Unregister<TaskCompletedEventData>(handler);
它也提供過載的方法給取消註冊的委派和工廠。取消註冊處理器物件必須與之前註冊的物件是同一個。
最後,EventBus提供一個UnregisterAll()方法來取消某個事件所有處理器的註冊,而UnregisterAll()方法則是所有事件的所有處理器。
希望更多國內的架構師能關注到ABP這個專案,也許這其中有能幫助到您的地方,也許有您的參與,這個專案可以發展得更好。
歡迎加ABP架構設計交流QQ群:134710707