.Net Core3.0 WEB API中使用FluentValidation验证(批量注入)

下面我来详细讲解“.Net Core3.0 WEB API中使用FluentValidation验证(批量注入)”的完整攻略。

简介

FluentValidation是一个验证库，可用于在C＃中编写验证规则。 它专门用于面向对象验证，并提供了一种简单、强大的方法来验证您的一般的“POCO”类，而不需要创建过于复杂的自定义验证器。本文将介绍如何在.NET Core 3.0 WEB API中使用FluentValidation验证（批量注入）。

步骤

1.安装必要的软件包

在您的.NET Core 3.0 WEB API项目中，您需要使用NuGet包管理器安装以下软件包：

• FluentValidation
• FluentValidation.AspNetCore

您可以使用以下命令安装这些软件包：

Install-Package FluentValidation
Install-Package FluentValidation.AspNetCore

2.创建验证器

要使用FluentValidation验证，您需要为每个DTO创建一个验证器。在这里，我们创建一个名为“ProductViewModelValidator”的验证器，以验证DTO的每个属性。请参考下面的代码示例：

using FluentValidation;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;

namespace MyWebAPI.Models.ViewModels.Validators
{
    public class ProductViewModelValidator : AbstractValidator<ProductViewModel>
    {
        public ProductViewModelValidator()
        {
            RuleFor(x => x.Name).NotEmpty().WithMessage("Name is required.");
            RuleFor(x => x.Price).NotEmpty().WithMessage("Price is required.");
            RuleFor(x => x.Description).NotEmpty().WithMessage("Description is required.");
        }
    }
}

在上面的代码中，我们创建了一个“ProductViewModelValidator”类，该类通过AbstractValidator<ProductViewModel>继承FluentValidation的AbstractValidator类，并为每个属性编写了验证规则。

3.配置验证

完成验证器的创建后，我们需要将其配置为.NET Core 3.0 WEB API的服务。在Startup.cs文件的ConfigureServices()方法中添加以下代码：

using FluentValidation.AspNetCore;
using MyWebAPI.Models.ViewModels.Validators;

public void ConfigureServices(IServiceCollection services)
{
    // ...

    // Add fluent validation to the project
    services.AddControllers()
        .AddFluentValidation(fv => fv.RegisterValidatorsFromAssemblyContaining<ProductViewModelValidator>());

    // ...
}

这里我们使用AddFluentValidation()方法注册了FluentValidation服务，并为其提供验证器所在的程序集。FluentValidation将自动扫描该程序集中的验证器类，并将其注册到.NET Core 3.0 WEB API项目中。

4.完成验证

现在，我们将创建一个控制器并使用我们的验证器验证该控制器中的DTO。在下面的控制器中，我们使用了我们之前创建的ProductViewModelValidator验证器来验证CreateProductViewModel DTO。

using Microsoft.AspNetCore.Mvc;
using Microsoft.Extensions.Logging;
using MyWebAPI.Models.ViewModels;
using MyWebAPI.Models.ViewModels.Validators;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;

namespace MyWebAPI.Controllers.V1
{
    [ApiController]
    [Route("api/v1/[controller]")]
    public class ProductsController : ControllerBase
    {
        private readonly ILogger<ProductsController> _logger;

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

        // POST: api/v1/products
        [HttpPost]
        public IActionResult Post(CreateProductViewModel model)
        {
            var productValidator = new ProductViewModelValidator();
            var validationResult = productViewModelValidator.Validate(model);
            if (!validationResult.IsValid)
            {
                return BadRequest(validationResult.Errors);
            }

            // TODO: Create product

            return Ok("Product created successfully.");
        }
    }
}

在上面的代码中，我们使用ProductViewModelValidator验证器来验证CreateProductViewModel DTO，如果验证不通过则返回400错误。在通过验证之后，我们可以创建一个新的产品或者在此之前做其他的事情。

示例说明

这里我们为您提供两个示例，以帮助您更好地理解上述过程。

示例1：简单验证

我们将创建一个简单的验证，用于验证用户的姓名和年龄。在这个示例中，我们的验证器将验证用户的姓名是否为空，并且年龄必须大于18岁。请参考以下代码示例：

using FluentValidation;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;

namespace MyWebAPI.Models.ViewModels.Validators
{
    public class UserViewModelValidator : AbstractValidator<UserViewModel>
    {
        public UserViewModelValidator()
        {
            RuleFor(x => x.Name)
                .NotNull()
                .NotEmpty()
                .WithMessage("Name is required.");

            RuleFor(x => x.Age)
                .GreaterThan(18)
                .WithMessage("Age must be greater than 18.");
        }
    }
}

示例2：自定义验证器

我们将创建一个自定义验证器，用于验证密码是否符合一定的规则。在这个示例中，我们的验证器将验证密码是否包含数字，并且长度必须大于6个字符。请参考以下代码示例：

using FluentValidation;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text.RegularExpressions;
using System.Threading.Tasks;

namespace MyWebAPI.Models.ViewModels.Validators
{
    public class PasswordValidator : AbstractValidator<string>
    {
        public PasswordValidator()
        {
            RuleFor(x => x)
                .NotNull()
                .NotEmpty()
                .WithMessage("Password is required.")
                .Must(BeAValidPassword)
                .WithMessage("Password must contain a number and be at least 6 characters long.");
        }

        private bool BeAValidPassword(string text)
        {
            return text != null && text.Length >= 6 && Regex.IsMatch(text, @"\d");
        }
    }
}

在上面的代码中，我们创建了一个验证器来验证密码是否符合一定的规则。验证器内部使用了一个自定义的方法用于验证密码是否包含数字，并同时检查密码长度是否大于等于6个字符。