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
  • .NET下 支持大小寫不敏感的JSON Schema驗證方法
    問題 有很多應用程式在驗證JSON數據的時候用到了JSON Schema。 在微服務架構下，有時候各個微服務由於各種歷史原因，它們所生成的數據對JSON Object屬性名的大小寫規則可能並不統一，它們需要消費的JSON數據的屬性名可能需要大小寫無關。 遺憾的是，目前的JSON Schema沒有這方 ...
  • 虛擬機安裝Linux CENTOS 07 部署NET8 踩坑大全
    首先下載centos07鏡像，建議使用阿裡雲推薦的地址： https://mirrors.aliyun.com/centos/7.9.2009/isos/x86_64/?spm=a2c6h.25603864.0.0.59b5f5ad5Nfr0X 其實這裡就已經出現第一個坑了 centos 07 /u ...
  • 為什麼不推薦使用Linq?
    相信很多.NETer看了標題，都會忍不住好奇，點進來看看，並且順便準備要噴作者！ 這裡，首先要申明一下，作者本人也非常喜歡Linq，也在各個項目中常用Linq。 我愛Linq，Linq優雅萬歲！！！（PS：順便吐槽一下，隔壁Java從8.0版本推出的Streams API，抄了個四不像，一點都不優雅 ...
  • 碼農的轉型之路-全力以赴升級物聯網瀏覽器(IoTBrowser)
    在人生的重要時刻，我站在了畢業的門檻上，望著前方的道路，心中涌動著對未來的無限憧憬與些許忐忑。面前，兩條道路蜿蜒伸展：一是繼續在職場中尋求穩定，一是勇敢地走出一條屬於自己的創新之路。儘管面臨年齡和現實的挑戰，我仍舊選擇勇往直前，用技術這把鑰匙，開啟新的人生篇章。 迴首過去，我深知時間寶貴，精力有限。 ...
  • [C#] 在非同步請求併發情況下，dbcontext的安全問題
    單元測試 前言 時隔多個月，終於抽空學習了點新知識，那麼這次來記錄一下C#怎麼進行單元測試，單元測試是做什麼的。 我相信大部分剛畢業的都很疑惑單元測試是乾什麼的？在小廠實習了6個月後，我發現每天除了寫CRUD就是寫CRUD，幾乎用不到單元測試。寫完一個功能直接上手去測，當然這隻是我個人感受，僅供參考 ...
  • [WPF]用HtmlTextBlock實現消息對話框的內容高亮和跳轉
    一：背景 1. 講故事 最近在分析dump時，發現有程式的卡死和WeakReference有關，在以前只知道怎麼用，但不清楚底層邏輯走向是什麼樣的，藉著這個dump的契機來簡單研究下。 二：弱引用的玩法 1. 一些基礎概念 用過WeakReference的朋友都知道這裡面又可以分為弱短和弱長兩個概念 ...
  • Dotnet core Console調用WIndows.Forms的MessageBox提示
    最近想把ET打表工具的報錯提示直接調用win系統彈窗，好讓策劃明顯的知道表格哪裡填錯數據，彈窗需要調用System.Windows.Forms庫。操作如下： 需要在 .csproj 文件中添加： <UseWindowsForms>true</UseWindowsForms> 須將目標平臺設置為 Wi ...
  • C# 13前瞻:Extensions
    從C#3開始，拓展方法這一特性就得到了廣泛的應用。 此功能允許你能夠使用實例方法的語法調用某個靜態方法，以下是一個獲取/創建文件的靜態方法: public static async Task<StorageFile> GetOrCreateFileAsync(this StorageFolder f ...
  • 修複Win10上ListView樣式不正確的問題
    在Windows 11下，使用WinUI2.6以上版本的ListView長這樣： 然而到了Win10上，儘管其他控制項的樣式沒有改變，但ListViewItem變成了預設樣式（初代Fluent） 最重大的問題是，Win10上的HorizontalAlignment未被設置成Stretch，可能造成嚴重 ...
  • 記錄一次Windows下安裝RabbitMQ
    前言 周六在公司加班，幹完活後越顯無聊，想著下載RabbiitMQ做個小項目玩玩。然而這一下就下載了2個小時，真讓人頭痛。 簡單的講一下如何安裝吧，網上教程和踩坑文章還是很多的，我講我感覺有用的文章放在本文末尾。 安裝地址 erlang 下載 - Erlang/OTP https://www.erl ...
所有分類