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 MAUI開發第一個安卓APP
    移動開發（一）：使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說，近來想嘗試開發一款安卓APP，考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP，畢竟是使用Visual Studio開發工具，使用起來也比較的順手，結合微軟官方的教程進行了安卓 ...
  • wpf ToggleButton選中效果和一個登錄界面
    前言 QuestPDF 是一個開源 .NET 庫，用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫，它徹底改變了我們生成 PDF 文檔的方 ...
  • 彈幕樹洞項目功能新增篇
    項目地址 項目後端地址： https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址： ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址： http://tree ...
  • 第27篇 sqlserver2022詳細安裝步驟
    話不多說，直接開乾 一.下載 1.官方鏈接下載： https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe，運行開始下載SQL server； 二. ...
  • .NET 開源高性能 MQTT 類庫
    前言 隨著物聯網（IoT）技術的迅猛發展，MQTT（消息隊列遙測傳輸）協議憑藉其輕量級和高效性，已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫，為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog文檔翻譯系列（六） - 可用的接收器、增強器、格式化輸出
    Serilog支持多種接收器用於日誌存儲，增強器用於添加屬性，LogContext管理動態屬性，支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項，適用於不同需求。 ...
  • 警惕 Visual Studio 屬性求值副作用導致邏輯不符合預期
    目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據，爬取信息時需要模擬瀏覽器行為，否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下： 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • [使用目前最新版]HybridCLR6.9.0+YooAsset2.2.4實現純C# Unity熱更新方案 (一)
    1.前言 什麼是熱更新 游戲或者軟體更新時，無需重新下載客戶端進行安裝，而是在應用程式啟動的情況下，在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR，Xlua，ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles，Addressable， ...
  • 在 ASP.NET Core Web API 中使用操作篩選器統一處理通用操作
    本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺，其實像阿裡雲，騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後，它會送 ...
  • 第28篇 如何.net中實現高效可靠數據同步api
    通過以下方式可以高效，並保證數據同步的可靠性 1.API設計 使用RESTful設計，確保API端點明確，並使用適當的HTTP方法（如POST用於創建，PUT用於更新）。 設計清晰的請求和響應模型，以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證，確保接收到的數據符合預期格 ...
所有分類