MediatR 教程:.NET 中的轻量级中介者实现
1. 项目介绍
MediatR 是一个简单的 .NET 实现的中介者模式库,旨在帮助解耦对象间的通信。该模式鼓励通过一个中央调度器(即中介者)来处理应用程序中的请求、通知和事件,而不是让对象直接互相依赖。这种设计降低了复杂性并提高了代码的可测试性。MediatR 由 jbogard 维护并在 GitHub 上开源。
2. 项目快速启动
安装 MediatR
在你的 .NET 项目中,可以通过以下方式安装 MediatR:
使用 NuGet 命令行(Package Manager Console)
Install-Package MediatR
或者
使用 .NET Core CLI
dotnet add package MediatR
注册 MediatR
在 .NET
应用中,你需要在 Startup.cs
的 ConfigureServices
方法中注册 MediatR:
using MediatR;
public void ConfigureServices(IServiceCollection services)
{
// 添加其他服务...
services.AddMediatR(typeof(YourEntryPointClass)); // 替换 'YourEntryPointClass' 为你的主程序类或任何公共类型
}
编写基本请求处理程序
创建一个请求接口和相应的处理程序:
// 请求接口
public interface IGreetingRequest
{
string Name { get; set; }
}
// 请求处理程序
public class GreetingRequestHandler : IRequestHandler<IGreetingRequest, string>
{
public Task<string> Handle(IGreetingRequest request, CancellationToken cancellationToken)
{
return Task.FromResult($"Hello, {request.Name}!");
}
}
发送请求
在控制器或其他需要的地方,使用依赖注入来发送请求:
[ApiController]
public class GreetingsController : ControllerBase
{
private readonly IMediator _mediator;
public GreetingsController(IMediator mediator)
{
_mediator = mediator;
}
[HttpGet]
public async Task<IActionResult> GetGreeting(string name)
{
var result = await _mediator.Send(new GreetingRequest { Name = name });
return Ok(result);
}
}
现在,当你访问 /api/greetings?name=John
,你将看到问候消息 "Hello, John!"
。
3. 应用案例与最佳实践
- 请求管道:可以添加自定义逻辑作为处理请求前后的管道,例如验证、日志记录等。
- 通知:用于广播事件,多个监听者可以响应同一个通知,但不需要返回值。
- 异步支持:所有处理程序都支持异步操作,以实现非阻塞执行。
- 独立组件:鼓励将业务逻辑组织成独立的处理程序,以保持代码的模块化和松散耦合。
4. 典型生态项目
- AutoFac.Extensions.MediatR: 提供对 AutoFac 集成的支持。
- MediatR.Extensions.Microsoft.DependencyInjection: 用于 .NET Core 中的服务注册。
- MediatRExtensions: 扩展了 MediatR 功能,如拦截器、查询分页等。
通过这些生态项目,你可以更好地利用 MediatR 并构建更健壮的应用程序。