Asp.Net Core FluentValidation校验框架

---

媒介

FluentValidation 是一个流行的 .NET 库，用于构建强范例的验证规则。它通常用于验证领域模型、DTO等对象。
注意：在ASP.NET Core中，我们可以利用FluentValidation.AspNetCore包来更好地集成，它提供了自动验证的功能，这样我们就不需要在每个Action中手动调用验证了。
一、利用步骤

1.安装 NuGet 包

• 实验下令
  1. Install-Package FluentValidation.AspNetCore

  复制代码

2.创建模型

• UserRequest.cs
  1. namespace HostedService.Entity.ResOrReqEntity
  2. {
  3.     public class UserRequest
  4.     {
  5.         public long Id { get; set; }
  7.         public string UserName { get; set; }
  8.         public string Email {  get; set; }
  10.         public string Password { get; set; }
  12.         public string PasswordAgain {  get; set; }
  13.     }
  14. }

  复制代码

3.创建验证器

• UserRequestValidate.cs
  1. using FluentValidation;
  2. using HostedService.Entity;
  3. using HostedService.Entity.ResOrReqEntity;
  4. using Microsoft.AspNetCore.Http.HttpResults;
  5. using Microsoft.AspNetCore.Identity;
  6. using Microsoft.AspNetCore.Mvc;
  8. namespace HostedService.ValidateService
  9. {
  10.     public class UserRequestValidate : AbstractValidator<UserRequest>
  11.     {
  12.         private readonly UserManager<User> _user;
  13.         public UserRequestValidate(UserManager<User> user)
  14.         {
  15.             _user= user;      
  17.             RuleFor(x => x.Email).NotNull().EmailAddress()
  18.                 .WithMessage("邮箱不合法")
  19.                 .Must(x => x.EndsWith("@163.com") || x.EndsWith("@qq.com"))
  20.                 .WithMessage("邮箱只支持163或QQ邮箱");
  21.             RuleFor(x => x.UserName).NotNull().Length(3, 10)
  22.                 .WithMessage("用户名长度需要为3-10个")
  23.                 .MustAsync(FindUserByNameAsync)
  24.                 //.MustAsync(async (x, _) => await user.FindByNameAsync(x) == null)
  25.                 .WithMessage("用户已存在");
  27.             RuleFor(x => x.Password).Equal(x => x.PasswordAgain)
  28.                 .WithMessage("两次输入的密码必须一致");
  30.         }
  31.         private async Task<bool> FindUserByNameAsync(string name, CancellationToken  token)
  32.         {
  33.             var res=await _user.FindByNameAsync(name);
  34.             return res == null;
  35.         }
  36.     }
  37. }

  复制代码

4.设置 Program.cs

• Program.cs
  

1. // 注册验证器（使用异步支持）
2. builder.Services.AddValidatorsFromAssemblyContaining<Program>(ServiceLifetime.Scoped);
3. // 自定义验证错误响应
4. builder.Services.Configure<ApiBehaviorOptions>(options =>
5. {
6.     options.InvalidModelStateResponseFactory = context =>
7.     {
8.         var errors = context.ModelState
9.             .Where(e => e.Value.Errors.Count > 0)
10.             .ToDictionary(
11.                 kvp => kvp.Key,
12.                 kvp => kvp.Value.Errors.Select(e => e.ErrorMessage).ToArray()
13.             );
15.         return new BadRequestObjectResult(new
16.         {
17.             Status = 400,
18.             Message = "Validation failed",
19.             Errors = errors
20.         });
21.     };
22. });

复制代码

5.创建控制器

• TestController.cs
  
  1. using HostedService.Entity;
  2. using HostedService.Entity.ResOrReqEntity;
  3. using Microsoft.AspNetCore.Http;
  4. using Microsoft.AspNetCore.Identity;
  5. using Microsoft.AspNetCore.Mvc;
  7. namespace HostedService.Controllers
  8. {
  9.     [Route("api/[controller]/[action]")]
  10.     [ApiController]
  11.     public class TestController : ControllerBase
  12.     {
  13.         private readonly UserManager<User> _userManager;
  14.         private readonly RoleManager<Role> _roleManager;
  15.         private readonly IWebHostEnvironment _webHostEnvironment;
  17.         public TestController(UserManager<User> userManager, RoleManager<Role> roleManager, IWebHostEnvironment webHostEnvironment)
  18.         {
  19.             _userManager = userManager;
  20.             _roleManager = roleManager;
  21.             _webHostEnvironment = webHostEnvironment;
  22.         }
  23.         
  24.              [HttpPost]
  25.              public async Task<IActionResult> Add(UserRequest userRequest, [FromServices] IValidator<UserRequest> validator)
  26.              {
  27.                       //手动出发验证
  28.                  var validateRes =await validator.ValidateAsync(userRequest);
  29.                  if (!validateRes.IsValid)
  30.                  {
  31.                      return BadRequest(validateRes.ToDictionary());
  32.                  }
  33.                  User user = new User { UserName = userRequest.UserName, Email = userRequest.Email };
  34.                  await _userManager.CreateAsync(user, userRequest.Password);
  35.                  return Ok();
  36.              }
  37.     }
  38. }

  复制代码

6.测试效果

• 示例
  UserRequest
  1. {
  2.   "id": 0,
  3.   "userName": "LGF",
  4.   "email": "[email protected]",
  5.   "password": "123ggg",
  6.   "passwordAgain": "123gg"
  7. }

  复制代码
  Response Body
  1. Error: response status is 400
  3. Response body
  4. {
  5.   "Email": [
  6.     "邮箱只支持163或QQ邮箱"
  7.   ],
  8.   "UserName": [
  9.     "用户已存在"
  10.   ],
  11.   "Password": [
  12.     "两次输入的密码必须一致"
  13.   ]
  14. }

  复制代码

二、常见问题及注意事项

• 验证器未触发
  
  
  
  • 确保 AddFluentValidation() 在 AddControllers() 之后调用
    
  • 检查验证器是否在注册的程序集中
    
  
  
• 生命周期管理
  
  
  
  • 验证器发起注册为 Scoped 生命周期
    
  • 异步验证中注入的仓储需支持异步操纵
    
  
  
• 混合验证规则优先级
  1. RuleFor(x => x.UserName).NotNull().Length(3, 10) //同步验证
  2. .WithMessage("用户名长度需要为3-10个")
  3. .MustAsync(FindUserByNameAsync)//异步验证
  4. .WithMessage("用户已存在");

  复制代码

三、性能优化发起

• 同步验证优先原则：将轻量级验证（如格式校验）放在同步阶段
  
• 异步验证批处置惩罚：对需要访问外部资源的验证举行归并查询
  
• 验证缓存机制：对高频静态数据（如行政区划）可添加内存缓存
  

---

总结

通过以上设置，您可以在 ASP.NET Core 8.0 Web API 中实现验证逻辑，保持控制器简洁并返回布局化的错误相应。