天天看点

.NET 源代码自动生成:MediatR、CQRS 与源代码生成器

引言

在现代软件开发中,代码生成器正变得越来越流行,尤其是在 .NET 5 中引入的新特性。通过源代码生成器,我们可以在编译时自动生成代码,从而减少手动编写的样板代码。本文将探讨如何结合 MediatR 库和 CQRS 模式,使用 .NET 源代码生成器自动为系统生成 API。

1. 理解中介者模式(Mediator Pattern)

中介者模式是一种行为设计模式,它允许我们通过一个中介对象来封装一系列对象之间的交互。在 .NET 中,MediatR 是实现这一模式的流行库之一。

```csharp              public class CreateUser : IRequest<string>              {              public string Id { get; set; }              public string Name { get; set; }              }                  [Route("api/[controller]")]              [ApiController]              public class CommandController : ControllerBase              {              private readonly IMediator _mediator;                  public CommandController(IMediator mediator)              {              _mediator = mediator;              }                  [HttpPost]              public async Task<string> Get([FromBody] CreateUser command)              {              return await _mediator.Send(command);              }              }              ```               

2. 实现命令处理程序

在接收端,我们需要实现一个处理程序来处理命令。

```csharp              public class CommandHandler : IRequestHandler<CreateUser, string>              {              public Task<string> Handle(CreateUser request, CancellationToken cancellationToken)              {              return Task.FromResult("User Created");              }              }              ```           

3. CQRS 模式简介

Command Query Responsibility Segregation(CQRS)是一种模式,它要求我们将系统中的命令(写操作)与查询(读操作)分离。

```csharp              public interface ICommand<T> : IRequest<T> { }                  public interface IQuery<T> : IRequest<T> { }                  public record CreateOrder : ICommand<string>              {              public int Id { get; set; }              public int CustomerId { get; set; }              }                  public record GetOrder : IQuery<Order>              {              public int OrderId { get; set; }              }              ```               

4. 源代码生成器

源代码生成器是 Roslyn 编译器的一个特性,它允许我们在编译过程中生成额外的代码。

```csharp              [Generator]              public class MySourceGenerator : ISourceGenerator              {              public void Execute(GeneratorExecutionContext context)              {              // 检查语法树并生成新的 C# 源代码              }                  public void Initialize(GeneratorInitializationContext context)              {              // 初始化生成器              }              }              ```           

5. 源代码生成器与 MediatR 和 CQRS 结合

我们可以创建一个源代码生成器,它将自动为我们的 Command 和 Query 生成相应的 ASP.NET Core 控制器和 Action 方法。

```csharp              [Route("api/[controller]/[Action]")]              [ApiController]              public class CommandController : ControllerBase              {              private readonly IMediator _mediator;                  public CommandController(IMediator mediator)              {              _mediator = mediator;              }                  [HttpPost]              [Produces("application/json")]              [ProducesResponseType(typeof(string), StatusCodes.Status201Created)]              [ProducesResponseType(StatusCodes.Status400BadRequest)]              public async Task<string> CreateOrder([FromBody] CreateOrder command)              {              return await _mediator.Send(command);              }                  [HttpPost]              [Produces("application/json")]              [ProducesResponseType(typeof(Order), StatusCodes.Status200OK)]              [ProducesResponseType(StatusCodes.Status400BadRequest)]              public async Task<Order> GetOrder([FromBody] GetOrder command)              {              return await _mediator.Send(command);              }              }              ```               

6. 使用 OpenAPI 生成 API 文档

通过 Swashbuckle,我们可以为自动生成的 API 控制器生成 OpenAPI(Swagger)文档。

```csharp              public void ConfigureServices(IServiceCollection services)              {              services.AddSwaggerGen(c =>              {              c.SwaggerDoc("v1", new OpenApiInfo { Title = "My API", Version = "v1" });              });              }              ```           

通过源代码生成器,我们可以显著减少需要手动编写的代码量,提高开发效率并降低出错率。结合 MediatR 和 CQRS 模式,我们可以创建一个清晰、可维护的应用程序架构。

继续阅读