CodeWF.EventBus：輕量級事件匯流排，讓通信更流暢

来源:https://www.cnblogs.com/lsq6/p/18240479
-Advertisement-
Play Games

CodeWF.EventBus，一款靈活的事件匯流排庫，實現模塊間解耦通信。支持多種.NET項目類型，如WPF、WinForms、ASP.NET Core等。採用簡潔設計，輕鬆實現事件的發佈與訂閱。通過有序的消息處理，確保事件得到妥善處理。簡化您的代碼，提升系統可維護性。 ...


1. CodeWF.EventBus

EventBus(事件匯流排)，用於解耦模塊之間的通訊。本庫（CodeWF.EventBus）適用於進程內消息傳遞（無其他外部依賴），與大家普遍使用的MediatR部分類似，但MediatR庫側重於ASP.NET Core設計使用，而本庫也有點點優勢：

  1. 設計可在各種模板項目使用，如WPF、Winform、AvaloniaUI、ASP.NET Core等，主要參考了Prism.Events設計;
  2. 參考MASA Framework增強消息處理能力：
internal class MessageHandler
{
    [EventHandler(Order = 3)]
    private void ReceiveAutoCreateProductMessage3(CreateProductMessage message)
    {
        AddLog($"收到自動訂閱消息3({message}”");
    }

    [EventHandler(Order = 1)]
    private void ReceiveAutoDeleteProductMessage(DeleteProductMessage message)
    {
        AddLog($"收到自動訂閱消息({message}”");
    }

    [EventHandler(Order = 2)]
    private void ReceiveAutoCreateProductMessage2(CreateProductMessage message)
    {
        AddLog($"收到自動訂閱消息2({message}”");
    }
}

2. 怎麼使用事件匯流排？

首先定義消息類，消息需要繼承自CodeWF.EventBus.Message：

public class CreateProductMessage : CodeWF.EventBus.Message
{
    public string Name { get; }

    public CreateProductMessage(object sender, string name) : base(sender)
    {
        Name = name;
    }

    public override string ToString()
    {
        return $"創建產品消息-》產品名稱：{Name}";
    }
}

public class DeleteProductMessage : CodeWF.EventBus.Message
{
    public string Id { get; }

    public DeleteProductMessage(object sender, string id) : base(sender)
    {
        Id = id;
    }

    public override string ToString()
    {
        return $"刪除產品消息-》產品Id：{Id}";
    }
}

定義好消息，這裡我們有兩種方式使用事件匯流排，非IOC和IOC方式：

  1. 非IOC方式：需要安裝CodeWF.EventBus包，適用於未使用IOC的模板程式，比如WPF、Winform、AvaloniaUI、控制台程式，當然ASP.NET Core也能用。
  2. IOC方式：需要安裝CodeWF.AspNetCore.EventBus包，適合於在ASP.NET Core程式中使用。

2.1. 非IOC方式使用

適合於未使用IOC方式使用事件匯流排，比如在WPF、Winform、AvaloniaUI、控制台等程式中直接使用事件幫助類的靜態實例，下麵是使用步驟。

創建項目（不限於項目類型，比如控制台程式），通過NuGet引入CodeWF.EventBus包：

Install-Package CodeWF.EventBus -Version 1.0.1

創建消息處理程式，這裡參考了Prism.Events設計，可訂閱消息、取消訂閱消息、發佈消息，適合於手工指定處理方法：

internal class MessageHandler
{
    internal void ManuSubscribe()
    {
        Messenger.Default.Subscribe<CreateProductMessage>(this, ReceiveManuCreateProductMessage);
        Messenger.Default.Subscribe<DeleteProductMessage>(this, ReceiveManuDeleteProductMessage);
    }

    internal void ManuUnsubscribe()
    {
        Messenger.Default.Unsubscribe<CreateProductMessage>(this, ReceiveManuCreateProductMessage);
        Messenger.Default.Unsubscribe<DeleteProductMessage>(this, ReceiveManuDeleteProductMessage);
    }

    internal void Publish()
    {
        Messenger.Default.Publish(this, new CreateProductMessage(this, $"{DateTime.Now:HHmmss}號產品"));
        Messenger.Default.Publish(this, new DeleteProductMessage(this, $"{DateTime.Now:HHmmss}號"));
    }

    void ReceiveManuCreateProductMessage(CreateProductMessage message)
    {
        AddLog($"收到手動註冊的{message}");
    }

    void ReceiveManuDeleteProductMessage(DeleteProductMessage message)
    {
        AddLog($"收到手動註冊的{message}");
    }

    private void AddLog(string message)
    {
        Console.WriteLine($"{DateTime.Now:HH:mm:ss fff} {message}\r\n");
    }
}

最後是消息使用：

using ConsoleDemo.EventBus;

var handler = new MessageHandler();

Console.WriteLine("1、未註冊時發佈消息：");
handler.Publish();
Console.WriteLine();

Console.WriteLine("2、手動註冊後發佈消息：");
handler.ManuSubscribe();
handler.Publish();

Console.WriteLine("3、取消手動註冊後發佈消息：");
handler.ManuUnsubscribe();
handler.Publish();

Console.ReadKey();

如果消息較多，也可使用自動註冊消息處理方法，我們修改處理程式：

internal class MessageHandler
{
    internal void AutoSubscribe()
    {
        Messenger.Default.Subscribe(this);
    }

    internal void AutoUnsubscribe()
    {
        Messenger.Default.Unsubscribe(this);
    }

    internal void Publish()
    {
        Messenger.Default.Publish(this, new CreateProductMessage(this, $"{DateTime.Now:HHmmss}號產品"));
        Messenger.Default.Publish(this, new DeleteProductMessage(this, $"{DateTime.Now:HHmmss}號"));
    }

    [EventHandler(Order = 3)]
    private void ReceiveAutoCreateProductMessage3(CreateProductMessage message)
    {
        AddLog($"收到自動訂閱消息3({message}”");
    }

    [EventHandler(Order = 1)]
    private void ReceiveAutoDeleteProductMessage(DeleteProductMessage message)
    {
        AddLog($"收到自動訂閱消息({message}”");
    }

    [EventHandler(Order = 2)]
    private void ReceiveAutoCreateProductMessage2(CreateProductMessage message)
    {
        AddLog($"收到自動訂閱消息2({message}”");
    }

    private void AddLog(string message)
    {
        Console.WriteLine($"{DateTime.Now:HH:mm:ss fff} {message}\r\n");
    }
}

[EventHandler(Order = 0)] 定義消息的執行順序。每個消息都可以匹配多個處理程式。一個類中可以有多個消息處理方法，可以訂閱同一個消息，也可以訂閱不同的消息。

支持消息處理程式的註銷：

  1. 註銷指定處理程式：Messenger.Default.Unsubscribe<CreateProductMessage>(this, ReceiveManuCreateProductMessage)
  2. 註銷指定類的所有處理程式：Messenger.Default.Unsubscribe(this)

消息使用：

using ConsoleDemo.EventBus;

var handler = new MessageHandler();

Console.WriteLine("1、未註冊時發佈消息：");
handler.Publish();
Console.WriteLine();

Console.WriteLine("2、自動註冊後發佈消息：");
handler.AutoSubscribe();
handler.Publish();

Console.WriteLine("3、取消自動註冊後發佈消息：");
handler.AutoUnsubscribe();
handler.Publish();

Console.ReadKey();

2.2. IOC方式使用

適合於在ASP.NET Core程式中使用，下麵是使用步驟。

創建項目（ASP.NET Core模塊項目，比如Web API、MVC、Razor Page、Blazor Server等），通過NuGet引入CodeWF.AspNetCore.EventBus:

Install-Package CodeWF.AspNetCore.EventBus -Version 1.0.1

創建消息處理程式，處理類中可以正常使用構造函數註入IOC服務：

public class MessageHandler
{
    private readonly ITimeService timeService;

    public MessageHandler(ITimeService timeService)
    {
        this.timeService = timeService;
    }
    [EventHandler(Order = 3)]
    public void ReceiveAutoCreateProductMessage3(CreateProductMessage message)
    {
        AddLog($"收到消息3({message}”");
    }

    [EventHandler(Order = 1)]
    public void ReceiveAutoDeleteProductMessage(DeleteProductMessage message)
    {
        AddLog($"收到消息({message}”");
    }

    [EventHandler(Order = 2)]
    public void ReceiveAutoCreateProductMessage2(CreateProductMessage message)
    {
        AddLog($"收到消息2({message}”");
    }

    private void AddLog(string message)
    {
        Console.WriteLine($"{timeService.GetTime()}: {message}\r\n");
    }
}
public interface ITimeService
{
    string GetTime();
}

public class TimeService : ITimeService
{
    public string GetTime()
    {
        return DateTime.Now.ToString("HH:mm:ss fff");
    }
}

在Program中註冊事件匯流排：

using CodeWF.AspNetCore.EventBus;

var builder = WebApplication.CreateBuilder(args);

builder.Services.AddControllers();
builder.Services.AddEndpointsApiExplorer();
builder.Services.AddSwaggerGen();

// 用於測試事件處理類正常使用IOC功能
builder.Services.AddSingleton<ITimeService, TimeService>();

// 1、註冊事件匯流排，將標註`EventHandler`特性方法的類採用單例方式註入IOC容器
builder.Services.AddEventBus();

var app = builder.Build();

// Configure the HTTP request pipeline.
if (app.Environment.IsDevelopment())
{
    app.UseSwagger();
    app.UseSwaggerUI();
}

app.UseAuthorization();
app.MapControllers();

// 2、將上面已經註入IOC容器的類取出、關聯處理方法到事件匯流排管理
app.UseEventBus();

app.Run();

在控制器或其他服務可以發佈消息，上面的處理程式會接收處理：

[ApiController]
[Route("[controller]")]
public class EventController : ControllerBase
{
    private readonly ILogger<EventController> _logger;
    private readonly IMessenger _messenger;

    public EventController(ILogger<EventController> logger, IMessenger messenger)
    {
        _logger = logger;
        _messenger = messenger;
    }

    [HttpPost]
    public void Add()
    {
        _messenger.Publish(this, new CreateProductMessage(this, $"{DateTime.Now:HHmmss}號產品"));
    }

    [HttpDelete]
    public void Delete()
    {
        _messenger.Publish(this, new DeleteProductMessage(this, $"{DateTime.Now:HHmmss}號"));
    }
}

3. 總結

CodeWF.EventBus，一款靈活的事件匯流排庫，實現模塊間解耦通信。支持多種.NET項目類型，如WPF、WinForms、ASP.NET Core等。採用簡潔設計，輕鬆實現事件的發佈與訂閱。通過有序的消息處理，確保事件得到妥善處理。簡化您的代碼，提升系統可維護性。立即體驗CodeWF.EventBus，讓事件處理更加高效！

倉庫地址是https://github.com/dotnet9/CodeWF.EventBus，開發過程中參考不少開源項目，他們是：

  1. Prism.Events
  2. MediatR
  3. MASA Framework

您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • Scala代碼練習（複習用）
    1、編程實現百分制轉換成五級制，規則如下： 90~100分，返回優秀； 80~89分，返回良好； 70~79分，返回中等； 60~69分，返回及格； 60分以下，返回不及格。 package main.scala.classStudy object grade { def main(args: Ar ...
  • 兩次pta題目總結
    兩次pta題目總結 寫在前面 這兩次pta是新題目，上次那個答題判題的沒有繼續迭代了，根據這兩次題目我也學到了一些東西，主要是面向對象設計模式的運用，介面的使用，以及遞歸演算法的使用等等 第一題題目內容： 智能家居是在當下家庭中越來越流行的一種配置方案，它通過物聯網技術將家中的各種設備（如音視頻設備、 ...
  • FFmpeg開發筆記（二十八）Linux環境給FFmpeg集成libxvid
    ​XviD是個開源的視頻編解碼器，它與DivX一同被納入MPEG-4規範第二部分的視頻標準，但DivX並未開源。早期的MP4視頻大多採用XviD或者DivX編碼，當時的視頻格式被稱作MPEG-4。現在常見的H.264後來才增補到MPEG-4規範的第十部分，當然如今使用XviD壓縮的視頻已經不多了。 ...
  • 跟著GPT學習Java線程中斷機制
    Intellij插件之調試停止生命周期 目錄Intellij插件之調試停止生命周期調試會話的創建調試停止調試會話各個監聽器停止順序 調試會話的創建 調試會話的創建由 XDebuggerManager.startSessionAndShowTab 介面創建，返回一個類型為 XDebugSession ...
  • 誰說.net core不好動態訪問webservice？看這篇文章，C#快速實現動態訪問webservice，相容.net framework和.net core+
    前言：訪問webservice，大多數人都是用服務引用的方式，但是這種方式比較麻煩，例如遇到服務更新了，你還需要手動更新你的服務引用，再重新發佈，很麻煩。或者已有的一些例子，至少我看到的很多案例，動態訪問也只能止步於使用.net framework環境，沒看到有啥.net core上面動態訪問的案例 ...
  • .NET 使用 OpenTelemetry metrics 監控應用程式指標
    上一次我們講了 OpenTelemetry Logs 與 OpenTelemetry Traces。今天繼續來說說 OpenTelemetry Metrics。 隨著現代應用程式的複雜性不斷增加，對於性能監控和故障排除的需求也日益迫切。在 .NET 生態系統中，OpenTelemetry Metri ...
  • 新手使用ABP框架及註意事項--純後端
    什麼是ABP？ 1、ABP全稱為ASP.NET Boilerplate Project（ASP.NET樣板項目）、誕生的主要目的就是為了讓.NET程式員“秒變”架構師，將.NET企業級項目的主流開發技術、最先進的架構整合起來，讓.NET工程師能夠更快的開發出更好的項目 2、主要特性：模塊化，多租戶， ...
  • NET9 提供HybridCache解決分散式緩存中存在的遠程鏈接&序列化帶來的性能問題
    下麵是一個標準的IDistributedCache用例: public class SomeService(IDistributedCache cache) { public async Task<SomeInformation> GetSomeInformationAsync (string na ...
一周排行
    -Advertisement-
    Play Games
  • （開源）都進來！簡單易懂、功能強大的許可權+可視化流程管理系統
    1、預覽地址：http://139.155.137.144:9012 2、qq群:801913255 一、前言 隨著網路的發展，企業對於信息系統數據的保密工作愈發重視，不同身份、角色對於數據的訪問許可權都應該大相徑庭。 列如 1、不同登錄人員對一個數據列表的可見度是不一樣的，如數據列、數據行、數據按鈕 ...
  • 設計模式-C#實現簡單工廠模式
    前言 上一篇文章寫瞭如何使用RabbitMQ做個簡單的發送郵件項目，然後評論也是比較多，也是準備去學習一下如何確保RabbitMQ的消息可靠性，但是由於時間原因，先來說說設計模式中的簡單工廠模式吧！ 在瞭解簡單工廠模式之前，我們要知道C#是一款面向對象的高級程式語言。它有3大特性，封裝、繼承、多態。 ...
  • Nodify學習 一：介紹與使用
    Nodify學習 一：介紹與使用 - 可樂_加冰 - 博客園 (cnblogs.com) Nodify學習 二：添加節點 - 可樂_加冰 - 博客園 (cnblogs.com) 介紹 Nodify是一個WPF基於節點的編輯器控制項，其中包含一系列節點、連接和連接器組件，旨在簡化構建基於節點的工具的過程 ...
  • 使用C#/.NET解析Wiki百科數據實現獲取歷史上的今天
    創建一個webapi項目做測試使用。 創建新控制器，搭建一個基礎框架，包括獲取當天日期、wiki的請求地址等 創建一個Http請求幫助類以及方法，用於獲取指定URL的信息 使用http請求訪問指定url，先運行一下，看看返回的內容。內容如圖右邊所示，實際上是一個Json數據。我們主要解析 大事記 部 ...
  • .NET科普：.NET簡史、.NET Standard以及C#和.NET Framework之間的關係
    最近在不少自媒體上看到有關.NET與C#的資訊與評價，感覺大家對.NET與C#還是不太瞭解，尤其是對2016年6月發佈的跨平臺.NET Core 1.0，更是知之甚少。在考慮一番之後，還是決定寫點東西總結一下，也回顧一下.NET的發展歷史。 首先，你沒看錯，.NET是跨平臺的，可以在Windows、 ...
  • Nodify學習 二：添加節點
    Nodify學習 一：介紹與使用 - 可樂_加冰 - 博客園 (cnblogs.com) Nodify學習 二：添加節點 - 可樂_加冰 - 博客園 (cnblogs.com) 添加節點（nodes） 通過上一篇我們已經創建好了編輯器實例現在我們為編輯器添加一個節點 添加model和viewmode ...
  • 論如何直接用EF Core實現創建更新時間、用戶審計，自動化樂觀併發、軟刪除和樹形查詢（上）
    前言 資料庫併發，數據審計和軟刪除一直是數據持久化方面的經典問題。早些時候，這些工作需要手寫複雜的SQL或者通過存儲過程和觸發器實現。手寫複雜SQL對軟體可維護性構成了相當大的挑戰，隨著SQL字數的變多，用到的嵌套和複雜語法增加，可讀性和可維護性的難度是幾何級暴漲。因此如何在實現功能的同時控制這些S ...
  • C# 使用模式匹配的好處,因為好用所以推薦~
    類型檢查和轉換：當你需要檢查對象是否為特定類型，並且希望在同一時間內將其轉換為那個類型時，模式匹配提供了一種更簡潔的方式來完成這一任務，避免了使用傳統的as和is操作符後還需要進行額外的null檢查。 複雜條件邏輯：在處理複雜的條件邏輯時，特別是涉及到多個條件和類型的情況下，使用模式匹配可以使代碼更 ...
  • 推薦一種批量判斷文件是否存在的快速辦法
    在日常開發中，我們經常需要和文件打交道，特別是桌面開發，有時候就會需要載入大批量的文件，而且可能還會存在部分文件缺失的情況，那麼如何才能快速的判斷文件是否存在呢？如果處理不當的，且文件數量比較多的時候，可能會造成卡頓等情況，進而影響程式的使用體驗。今天就以一個簡單的小例子，簡述兩種不同的判斷文件是否... ...
  • 論如何直接用EF Core實現創建更新時間、用戶審計，自動化樂觀併發、軟刪除和樹形查詢（中）
    前言 資料庫併發，數據審計和軟刪除一直是數據持久化方面的經典問題。早些時候，這些工作需要手寫複雜的SQL或者通過存儲過程和觸發器實現。手寫複雜SQL對軟體可維護性構成了相當大的挑戰，隨著SQL字數的變多，用到的嵌套和複雜語法增加，可讀性和可維護性的難度是幾何級暴漲。因此如何在實現功能的同時控制這些S ...
所有分類