MediatR.AspNetCore.Endpoints 使用指南

MediatR.AspNetCore.Endpoints 使用指南

MediatR.AspNetCore.Endpoints项目地址:https://gitcode.com/gh_mirrors/me/MediatR.AspNetCore.Endpoints

项目介绍

MediatR.AspNetCore.Endpoints 是一个结合了 ASP.NET Core 最小API特性的开源项目，旨在简化请求到REST API端点的映射过程。通过利用 MediatR 的中介者模式，该项目提供了一种更轻量级、灵活的方式来处理应用程序中的命令和查询，从而减少对控制器的依赖，实现更解耦的服务设计。它支持 .NET Core 及更高版本，适用于构建微服务架构和现代化Web应用。

项目快速启动

要快速启动并运行 MediatR.AspNetCore.Endpoints，首先确保你的开发环境已安装了 .NET SDK 相关版本。接下来，按照以下步骤操作：

安装包

在你的 ASP.NET Core 项目中，通过 NuGet 添加 MediatR.AspNetCore.Endpoints 包:

dotnet add package MediatR.AspNetCore.Endpoints --version 3.2.0

配置服务

在 Startup.cs 文件（或者等效配置类中），你需要在服务容器中添加 MediatR 和它的端点扩展方法：

using MediatR.AspNetCore.Endpoints;

public void ConfigureServices(IServiceCollection services)
{
    // 添加 MediatR
    services.AddMediatR(typeof(YourFirstCommandHandler).Assembly);
    
    // 随后添加 MediatR 的端点支持
    services.AddMediatREndpoints();
}

创建命令或查询

定义一个简单的命令，例如 YourFirstCommand 和它的处理器 YourFirstCommandHandler：

YourFirstCommand.cs

public class YourFirstCommand : IRequest<string>
{
    public string Message { get; set; }
}

YourFirstCommandHandler.cs

public class YourFirstCommandHandler : IRequestHandler<YourFirstCommand, string>
{
    public Task<string> Handle(YourFirstCommand request, CancellationToken cancellationToken)
    {
        return Task.FromResult($"Received: {request.Message}");
    }
}

映射端点

在 Configure 方法中，将路由映射到 MediatR 端点：

public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
    if (env.IsDevelopment())
    {
        app.UseDeveloperExceptionPage();
    }

    app.UseRouting();

    app.MapPost("/api/command", async context =>
    {
        var mediator = context.RequestServices.GetRequiredService<IMediator>();
        var response = await mediator.Send(new YourFirstCommand { Message = "Hello World!" });
        await context.Response.WriteAsync(response);
    });

    app.UseEndpoints(endpoints =>
    {
        endpoints.MapMediatREndpoints();
    });
}

现在，当你向 /api/command 发送 POST 请求时，它应该通过 MediatR 处理并响应。

应用案例和最佳实践

• 领域驱动设计：在复杂的业务逻辑中，利用 MediatR 实现领域模型与应用层的解耦。
• 分离关注点：让每个处理程序专注于特定的任务，保持代码清晰和可维护。
• 热重载支持：在开发过程中，自动扫描更改的装配文件以即时反映改动。
• 利用Pipelines：集成MediatR的管道行为来增加日志记录、事务管理等功能。

典型生态项目

MediatR 在微服务体系中常与其他生态组件一起使用，如：

• ASP.NET Core：作为基础平台，提供RESTful服务。
• Clean Architecture：促进层间隔离，保持核心业务逻辑纯净。
• Autofac 或 other IoC Containers：用于依赖注入，提高服务的灵活性和可测试性。
• Swagger/OpenAPI：与API文档工具集成，自动化生成接口文档。

通过上述介绍和步骤，你可以开始探索如何有效地在你的ASP.NET Core项目中运用MediatR.AspNetCore.Endpoints，实现更加模块化、灵活的服务设计。

MediatR.AspNetCore.Endpoints项目地址:https://gitcode.com/gh_mirrors/me/MediatR.AspNetCore.Endpoints