C#怎么使用MediatR管道实现请求前置校验与日志记录

在C#的分布式应用或者分层架构项目中，MediatR作为轻量级的进程内消息传递库，能够有效降低各个组件之间的耦合度。而它的管道行为（Pipeline Behavior）特性，允许我们在请求被处理器处理的前后插入自定义逻辑，非常适合用来实现请求前置校验和日志记录这类通用功能。

MediatR管道行为的基本原理

MediatR的管道行为本质上是一个实现了IPipelineBehavior<TRequest,TResponse>接口的类，多个管道行为会按照注册的顺序形成一个处理链，请求会依次经过每个管道行为的处理逻辑，最终到达对应的请求处理器。我们可以在管道行为中编写前置处理和后置处理的代码，不需要在每个请求处理器中重复编写校验和日志逻辑。

环境准备与依赖引入

首先需要在C#项目中引入MediatR相关的NuGet包，以.NET 6及以上版本为例，需要安装以下两个包：

• MediatR
• MediatR.Extensions.Microsoft.DependencyInjection

安装完成后，需要在项目的Program.cs中注册MediatR服务，指定请求处理器所在的程序集：

using MediatR;
using Microsoft.Extensions.DependencyInjection;

var builder = WebApplication.CreateBuilder(args);

// 注册MediatR，扫描当前程序集中的请求处理器和管道行为
builder.Services.AddMediatR(cfg =>
{
    cfg.RegisterServicesFromAssembly(typeof(Program).Assembly);
});

var app = builder.Build();
app.MapGet("/", () => "Hello World!");
app.Run();

定义请求与响应模型

我们先定义一个简单的创建用户请求作为示例，包含用户的基本信息和对应的响应模型：

using MediatR;

// 创建用户请求模型
public class CreateUserCommand : IRequest<CreateUserResponse>
{
    public string UserName { get; set; }
    public string Email { get; set; }
    public int Age { get; set; }
}

// 创建用户响应模型
public class CreateUserResponse
{
    public bool Success { get; set; }
    public string Message { get; set; }
    public int UserId { get; set; }
}

实现请求处理器

接下来编写创建用户请求对应的处理器，这里只做简单的模拟处理，实际项目中可以替换为数据库操作等真实逻辑：

using MediatR;

public class CreateUserCommandHandler : IRequestHandler<CreateUserCommand, CreateUserResponse>
{
    public Task<CreateUserResponse> Handle(CreateUserCommand request, CancellationToken cancellationToken)
    {
        // 模拟创建用户逻辑，实际项目中可以写入数据库
        var response = new CreateUserResponse
        {
            Success = true,
            Message = "用户创建成功",
            UserId = new Random().Next(1000, 9999)
        };
        return Task.FromResult(response);
    }
}

自定义前置校验管道行为

前置校验需要在请求到达处理器之前执行，比如校验请求参数的合法性，我们可以实现一个校验管道行为：

using MediatR;
using System;
using System.Threading;
using System.Threading.Tasks;

// 前置校验管道行为
public class ValidationPipelineBehavior<TRequest, TResponse> : IPipelineBehavior<TRequest, TResponse>
    where TRequest : IRequest<TResponse>
{
    public async Task<TResponse> Handle(TRequest request, RequestHandlerDelegate<TResponse> next, CancellationToken cancellationToken)
    {
        // 只处理CreateUserCommand类型的请求，实际项目中可以根据需要扩展通用校验
        if (request is CreateUserCommand createUserCommand)
        {
            // 校验用户名不为空
            if (string.IsNullOrWhiteSpace(createUserCommand.UserName))
            {
                throw new ArgumentException("用户名不能为空");
            }
            // 校验邮箱不为空
            if (string.IsNullOrWhiteSpace(createUserCommand.Email))
            {
                throw new ArgumentException("邮箱不能为空");
            }
            // 校验年龄合法
            if (createUserCommand.Age <= 0 || createUserCommand.Age > 120)
            {
                throw new ArgumentException("年龄必须在1到120之间");
            }
        }
        // 校验通过，继续执行下一个管道或者请求处理器
        return await next();
    }
}

自定义日志记录管道行为

日志记录需要在请求处理前后分别记录相关信息，我们可以实现一个日志管道行为，记录请求内容、处理耗时和处理结果：

using MediatR;
using System;
using System.Diagnostics;
using System.Threading;
using System.Threading.Tasks;

// 日志记录管道行为
public class LoggingPipelineBehavior<TRequest, TResponse> : IPipelineBehavior<TRequest, TResponse>
    where TRequest : IRequest<TResponse>
{
    public async Task<TResponse> Handle(TRequest request, RequestHandlerDelegate<TResponse> next, CancellationToken cancellationToken)
    {
        var stopwatch = Stopwatch.StartNew();
        // 记录请求开始时间和请求内容
        Console.WriteLine($"[{DateTime.Now:yyyy-MM-dd HH:mm:ss}] 请求开始处理，请求类型：{typeof(TRequest).Name}，请求内容：{request}");

        try
        {
            // 执行下一个管道或者请求处理器
            var response = await next();
            stopwatch.Stop();
            // 记录请求处理完成的信息
            Console.WriteLine($"[{DateTime.Now:yyyy-MM-dd HH:mm:ss}] 请求处理完成，耗时：{stopwatch.ElapsedMilliseconds}ms，响应类型：{typeof(TResponse).Name}");
            return response;
        }
        catch (Exception ex)
        {
            stopwatch.Stop();
            // 记录请求处理异常的信息
            Console.WriteLine($"[{DateTime.Now:yyyy-MM-dd HH:mm:ss}] 请求处理异常，耗时：{stopwatch.ElapsedMilliseconds}ms，异常信息：{ex.Message}");
            throw;
        }
    }
}

注册管道行为并测试

管道行为需要注册到依赖注入容器中，MediatR会自动按照注册的顺序执行这些管道行为，通常我们会把前置校验的管道放在日志记录管道之前，这样校验不通过的时候也会记录日志：

var builder = WebApplication.CreateBuilder(args);

// 注册管道行为，先注册校验，再注册日志
builder.Services.AddTransient(typeof(IPipelineBehavior<,>), typeof(ValidationPipelineBehavior<,>));
builder.Services.AddTransient(typeof(IPipelineBehavior<,>), typeof(LoggingPipelineBehavior<,>));

// 注册MediatR
builder.Services.AddMediatR(cfg =>
{
    cfg.RegisterServicesFromAssembly(typeof(Program).Assembly);
});

var app = builder.Build();

// 添加一个测试接口
app.MapPost("/create-user", async (IMediator mediator, CreateUserCommand command) =>
{
    try
    {
        var result = await mediator.Send(command);
        return Results.Ok(result);
    }
    catch (ArgumentException ex)
    {
        return Results.BadRequest(new { Success = false, Message = ex.Message });
    }
});

app.Run();

当我们发送一个合法的创建用户请求时，会先执行校验管道，通过后进入日志管道，记录请求开始信息，然后执行处理器，最后日志管道记录处理完成的信息。如果请求参数不合法，校验管道会直接抛出异常，日志管道也会捕获到异常并记录相关信息。

注意事项

• 管道行为的注册顺序决定了执行顺序，需要根据业务逻辑合理安排校验、日志等管道的顺序
• 管道行为中抛出的异常会被上层调用者捕获，需要在合适的层级处理异常，避免未捕获的异常导致程序崩溃
• 如果管道行为中需要依赖其他服务，比如日志服务、校验服务，可以通过构造函数注入的方式获取，MediatR会自动处理依赖关系
• 尽量让管道行为的逻辑保持通用，避免在一个管道中编写太多和特定请求相关的逻辑，特殊逻辑可以放在对应的请求处理器中

C#MediatR请求前置校验日志记录管道_behavior修改时间：2026-06-15 02:15:46