代碼解耦之道：MediatR在.NET中的實(shí)戰(zhàn)應(yīng)用
作者：Rick
MediatR是一個(gè)強(qiáng)大的工具,可以幫助你構(gòu)建松耦合、可維護(hù)的C#應(yīng)用程序。通過(guò)分離請(qǐng)求和處理程序,它促進(jìn)了關(guān)注點(diǎn)分離,并使得添加新功能和修改現(xiàn)有功能變得更加容易。
1. 引言
MediatR是一個(gè)輕量級(jí)的中介者模式實(shí)現(xiàn)庫(kù),用于在.NET應(yīng)用程序中處理進(jìn)程內(nèi)消息傳遞。它有助于降低代碼耦合度,提高可維護(hù)性和可測(cè)試性。本文將深入探討MediatR的使用方法,并提供多個(gè)實(shí)際示例。
2. MediatR的核心概念
在深入示例之前,讓我們先了解MediatR的幾個(gè)核心概念:
- 請(qǐng)求(Request): 表示要執(zhí)行的操作。
- 處理程序(Handler): 負(fù)責(zé)處理特定類型的請(qǐng)求。
- 中介者(Mediator): 協(xié)調(diào)請(qǐng)求和處理程序之間的通信。
3. 安裝MediatR
首先,通過(guò)NuGet包管理器安裝MediatR:
dotnet add package MediatR4. 基本用法示例
4.1 創(chuàng)建請(qǐng)求和處理程序
讓我們從一個(gè)簡(jiǎn)單的示例開始,創(chuàng)建一個(gè)獲取用戶信息的請(qǐng)求:
public class GetUserQuery : IRequest<UserDto>
{
public int UserId { get; set; }
}
public class GetUserQueryHandler : IRequestHandler<GetUserQuery, UserDto>
{
public async Task<UserDto> Handle(GetUserQuery request, CancellationToken cancellationToken)
{
// 模擬從數(shù)據(jù)庫(kù)獲取用戶
await Task.Delay(100, cancellationToken); // 模擬異步操作
return new UserDto { Id = request.UserId, Name = $"User {request.UserId}" };
}
}
public class UserDto
{
public int Id { get; set; }
public string Name { get; set; }
}4.2 配置依賴注入
在Program.cs中配置MediatR:
builder.Services.AddMediatR(cfg => cfg.RegisterServicesFromAssembly(Assembly.GetExecutingAssembly()));4.3 使用MediatR發(fā)送請(qǐng)求在控制器或服務(wù)中使用MediatR:
public class UserController : ControllerBase
{
private readonly IMediator _mediator;
public UserController(IMediator mediator)
{
_mediator = mediator;
}
[HttpGet("{id}")]
public async Task<ActionResult<UserDto>> GetUser(int id)
{
var query = new GetUserQuery { UserId = id };
var result = await _mediator.Send(query);
return Ok(result);
}
}5. 高級(jí)用法示例
5.1 使用通知(Notification)
通知允許多個(gè)處理程序響應(yīng)同一個(gè)事件:
public class UserCreatedNotification : INotification
{
public int UserId { get; set; }
public string UserName { get; set; }
}
public class EmailNotificationHandler : INotificationHandler<UserCreatedNotification>
{
public Task Handle(UserCreatedNotification notification, CancellationToken cancellationToken)
{
Console.WriteLine($"Sending email for new user: {notification.UserName}");
return Task.CompletedTask;
}
}
public class LogNotificationHandler : INotificationHandler<UserCreatedNotification>
{
public Task Handle(UserCreatedNotification notification, CancellationToken cancellationToken)
{
Console.WriteLine($"Logging new user creation: {notification.UserId}");
return Task.CompletedTask;
}
}使用通知:
await _mediator.Publish(new UserCreatedNotification { UserId = 1, UserName = "John Doe" });5.2 使用管道行為(Pipeline Behavior)
管道行為允許你在處理請(qǐng)求之前和之后執(zhí)行代碼:
public class LoggingBehavior<TRequest, TResponse> : IPipelineBehavior<TRequest, TResponse>
{
private readonly ILogger<LoggingBehavior<TRequest, TResponse>> _logger;
public LoggingBehavior(ILogger<LoggingBehavior<TRequest, TResponse>> logger)
{
_logger = logger;
}
public async Task<TResponse> Handle(TRequest request, RequestHandlerDelegate<TResponse> next,CancellationToken cancellationToken)
{
_logger.LogInformation($"開始處理請(qǐng)求 {typeof(TRequest).Name}");
var response = await next();
_logger.LogInformation($"完成處理請(qǐng)求 {typeof(TResponse).Name}");
return response;
}
}注冊(cè)管道行為:
services.AddTransient(typeof(IPipelineBehavior<,>), typeof(LoggingBehavior<,>));觸發(fā)：var query = new GetUserQuery { UserId = 1 };
var result = await _mediator.Send(query);
return Ok();6. 實(shí)現(xiàn)請(qǐng)求重試機(jī)制
創(chuàng)建一個(gè)行為來(lái)自動(dòng)重試失敗的請(qǐng)求:
public class RetryBehavior<TRequest, TResponse> : IPipelineBehavior<TRequest, TResponse>
where TRequest : IRequest<TResponse>
{
private readonly ILogger<RetryBehavior<TRequest, TResponse>> _logger;
private const int MaxRetries = 3;
public RetryBehavior(ILogger<RetryBehavior<TRequest, TResponse>> logger)
{
_logger = logger;
}
public async Task<TResponse> Handle(TRequest request, RequestHandlerDelegate<TResponse> next, CancellationToken cancellationToken)
{
for (int i = 0; i <= MaxRetries; i++)
{
try
{
if (i > 0)
{
_logger.LogWarning($"Retrying {typeof(TRequest).Name} (attempt {i})");
}
return await next();
}
catch (Exception ex) when (i < MaxRetries)
{
_logger.LogError(ex, $"Error handling {typeof(TRequest).Name}. Retry attempt {i + 1} of {MaxRetries}");
await Task.Delay(1000 * i, cancellationToken);
}
}
throw new Exception($"Failed to process {typeof(TRequest).Name} after {MaxRetries} retries.");
}
}// 在Program.cs中注冊(cè)
builder.Services.AddTransient(typeof(IPipelineBehavior<,>), typeof(RetryBehavior<,>));7. 最佳實(shí)踐
- 保持請(qǐng)求和處理程序的簡(jiǎn)單性和單一職責(zé)。
- 使用通知處理跨切面關(guān)注點(diǎn),如日志記錄和事件發(fā)布。
- 利用管道行為實(shí)現(xiàn)橫切關(guān)注點(diǎn),如驗(yàn)證、日志記錄和性能監(jiān)控。
- 在大型項(xiàng)目中,考慮按功能或模塊組織請(qǐng)求和處理程序。
- 使用依賴注入容器管理MediatR和其他依賴項(xiàng)。
8. 結(jié)論
MediatR是一個(gè)強(qiáng)大的工具,可以幫助你構(gòu)建松耦合、可維護(hù)的C#應(yīng)用程序。通過(guò)分離請(qǐng)求和處理程序,它促進(jìn)了關(guān)注點(diǎn)分離,并使得添加新功能和修改現(xiàn)有功能變得更加容易。結(jié)合CQRS模式,MediatR可以成為構(gòu)建可擴(kuò)展和高性能應(yīng)用程序的有力工具。
責(zé)任編輯：武曉燕
來(lái)源：
技術(shù)老小子
