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
更多相關文章
  • 1、編程實現百分制轉換成五級制,規則如下: 90~100分,返回優秀; 80~89分,返回良好; 70~79分,返回中等; 60~69分,返回及格; 60分以下,返回不及格。 package main.scala.classStudy object grade { def main(args: Ar ...
  • 兩次pta題目總結 寫在前面 這兩次pta是新題目,上次那個答題判題的沒有繼續迭代了,根據這兩次題目我也學到了一些東西,主要是面向對象設計模式的運用,介面的使用,以及遞歸演算法的使用等等 第一題題目內容: 智能家居是在當下家庭中越來越流行的一種配置方案,它通過物聯網技術將家中的各種設備(如音視頻設備、 ...
  • ​XviD是個開源的視頻編解碼器,它與DivX一同被納入MPEG-4規範第二部分的視頻標準,但DivX並未開源。早期的MP4視頻大多採用XviD或者DivX編碼,當時的視頻格式被稱作MPEG-4。現在常見的H.264後來才增補到MPEG-4規範的第十部分,當然如今使用XviD壓縮的視頻已經不多了。 ...
  • Intellij插件之調試停止生命周期 目錄Intellij插件之調試停止生命周期調試會話的創建調試停止調試會話各個監聽器停止順序 調試會話的創建 調試會話的創建由 XDebuggerManager.startSessionAndShowTab 介面創建,返回一個類型為 XDebugSession ...
  • 前言:訪問webservice,大多數人都是用服務引用的方式,但是這種方式比較麻煩,例如遇到服務更新了,你還需要手動更新你的服務引用,再重新發佈,很麻煩。或者已有的一些例子,至少我看到的很多案例,動態訪問也只能止步於使用.net framework環境,沒看到有啥.net core上面動態訪問的案例 ...
  • 上一次我們講了 OpenTelemetry Logs 與 OpenTelemetry Traces。今天繼續來說說 OpenTelemetry Metrics。 隨著現代應用程式的複雜性不斷增加,對於性能監控和故障排除的需求也日益迫切。在 .NET 生態系統中,OpenTelemetry Metri ...
  • 什麼是ABP? 1、ABP全稱為ASP.NET Boilerplate Project(ASP.NET樣板項目)、誕生的主要目的就是為了讓.NET程式員“秒變”架構師,將.NET企業級項目的主流開發技術、最先進的架構整合起來,讓.NET工程師能夠更快的開發出更好的項目 2、主要特性:模塊化,多租戶, ...
  • 下麵是一個標準的IDistributedCache用例: public class SomeService(IDistributedCache cache) { public async Task<SomeInformation> GetSomeInformationAsync (string na ...
一周排行
    -Advertisement-
    Play Games
  • PasteSpider是什麼? 一款使用.net編寫的開源的Linux容器部署助手,支持一鍵發佈,平滑升級,自動伸縮, Key-Value配置,項目網關,環境隔離,運行報表,差量升級,私有倉庫,集群部署,版本管理等! 30分鐘上手,讓開發也可以很容易的學會在linux上部署你得項目! [從需求角度介 ...
  • SQLSugar是什麼 **1. 輕量級ORM框架,專為.NET CORE開發人員設計,它提供了簡單、高效的方式來處理資料庫操作,使開發人員能夠更輕鬆地與資料庫進行交互 2. 簡化資料庫操作和數據訪問,允許開發人員在C#代碼中直接操作資料庫,而不需要編寫複雜的SQL語句 3. 支持多種資料庫,包括但 ...
  • 在C#中,經常會有一些耗時較長的CPU密集型運算,因為如果直接在UI線程執行這樣的運算就會出現UI不響應的問題。解決這類問題的主要途徑是使用多線程,啟動一個後臺線程,把運算操作放在這個後臺線程中完成。但是原生介面的線程操作有一些難度,如果要更進一步的去完成線程間的通訊就會難上加難。 因此,.NET類 ...
  • 一:背景 1. 講故事 前些天有位朋友在微信上丟了一個崩潰的dump給我,讓我幫忙看下為什麼出現了崩潰,在 Windows 的事件查看器上顯示的是經典的 訪問違例 ,即 c0000005 錯誤碼,不管怎麼說有dump就可以上windbg開幹了。 二:WinDbg 分析 1. 程式為誰崩潰了 在 Wi ...
  • CSharpe中的IO+NPOI+序列化 文件文件夾操作 學習一下常見的文件、文件夾的操作。 什麼是IO流? I:就是input O:就是output,故稱:輸入輸出流 將數據讀入記憶體或者記憶體輸出的過程。 常見的IO流操作,一般說的是[記憶體]與[磁碟]之間的輸入輸出。 作用 持久化數據,保證數據不再 ...
  • C#.NET與JAVA互通之MD5哈希V2024 配套視頻: 要點: 1.計算MD5時,SDK自帶的計算哈希(ComputeHash)方法,輸入輸出參數都是byte數組。就涉及到字元串轉byte數組轉換時,編碼選擇的問題。 2.輸入參數,字元串轉byte數組時,編碼雙方要統一,一般為:UTF-8。 ...
  • CodeWF.EventBus,一款靈活的事件匯流排庫,實現模塊間解耦通信。支持多種.NET項目類型,如WPF、WinForms、ASP.NET Core等。採用簡潔設計,輕鬆實現事件的發佈與訂閱。通過有序的消息處理,確保事件得到妥善處理。簡化您的代碼,提升系統可維護性。 ...
  • 一、基本的.NET框架概念 .NET框架是一個由微軟開發的軟體開發平臺,它提供了一個運行時環境(CLR - Common Language Runtime)和一套豐富的類庫(FCL - Framework Class Library)。CLR負責管理代碼的執行,而FCL則提供了大量預先編寫好的代碼, ...
  • 本章將和大家分享在ASP.NET Core中如何使用高級客戶端NEST來操作我們的Elasticsearch。 NEST是一個高級別的Elasticsearch .NET客戶端,它仍然非常接近原始Elasticsearch API的映射。所有的請求和響應都是通過類型來暴露的,這使得它非常適合快速上手 ...
  • 參考delphi的代碼更改為C# Delphi 檢測密碼強度 規則(仿 google) 仿 google 評分規則 一、密碼長度: 5 分: 小於等於 4 個字元 10 分: 5 到 7 字元 25 分: 大於等於 8 個字元 二、字母: 0 分: 沒有字母 10 分: 全都是小(大)寫字母 20 ...