ABP是基于ASP.NET框架之上的Web開發(fā)框架(GitHub：https://github.com/aspnetboilerplate),這篇我們來(lái)詳解ABP框架中領(lǐng)域?qū)拥念I(lǐng)域事件Domain events,需要的朋友可以參考下

在C#中,一個(gè)類可以定義其專屬的事件并且其它類可以注冊(cè)該事件并監(jiān)聽，當(dāng)事件被觸發(fā)時(shí)可以獲得事件通知。這對(duì)于對(duì)于桌面應(yīng)用程序或獨(dú)立的Windows Service來(lái)說(shuō)非常有用。但是, 對(duì)于Web應(yīng)用程序來(lái)說(shuō)會(huì)有點(diǎn)問(wèn)題,因?yàn)閷?duì)象是根據(jù)請(qǐng)求(request)被創(chuàng)建并且它們的生命周期都很短暫。我們很難注冊(cè)其它類別的事件。同樣地,直接注冊(cè)其它類別的事件也造成了類之間的耦合性。

在應(yīng)用系統(tǒng)中，領(lǐng)域事件被用于解耦并且重用(re-use)商業(yè)邏輯。

事件總線

事件總線為一個(gè)單體(singleton)的對(duì)象,它由所有其它類所共享,可通過(guò)它觸發(fā)和處理事件。要使用這個(gè)事件總線,你需要引用它。你可以用兩種方式來(lái)實(shí)現(xiàn):

獲取默認(rèn)實(shí)例( Getting the default instance)

你可以直接使用EventBus.Default。它是全局事件總線并且可以如下方式使用:

EventBus.Default.Trigger(...); //觸發(fā)事件

注入IEventBus事件接口(Injecting IEventBus)

除了直接使用EventBus.Default外,你還可以使用依賴注入(DI)的方式來(lái)取得IEventBus的參考。這利于進(jìn)行單元測(cè)試。在這里,我們使用屬性注入的范式:

public class TaskAppService : ApplicaService {

 public IEventBus EventBus { get; set; }

 public TaskAppService() {

  EventBus = NullEventBus.Instance;

 }

}

注入事件總線,采用屬性注入比建構(gòu)子注入更適合。事件是由類所描述并且該事件對(duì)象繼承自EventData。假設(shè)我們想要觸發(fā)某個(gè)事件于某個(gè)任務(wù)完成后:

public class TaskCompletedEventData : EventData {

 public int TaskId { get; set; }

}

這個(gè)類所包含的屬性都是類在處理事件時(shí)所需要的。EventData類定義了EventSource(那個(gè)對(duì)象觸發(fā)了這個(gè)事件)和EventTime(何時(shí)觸發(fā))屬性。

定義事件

ABP定義AbpHandledExceptionData事件并且在異常發(fā)生的時(shí)候自動(dòng)地觸發(fā)這個(gè)事件。這在你想要取得更多關(guān)于異常的信息時(shí)特別有用(即便ABP已自動(dòng)地紀(jì)錄所有的異常)。你可以注冊(cè)這個(gè)事件并且設(shè)定它的觸發(fā)時(shí)機(jī)是在異常發(fā)生的時(shí)候。

ABP也提供在實(shí)體變更方面許多的通用事件數(shù)據(jù)類: EntityCreatedEventData, EntityUpdatedEventData和EntityDeletedEventData。它們被定義在Abp.Events.Bus.Entitis命名空間中。當(dāng)某個(gè)實(shí)體新增/更新/刪除后,這些事件會(huì)由ABP自動(dòng)地觸發(fā)。如果你有一個(gè)Person實(shí)體,可以注冊(cè)到EntityCreatedEventData,事件會(huì)在新的Person實(shí)體創(chuàng)建且插入到數(shù)據(jù)庫(kù)后被觸發(fā)。這些事件也支持繼承。如果Student類繼承自Person類,并且你注冊(cè)到EntityCreatedEventData中,接著你將會(huì)在Person或Student新增后收到觸發(fā)。

觸發(fā)事件

觸發(fā)事件的范例如下:

public class TaskAppService : ApplicationService {

 public IEventBus EventBus { get; set; }

 public TaskAppService() {

  EventBus = NullEventBus.Instance;

 }

 public void CompleteTask(CompleteTaskInput input) {

  //TODO: 已完成數(shù)據(jù)庫(kù)上的任務(wù)

  EventBus.Trigger(new TaskCompletedEventData { TaskId = 42 } );

 }

}

這里有一些觸發(fā)方法的重載:

EventBus.Trigger<TaskcompletedEventData>(new TaskCompletedEventData { TaskId = 42});

EventBus.Trigger(this, new TaskCompletedEventData { TaskId = 42 });

EventBus.Trigger(typeof(TaskCompletedEventData), this, new TaskCompletedEventData { TaskId = 42});

事件處理

要進(jìn)行事件的處理,你應(yīng)該要實(shí)現(xiàn)IEventHandler接口如下所示:

public class ActivityWriter : IEventHandler<TaskCompletedEventData>, ITransientDependency {

 public void HandleEvent(TaskCompletedEventData eventData) {

  WriteActivity("A task is completed by id = " + eventData.TaskId);

 }

}

EventBus已集成到依賴注入系統(tǒng)中。就如同我們?cè)谏侠袑?shí)現(xiàn)ITransientDependency那樣,當(dāng)TaskCompleted事件觸發(fā),它會(huì)創(chuàng)建一個(gè)新的ActivityWriter類的實(shí)體并且調(diào)用它的HandleEvent方法,并接著釋放它。詳情請(qǐng)見依賴注入(DI)一文。

1.基礎(chǔ)事件的處理(Handling base events)

 EventBus支持事件的繼承。舉例來(lái)說(shuō),你可以創(chuàng)建TaskEventData以及兩個(gè)繼承類: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; }

}

然而,你可以實(shí)現(xiàn)IEventHandler來(lái)處理這兩個(gè)事件:

public class ActivityWriter : IEventHandler<TaskEventData>, ITransientDependency {

 public void HandleEvent(TaskEventData eventData) {

  if(eventData is TaskCreatedEventData) {

  ...

  }else{

  ...

  }

 }

}

當(dāng)然,你也可以實(shí)現(xiàn)IEventHandler來(lái)處理所有的事件,如果你真的想要這樣做的話(譯者注:作者不太建議這種方式)。

2.處理多個(gè)事件(Handling multiple events)

在單個(gè)處理器(handler)中我們可以可以處理多個(gè)事件。此時(shí),你應(yīng)該針對(duì)不同事件實(shí)現(xiàn)IEventHandler。范例如下:

public class ActivityWriter :

 IEventHandler<TaskCompletedEventData>,

 IEventHandler<TaskCreatedEventData>,

 ITransientDependency

{

 public void HandleEvent(TaskCompletedEventData eventData) {

  //TODO: 處理事件

 }

 public void HandleEvent(TaskCreatedEventData eventData) {

  //TODO: 處理事件

 }

}

注冊(cè)處理器

我們必需注冊(cè)處理器(handler)到事件總線中來(lái)處理事件。

1.自動(dòng)型Automatically

ABP掃描所有實(shí)現(xiàn)IEventHandler接口的類,并且自動(dòng)注冊(cè)它們到事件總線中。當(dāng)事件發(fā)生, 它通過(guò)依賴注入(DI)來(lái)取得處理器(handler)的引用對(duì)象并且在事件處理完畢之后將其釋放。這是比較建議的事件總線使用方式于ABP中。

2.手動(dòng)型(Manually)

也可以通過(guò)手動(dòng)注冊(cè)事件的方式,但是會(huì)有些問(wèn)題。在Web應(yīng)用程序中,事件的注冊(cè)應(yīng)該要在應(yīng)用程序啟動(dòng)的時(shí)候。當(dāng)一個(gè)Web請(qǐng)求(request)抵達(dá)時(shí)進(jìn)行事件的注冊(cè),并且反復(fù)這個(gè)行為。這可能會(huì)導(dǎo)致你的應(yīng)用程序發(fā)生一些問(wèn)題,因?yàn)樽?cè)的類可以被調(diào)用多次。同樣需要注意的是,手動(dòng)注冊(cè)無(wú)法與依賴注入系統(tǒng)一起使用。

ABP提供了多個(gè)事件總線注冊(cè)方法的重載(overload)。最簡(jiǎn)單的一個(gè)重載方法是等待委派(delegate)或Lambda。

EventBus.Register<TaskCompletedEventData>(eventData =>

 {

  WriteActivity("A task is completed by id = " + eventData.TaskId);

 });

因此,事件:task completed會(huì)發(fā)生,而這個(gè)Lambda方法會(huì)被調(diào)用。第二個(gè)重載方法等待的是一個(gè)對(duì)象,該對(duì)象實(shí)現(xiàn)了IEventHandler:

Eventbus.Register<TaskCompletedEventData>(new ActivityWriter());

相同的例子,如果ActivityWriter因事件而被調(diào)用。這個(gè)方法也有一個(gè)非泛型的重載。另一個(gè)重載接受兩個(gè)泛化的參數(shù):

EventBus.Register<TaskCompletedEventData, ActivityWriter>();

此時(shí),事件總線創(chuàng)建一個(gè)新的ActivityWriter于每個(gè)事件。當(dāng)它釋放的時(shí)候,它會(huì)調(diào)用ActivityWriter.Dispose方法。

最后,你可以注冊(cè)一個(gè)事件處理器工廠(event handler factory)來(lái)負(fù)責(zé)創(chuàng)建處理器。處理器工廠有兩個(gè)方法: GetHandler和ReleaseHandler,范例如下:

public class ActivityWriterFactory : IEventHandlerFactory {

  public IEventHandler GetHandler() {

   return new ActivityWriter();

  }

  public void ReleaseHandler(IEventHandler handler) {

   //TODO: 釋放ActivityWriter實(shí)體(處理器)

  }

 }

ABP也提供了特殊的工廠類,IocHandlerFactory,通過(guò)依賴注入系統(tǒng)，IocHandlerFactory可以用來(lái)創(chuàng)建或者釋放(dispose)處理器。ABP可以自動(dòng)化注冊(cè)IocHandlerFactory。因此,如果你想要使用依賴注入系統(tǒng),請(qǐng)直接使用自動(dòng)化注冊(cè)的方式。

取消注冊(cè)事件

當(dāng)你手動(dòng)注冊(cè)事件總線,你或許想要在之后取消注冊(cè)。最簡(jiǎn)單的取消事件注冊(cè)的方式即為registration.Dispose()。舉例如下:

//注冊(cè)一個(gè)事件

Var registration = EventBus.Register<TaskCompletedEventData>(eventData => WriteActivity("A task is completed by id = " + eventData.TaskId));

//取消注冊(cè)一個(gè)事件

registration.Dispose();

當(dāng)然,取消注冊(cè)可以在任何地方任何時(shí)候進(jìn)行。保存(keep)好注冊(cè)的對(duì)象并且在你想要取消注冊(cè)的時(shí)候釋放(dispose)掉它。所有注冊(cè)方法的重載(overload)都會(huì)返回一個(gè)可釋放(disposable)的對(duì)象來(lái)取消事件的注冊(cè)。

事件總線也提供取消注冊(cè)方法。使用范例:

//創(chuàng)建一個(gè)處理器

var handler = new ActivityWriter();

//注冊(cè)一個(gè)事件

EventBus.Register<TaskCompletedEventData>(handler);

//取消這個(gè)事件的注冊(cè)

EventBus.Unregister<TaskCompletedEventData>(handler);

它也提供重載的方法給取消注冊(cè)的委派和工廠。取消注冊(cè)處理器對(duì)象必須與之前注冊(cè)的對(duì)象是同一個(gè)。

最后,EventBus提供一個(gè)UnregisterAll()方法來(lái)取消某個(gè)事件所有處理器的注冊(cè),而UnregisterAll()方法則是所有事件的所有處理器。