.NET Core中GRPC输入请求参数的最优验证方案探讨

首先要指出你提供的示例Protocol Buffer定义存在问题：id和name的字段序号都设为1，这不符合Proto规范——字段序号必须唯一，修正后的正确定义应该是：

message AudienceRequest {
    int32 id = 1;
    string name = 2;
}

针对这个需要验证id和name为必填字段的场景，以下是几种实用的验证方案：

方案一：利用.NET原生DataAnnotations验证 #

无需额外依赖，通过扩展自动生成的gRPC实体类添加验证属性：

1. 创建AudienceRequest的分部类，添加数据注解：

using System.ComponentModel.DataAnnotations;

public partial class AudienceRequest
{
    [Required(ErrorMessage = "Id 为必填字段")]
    public override int Id { get => base.Id; set => base.Id = value; }

    [Required(ErrorMessage = "Name 为必填字段")]
    public override string Name { get => base.Name; set => base.Name = value; }
}

2. 在gRPC服务方法中执行验证：

public override async Task<AudienceResponse> ProcessAudience(AudienceRequest request, ServerCallContext context)
{
    var validationContext = new ValidationContext(request);
    var validationResults = new List<ValidationResult>();
    
    if (!Validator.TryValidateObject(request, validationContext, validationResults, validateAllProperties: true))
    {
        var errorMessages = validationResults.Select(r => r.ErrorMessage);
        throw new RpcException(new Status(StatusCode.InvalidArgument, string.Join("; ", errorMessages)));
    }

    // 后续业务逻辑处理
}

方案二：使用FluentValidation实现灵活验证 #

如果需要更复杂的验证规则，FluentValidation是更优选择，步骤如下：

1. 安装NuGet包：Install-Package FluentValidation
2. 创建专属验证器类：

using FluentValidation;

public class AudienceRequestValidator : AbstractValidator<AudienceRequest>
{
    public AudienceRequestValidator()
    {
        RuleFor(x => x.Id).NotEmpty().WithMessage("Id 不能为空");
        RuleFor(x => x.Name).NotEmpty().WithMessage("Name 不能为空");
        // 可添加更多规则，比如Id范围、Name长度限制等
    }
}

3. 注册验证器（在Program.cs/Startup.cs中）：

builder.Services.AddValidatorsFromAssemblyContaining<AudienceRequestValidator>();

4. 在gRPC服务中注入并使用验证器：

private readonly IValidator<AudienceRequest> _validator;

public AudienceService(IValidator<AudienceRequest> validator)
{
    _validator = validator;
}

public override async Task<AudienceResponse> ProcessAudience(AudienceRequest request, ServerCallContext context)
{
    var validationResult = await _validator.ValidateAsync(request);
    if (!validationResult.IsValid)
    {
        var errors = validationResult.Errors.Select(e => e.ErrorMessage);
        throw new RpcException(new Status(StatusCode.InvalidArgument, string.Join("; ", errors)));
    }

    // 业务逻辑处理
}

方案三：手动验证（适合极简场景） #

如果验证逻辑非常简单，直接在服务方法中编写判断即可：

public override async Task<AudienceResponse> ProcessAudience(AudienceRequest request, ServerCallContext context)
{
    var errorList = new List<string>();
    if (request.Id == 0) // 这里根据业务需求判断，比如Id不能为默认值0
    {
        errorList.Add("Id 为必填字段，且不能为0");
    }
    if (string.IsNullOrEmpty(request.Name))
    {
        errorList.Add("Name 为必填字段");
    }

    if (errorList.Any())
    {
        throw new RpcException(new Status(StatusCode.InvalidArgument, string.Join("; ", errorList)));
    }

    // 后续业务逻辑
}

方案选择建议 #

• 原生DataAnnotations：适合简单验证场景，无额外依赖，快速实现
• FluentValidation：适合复杂验证规则，支持链式调用，规则易维护和扩展
• 手动验证：适合极简单的验证需求，无需引入任何框架

内容的提问来源于stack exchange，提问作者Mayank Gupta