CodeWF.EventBus:轻量级事件总线,让通信更流畅
CodeWF.EventBusEventBus(事件总线),用于解耦模块之间的通讯。本库(CodeWF.EventBus)适用于进程内消息传递(无其他外部依赖),与大家普遍使用的 MediatR 部分类似,但 MediatR 库侧重于 ASP.NET Core 设计使用,而本库也有点点优势:
设计可在各种模板项目使用,如 WPF、Winform、AvaloniaUI、ASP.NET Core 等,主要参考了 Prism.Events 设计;参考 MASA Framework 增强消息处理能力:internal class MessageHandler{[EventHandler(Order = 3)]private void ReceiveAutoCreateProductMessage3(CreateProductMessage message){AddLog($"收到自动订阅消息 3({message}”");}
}2. 怎么使用事件总线?首先定义消息类,消息需要继承自 CodeWF.EventBus.Message:
public class CreateProductMessage : CodeWF.EventBus.Message{public string Name { get; }
}
public class DeleteProductMessage : CodeWF.EventBus.Message{public string Id { get; }
}定义好消息,这里我们有两种方式使用事件总线,非 IOC 和 IOC 方式:
非 IOC 方式:需要安装 CodeWF.EventBus 包,适用于未使用 IOC 的模板程序,比如 WPF、Winform、AvaloniaUI、控制台程序,当然 ASP.NET Core 也能用。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);}
}最后是消息使用:
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);}
}[EventHandler(Order = 0)] 定义消息的执行顺序。每个消息都可以匹配多个处理程序。一个类中可以有多个消息处理方法,可以订阅同一个消息,也可以订阅不同的消息。
支持消息处理程序的注销:
注销指定处理程序:Messenger.Default.Unsubscribe<CreateProductMessage>(this, ReceiveManuCreateProductMessage)注销指定类的所有处理程序: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 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;
}3. 总结 CodeWF.EventBus,一款灵活的事件总线库,实现模块间解耦通信。支持多种.NET 项目类型,如 WPF、WinForms、ASP.NET Core 等。采用简洁设计,轻松实现事件的发布与订阅。通过有序的消息处理,确保事件得到妥善处理。简化您的代码,提升系统可维护性。立即体验 CodeWF.EventBus,让事件处理更加高效!
仓库地址是https://github.com/dotnet9/CodeWF.EventBus,开发过程中参考不少开源项目,他们是:
Prism.EventsMediatRMASA Frameworkc
版权声明: 本文为 InfoQ 作者【沙漠尽头的狼】的原创文章。
原文链接:【http://xie.infoq.cn/article/ecf9dffb683670daa48a46276】。
本文遵守【CC-BY 4.0】协议,转载请保留原文出处及本版权声明。
评论