ASP.NET Core WebApi中使用FluentValidation验证数据模型的方法

下面我将为您详细讲解“ASP.NET Core WebApi中使用FluentValidation验证数据模型的方法”的完整攻略。

步骤一：安装FluentValidation库

在使用FluentValidation之前，需要通过Nuget包管理器安装FluentValidation库。可以使用下面的命令安装：

Install-Package FluentValidation.AspNetCore

或者在Visual Studio中通过Nuget包管理器搜索FluentValidation.AspNetCore并进行安装。

步骤二：创建验证规则

接下来需要创建验证规则。可以在项目中的任意位置创建验证规则，但最好将其放在Models文件夹中。下面是一个示例：

public class OrderValidator : AbstractValidator<Order>
{
    public OrderValidator()
    {
        RuleFor(x => x.CustomerName).NotEmpty().WithMessage("Customer name is required.");
        RuleFor(x => x.Email).NotEmpty().EmailAddress().WithMessage("Email is required and must be a valid email address.");
        RuleFor(x => x.Total).GreaterThan(0).WithMessage("Total must be greater than 0.");
    }
}

在这个示例中，我们创建了一个验证规则OrderValidator，它继承自AbstractValidator<Order>，其中Order是我们要验证的模型。接着我们创建了三个验证规则：

1. CustomerName不能为空；
2. Email必须为有效的Email地址；
3. Total必须大于0。

如果验证失败，则会返回相应的错误消息。

步骤三：注册FluentValidation

在Startup.cs文件中注册FluentValidation，如下所示：

services.AddControllers()
        .AddFluentValidation(fv => fv.RegisterValidatorsFromAssemblyContaining<OrderValidator>());

通过调用AddFluentValidation()方法，我们可以方便地注册FluentValidation。需要注意的是，我们还需要调用RegisterValidatorsFromAssemblyContaining()方法，该方法将验证器注册到验证程序集中，如果有多个验证程序集，请多次调用该方法。

步骤四：使用验证规则

最后，在控制器中使用我们前面创建的验证规则，如下所示：

[ApiController]
public class OrderController : ControllerBase
{
    private readonly ILogger _logger;

    public OrderController(ILogger<OrderController> logger)
    {
        _logger = logger;
    }

    [HttpPost]
    public IActionResult CreateOrder(Order order)
    {
        var validator = new OrderValidator();
        var result = validator.Validate(order);

        if (!result.IsValid)
        {
            foreach (var error in result.Errors)
            {
                _logger.LogError(error.ErrorMessage);
            }
            return BadRequest();
        }

        // TODO: create order and return success response
        return Ok();
    }
}

在这个示例中，我们在控制器的CreateOrder()方法中创建了一个OrderValidator对象并使用Validate()方法对模型进行验证。如果验证失败，则使用ILogger记录错误消息并返回BadRequest。如果验证成功，则可以继续使用模型创建订单并返回成功响应。

另一个使用示例是将验证规则作为自定义筛选器中的一部分来使用，如下所示：

public class ValidateModelFilter : IActionFilter
{
    public void OnActionExecuting(ActionExecutingContext context)
    {
        var validatorFactory = context.HttpContext.RequestServices.GetService<IValidatorFactory>();
        var validator = validatorFactory.GetValidator(context.ActionDescriptor.Parameters.FirstOrDefault()?.ParameterType);

        if (validator != null)
        {
            foreach (var argument in context.ActionArguments)
            {
                var result = validator.Validate(argument.Value);

                if (!result.IsValid)
                {
                    foreach (var error in result.Errors)
                    {
                        context.ModelState.AddModelError(error.PropertyName, error.ErrorMessage);
                    }
                }
            }
        }
    }

    public void OnActionExecuted(ActionExecutedContext context)
    {
        // do nothing
    }
}

在这个示例中，我们实现了一个自定义筛选器ValidateModelFilter，它用于验证模型。我们使用IValidatorFactory来获取验证器，并使用Validate()方法对模型进行验证。如果验证失败，则将错误添加到ModelState中。最后，在Startup.cs文件中注册自定义筛选器，如下所示：

services.AddControllers(options =>
{
    options.Filters.Add<ValidateModelFilter>();
})
.AddFluentValidation(fv => fv.RegisterValidatorsFromAssemblyContaining<OrderValidator>());

在这个示例中，我们将自定义筛选器ValidateModelFilter添加到控制器选项中，这样就可以对模型进行自动验证。