在Winform系統開發中，使用MediatR來實現類似事件總線的消息處理
當前位置：點晴教程→知識管理交流
→『 技術文檔交流 』
MediatR是一款進程內的消息訂閱、發布框架，可實現請求/響應、命令、查詢、通知和事件的消息傳遞，解耦了消息處理器和消息之間耦合。提供了Send方法用于發布到單個處理程序、Publish方法發布到多個處理程序，使用起來非常方便。目前支持 .NET Framework 、.NET Stardand、.NETCore等版本，可跨平臺使用。本篇隨筆介紹在Winform系統開發中，使用MediatR來實現類似事件總線的消息處理。 1、安裝使用MediatRMediatR的GitHub項目地址：https://github.com/jbogard/MediatR MediatR的各種場景使用代碼：https://github.com/jbogard/MediatR/wiki 如果我們在VS開發項目，我們在Nugget上找到對應模塊，直接添加到項目引用即可，如下所示。
MediatR使用 Microsoft.Extensions.DependencyInjection.Abstractions 來 注入服務處理，我們使用MediatR的時候，首先需要構造ServiceCollection，然后添加配置到其中。 // IServiceCollection負責注冊
IServiceCollection services = new ServiceCollection();
//注冊MediatR服務，用于測試MediatR的服務
services.AddMediatR(cfg => {
cfg.RegisterServicesFromAssembly(typeof(Portal).Assembly);
});使用注入服務的時候，我們需要獲得其中的ServiceProvider，如下通過BuildServiceProvider 獲得該對象。 IServiceProvider provider = services.BuildServiceProvider(); 然后我們創建一個靜態類來存儲這個對象。 //存儲全局IServiceProvider的接口實例, 便于后續獲得接口實例ServiceLocator.ConfigService(provider); 其中靜態類 ServiceLocator 的代碼如下所示。 /// <summary>
/// 全局存儲IServiceProvider
/// </summary>
public class ServiceLocator
{
/// <summary>
/// IOC中的IServiceProvider對象接口
/// </summary>
public static IServiceProvider SerivcePovider { get; private set; }
/// <summary>
/// 賦值IServiceProvider到靜態變量中
/// </summary>
/// <param name="provider">IServiceProvider對象接口</param>
public static void ConfigService(IServiceProvider provider)
{
SerivcePovider = provider;
}
/// <summary>
/// 獲取指定服務接口實例
/// </summary>
/// <returns></returns>
public static T GetService<T>()
{
return SerivcePovider.GetService<T>();
}
}后面我們就可以通過該靜態類的 GetService<T>() 方法獲取對應的注入接口IMediator，我們需要利用該接口來發送Send請求/應答命令或者發布Publish消息的處理。例如我們在窗體對象中定義該接口，用于實際的相關命令、消息的處理。 public partial class TestMediatR : BaseForm
{
private readonly IMediator _mediator;
public TestMediatR()
{
InitializeComponent();
_mediator = ServiceLocator.GetService<IMediator>();
}
2、MediatR命令或者消息的處理MediatR是一個跨平臺通過一種進程內消息傳遞機制，進行請求/響應、命令、查詢、通知和事件的消息傳遞，并通過C#泛型來支持消息的智能調度，其目的是消息發送和消息處理的解耦。它支持以單播和多播形式使用同步或異步的模式來發布消息，創建和偵聽事件。它主要的幾個對象： IMediator：主要提供Send與Publish方法，需要執行的命令都是通過這兩個方法實現 IRequest、IRequest<T>：命令查詢 | 處理類所繼承的接口，一個有返回類型，一個無返回類型，一個查詢對應一個處理類，程序集只認第一個掃描到的類。 IRequestHandler<in TRequest,TResponse>（實現Handle方法） ：命令處理接口。命令查詢 | 處理類繼承它，也可以繼承AsyncRequestHandler（實現抽象Handle方法）、RequestHandler（實現抽象Handle方法）接口 INotification：命令查詢 | 處理類所繼承的接口這個沒有返回，與IRequest不通的是可以對于多個處理類。 INotificationHandler<in TNotification>：與IRequestHandler一樣的只不過這是INotification的處理接口。 Request/Response模式對象定義 /// <summary>
/// 請求類
/// </summary>
public class RetrieveInfoCommandRequest : IRequest<RetrieveInfoCommandResponse>
{
public string Text { get; set; }
}
/// <summary>
/// 回應消息
/// </summary>
public class RetrieveInfoCommandResponse
{
public string OutputMessage { get; set; }
}
/// <summary>
/// 請求應答處理類
/// </summary>
public class RetrieveInfoCommandHandler : IRequestHandler<RetrieveInfoCommandRequest, RetrieveInfoCommandResponse>
{
public async Task<RetrieveInfoCommandResponse> Handle(RetrieveInfoCommandRequest request, CancellationToken cancellationToken)
{
var response = new RetrieveInfoCommandResponse();
response.OutputMessage = $"This is an example of MediatR using {request.Text}";
return response;
}
}例如我們根據這個請求、應答的消息協議，以及定義的處理Handler類（唯一一個），我們可以設計一個Winform界面來測試消息的處理。
界面的代碼如下所示。 /// <summary>
/// 測試MediatR的窗體例子
/// </summary>
public partial class TestMediatR : BaseForm
{
private readonly IMediator _mediator;
public TestMediatR()
{
InitializeComponent();
_mediator = ServiceLocator.GetService<IMediator>();
}
/// <summary>
/// 使用請求、應答的消息進行測試，獲得返回結果后輸出顯示
/// </summary>
private async void btnSend_Click(object sender, EventArgs e)
{
//應答處理
var outputMessage = await _mediator.Send(new RetrieveInfoCommandRequest
{
Text = this.txtSend.Text
});
Console.WriteLine(outputMessage.OutputMessage);
this.txtReceived.AppendText(outputMessage.OutputMessage + Environment.NewLine);
}上面的命令消息方式，有返回值，如果不需要返回值，也可以采用這種一一應答的方式，那么定義的時候，繼承IRequest接口即可。 public class OneWay : IRequest { }
public class OneWayHandler : IRequestHandler<OneWay>
{
public Task Handle(OneWay request, CancellationToken cancellationToken)
{
// do work
return Task.CompletedTask;
}
}
Notification 消息通知模式 如果我們需要類似事件多播的處理，也就是常規的消息通知處理，我們采用INotification方式。 Notification模式將消息發布給多個處理程序，消息的處理沒有返回值。 /// <summary>
/// 通知類
/// </summary>
public class MyNotification : INotification
{
public string Message { get; }
public MyNotification(string message)
{
Message = message;
}
}
/// <summary>
/// Notification處理程序-模塊1
/// </summary>
public class MyNotifyHandler : INotificationHandler<MyNotification>
{
public Task Handle(MyNotification notification, CancellationToken cancellationToken)
{
var message = "模塊1-收到消息:" + notification.Message;
//MessageDxUtil.ShowTips(message);
//提示消息
var alert = new AlertControl();
alert.FormLocation = AlertFormLocation.TopRight;
alert.AutoFormDelay = 3000;
alert.Show(Portal.gc.MainDialog, message, message);
// 處理通知
Console.WriteLine($"Notification處理程序-模塊1-收到消息: {notification.Message}");
return Task.CompletedTask;
}
}
/// <summary>
/// Notification處理程序-模塊2
/// </summary>
public class MySecondNotifyHandler : INotificationHandler<MyNotification>
{
public Task Handle(MyNotification notification, CancellationToken cancellationToken)
{
var message = "模塊2-收到消息:" + notification.Message;
//MessageDxUtil.ShowTips(message);
//提示消息
var alert = new AlertControl();
alert.FormLocation = AlertFormLocation.TopRight;
alert.AutoFormDelay = 3000;
alert.Show(Portal.gc.MainDialog, message, message);
// 處理通知
Console.WriteLine($"Notification處理程序-模塊2-收到消息: {notification.Message}");
return Task.CompletedTask;
}
}/// <summary>
/// 通知類
/// </summary>
public class MyNotification : INotification
{
public string Message { get; }
public MyNotification(string message)
{
Message = message;
}
}
/// <summary>
/// Notification處理程序-模塊1
/// </summary>
public class MyNotifyHandler : INotificationHandler<MyNotification>
{
public Task Handle(MyNotification notification, CancellationToken cancellationToken)
{
var message = "模塊1-收到消息:" + notification.Message;
//MessageDxUtil.ShowTips(message);
//提示消息
var alert = new AlertControl();
alert.FormLocation = AlertFormLocation.TopRight;
alert.AutoFormDelay = 3000;
alert.Show(Portal.gc.MainDialog, message, message);
// 處理通知
Console.WriteLine($"Notification處理程序-模塊1-收到消息: {notification.Message}");
return Task.CompletedTask;
}
}
/// <summary>
/// Notification處理程序-模塊2
/// </summary>
public class MySecondNotifyHandler : INotificationHandler<MyNotification>
{
public Task Handle(MyNotification notification, CancellationToken cancellationToken)
{
var message = "模塊2-收到消息:" + notification.Message;
//MessageDxUtil.ShowTips(message);
//提示消息
var alert = new AlertControl();
alert.FormLocation = AlertFormLocation.TopRight;
alert.AutoFormDelay = 3000;
alert.Show(Portal.gc.MainDialog, message, message);
// 處理通知
Console.WriteLine($"Notification處理程序-模塊2-收到消息: {notification.Message}");
return Task.CompletedTask;
}
}我們在界面上發布消息的代碼如下所示。 private async void btnNotify_Click(object sender, EventArgs e)
{ //發布消息
await _mediator.Publish(new MyNotification(this.txtSend.Text));
}可以看到在控制臺和UI上我們的都有測試消息的輸出。
默認情況下，MediatR的消息發布是一個一個執行的，即便是返回Task的情況，也是使用await等待上一個執行完成后才進行下一個的調用。如果需要使用并行的方法進行調用，可以進行定制，具體可參考官方示例：MediatR.Examples.PublishStrategies。 對于MediatR來說，無論是發送IRequest類型消息，還是發布INotification類型消息，都是異步的。這里需要特別留意，即使你使用的是同步的消息處理程序，對于消息發布來說，都是異步的，與你的處理程序是同步或異步無關。 詳細的介紹，可以參考官方的案例介紹：https://github.com/jbogard/MediatR/wiki。
3、回顧WPF的MVVM的消息處理對于WPF，其實也是類似采用該組件實現事件、消息的處理的，不過如果我們采用MVVM的框架設計模式，可以采用MVVM（微軟的 CommunityToolkit.Mvvm的組件包）的內置的消息處理模式，我在隨筆《使用WPF開發自定義用戶控件，以及實現相關自定義事件的處理》有相關的介紹。
利用MVVM推送一條消息，如下代碼所示。 //發送MVVM消息信息通知方式（一）WeakReferenceMessenger.Default.Send(new ClickEventMessage(eventData)); 而其中 ClickEventMessage 是我們根據要求定義的一個消息對象類，如下代碼所示。
完整的Command命令如下所示。 /// <summary>
/// 雙擊觸發MVVM消息通知
/// </summary>
/// <param name="typeName">處理類型：Number、Animal、WuHan</param>
/// <returns></returns>
[RelayCommand]
private async Task DoubleClick(string typeName)
{
var clickType = ClickEventType.Number;
var clickValue = this.Number;
..............//處理不同typeName值邏輯//事件數據
var eventData = new ClickEventData(clickType, clickValue);
//發送MVVM消息信息通知方式（一）
WeakReferenceMessenger.Default.Send(new ClickEventMessage(eventData));
}通過這樣的消息發送，就需要有個地方來接收這個信息的，我們在需要處理事件的父窗口中攔截處理消息即可。 //處理MVVM的消息通知
WeakReferenceMessenger.Default.Register<ClickEventMessage>(this, (r, m) =>
{
var data = m.Value;
var list = ControlHelper.FindVisualChildren<LotteryItemControl>(this.listControl);
foreach (var lottery in list)
{
lottery.SetSelected(data);
}
});從而實現了WPF消息的發送和應答處理。 另外，我在隨筆《使用 FastEndpoints 來垂直切割Web API的控制器方法》介紹的FastEndpoints 處理機制，也是類似這樣的模式，有興趣可以了解一下FastEndpoints 的處理。
作者：伍華聰 轉自：https://www.cnblogs.com/wuhuacong/p/17984987 該文章在 2024/1/25 17:22:35 編輯過 |
關鍵字查詢
相關文章
正在查詢... 
|
400 186 1886
