標題：ASP.NET Core中實現(xiàn)單體程序的事件發(fā)布/訂閱作者：Lamond Lu

地址：https://www.cnblogs.com/lwqlun/p/10468058.html

項目源代碼：https://github.com/lamondlu/EventHandlerInSingleApplication

背景

事件發(fā)布/訂閱是一種非常強大的模式，它可以幫助業(yè)務組件間實現(xiàn)完全解耦，不同的業(yè)務組件只依賴事件，只關注哪些事件是需要自己處理的，而不用關注誰來處理自己發(fā)布事件，事件追溯(Event Sourcing)也是基于事件發(fā)布/訂閱的。在微服務架構中，事件發(fā)布/訂閱有非常多的應用場景。今天我給大家分享一個基于ASP.NET Core的單體程序使用事件發(fā)布/訂閱的例子，針對分布式項目的事件發(fā)布/訂閱比較復雜，難點是事務處理，后續(xù)我會另寫一篇博文來演示。

案例說明

當前我們有一個基于ASP.NET Core的電子商務系統(tǒng)，在項目的初期，業(yè)務非常簡單，只有一個購物車模塊和一個訂單模塊，所有的代碼都放在一個項目中。

整個項目使用了一個簡單的三層架構。

這里當用戶提交購物車的時候，程序會在ShoppingCartManager類的SubmitShoppingCart方法中執(zhí)行3個操作

• 修改當前購物車的狀態(tài)為完成

• 根據(jù)購物車中的物品創(chuàng)建一個新訂單

• 給用戶發(fā)郵件

代碼如下：

public void SubmitShoppingCart(string shoppingCartId) { var shoppingCart = _unitOfWork.ShoppingCartRepository .GetShoppingCart(shoppingCartId); _unitOfWork.ShoppingCartRepository .SubmitShoppingCart(shoppingCartId); _unitOfWork.OrderRepository .CreatOrder(new CreateOrderDTO { Items = shoppingCart.Items .Select(p => new NewOrderItemDTO { ItemId = p.ItemId, Name = p.Name, Price = p.Price }).ToList() }); //這里為了簡化代碼，我用命令行表示發(fā)送郵件的邏輯 Console.WriteLine("Confirm Email Sent."); _unitOfWork.Save(); }

根據(jù)SOLID設計原則中的單一責任原則，如果一個類承擔的職責過多，就等于把這些職責耦合在一起了。這里生成訂單和發(fā)送郵件都不應該是當前SubmitShoppingCart需要負責的，所以我們需要它們從這個方法中移出去，使用的方法就是事件訂閱/發(fā)布。

新的架構圖

以下是使用事件發(fā)布/訂閱之后的系統(tǒng)架構圖。

• 這里我們會創(chuàng)建一個購物車提交事件ShoppingCartSubmittedEvent。

• 當站點啟動的時候，我們會在一個名為EventHandlerContainer的類中注冊訂閱ShoppingCartSubmittedEvent事件的2個處理類CreateOrderHandler和ConfirmEmailSentHandler。

• 在SubmitShoppingCart方法中，我們會做2件事情：

  • 更改當前購物車的狀態(tài)。

  • 發(fā)布ShoppingCartSubmittedEvent事件。

• CreateOrderHandler事件處理器會調用OrderManager類中的創(chuàng)建訂單方法。

• ConfirmEmailSentHandler事件處理器會負責發(fā)送郵件。

好的，下面讓我們來一步一步實現(xiàn)以上描述的代碼。

添加事件基類

這里我們首先定義一個事件基類，其中暫時只添加了一個屬性OccuredOn，它表示了當前事件的觸發(fā)時間。

public class EventBase { public EventBase() { OccuredOn = DateTime.Now; } protected DateTime OccuredOn { get; set; } }

定義購物車提交事件

接下來我們就需要創(chuàng)建購物車提交事件類ShoppingCartSubmittedEvent， 它繼承自EventBase, 并提供了一個購物項集合

public class ShoppingCartSubmittedEvent : EventBase { public ShoppingCartSubmittedEvent() { Items = new List<ShoppingCartSubmittedItem>(); } public List<ShoppingCartSubmittedItem> Items { get; set; } } public class ShoppingCartSubmittedItem { public string ItemId { get; set; } public string Name { get; set; } public decimal Price { get; set; } }

定義事件處理器接口

為了添加事件處理器，我們首先需要定義一個泛型接口類IEventHandler

public interface IEventHandler<T> where T : EventBase { void Run(T obj); Task RunAsync(T obj); }

這個泛型接口類的是泛型類型必須繼承自EventBase類。接口提供了2個方法Run和RunAsync。 它們定義了該接口的實現(xiàn)類必須實現(xiàn)同一個處理邏輯的同步和異步方法。

為購物車提交事件編寫事件處理器

有了事件處理器接口，接下來我們就可以開始為購物車提交事件添加事件處理器了。這里我們?yōu)榱藢崿F(xiàn)前面定義的邏輯，我們需要創(chuàng)建2個處理器CreateOrderHandler和ConfirmEmailSentHandler

CreateOrderHandler.cs

public class CreateOrderHandler : IEventHandler<ShoppingCartSubmittedEvent> { private IOrderManager _orderManager = null; public CreateOrderHandler(IOrderManager orderManager) { _orderManager = orderManager; } public void Run(ShoppingCartSubmittedEvent obj) { _orderManager.CreateNewOrder(new Models.DTOs.CreateOrderDTO { Items = obj.Items.Select(p => new Models.DTOs.NewOrderItemDTO { ItemId = p.ItemId, Name = p.Name, Price = p.Price }).ToList() }); } public Task RunAsync(ShoppingCartSubmittedEvent obj) { return Task.Run(() => { Run(obj); }); } }

代碼解釋：

• 在CreateOrderHandler的構造函數(shù)中，我們注入了IOrderManager接口對象，CreateNewOrder負責最終創(chuàng)建訂單的工作

• 這里為了簡化代碼，我直接使用了Task.Run，并在其中調用了同步方法實現(xiàn)

ConfirmEmailSentHandler.cs

public class ConfirmEmailSentHandler : IEventHandler<ShoppingCartSubmittedEvent> { public void Run(ShoppingCartSubmittedEvent obj) { Console.WriteLine("Confirm Email Sent."); } public Task RunAsync(ShoppingCartSubmittedEvent obj) { return Task.Run(() => { Console.WriteLine("Confirm Email Sent."); }); } }

代碼解釋：

• 這個處理類非常簡單，為了簡化代碼，我僅輸出了一行文本來表示實際需要運行的代碼。

為OrderManager類添加創(chuàng)建訂單方法

IOrderManager.cs

public interface IOrderManager { string CreateNewOrder(CreateOrderDTO dto); }

OrderManager.cs

public class OrderManager : IOrderManager { private IOrderRepository _orderRepository; public OrderManager(IOrderRepository orderRepository) { _orderRepository = orderRepository; } public string CreateNewOrder(CreateOrderDTO dto) { var orderId = _orderRepository.CreatOrder(dto); Console.WriteLine($"One order created: {JsonConvert.SerializeObject(dto)}"); return orderId; } }

創(chuàng)建EventHandlerContainer

下面我們來編寫最核心的事件處理器容器。在這里我們的事件處理器容器完成了3個功能

• 訂閱事件(Subscribe Event)

• 取消訂閱事件(Unsubscribe Event)

• 發(fā)布事件(Publish Event)

public class EventHandlerContainer { private IServiceProvider _serviceProvider = null; private static Dictionary<string, List<Type>> _mappings = new Dictionary<string, List<Type>>(); public EventHandlerContainer(IServiceProvider serviceProvider) { _serviceProvider = serviceProvider; } public static void Subscribe<T, THandler>() where T : EventBase where THandler : IEventHandler<T> { var name = typeof(T).Name; if (!_mappings.ContainsKey(name)) { _mappings.Add(name, new List<Type> { }); } _mappings[name].Add(typeof(THandler)); } public static void Unsubscribe<T, THandler>() where T : EventBase where THandler : IEventHandler<T> { var name = typeof(T).Name; _mappings[name].Remove(typeof(THandler)); if (_mappings[name].Count == 0) { _mappings.Remove(name); } } public void Publish<T>(T o) where T : EventBase { var name = typeof(T).Name; if (_mappings.ContainsKey(name)) { foreach (var handler in _mappings[name]) { var service = (IEventHandler<T>)_serviceProvider.GetService(handler); service.Run(o); } } } public async Task PublishAsync<T>(T o) where T : EventBase { var name = typeof(T).Name; if (_mappings.ContainsKey(name)) { foreach (var handler in _mappings[name]) { var service = (IEventHandler<T>)_serviceProvider.GetService(handler); await service.RunAsync(o); } } } }

代碼解釋：

• 這里我沒有直接訂閱事件處理器的實例，而且訂閱了事件處理器的類型

• 多個事件處理器可以訂閱同一個事件

• EventHandlerContainer的構造函數(shù)中，我們注入了一個IServiceProvider，我們可以使用它來獲得對應事件處理器的實例。

在程序啟動時，注冊事件訂閱

現(xiàn)在我們來Startup.cs的ConfigureServices方法，這里我們需要進行服務注冊，并完成事件訂閱。

public void ConfigureServices(IServiceCollection services) { services.AddMvc().SetCompatibilityVersion(CompatibilityVersion.Version_2_2); services.AddScoped<IOrderManager, OrderManager>(); services.AddScoped<IShoppingCartManager, ShoppingCartManager>(); services.AddScoped<IShoppingCartRepository, ShoppingCartRepository>(); services.AddScoped<IOrderRepository, OrderRepository>(); services.AddScoped<IUnitOfWork, UnitOfWork>(); services.AddScoped<CreateOrderHandler>(); services.AddScoped<ConfirmEmailSentHandler>(); services.AddScoped<EventHandlerContainer>(); EventHandlerContainer.Subscribe<ShoppingCartSubmittedEvent, CreateOrderHandler>(); EventHandlerContainer.Subscribe<ShoppingCartSubmittedEvent, ConfirmEmailSentHandler>(); }

注意：這里保證一個Api請求中的所有數(shù)據(jù)庫操作在一個事務里，這里我們使用Scoped作用域。這樣我們就可以在調用工作單元IUnitOfWork接口的Save代碼中啟用事務。

最后我們來修改ShoppingCartManager, 改用發(fā)布事件的方式來完成后續(xù)創(chuàng)建訂單和發(fā)送郵件的功能。

public void SubmitShoppingCart(string shoppingCartId) { var shoppingCart = _unitOfWork.ShoppingCartRepository .GetShoppingCart(shoppingCartId); _unitOfWork.ShoppingCartRepository .SubmitShoppingCart(shoppingCartId); _container.Publish(new ShoppingCartSubmittedEvent() { Items = shoppingCart .Items .Select(p => new ShoppingCartSubmittedItem { ItemId = p.ItemId, Name = p.Name, Price = p.Price }) .ToList() }); _unitOfWork.Save(); }

這樣ShoppingCartManager就只需要關注購物車狀態(tài)的變更，而不需要關注發(fā)送確認郵件和創(chuàng)建訂單了。

最終效果

現(xiàn)在讓我們啟動項目，

首先我們使用[POST] /api/shoppingCarts來添加一個新的購物車, 這個API會返回當前購物車的Id

然后我們使用[PUT] /api/shoppingCarts/ShoppingCart_636872897140555966來模擬提交購物車，程序返回操作成功

最后我們查看一下控制臺的輸出日志

2個事件處理器都被正確觸發(fā)了。

總結

至此我們的代碼重構完成。 最終的代碼中，SubmitShoppingCart方法，僅負責修改購物車狀態(tài)并發(fā)布一個購物車提交的事件。生成訂單和發(fā)送郵件的功能代碼都被移動到了獨立的處理類中。

這樣的方式的好處不僅僅是完成了代碼的解耦，針對后續(xù)的擴展也非常有利，想想一下，如果在未來當前項目需求追加這樣一個功能，當提交購物車的時候，除了要發(fā)送確認郵件，還要發(fā)送手機短信。這時候你根本不需要去修改ShoppingCartManager類，你只需要針對ShoppingCartSubmittedEvent在再添加一個新的事件處理器即可，這也滿足的SOLID的開閉原則。

原文地址：https://www.cnblogs.com/lwqlun/p/10468058.html

.NET社區(qū)新聞，深度好文，歡迎訪問公眾號文章匯總 http://www.csharpkit.com

總結

以上是生活随笔為你收集整理的ASP.NET Core中实现单体程序的事件发布/订阅 - LamondLu - 博客园的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網(wǎng)站內容還不錯，歡迎將生活随笔推薦給好友。