ABP(現代ASP.NET樣板開發框架)系列之1四、ABP領域層——領域事件（Domain events）

點這裏進入ABP系列文章總目錄

 

基於DDD的現代ASP.NET開發框架--ABP系列之1四、ABP領域層——領域事件（Domain events）

 

ABP是「ASP.NET Boilerplate Project (ASP.NET樣板項目)」的簡稱。

ABP的官方網站：http://www.aspnetboilerplate.com

ABP在Github上的開源項目：https://github.com/aspnetboilerplate

 

---

 在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

 

點這裏進入ABP系列文章總目錄