CodeWF.EventBus：轻量级事件总线，让通信更流畅

杨家健康理疗

1. CodeWF.EventBus

EventBus(事件总线)，用于解耦模块之间的通讯。本库（CodeWF.EventBus）适用于进程内消息传递（无其他外部依赖），与大家普遍使用的MediatR部分类似，但MediatR库侧重于ASP.NET Core设计使用，而本库也有点点优势：

• 设计可在各种模板项目使用，如WPF、Winform、AvaloniaUI、ASP.NET Core等，主要参考了Prism.Events设计;
  
• 参考MASA Framework增强消息处理能力：
  

1. internal class MessageHandler
2. {
3.     [EventHandler(Order = 3)]
4.     private void ReceiveAutoCreateProductMessage3(CreateProductMessage message)
5.     {
6.         AddLog($"收到自动订阅消息3({message}”");
7.     }
9.     [EventHandler(Order = 1)]
10.     private void ReceiveAutoDeleteProductMessage(DeleteProductMessage message)
11.     {
12.         AddLog($"收到自动订阅消息({message}”");
13.     }
15.     [EventHandler(Order = 2)]
16.     private void ReceiveAutoCreateProductMessage2(CreateProductMessage message)
17.     {
18.         AddLog($"收到自动订阅消息2({message}”");
19.     }
20. }

复制代码

2. 怎么使用事件总线？

首先定义消息类，消息需要继承自CodeWF.EventBus.Message：

1. public class CreateProductMessage : CodeWF.EventBus.Message
2. {
3.     public string Name { get; }
5.     public CreateProductMessage(object sender, string name) : base(sender)
6.     {
7.         Name = name;
8.     }
10.     public override string ToString()
11.     {
12.         return $"创建产品消息-》产品名称：{Name}";
13.     }
14. }
16. public class DeleteProductMessage : CodeWF.EventBus.Message
17. {
18.     public string Id { get; }
20.     public DeleteProductMessage(object sender, string id) : base(sender)
21.     {
22.         Id = id;
23.     }
25.     public override string ToString()
26.     {
27.         return $"删除产品消息-》产品Id：{Id}";
28.     }
29. }

复制代码

定义好消息，这里我们有两种方式使用事件总线，非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包：

1. Install-Package CodeWF.EventBus -Version 1.0.1

复制代码

创建消息处理程序，这里参考了Prism.Events设计，可订阅消息、取消订阅消息、发布消息，适合于手工指定处理方法：

1. internal class MessageHandler
2. {
3.     internal void ManuSubscribe()
4.     {
5.         Messenger.Default.Subscribe<CreateProductMessage>(this, ReceiveManuCreateProductMessage);
6.         Messenger.Default.Subscribe<DeleteProductMessage>(this, ReceiveManuDeleteProductMessage);
7.     }
9.     internal void ManuUnsubscribe()
10.     {
11.         Messenger.Default.Unsubscribe<CreateProductMessage>(this, ReceiveManuCreateProductMessage);
12.         Messenger.Default.Unsubscribe<DeleteProductMessage>(this, ReceiveManuDeleteProductMessage);
13.     }
15.     internal void Publish()
16.     {
17.         Messenger.Default.Publish(this, new CreateProductMessage(this, $"{DateTime.Now:HHmmss}号产品"));
18.         Messenger.Default.Publish(this, new DeleteProductMessage(this, $"{DateTime.Now:HHmmss}号"));
19.     }
21.     void ReceiveManuCreateProductMessage(CreateProductMessage message)
22.     {
23.         AddLog($"收到手动注册的{message}");
24.     }
26.     void ReceiveManuDeleteProductMessage(DeleteProductMessage message)
27.     {
28.         AddLog($"收到手动注册的{message}");
29.     }
31.     private void AddLog(string message)
32.     {
33.         Console.WriteLine($"{DateTime.Now:HH:mm:ss fff} {message}\r\n");
34.     }
35. }

复制代码

最后是消息使用：

1. using ConsoleDemo.EventBus;
3. var handler = new MessageHandler();
5. Console.WriteLine("1、未注册时发布消息：");
6. handler.Publish();
7. Console.WriteLine();
9. Console.WriteLine("2、手动注册后发布消息：");
10. handler.ManuSubscribe();
11. handler.Publish();
13. Console.WriteLine("3、取消手动注册后发布消息：");
14. handler.ManuUnsubscribe();
15. handler.Publish();
17. Console.ReadKey();

复制代码

如果消息较多，也可使用自动注册消息处理方法，我们修改处理程序：

1. internal class MessageHandler
2. {
3.     internal void AutoSubscribe()
4.     {
5.         Messenger.Default.Subscribe(this);
6.     }
8.     internal void AutoUnsubscribe()
9.     {
10.         Messenger.Default.Unsubscribe(this);
11.     }
13.     internal void Publish()
14.     {
15.         Messenger.Default.Publish(this, new CreateProductMessage(this, $"{DateTime.Now:HHmmss}号产品"));
16.         Messenger.Default.Publish(this, new DeleteProductMessage(this, $"{DateTime.Now:HHmmss}号"));
17.     }
19.     [EventHandler(Order = 3)]
20.     private void ReceiveAutoCreateProductMessage3(CreateProductMessage message)
21.     {
22.         AddLog($"收到自动订阅消息3({message}”");
23.     }
25.     [EventHandler(Order = 1)]
26.     private void ReceiveAutoDeleteProductMessage(DeleteProductMessage message)
27.     {
28.         AddLog($"收到自动订阅消息({message}”");
29.     }
31.     [EventHandler(Order = 2)]
32.     private void ReceiveAutoCreateProductMessage2(CreateProductMessage message)
33.     {
34.         AddLog($"收到自动订阅消息2({message}”");
35.     }
37.     private void AddLog(string message)
38.     {
39.         Console.WriteLine($"{DateTime.Now:HH:mm:ss fff} {message}\r\n");
40.     }
41. }

复制代码

[EventHandler(Order = 0)] 定义消息的执行顺序。每个消息都可以匹配多个处理程序。一个类中可以有多个消息处理方法，可以订阅同一个消息，也可以订阅不同的消息。
支持消息处理程序的注销：

• 注销指定处理程序：Messenger.Default.Unsubscribe(this, ReceiveManuCreateProductMessage)
  
• 注销指定类的所有处理程序：Messenger.Default.Unsubscribe(this)
  

消息使用：

1. using ConsoleDemo.EventBus;
3. var handler = new MessageHandler();
5. Console.WriteLine("1、未注册时发布消息：");
6. handler.Publish();
7. Console.WriteLine();
9. Console.WriteLine("2、自动注册后发布消息：");
10. handler.AutoSubscribe();
11. handler.Publish();
13. Console.WriteLine("3、取消自动注册后发布消息：");
14. handler.AutoUnsubscribe();
15. handler.Publish();
17. Console.ReadKey();

复制代码

2.2. IOC方式使用

适合于在ASP.NET Core程序中使用，下面是使用步骤。
创建项目（ASP.NET Core模块项目，比如Web API、MVC、Razor Page、Blazor Server等），通过NuGet引入CodeWF.AspNetCore.EventBus:

1. Install-Package CodeWF.AspNetCore.EventBus -Version 1.0.1

复制代码

创建消息处理程序，处理类中可以正常使用构造函数注入IOC服务：

1. public class MessageHandler
2. {
3.     private readonly ITimeService timeService;
5.     public MessageHandler(ITimeService timeService)
6.     {
7.         this.timeService = timeService;
8.     }
9.     [EventHandler(Order = 3)]
10.     public void ReceiveAutoCreateProductMessage3(CreateProductMessage message)
11.     {
12.         AddLog($"收到消息3({message}”");
13.     }
15.     [EventHandler(Order = 1)]
16.     public void ReceiveAutoDeleteProductMessage(DeleteProductMessage message)
17.     {
18.         AddLog($"收到消息({message}”");
19.     }
21.     [EventHandler(Order = 2)]
22.     public void ReceiveAutoCreateProductMessage2(CreateProductMessage message)
23.     {
24.         AddLog($"收到消息2({message}”");
25.     }
27.     private void AddLog(string message)
28.     {
29.         Console.WriteLine($"{timeService.GetTime()}: {message}\r\n");
30.     }
31. }
32. public interface ITimeService
33. {
34.     string GetTime();
35. }
37. public class TimeService : ITimeService
38. {
39.     public string GetTime()
40.     {
41.         return DateTime.Now.ToString("HH:mm:ss fff");
42.     }
43. }

复制代码

在Program中注册事件总线：

1. using CodeWF.AspNetCore.EventBus;
3. var builder = WebApplication.CreateBuilder(args);
5. builder.Services.AddControllers();
6. builder.Services.AddEndpointsApiExplorer();
7. builder.Services.AddSwaggerGen();
9. // 用于测试事件处理类正常使用IOC功能
10. builder.Services.AddSingleton<ITimeService, TimeService>();
12. // 1、注册事件总线，将标注`EventHandler`特性方法的类采用单例方式注入IOC容器
13. builder.Services.AddEventBus();
15. var app = builder.Build();
17. // Configure the HTTP request pipeline.
18. if (app.Environment.IsDevelopment())
19. {
20.     app.UseSwagger();
21.     app.UseSwaggerUI();
22. }
24. app.UseAuthorization();
25. app.MapControllers();
27. // 2、将上面已经注入IOC容器的类取出、关联处理方法到事件总线管理
28. app.UseEventBus();
30. app.Run();

复制代码

在控制器或其他服务可以发布消息，上面的处理程序会接收处理：

1. [ApiController]
2. [Route("[controller]")]
3. public class EventController : ControllerBase
4. {
5.     private readonly ILogger<EventController> _logger;
6.     private readonly IMessenger _messenger;
8.     public EventController(ILogger<EventController> logger, IMessenger messenger)
9.     {
10.         _logger = logger;
11.         _messenger = messenger;
12.     }
14.     [HttpPost]
15.     public void Add()
16.     {
17.         _messenger.Publish(this, new CreateProductMessage(this, $"{DateTime.Now:HHmmss}号产品"));
18.     }
20.     [HttpDelete]
21.     public void Delete()
22.     {
23.         _messenger.Publish(this, new DeleteProductMessage(this, $"{DateTime.Now:HHmmss}号"));
24.     }
25. }

复制代码

3. 总结

CodeWF.EventBus，一款灵活的事件总线库，实现模块间解耦通信。支持多种.NET项目类型，如WPF、WinForms、ASP.NET Core等。采用简洁设计，轻松实现事件的发布与订阅。通过有序的消息处理，确保事件得到妥善处理。简化您的代码，提升系统可维护性。立即体验CodeWF.EventBus，让事件处理更加高效！
仓库地址是https://github.com/dotnet9/CodeWF.EventBus，开发过程中参考不少开源项目，他们是：

• Prism.Events
  
• MediatR
  
• MASA Framework
  

来源:https://www.cnblogs.com/lsq6/p/18240479
免责声明：由于采集信息均来自互联网，如果侵犯了您的权益，请联系我们【E-Mail:cb@itdo.tech】 我们会及时删除侵权内容，谢谢合作！