MediatR讓進程內通信如此簡單,基于MediatR實現事件訂閱發布功能
當使用 MediatR 這個.NET庫時,你可以實現各種不同的應用方法,包括基礎功能的使用方法以及一些高級應用。下面將詳細介紹 MediatR 在.NET應用中的各種用法,包括基礎用法和高級應用,提供帶有中文注釋的源代碼示例。
MediatR 簡介
MediatR 是一個.NET庫,用于實現 Mediator 模式,它允許你將請求和處理程序解耦,從而提高代碼的可維護性和可擴展性。在 Mediator 模式中,消息發送者(請求)不直接與消息處理者(處理程序)通信,而是通過中介者(MediatR)來傳遞消息。這可以幫助降低代碼的復雜度,使應用程序更容易擴展和維護。
基礎功能的使用方法
首先,讓我們從 MediatR 的基礎功能開始,包括請求和處理程序的創建、注冊和使用。
1. 創建請求和處理程序
在使用 MediatR 之前,你需要創建請求和處理程序。
// 創建一個請求類,它代表一個請求消息
public class MyRequest : IRequest<string>
{
public string Message { get; set; }
}
// 創建一個處理程序類,用于處理請求
public class MyRequestHandler : IRequestHandler<MyRequest, string>
{
public async Task<string> Handle(MyRequest request, CancellationToken cancellationToken)
{
// 處理請求的邏輯在這里,然后返回結果
return $"處理請求: {request.Message}";
}
}
2. 注冊 MediatR
接下來,你需要在應用程序中注冊 MediatR 服務。通常,這是在啟動時進行的操作。
public void ConfigureServices(IServiceCollection services)
{
// 注冊 MediatR 服務
services.AddMediatR(Assembly.GetExecutingAssembly());
}
這樣,MediatR 將能夠識別并管理你的請求和處理程序。
3. 發送請求
現在,你可以在你的應用程序中發送請求,MediatR 將負責將請求傳遞給正確的處理程序,并返回處理結果。
public class MyController : ControllerBase
{
private readonly IMediator _mediator;
public MyController(IMediator mediator)
{
_mediator = mediator;
}
[HttpGet]
public async Task<IActionResult> Get()
{
var request = new MyRequest { Message = "Hello, MediatR!" };
var response = await _mediator.Send(request);
return Ok(response);
}
}
這個簡單示例演示了如何創建請求、處理程序、注冊 MediatR 服務以及發送請求。MediatR 將自動路由請求到正確的處理程序,然后返回響應。
高級應用
除了基本功能,MediatR 還提供了一些高級功能,以幫助你更好地組織和擴展你的代碼。
4. 中介者管道
MediatR 提供了中介者管道,你可以在請求處理前后執行一些操作,如身份驗證、日志記錄等。這有助于分離關注點和提高代碼的可維護性。
創建中介者管道
首先,我們來創建一個中介者管道,用于記錄請求和響應的日志。
public class LoggingMiddleware<TRequest, TResponse> : IPipelineBehavior<TRequest, TResponse>
{
private readonly ILogger<LoggingMiddleware<TRequest, TResponse>> _logger;
public LoggingMiddleware(ILogger<LoggingMiddleware<TRequest, TResponse>> logger)
{
_logger = logger;
}
public async Task<TResponse> Handle(TRequest request, CancellationToken cancellationToken, RequestHandlerDelegate<TResponse> next)
{
_logger.LogInformation("處理請求: {Request}", request);
var response = await next();
_logger.LogInformation("處理結果: {Response}", response);
return response;
}
}
注冊中介者管道
在 Startup.cs 文件中,將中介者管道注冊到 MediatR。
services.AddTransient(typeof(IPipelineBehavior<,>), typeof(LoggingMiddleware<,>));
現在,每次發送請求時,LoggingMiddleware 將記錄請求和響應信息,幫助你跟蹤請求的執行過程。
5. 異常處理
MediatR 還允許你處理請求處理過程中可能發生的異常。你可以創建一個異常處理程序,并在需要時將其注冊到 MediatR。
創建異常處理程序
public class ExceptionHandlingMiddleware<TRequest, TResponse> : IPipelineBehavior<TRequest, TResponse>
{
public async Task<TResponse> Handle(TRequest request, CancellationToken cancellationToken, RequestHandlerDelegate<TResponse> next)
{
try
{
return await next();
}
catch (Exception ex)
{
// 處理異常,例如記錄日志或返回自定義錯誤信息
throw;
}
}
}
注冊異常處理程序
在 Startup.cs 文件中,將異常處理程序注冊到 MediatR。
services.AddTransient(typeof(IPipelineBehavior<,>), typeof(ExceptionHandlingMiddleware<,>));
現在,當請求處理程序中發生異常時,異常處理程序將捕獲并處理它,這有助于提高應用程序的可靠性和健壯性。
6. 多個處理程序
MediatR 允許你將多個處理程序與一個請求相關聯,這是一個非常有用的功能,特別是在需要執行多個操作或獲取多個不同處理程序的結果時。
創建多個處理程序
假設我們有一個額外的處理程序用于處理相同的請求。
public class MySecondRequestHandler : IRequestHandler<MyRequest, string>
{
public async Task<string> Handle(MyRequest request, CancellationToken cancellationToken)
{
return $"第二個處理程序: {request.Message}";
}
}
發送請求到多個處理程序
在控制器中,你可以發送請求到多個處理程序,并獲取所有處理程序的響應。
public async Task<IActionResult> Get()
{
var request = new MyRequest { Message = "Hello, MediatR!" };
var responses = await _medi
ator.Send(request);
return Ok(responses);
}
現在,你將獲得一個包含所有處理程序響應的列表,這在某些場景下非常有用。
我們詳細介紹了 MediatR 的基礎功能和高級應用,包括請求和處理程序的創建、注冊和使用,中介者管道的使用,異常處理和多個處理程序的應用。MediatR 是一個非常強大和靈活的庫,它可以幫助你更好地組織和解耦你的代碼,提高代碼的可維護性和可擴展性。