C# 如何使用MediatR库 – 实现CQRS模式中的命令和查询

2次阅读

CQRS将操作分为命令与查询,MediatR通过中介者模式实现解耦,提升系统可维护性与扩展性,适用于复杂业务场景。

C# 如何使用MediatR库 – 实现CQRS模式中的命令和查询

在现代C#应用程序开发中,CQRS(命令查询职责分离)模式被广泛用于提升系统可维护性和可扩展性。MediatR 是一个轻量级库,帮助我们在项目中轻松实现这一模式。它通过中介者模式将请求与处理逻辑解耦,使代码更清晰、更易于测试。

什么是CQRS?

CQRS 将数据操作分为两类:

  • 命令(Commands):用于修改状态的操作,比如创建、更新或删除数据。
  • 查询(Queries):仅用于读取数据,不改变任何状态。

这种分离让我们可以为写操作和读操作设计不同的模型、数据库甚至架构

安装与配置 MediatR

在使用之前,先通过 NuGet 安装 MediatR 和依赖注入支持包:

do.net add package MediatR
dotnet add package MediatR.Extensions.microsoft.DependencyInjection

然后在 Program.csStartup.cs 中注册服务:

builder.Services.AddMediatR(cfg => cfg.RegisterServicesFromAssembly(typeof(Program).Assembly));

这样,MediatR 就会自动发现并注册所有实现 IRequestHandler 的类。

定义命令与处理程序

以“创建用户”为例,我们定义一个命令类:

public record CreateUserCommand(String Name, string Email) : IRequest;

接着编写对应的处理程序:

public class CreateUserCommandHandler : IRequestHandler
{
private readonly IUserRepository _userRepository;

public CreateUserCommandHandler(IUserRepository userRepository)
{
_userRepository = userRepository;
}

public async Task Handle(CreateUserCommand request, CancellationToken ct)
{
var user = new User(request.Name, request.Email);
await _userRepository.AddAsync(user, ct);
return user.Id;
}
}

这个处理程序接收命令,执行业务逻辑,并返回新用户的 ID。

C# 如何使用MediatR库 – 实现CQRS模式中的命令和查询

NameGPT

免费的名称生成器,AI驱动在线生成企业名称及Logo

C# 如何使用MediatR库 – 实现CQRS模式中的命令和查询 119

查看详情 C# 如何使用MediatR库 – 实现CQRS模式中的命令和查询

定义查询与处理程序

对于查询,比如“根据ID获取用户信息”,我们这样定义:

public record GetUserByIdQuery(Guid Id) : IRequest;

处理程序从只读数据源中提取数据:

public class GetUserByIdQueryHandler : IRequestHandler
{
private readonly IUserReadRepository _readRepository;

public GetUserByIdQueryHandler(IUserReadRepository readRepository)
{
_readRepository = readRepository;
}

public async Task Handle(GetUserByIdQuery request, CancellationToken ct)
{
var user = await _readRepository.GetByIdAsync(request.Id, ct);
if (user == NULL) throw new KeyNotFoundException();
return user;
}
}

在控制器中使用 MediatR

在 ASP.NET Core 控制器中注入 ISender 接口来发送请求:

[ApiController]
[Route(“api/users”)]
public class UsersController : ControllerBase
{
private readonly ISender _sender;

public UsersController(ISender sender)
{
_sender = sender;
}

[HttpPost]
public async Task CreateUser([FromBody] CreateUserCommand command)
{
var userId = await _sender.Send(command);
return CreatedAtAction(nameof(GetUser), new { id = userId }, userId);
}

[HttpGet(“{id}”)]
public async Task> GetUser(Guid id)
{
var query = new GetUserByIdQuery(id);
var user = await _sender.Send(query);
return Ok(user);
}
}

ISender 是 MediatR 提供的核心接口,可用于发送任意请求类型。

优点与适用场景

使用 MediatR 实现 CQRS 带来的好处包括:

  • 职责清晰:每个类只做一件事。
  • 便于添加横切关注点:如日志、验证、事务控制等,可通过行为(Behaviors)统一处理。
  • 可测试性强:处理程序容易单元测试。
  • 适合复杂业务系统:尤其在读写频率差异大或性能要求高的场景下表现优异。

基本上就这些。掌握 MediatR 的基本用法后,你可以逐步引入管道行为、缓存机制或事件发布等功能,进一步增强系统的灵活性和健壮性。不复杂但容易忽略的是保持请求类的简洁和单一职责,避免滥用导致过度拆分。

text=ZqhQzanResources